Jersey客户端:如何将列表添加为查询参数

时间:2012-12-06 18:20:39

标签: java rest jersey

我正在为具有List作为查询参数的GET服务创建Jersey客户端。根据{{​​3}},可以将List作为查询参数(此信息也位于documentation javadoc),请查看:

  

通常,方法参数的Java类型可以是:

     
      
  1. 是原始类型;
  2.   
  3. 拥有一个接受单个String参数的构造函数;
  4.   
  5. 有一个名为valueOf或fromString的静态方法,它接受一个String参数(例如,参见Integer.valueOf(String)和java.util.UUID.fromString(String));或
  6.   
  7. Be List,Set或SortedSet,其中T满足上面的2或3。生成的集合是只读的。
  8.         

    有时参数可能包含同一个名称的多个值。如果是这种情况,那么4)中的类型可用于获取所有值。

但是,我无法弄清楚如何使用Jersey客户端添加List查询参数。

我理解替代解决方案是:

  1. 使用POST代替GET;
  2. 将List转换为JSON字符串并将其传递给服务。
  3. 第一个不好,因为服务的正确HTTP动词是GET。这是一种数据检索操作。

    如果你无法帮助我,第二个将是我的选择。 :)

    我也正在开发这项服务,所以我可以根据需要进行更改。

    谢谢!

    更新

    客户端代码(使用json)

    Client client = Client.create();
    
    WebResource webResource = client.resource(uri.toString());
    
    SearchWrapper sw = new SearchWrapper(termo, pagina, ordenacao, hits, SEARCH_VIEW, navegadores);
    
    MultivaluedMap<String, String> params = new MultivaluedMapImpl();
    params.add("user", user.toUpperCase()); 
    params.add("searchWrapperAsJSON", (new Gson()).toJson(sw));
    
    ClientResponse clientResponse = webResource .path("/listar")
                                                .queryParams(params)
                                                .header(HttpHeaders.AUTHORIZATION, AuthenticationHelper.getBasicAuthHeader())
                                                .get(ClientResponse.class);
    
    SearchResultWrapper busca = clientResponse.getEntity(new GenericType<SearchResultWrapper>() {});
    

5 个答案:

答案 0 :(得分:100)

@GET支持字符串列表

设置
Java:1.7
泽西版:1.9

资源

@Path("/v1/test")

<强>子资源

// receive List of Strings
@GET
@Path("/receiveListOfStrings")
public Response receiveListOfStrings(@QueryParam("list") final List<String> list){
    log.info("receieved list of size="+list.size());
    return Response.ok().build();
}

泽西测试用例

@Test
public void testReceiveListOfStrings() throws Exception {
    WebResource webResource = resource();
    ClientResponse responseMsg = webResource.path("/v1/test/receiveListOfStrings")
            .queryParam("list", "one")
            .queryParam("list", "two")
            .queryParam("list", "three")
            .get(ClientResponse.class);
    Assert.assertEquals(200, responseMsg.getStatus());
}

答案 1 :(得分:27)

如果您要发送除简单字符串以外的任何内容,我建议您使用具有相应请求正文的POST,或将整个列表作为适当编码的JSON字符串传递。但是,使用简单的字符串,您只需要将每个值适当地附加到请求URL,Jersey将为您反序列化它。因此,给出以下示例端点:

@Path("/service/echo") public class MyServiceImpl {
    public MyServiceImpl() {
        super();
    }

    @GET
    @Path("/withlist")
    @Produces(MediaType.TEXT_PLAIN)
    public Response echoInputList(@QueryParam("list") final List<String> inputList) {
        return Response.ok(inputList).build();
    }
}

您的客户将发送与以下内容相对应的请求:

  

获取http://example.com/services/echo?list=Hello&list=Stay&list=Goodbye

这将导致inputList被反序列化以包含值'Hello','Stay'和'Goodbye'

答案 2 :(得分:6)

我同意你关于上面提到的替代解决方案

1. Use POST instead of GET;
2. Transform the List into a JSON string and pass it to the service.

并且您无法将List添加到MultiValuedMap,因为它的impl类MultivaluedMapImpl具有接受字符串键和字符串值的功能。如下图所示

enter image description here

你仍然想要做的事情,而不是尝试下面的代码。

控制器类

package net.yogesh.test;

import java.util.List;

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

import com.google.gson.Gson;

@Path("test")
public class TestController {
       @Path("testMethod")
       @GET
       @Produces("application/text")
       public String save(
               @QueryParam("list") List<String> list) {

           return  new Gson().toJson(list) ;
       }
}

客户等级

