知識庫 / Spring RSS 訂閱

public enum PhoneType implements com.google.protobuf.ProtocolMessageEnum {
    MOBILE(0),
    LANDLINE(1),
    UNRECOGNIZED(-1),
    ;
    // Other declarations
}

@SpringBootApplication
public class Application {
    @Bean
    ProtobufHttpMessageConverter protobufHttpMessageConverter() {
        return new ProtobufHttpMessageConverter();
    }

    @Bean
    public CourseRepository createTestCourses() {
        Map<Integer, Course> courses = new HashMap<>();
        Course course1 = Course.newBuilder()
          .setId(1)
          .setCourseName("REST with Spring")
          .addAllStudent(createTestStudents())
          .build();
        Course course2 = Course.newBuilder()
          .setId(2)
          .setCourseName("Learn Spring Security")
          .addAllStudent(new ArrayList<Student>())
          .build();
        courses.put(course1.getId(), course1);
        courses.put(course2.getId(), course2);
        return new CourseRepository(courses);
    }

    // Other declarations
}

public class CourseRepository {
    Map<Integer, Course> courses;
    
    public CourseRepository (Map<Integer, Course> courses) {
        this.courses = courses;
    }
    
    public Course getCourse(int id) {
        return courses.get(id);
    }
}

我們可以通過以下方式定義測試 URL 的 <em @Controller@ 類：

@RestController
public class CourseController {
    @Autowired
    CourseRepository courseRepo;

    @RequestMapping("/courses/{id}")
    Course customer(@PathVariable Integer id) {
        return courseRepo.getCourse(id);
    }
}

再次強調，這裏最重要的是，我們從控制器層返回的 Course DTO 不是一個標準的 POJO。這將會觸發它被轉換為 protocol buffer 消息，然後再被傳輸回客户端。

4. REST 客户端和測試

現在我們已經瞭解了簡單的 API 實現——現在讓我們演示客户端上 Protocol Buffer 消息的解串，使用兩種方法。

第一種方法利用了 RestTemplate API 和預配置的 ProtobufHttpMessageConverter Bean，自動將消息轉換為目標格式。

第二種方法是使用 protobuf-java-format 手動將 Protocol Buffer 響應轉換為 JSON 文檔。

首先，我們需要設置集成測試的上下文，並指示 Spring Boot 通過聲明測試類來查找配置信息在 Application 類中：

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = Application.class)
@WebIntegrationTest
public class ApplicationTest {
    // Other declarations
}

本部分的所有代碼片段將被放置在 ApplicationTest 類中。

4.1. 預期響應

訪問 REST 服務的第一步是確定請求 URL：

private static final String COURSE1_URL = "http://localhost:8080/courses/1";

本 COURSE1_URL 將用於從我們之前創建的 REST 服務中獲取第一個測試雙倍課程。 發送 GET 請求到上述 URL 後，將使用以下斷言驗證相應的響應：

private void assertResponse(String response) {
    assertThat(response, containsString("id"));
    assertThat(response, containsString("course_name"));
    assertThat(response, containsString("REST with Spring"));
    assertThat(response, containsString("student"));
    assertThat(response, containsString("first_name"));
    assertThat(response, containsString("last_name"));
    assertThat(response, containsString("email"));
    assertThat(response, containsString("[email protected]"));
    assertThat(response, containsString("[email protected]"));
    assertThat(response, containsString("[email protected]"));
    assertThat(response, containsString("phone"));
    assertThat(response, containsString("number"));
    assertThat(response, containsString("type"));
}

我們將在後續子章節中涵蓋的測試用例中充分利用這個輔助方法。

4.2. 使用 RestTemplate 進行測試

以下是如何創建一個客户端，向指定目的地發送 GET 請求，接收以 Protocol Buffer 消息形式的響應，並使用 RestTemplate API 進行驗證：

@Autowired
private RestTemplate restTemplate;

@Test
public void whenUsingRestTemplate_thenSucceed() {
    ResponseEntity<Course> course = restTemplate.getForEntity(COURSE1_URL, Course.class);
    assertResponse(course.toString());
}

為了使此測試用例生效，我們需要在配置類中註冊一個類型的 RestTemplate 類型的 Bean：

@Bean
RestTemplate restTemplate(ProtobufHttpMessageConverter hmc) {
    return new RestTemplate(Arrays.asList(hmc));
}

另一個 <em ProtobufHttpMessageConverter</em> 類型的 Bean 也需要被配置，以自動轉換接收到的 Protocol Buffer 消息。這個 Bean 與子章節 3.1 中定義的 Bean 相同。由於本教程中的客户端和服務器共享相同的應用程序上下文，因此我們可以將 <em RestTemplate</em> Bean 聲明在 <em Application</em> 類中，並重用 <em ProtobufHttpMessageConverter</em> Bean。

4.3. 使用 HttpClient 進行測試

要使用 HttpClient API 並手動轉換協議緩衝區消息，請在 Maven POM 文件中添加以下兩個依賴項：

<dependency>
    <groupId>com.googlecode.protobuf-java-format</groupId>
    <artifactId>protobuf-java-format</artifactId>
    <version>1.4</version>
</dependency>
<dependency>
    <groupId>org.apache.httpcomponents</groupId>
    <artifactId>httpclient</artifactId>
    <version>4.5.14</version>
</dependency>

請查閲這些依賴項的最新版本：protobuf-java-format 和 httpclient 在 Maven 中央倉庫中的 Artifacts。

現在，讓我們創建一個客户端，執行一個 GET 請求並將相關的響應轉換為一個 InputStream 實例，使用提供的 URL：

private InputStream executeHttpRequest(String url) throws IOException {
    CloseableHttpClient httpClient = HttpClients.createDefault();
    HttpGet request = new HttpGet(url);
    HttpResponse httpResponse = httpClient.execute(request);
    return httpResponse.getEntity().getContent();
}

現在，我們將以InputStream對象的形式轉換協議緩衝區消息，將其轉換為JSON文檔：

private String convertProtobufMessageStreamToJsonString(InputStream protobufStream) throws IOException {
    JsonFormat jsonFormat = new JsonFormat();
    Course course = Course.parseFrom(protobufStream);
    return jsonFormat.printToString(course);
}

以下是如何使用在上方聲明的私有輔助方法以及驗證響應的測試用例：

@Test
public void whenUsingHttpClient_thenSucceed() throws IOException {
    InputStream responseStream = executeHttpRequest(COURSE1_URL);
    String jsonOutput = convertProtobufMessageStreamToJsonString(responseStream);
    assertResponse(jsonOutput);
}

4.4. 響應 JSON

為了便於理解，以下包含我們在先前子章節中描述的測試中接收到的響應的 JSON 格式：

id: 1
course_name: "REST with Spring"
student {
    id: 1
    first_name: "John"
    last_name: "Doe"
    email: "[email protected]"
    phone {
        number: "123456"
    }
}
student {
    id: 2
    first_name: "Richard"
    last_name: "Roe"
    email: "[email protected]"
    phone {
        number: "234567"
        type: LANDLINE
    }
}
student {
    id: 3
    first_name: "Jane"
    last_name: "Doe"
    email: "[email protected]"
    phone {
        number: "345678"
    }
    phone {
        number: "456789"
        type: LANDLINE
    }
}

5. 結論

本教程快速介紹了 Protocol Buffers 並演示了使用 Spring 框架設置 REST API 的方法。隨後，我們轉向了客户端支持以及序列化-反序列化機制。