JsonView - 定义默认视图

时间:2015-03-02 15:44:09

标签: java spring jpa jackson spring-boot

我正在开发Spring启动(MVC,JPA)应用程序,并且需要在不同的请求上返回不同的属性。我找到了@JsonView注释,它似乎工作。但是,我是否需要使用基本视图注释每个属性?

示例:

ENTITY1

 @Entity
    public class Entity1 implements Serializable {
      @Id
      @GeneratedValue(strategy = GenerationType.IDENTITY)
      private Long id;

      @JsonView(JsonViews.ExtendedView.class)
      private String name;

      @OneToMany(cascade = CascadeType.ALL, mappedBy = "entity1", fetch = FetchType.EAGER)
      List<Entity2> entities2;

      @JsonView(JsonView.ExtendedView.class)
      @OneToMany(cascade = CascadeType.ALL, mappedBy = "entity1", fetch = FetchType.LAZY)
      List<Entity3> entities3;

    }

ENTITY2

@Entity
public class Entity2 implements Serializable {
  @Id
  @GeneratedValue(strategy = GenerationType.IDENTITY)
  private Long id;

  private String name;
}

ENTITY3

@Entity
public class Entity3 implements Serializable {
  @Id
  @GeneratedValue(strategy = GenerationType.IDENTITY)
  private Long id;

  private String name;
}

视图

public class JsonViews {
  public static class BasicView { }
  public static class ExtendedView extends BasicView { }
}

控制器

@RequestMapping(method = RequestMethod.GET)
  @JsonView(JsonViews.BasicView.class)
  public @ResponseBody List<Entity1> index() {

    return repositoryEntity1.findAll();

  }

这是一个修剪过的例子,但我认为它适用于这个问题。我希望控制器返回Ids和Entity2对象列表。但它返回一个带有“No Properties”的空对象。如果我注释了此请求中涉及的每个类的每个属性,它似乎有效,但这是真的需要还是最好的解决方案?有没有办法定义“DefaultView”?

感谢

编辑:如果我注释JpaRepository,它将返回整个对象,包括带有Entity3对象的列表。

1 个答案:

答案 0 :(得分:6)

不,您不需要在所有属性上定义视图。插入

spring.jackson.mapper.default-view-inclusion=true

application.properties中。这将导致没有@JsonView注释的属性包含在响应中,并且只会过滤带注释的属性。

在您的控制器中,将返回没有视图或带有BasicView注释的属性。