RESTEasy - 在@ GET / @ POST时重用方法参数

Question

我的RESTEasy服务中有一个方法，我想将其用作@GET / @POST，其数据可能来自查询字符串和请求正文。

@GET
@POST
public String myMethod(@QueryParam("param1") @FormParam("param1") String param1,
                       @QueryParam("param2") @FormParam("param1") String param2) {
    // ...do things
}

但是，如果不执行以下操作，我还没有找到一种方法：

@GET
public String myMethod(@QueryParam("param1") String param1, @QueryParam("param2") String param2) {
    // ...do things
}

@POST
public String myMethod2(@FormParam("param1") String param1, @FormParam("param2") String param2) {
    return this.myMethod(param1, param2);
}

是否有人知道如何使第一个示例工作，或者使用代码最少的另一种方法？

Answer 1

引用本书 使用JAX-RS的RESTful Java ：

  

JAX-RS定义了五个映射到特定HTTP操作的注释：

     

  
• @javax.ws.rs.GET
  
• @javax.ws.rs.PUT
  
• @javax.ws.rs.POST
  
• @javax.ws.rs.DELETE
  
• @javax.ws.rs.HEAD
  

     

（...）
  @GET注释指示JAX-RS运行时使用此Java方法   将处理HTTP GET请求到URI。你会用的   前面描述的另外五个注释中的一个用于绑定   不同的HTTP操作。 但有一点需要注意的是，你   每个Java方法只能应用一个HTTP方法注释。一个   如果您应用多个，则会发生部署错误。

^{（上面的文字是由RESTEasy的创建者撰写的。）}

简而言之，由于RESTEasy符合JAX-RS，因此无法使用多个HTTP谓词注释方法。

如果您不相信，查看@GET注释，您可以看到@HttpMethod只是元注释。

/**
 * Indicates that the annotated method responds to HTTP GET requests
 * @see HttpMethod
 */
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@HttpMethod(HttpMethod.GET)
public @interface GET { 
}

如果您打开@HttpMethod，请检查javadoc（ 使用HttpMethod注释的多个注释对方法进行注释是错误的。< / EM> ）：

/**
 * Associates the name of a HTTP method with an annotation. A Java method annotated
 * with a runtime annotation that is itself annotated with this annotation will
 * be used to handle HTTP requests of the indicated HTTP method. It is an error
 * for a method to be annotated with more than one annotation that is annotated
 * with {@code HttpMethod}.
 *
 * @see GET
 * @see POST
 * @see PUT
 * @see DELETE
 * @see HEAD
 */
@Target({ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface HttpMethod
{

所以，就是这样，你不能用同样的方法把它们都放在一起。

---

那就是说，如果你真的必须通过在JAX-RS方法之前调用的PreProcessInterceptor来实现这一点。

但是，这种方式要复杂得多（因为你必须自己解析参数）而且可维护性较差（拦截器提供服务！？）。

最重要的是，据我所知，您的解决方案是最佳选择。

检查我在下面的测试中说的是什么：

public class QueryAndFormParamTest  {

    @Path("/")
    public static class InterceptedResource {
        @GET
        //@Path("/stuff") // uncomment this and it will not work
        public String otherService(@QueryParam("yadda") String name){
            return "Im never called in this example" + name;
        }
    }

    public static class MyInterceptor implements PreProcessInterceptor, AcceptedByMethod {
        @Override
        public boolean accept(Class declaring, Method method) {
            System.out.println("Accepted by method "+method.getName());
            // you can check if this interceptor should act on this method here
            return true; // it'll act everytime
        }

        @Override
        public ServerResponse preProcess(HttpRequest request, ResourceMethod method)
                throws Failure, WebApplicationException {

            // parsing form parameters
            if (request.getHttpHeaders().getMediaType() != null && request.getHttpHeaders().getMediaType().isCompatible(MediaType.valueOf("application/x-www-form-urlencoded"))) {
                MultivaluedMap<String, String> formParameters = request.getFormParameters();
                if (formParameters != null) {
                    for (String key : formParameters.keySet()) {
                        System.out.println("[FORM] "+key + ": "+formParameters.get(key));
                    }
                }
            }

            // parsing query parameters
            MultivaluedMap<String, String> queryParameters = request.getUri().getQueryParameters();
            if (queryParameters != null)
            for (String key : queryParameters.keySet()) {
                System.out.println("[QUERY] "+key + ": "+queryParameters.get(key));
            }

            String responseText = "do something: " + request.getUri().getQueryParameters().getFirst("test");
            return new ServerResponse(responseText, 200, new Headers<Object>());
        }
    }

    @Test
    public void test() throws Exception {
        Dispatcher dispatcher = MockDispatcherFactory.createDispatcher();
        dispatcher.getProviderFactory().getServerPreProcessInterceptorRegistry().register(new MyInterceptor());
        dispatcher.getRegistry().addSingletonResource(new InterceptedResource());

        MockHttpRequest request = MockHttpRequest.get("/?test=someStuff");
        MockHttpResponse response = new MockHttpResponse();

        dispatcher.invoke(request, response);

        System.out.println(response.getContentAsString());
        Assert.assertEquals("do something: someStuff", response.getContentAsString());
    }
}

Answer 2

您不能拥有REST方法，该方法使用多个@GET，@POST，@PUT，@DELETE注释进行注释，因为这与HTTP规范。

此外，如果myMethod2只返回myMethod的结果，则可以在应用程序中使用其中唯一的一个（例如，myMethod），因为基本上myMethod2只需从服务器读取和检索数据，但不会更新任何内容。这意味着使用@POST进行注释是不合适的，因为它不会更新服务器上的任何内容。如果使用@POST进行注释，它仍然有效，但不符合HTTP规范。

CRUD操作和HTTP谓词之间存在映射。如果您在服务器上创建资源，则必须使用PUT或POST，并且在您希望读取的情况下来自服务器的一些资源，您应该使用GET。所有案例如下：

Create = PUT with a new URI
         POST to a base URI returning a newly created URI
Read   = GET
Update = PUT with an existing URI
Delete = DELETE

Answer 3

为了将多个queryParam绑定到单个对象，我们需要在响应方法中添加@Form作为参数。它对我们来说很好。

@GET    
@Path("/")  
@Produces("application/json")
@Consumes("application/json")

public Response search(@Form CatalogSearchRequest reqObject)      
{

System.out.println("Entered into service"+reqObject.getAttribute());


}

POJO CLASS应包含每个属性的@QueryParam（“”） 例如：

@QueryParam("pageSize")
public Integer pageSize;

@QueryParam("page")
public Integer page;

public Integer getPageSize() {
    return pageSize;
}

public void setPageSize(Integer pageSize) {
    this.pageSize = pageSize;
}

public Integer getPage() 
{
 return page;
}

public void setPage(Integer page)
{
    this.page = page;
}

的问候，
人员Prasanna。