JAX-RS中需要@QueryParam（以及他們不在時需要做什麼）

Question

我使用RESTEasy JAX-RS實現部署了一個web服務組件到JBoss應用服務器7。

是否有標註可用來聲明要求，強制@QueryParam在JAX-RS參數？而且，如果不是，那麼處理這些參數丟失的情況的「標準」方法是什麼？

我的網絡服務（資源）方法返回JSON字符串化的結果時正確調用所有必需的參數，但我不知道什麼是最好的方式向調用方指出缺少必需的參數。

Answer 1

好問題。不幸的是（或者幸運的是）JAX-RS沒有任何機制來強制實現任何參數。如果沒有提供參數，它的值將是NULL，您的資源應該相應地處理它。我會建議使用WebApplicationException通知用戶：

@GET 
@Path("/some-path") 
public String read(@QueryParam("name") String name) { 
    if (name == null) { 
    throw new WebApplicationException(
     Response.status(HttpURLConnection.HTTP_BAD_REQUEST) 
     .entity("name parameter is mandatory") 
     .build() 
    ); 
    } 
    // continue with a normal flow 
} 

Answer 2

您可以使用javax.validation註解來強制執行的參數是通過@javax.validation.constraints.NotNull註解它們強制性的。參見an example for Jersey和one for RESTeasy。

所以，你的方法是簡單地變成：

@GET 
@Path("/some-path") 
public String read(@NotNull @QueryParam("name") String name) { 
    String something = 
    // implementation 
    return something; 
} 

注意異常被再由JAX-RS提供的一些錯誤代碼轉換。通常可以通過註冊您自己的實現javax.ws.rs.ext.ExceptionMapper<javax.validation.ValidationException>來覆蓋它。

這提供了一種集中的方式來將強制參數轉換爲錯誤響應，並且不需要代碼重複。

Answer 3

我遇到了同樣的問題，並決定，我不想分散在我的REST代碼一個極大樣板null檢查，所以這這是我決定的事情：

1. 創建導致的註解當沒有指定必需的參數時拋出異常。
2. 處理拋出的異常的方式與我處理在我的REST代碼中拋出的所有其他異常的方式相同。

對於1），我實現了以下注釋：

import java.lang.annotation.Documented; 
import java.lang.annotation.ElementType; 
import java.lang.annotation.Retention; 
import java.lang.annotation.RetentionPolicy; 
import java.lang.annotation.Target; 

@Target(ElementType.PARAMETER) 
@Retention(RetentionPolicy.RUNTIME) 
@Documented 
public @interface Required 
{ 
    // This is just a marker annotation, so nothing in here. 
} 

...及以下JAX-RS ContainerRequestFilter去執行：

import java.lang.reflect.Parameter; 
import javax.ws.rs.QueryParam; 
import javax.ws.rs.container.ContainerRequestContext; 
import javax.ws.rs.container.ContainerRequestFilter; 
import javax.ws.rs.container.ResourceInfo; 
import javax.ws.rs.core.Context; 
import javax.ws.rs.ext.Provider; 

@Provider 
public class RequiredParameterFilter implements ContainerRequestFilter 
{ 
    @Context 
    private ResourceInfo resourceInfo; 

    @Override 
    public void filter(ContainerRequestContext requestContext) 
    { 
     // Loop through each parameter 
     for (Parameter parameter : resourceInfo.getResourceMethod().getParameters()) 
     { 
      // Check is this parameter is a query parameter 
      QueryParam queryAnnotation = parameter.getAnnotation(QueryParam.class); 

      // ... and whether it is a required one 
      if (queryAnnotation != null && parameter.isAnnotationPresent(Required.class)) 
      { 
       // ... and whether it was not specified 
       if (!requestContext.getUriInfo().getQueryParameters().containsKey(queryAnnotation.value())) 
       { 
        // We pass the query variable name to the constructor so that the exception can generate a meaningful error message 
        throw new YourCustomRuntimeException(queryAnnotation.value()); 
       } 
      } 
     } 
    } 
} 

您需要註冊ContainerRequestFilter與使用JAX-RS庫註冊其他@Provider類的方法相同。也許RESTEasy自動爲你做。

對於2），我處理使用通用的JAX-RS ExceptionMapper所有運行時異常：

import javax.ws.rs.core.Response; 
import javax.ws.rs.ext.ExceptionMapper; 
import javax.ws.rs.ext.Provider; 

@Provider 
public class MyExceptionMapper implements ExceptionMapper<RuntimeException> 
{ 
    @Override 
    public Response toResponse(RuntimeException ex) 
    { 
     // In this example, we just return the .toString() of the exception. 
     // You might want to wrap this in a JSON structure if this is a JSON API, for example. 
     return Response 
      .status(Response.Status.BAD_REQUEST) 
      .entity(ex.toString()) 
      .build(); 
    } 
} 

和以前一樣，記得你的JAX-RS庫註冊類。