如何用Jersey将POJO序列化为查询参数

Question

我一直在尝试为公司的不同服务创建多个小型Java RESTful客户端库。大多数时候，我无法改变服务器端的任何东西，我需要编写Jersey代码片段来与现有的RESTful api交互。

---

<标题>上下文h1> 目前为止，我一直在使用Jersey与Jackson使用JSON:当我查询POJO时，我从JSON中反序列化它，当我需要发送POJO时，我将其序列化为JSON体。到目前为止，这两种代码段一直在为我做这项工作……

查询和反序列化

ClientResponse response = webResource
    .path("/path/to/resource")
    .queryParam("key", "value")
    .accept(Mediatype.APPLICATION_JSON)
    .get(ClientResponse.class);
// (...) Check response status code
MyClassPojo pojo = response.getEntity(MyClassPojo.class);

序列化和发送

ClientResponse response = webResource
    .path("/path/to/resource")
    .type(Mediatype.APPLICATION_JSON_TYPE)
    .accept(Mediatype.APPLICATION_JSON)
    .post(ClientResponse.class, pojo)
// (...) Check response status code

---

<标题>

我现在面对的是一个RESTful服务器，它不接受JSON体来发送pojo。唯一可行的方法似乎是使用查询参数。

例如，如果我想发送对象

public MyClassPojo {
    public int attr1;
    public String attr2;
}
MyClassPojo pojo = new MyClassPojo();
pojo.attr1 = 42;
pojo.attr2 = "Foo bar";

我很想把它序列化成JSON:

{
    "attr1": 42,
    "attr2": "Foo bar"
}

但是这个特定的RESTful服务器需要查询参数:

?attr1=42&attr2=Foo+bar

---

<标题>

这有点糟糕，但我真的没有选择…我现在希望有一个简单的方法来实现这一点与Jersey: 我怎么能自动序列化对象作为查询参数，发送到RESTful服务器?

注:我结束了这个问题，因为@Jukka回答了它。如果你像我一样，正在寻找一种发送x-www-form-urlencoded数据的方法，请不要犹豫地提到你创建的新问题。

---

<标题> 更新

根据@Jukka的想法，我写了以下方法:

public MultivaluedMap<String, String> toQueryParams() {
    final MultivaluedMap<String, String> queryParams = new Form();
    final Field[] fields = getClass().getDeclaredFields();
    for (Field field : fields) {
        final boolean accessible = field.isAccessible();
        try {
            field.setAccessible(true);
            final Object value = field.get(this);
            if (value != null) {
                final String name = field.getName();
                queryParams.add(name, value.toString());
            }
        } catch (IllegalAccessException e) {
            LOGGER.error("Error accessing a field", e);
        } finally {
            field.setAccessible(accessible);
        }
    }
    return queryParams;
}

这是一个很好的起点，如果您确实需要查询参数，它将完美地工作。在我的例子中，我感到困惑，我实际上需要一个x-www-form-urlencoded!为此，我必须编写一个MessageBodyWriter!

---

我的表单编码提供者

@Produces(MediaType.APPLICATION_FORM_URLENCODED)
public class MyFormEncodingProvider implements MessageBodyWriter<Object> {
    private static final String ENCODING = "UTF-8";
    @Override
    public boolean isWriteable(Class<?> aClass, Type type, Annotation[] annotations, MediaType mediaType) {
        return true;
    }
    @Override
    public long getSize(Object obj, Class<?> aClass, Type type, Annotation[] annotations, MediaType mediaType) {
        return -1;
    }
    @Override
    public void writeTo(Object obj, Class<?> aClass, Type type, Annotation[] annotations, MediaType mediaType,
                        MultivaluedMap<String, Object> stringObjectMultivaluedMap, OutputStream outputStream) throws IOException, WebApplicationException {
        final Writer osWriter = new OutputStreamWriter(outputStream);
        final MultivaluedMap<String, String> fieldsAndValues = getFieldsAndValues(obj);
        boolean firstVal = true;
        for (Entry<String, List<String>> entry : fieldsAndValues.entrySet()) {
            final List<String> values = entry.getValue();
            if (values == null || values.size() == 0) {
                if (!firstVal) {
                    osWriter.write("&");
                }
                osWriter.write(entry.getKey() + "=");
                firstVal = false;
            } else {
                for (String value : values) {
                    if (!firstVal) {
                        osWriter.write("&");
                    }
                    osWriter.write(entry.getKey() + "=" + URLEncoder.encode(value, ENCODING));
                    firstVal = false;
                }
            }
        }
        osWriter.flush();
        osWriter.close();
    }
    private static MultivaluedMap<String, String> getFieldsAndValues(Object obj) {
        // Find all available fields
        final Collection<Field> allFields = new ArrayList<>();
        Class<?> clazz = obj.getClass();
        while (clazz != null && clazz != Object.class) {
            Collections.addAll(allFields, clazz.getDeclaredFields());
            clazz = clazz.getSuperclass();
        }
        // Get all non-null values
        final MultivaluedMap<String, String> queryParams = new Form();
        for (Field field : allFields) {
            final boolean accessible = field.isAccessible();
            try {
                field.setAccessible(true);
                final Object value = field.get(obj);
                if (value != null) {
                    final String name = field.getName();
                    queryParams.add(name, value.toString());
                }
            } catch (IllegalAccessException e) {
                Logger.getLogger(AbstractIMSPojo.class).error("Error accessing a field", e);
            } finally {
                field.setAccessible(accessible);
            }
        }
        return queryParams;
    }
}

Answer 1

我会将这种视图实现到POJO:

class Pojo {
    ...
   public MultiValuedMap<String,String> asQueryParams() {
       ...
   }
}

并将结果传递给WebResource.queryParams(..)