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

时间:2013-06-12 14:19:09

标签: java rest jersey pojo query-parameters

我一直在为我公司的不同服务创建多个小型Java RESTful客户端库。大多数情况下,我无法在服务器端更改任何内容,我需要编写Jersey段代码以与现有RESTful API进行交互。


上下文

据我所知,我一直在使用带有Jackson的Jersey来使用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

问题

这有点糟糕,但我真的没有选择......我现在希望有一个简单的方法来实现这一点:如何自动将对象序列化为查询参数,发送到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;
}

这是一个很好的起点,如果您确实需要Query Params,它将完美运行。在我的情况下,我感到困惑,我实际上需要一个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;
    }
}

1 个答案:

答案 0 :(得分:5)

我会在你的POJO中实现这种观点:

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

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