为不同的Jersey REST服务调用应用不同的Jackson过滤器

时间:2012-06-01 08:06:14

标签: java jersey jax-rs jackson

我正在使用Jersey实现JAX-RS REST样式服务以及用于JSON映射的Jackson 2.0.2。其中一个REST服务返回List<EntityA>(我们称之为indexA),其中EntityA包含另一个List<EntityB>,而另一个服务只返回List<EntityB>(让我们称之为indexB):

@Entity
@JsonAutoDetect
public class EntityA {
  @Id
  private String id;

  @OneToMany
  private List<EntityB> b;

  ...
}

@Entity
@JsonAutoDetect
@JsonFilter("bFilter")
public class EntityB {
  @Id
  private String id;

  private String some;
  private String other;
  private String attributes;

  ...
}

@Path("/a")
public class AResource {

  @GET
  @Path("/")
  public List<EntityA> indexA() {
    ...
  }
}

@Path("/b")
public class BResource {

  @GET
  @Path("/")
  public List<EntityB> indexB() {
    ...
  }
}

我想要实现的是将Jackson过滤器应用于indexA调用,以便不会将子EntityB元素的所有属性序列化。 OTOH,indexB应该完整地返回EntityB

我知道存在ContextResolver<ObjectMapper>,我已将其用于其他目的。不幸的是,对于ContextResolver,似乎无法区分这两种服务调用,因为在{2}中提供给Class的{​​{1}}都是ContextResolver.getContext(Class)(并且由于类型擦除,我不能弄清楚泛型类型参数)。

是否有更适合配置ArrayList / ObjectMapper的钩子,具体取决于要映射的实体类型?

我可以使用How to return a partial JSON response using Java?中提出的方法:手动映射到FilterProvider,但这会破坏基于声明注释的方法的整体美感,所以我想避免这种情况。 / p>

1 个答案:

答案 0 :(得分:29)

我遇到了同样的情况,经过大量的研究,我发现它,解决方案是使用@JsonView和Spring,它可以将ObjectMapper注入JSON Writer而不会破坏美丽的泽西。

我正在研究一组REST API,我希望获得SystemObject的实例列表以及SystemObject的特定实例的详细信息,就像我只想要非常有限的数字一样列表中每个实例的属性以及详细信息中的一些其他属性,我只为它们定义视图,并在SystemObject类中添加注释。但默认情况下,没有@JsonView注释的所有属性都将输出到JSON,但我可以使用配置item(SerializationConfig.Feature.DEFAULT_VIEW_INCLUSION)来排除它们。

问题是我必须将其设置为true以满足我的需要。但是我无法改变ObjectMapper,它通过阅读下面的3篇文章来实现将对象转换为JSON的魔力,我认为我能做的唯一方法就是将一个修改后的ObjectMapper注入Jersey。 现在我得到了我想要的东西。

就像您为数据库表创建多个视图一样。

这3个链接将以不同的方式为您提供帮助:

How to create a ObjectMapperProvider which can be used by Spring to inject

Jersey, Jackson, Spring and JSON

Jersey + Spring integration example

REST资源:

package com.john.rest.resource;

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

import javax.ws.rs.GET;
import javax.ws.rs.HeaderParam;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Request;
import javax.ws.rs.core.UriInfo;

import org.codehaus.jackson.map.annotate.JsonView;
import org.springframework.stereotype.Component;

import com.midtronics.esp.common.EspException;
import com.midtronics.esp.common.SystemObject;
import com.midtronics.esp.mobile.model.SystemObjectView;
import com.midtronics.esp.model.accesscontrol.AccessControlBean;
import com.midtronics.esp.model.site.SiteBean;

@Component
@Path("/hierarchy")
public class Hierarchy {

    // Allows to insert contextual objects into the class, 
    // e.g. ServletContext, Request, Response, UriInfo
    @Context
    UriInfo uriInfo;

    @Context
    Request request;

    // Return the list of sites
    @GET
    @Path("sites")
    @Produces(MediaType.APPLICATION_JSON)
    @JsonView({SystemObjectView.ObjectList.class})
    public List<SystemObject> listSite(
            @HeaderParam("userId") String userId, 
            @HeaderParam("password") String password) {
        ArrayList<SystemObject> sites= new ArrayList<SystemObject>();

        try{
            if(!AccessControlBean.CheckUser(userId, password)){
                throw new WebApplicationException(401);
            }
            SystemObject.GetSiteListByPage(sites, 2, 3);

            return sites;
        } catch(EspException e){
            throw new WebApplicationException(401);
        } catch (Exception e) {
            throw new WebApplicationException(500);
        }
    }

    // Return the number of sites
    @GET
    @Path("sites/total")
    @Produces(MediaType.TEXT_PLAIN)
    public String getSiteNumber(@HeaderParam("userId") String userId, 
            @HeaderParam("password") String password) {
        try{
            return Integer.toString(SiteBean.GetSiteTotal()); 
        } catch(EspException e){
            throw new WebApplicationException(401);
        } catch (Exception e) {
            throw new WebApplicationException(500);
        }
    }

}

REST模型:

package com.john.rest.model;

import java.io.Serializable;
import java.util.ArrayList;

import javax.xml.bind.annotation.XmlRootElement;

import org.codehaus.jackson.annotate.JsonIgnore;
import org.codehaus.jackson.annotate.JsonProperty;
import org.codehaus.jackson.map.annotate.JsonView;

import com.midtronics.esp.mobile.model.SystemObjectView;
import com.midtronics.esp.model.common.ICommonDAO;

@XmlRootElement
public class SystemObject implements Serializable
{
    private static final long serialVersionUID = 3989499187492868996L;

    @JsonProperty("id")
    @JsonView({SystemObjectView.ObjectList.class, SystemObjectView.ObjectDetail.class})
    protected String objectID = "";

    @JsonProperty("parentId")
    protected String parentID = "";

    @JsonProperty("name")
    @JsonView({SystemObjectView.ObjectList.class, SystemObjectView.ObjectDetail.class})
    protected String objectName = "";

    //getters...
    //setters...

}

REST模型视图:

package com.john.rest.model;

public class SystemObjectView {
    public static class ObjectList { };

    public static class ObjectDetail extends ObjectList { }
}