【问题标题】:Jersey method selection by query parameters通过查询参数选择 Jersey 方法
【发布时间】:2018-06-23 08:28:34
【问题描述】:

我需要实现一个使用第一个查询参数来识别操作的 Web 服务,即客户端调用类似于:http://localhost:8080/ws/operation?info 或 http://localhost:8080/ws/operation?create&name=something。

似乎我无法区分使用@Path 注释的方法,因为区别特征在查询参数中。下面的例子也抛出了异常:

package com.example.ws;

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.QueryParam;

@Path("/operation")
public class Operation {

    @GET 
    public String info(@QueryParam("info") String info) {
        return "info";
    }

    @GET 
    public String create(@QueryParam("create") String create) {
        return "create";
    }
}

有没有办法根据查询参数指定要使用的方法?还是我真的必须定义一种方法并在该方法中检查是否设置了某些查询参数?

【问题讨论】:

  • “我需要实现一个使用第一个查询参数来识别操作的 web 服务” - JAXRS 允许您构建 REST 资源,但您似乎正在尝试将它用于implement URI tunneling。您是否考虑过一种更 RESTful 的方法,例如使用 POST 来创建请求并使用 GET 来请求信息,而不是通过 GET 进行隧道传输?如果您不能将您的 API 更改为更加 RESTful,IHMO JAXRS/Jersey 可能不是完成这项工作的最佳工具……您将一直与它作斗争。
  • 谢谢,约翰。我很乐意选择另一种方式,并获得一些关于您更喜欢哪种方式的提示。但是,不幸的是,当我尝试实现以这种方式对操作进行编码的接口规范时,我无法更改客户端调用资源的方式。

标签: java web-services jersey


【解决方案1】:

我看到这已经得到解答,但我遇到了类似的问题并使用子资源实现了解决方案。

package com.example.ws;

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.QueryParam;

@Path("/")
public class Operation {

    @Path("/")
    public Object sub(@QueryParam("operation") String operation)
    {
       if ("info".equals(operation))
          return new InfoOp();
       if ("create".equals(operation))
          return new CreateOp();
       //handle via error code
    }

    public class InfoOp {
        @GET 
        public String info() {
            return "info";
        }
    }

    public class CreateOp {
        @GET 
        public String create(@QueryParam("name") String name) {
            return "create: " + name;
        }
    }
}

【讨论】:

    【解决方案2】:

    我认为 Claudio 是正确的 - 您可以使用 Jersey,但您需要自己处理查询参数,因为它只匹配路径。

    您可以注入一个 UriInfo 并从中提取查询参数:

    @Path("/operation") 
    public class Operation {
    
        @Context
        protected UriInfo info;
    
        @GET 
        public String operation() {
            if (info.getQueryParameters().containsKey("create"))
                // do stuff
            else if (info.getQueryParameters().containsKey("info"))
                // other stuff
        } 
    

    }

    您可以从 Jersey 切换到另一个框架。我相信 Spring can route to multiple methods 基于查询参数。

    正如您所提到的,也许您可​​以编写一些更标准的东西,然后将请求重新映射到那个。例如,您可以使用 Servlet 过滤器或 Apache httpd 或 nginx 等前端服务器来修改请求。

    从resources 的角度思考这些操作在作用于什么?客户账户、电影、股票交易等。为了争论,假设它是“Foo”。你可能会选择这样的东西:

    @Path("/foo") 
    public class FooResource {
    
        @Context
        protected UriInfo info;
    
        @GET
        @Produces({MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON})
        public Foo getById(@QueryParam("id") int id) {
             // get Foo by id
             Foo = ....
    
             // return an instance of Foo and let Jersey convert it to XML
             // or JSON depending on the "Accept" header that the client sent
             return foo;
        } 
    
        @POST
        @Consumes({MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON})
        public Response create(Foo instance)
        {
             // let Jersey deserialize the request body from JSON or XML.
             // save the instance however you want
             int id = fooService.save(instance);
    
             // return a 204 "created" with a "Location" header
             URI location = info.getAbsolutePathBuilder().path("{id}").build(id);
         return Response.created(location).build();
        }
    

    }

    听起来您的 URI 结构是由其他人强制要求的,因此这可能不适合您。如果您确实继续使用当前的 URI 结构,那么您应该注意一个主要缺陷。

    根据HTTP 1.1 spec,GET 请求应该是idempotent。您当前的设计似乎正在使用 GET 请求创建新的服务器端实例。存在损坏的可能性...中间代理或网络浏览器可能会缓存对您的 GET 请求的响应并阻止创建新实例。

    【讨论】:

    • 再次感谢约翰。似乎这就是我的问题的全部答案。我会看看如何解决这个问题,但我首先必须接受来自给定客户的电话并尽力处理它。
    【解决方案3】:

    我认为方法选择是基于 URI 的非参数部分。您不能以客户端调用http://localhost:8080/ws/operation/info 和http://localhost:8080/ws/operation/create?name=something 的方式来设计它吗?

    这很容易实现:

    @Path("/operation")
    public class Operation {
    
        @GET 
        @Path("info")
        public String info() {
            return "info";
        }
    
        @GET 
        @Path("create")
        public String create(@QueryParam("name") String name) {
            return "create";
        }
    }
    

    【讨论】:

    • 不幸的是,我需要创建一个满足特定接口要求的服务,该接口以这种方式调用操作。也许我可以在两者之间有一个中介,它将这些请求映射到更 RESTful 和更接近常见做法的东西。
    猜你喜欢
    • 2016-02-07
    • 2019-12-09
    • 2014-09-23
    • 2014-12-15
    • 1970-01-01
    • 1970-01-01
    • 2011-05-23
    • 1970-01-01
    相关资源
    最近更新 更多