package net.yogesh.test;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import javax.ws.rs.core.MultivaluedMap;

import com.sun.jersey.api.client.ClientResponse;
import com.sun.jersey.api.client.WebResource;
import com.sun.jersey.api.client.config.ClientConfig;
import com.sun.jersey.api.client.config.DefaultClientConfig;
import com.sun.jersey.core.util.MultivaluedMapImpl;

public class Client {
    public static void main(String[] args) {
        String op = doGet("http://localhost:8080/JerseyTest/rest/test/testMethod");
        System.out.println(op);
    }

    private static String doGet(String url){
        List<String> list = new ArrayList<String>();
        list = Arrays.asList(new String[]{"string1,string2,string3"});

        MultivaluedMap<String, String> params = new MultivaluedMapImpl();
        String lst = (list.toString()).substring(1, list.toString().length()-1);
        params.add("list", lst);

        ClientConfig config = new DefaultClientConfig();
        com.sun.jersey.api.client.Client client = com.sun.jersey.api.client.Client.create(config);
        WebResource resource = client.resource(url);

        ClientResponse response = resource.queryParams(params).type("application/x-www-form-urlencoded").get(ClientResponse.class);
        String en = response.getEntity(String.class);
        return en;
    }
}
希望这对你有帮助。

答案 3 :(得分:1)

使用JSON查询参数获取请求

package com.rest.jersey.jerseyclient;
import com.sun.jersey.api.client.Client;
import com.sun.jersey.api.client.ClientResponse;
import com.sun.jersey.api.client.WebResource;

public class JerseyClientGET {

    public static void main(String[] args) {
        try {               

            String BASE_URI="http://vaquarkhan.net:8080/khanWeb";               
            Client client = Client.create();    
            WebResource webResource = client.resource(BASE_URI);

            ClientResponse response = webResource.accept("application/json").get(ClientResponse.class);

            /*if (response.getStatus() != 200) {
               throw new RuntimeException("Failed : HTTP error code : "
                + response.getStatus());
            }
*/
            String output = webResource.path("/msg/sms").queryParam("search","{\"name\":\"vaquar\",\"surname\":\"khan\",\"ext\":\"2020\",\"age\":\"34\""}").get(String.class);
            //String output = response.getEntity(String.class);

            System.out.println("Output from Server .... \n");
            System.out.println(output);                         

        } catch (Exception e) {

            e.printStackTrace();    
        }    
    }    
}

张贴申请:

package com.rest.jersey.jerseyclient;

import com.rest.jersey.dto.KhanDTOInput;
import com.sun.jersey.api.client.Client;
import com.sun.jersey.api.client.ClientResponse;
import com.sun.jersey.api.client.WebResource;
import com.sun.jersey.api.client.config.ClientConfig;
import com.sun.jersey.api.client.config.DefaultClientConfig;
import com.sun.jersey.api.json.JSONConfiguration;

public class JerseyClientPOST {

    public static void main(String[] args) {
        try {

            KhanDTOInput khanDTOInput = new KhanDTOInput("vaquar", "khan", "20", "E", null, "2222", "8308511500");                      

            ClientConfig clientConfig = new DefaultClientConfig();

            clientConfig.getFeatures().put( JSONConfiguration.FEATURE_POJO_MAPPING, Boolean.TRUE);

            Client client = Client.create(clientConfig);

               // final HTTPBasicAuthFilter authFilter = new HTTPBasicAuthFilter(username, password);
               // client.addFilter(authFilter);
               // client.addFilter(new LoggingFilter());

            //
            WebResource webResource = client
                    .resource("http://vaquarkhan.net:12221/khanWeb/messages/sms/api/v1/userapi");

              ClientResponse response = webResource.accept("application/json")
                .type("application/json").put(ClientResponse.class, khanDTOInput);


            if (response.getStatus() != 200) {
                throw new RuntimeException("Failed : HTTP error code :" + response.getStatus());
            }

            String output = response.getEntity(String.class);

            System.out.println("Server response .... \n");
            System.out.println(output);

        } catch (Exception e) {

            e.printStackTrace();

        }    
    }    
}

答案 4 :(得分:0)

可以使用queryParam方法,将参数名称和值数组传递给它:

    public WebTarget queryParam(String name, Object... values);

示例(jersey-client 2.23.2):

    WebTarget target = ClientBuilder.newClient().target(URI.create("http://localhost"));
    target.path("path")
            .queryParam("param_name", Arrays.asList("paramVal1", "paramVal2").toArray())
            .request().get();

这将向以下URL发出请求:

    http://localhost/path?param_name=paramVal1&param_name=paramVal2