知識庫 / Spring RSS 訂閱

4.2. 服務實現

現在，讓我們看看如何使用 JAX-RS 註解來創建 RESTful Web 服務：

@Path("/employees")
public class EmployeeResource {
 
    @Autowired
    private EmployeeRepository employeeRepository;

    @GET
    @Path("/{id}")
    @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
    public Employee getEmployee(@PathParam("id") int id) {
        return employeeRepository.getEmployee(id);
    }

    @POST
    @Consumes({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
    public Response addEmployee(
      Employee employee, @Context UriInfo uriInfo) {
 
        employeeRepository.addEmployee(new Employee(employee.getId(), 
          employee.getFirstName(), employee.getLastName(), 
          employee.getAge()));
 
        return Response.status(Response.Status.CREATED.getStatusCode())
          .header(
            "Location", 
            String.format("%s/%s",uriInfo.getAbsolutePath().toString(), 
            employee.getId())).build();
    }
}

@Path 標註提供服務端的相對 URI 路徑。 此外，我們還可以將變量嵌入 URI 語法中，如{id} 變量所示。 然後，變量將在運行時進行替換。 要獲取變量的值，可以使用@PathParam 標註。

@GET, @PUT, @POST, @DELETE 和 @HEAD 定義請求的 HTTP 方法， 這些方法將由標註的方法處理。

@Produces 標註定義端點的響應類型 (MIME 媒體類型)。 在我們的示例中，我們已將其配置為根據 HTTP 標頭Accept (application/json 或 application/xml) 的值返回 JSON 或 XML。

另一方面，@Consumes 標註定義服務可以消耗的 MIME 媒體類型。 在我們的示例中，服務可以根據 HTTP 標頭Content-Type (application/json 或 application/xml) 消耗 JSON 或 XML。

@Context 標註用於將信息注入到類字段、Bean 屬性或方法參數中。 在我們的示例中，我們使用它來注入 UriInfo。 此外，我們還可以使用它來注入 ServletConfig、ServletContext、HttpServletRequest 和 HttpServletResponse。

5. 使用 ExceptionMapper

ExceptionMapper 允許我們攔截異常並向客户端返回適當的 HTTP 響應代碼。 在下面的示例中，如果拋出 EmployeeNotFound 異常，則返回 HTTP 響應代碼 404。

@Provider
public class NotFoundExceptionHandler 
  implements ExceptionMapper<EmployeeNotFound> {
 
    public Response toResponse(EmployeeNotFound ex) {
        return Response.status(Response.Status.NOT_FOUND).build();
    }
}

6. 管理資源類

最後，讓我們將所有服務實現類和異常映射器與應用程序路徑連接起來：

@ApplicationPath("/resources")
public class RestConfig extends Application {
    public Set<Class<?>> getClasses() {
        return new HashSet<Class<?>>(
          Arrays.asList(
            EmployeeResource.class, 
            NotFoundExceptionHandler.class, 
            AlreadyExistsExceptionHandler.class));
    }
}

7. API 測試

現在，讓我們通過一些實測來測試 API：

public class JerseyApiLiveTest {

    private static final String SERVICE_URL
      = "http://localhost:8082/spring-jersey/resources/employees";

    @Test
    public void givenGetAllEmployees_whenCorrectRequest_thenResponseCodeSuccess() 
      throws ClientProtocolException, IOException {
 
        HttpUriRequest request = new HttpGet(SERVICE_URL);

        HttpResponse httpResponse = HttpClientBuilder
          .create()
          .build()
          .execute(request);

        assertEquals(httpResponse
          .getStatusLine()
          .getStatusCode(), HttpStatus.SC_OK);
    }
}

8. 結論

在本文中，我們介紹了 Jersey 框架並開發了一個簡單的 API。我們使用了 Spring 框架的依賴注入功能。我們還看到了 ExceptionMapper 的使用。