解决jackson序列化hibernate实体类manytomany循环

项目中用到jackson


   com.fasterxml.jackson.core
   jackson-databind
   2.x.x

可能会遇到 jackson 序列化 hibernate 实体类 manytomany 循环,导致 stackoverflow。解决 jackson 序列化 hibernate 实体类 manytomany 循环可能用到的注解:

1. @JsonIgnoreProperties

此注解作用在实体类上,@JsonIgnoreProperties({ “password”, “secret” }),这样就忽略了password属性、secret属性。

2. @JsonIgnore

此注解是作用在方法或类的属性上,对序列化和反序列化有影响,序列化(get):object --> json,反序列化(set):json ---> object:

a. 作用在方法上

/**
 * @return
 * @JsonIgnore 返回user不携带属性password
 */
@JsonIgnore
public String getPassword() {
    return password;
}

在 getPassword() 上,序列化时将会忽略此字段。

b. 作用在属性上:

  @JsonIgnore
  private String password;

意思是忽略 password 字段的序列化和反序列化

3. @JsonProperty

此注解用于属性上,作用是把该属性的名称序列化为另外一个名称。还有个作用就是和 @JsonIgnore 配合使用,@JsonIgnore 作用在 getPassword(),@JsonProperty作用在 setPassword(String password)

  /**
 * @param password
 * @return
 * @JsonProperty 接收user对象的时候序反列化password
 */
 @JsonProperty
 public User setPassword(String password) {
    this.password = password;
    return this;
}

4. @JsonManagedReference 和 @JsonBackReference

a. 作用在方法上

/**
 * @return
 * @JsonManagedReference 序列化,将json格式的password序列化为实体类的password属性。
 */
@JsonManagedReference 
public String getPassword() {
    return password;
}

/**
 * @return
 * @password
 * @JsonManagedReference 忽略反序列化:将实体类的password属性反序列化为json格式的password
 */
@JsonManagedReference 
public User setPassword(String password) {
    this.password = password;
    return this;
}

b. 作用在属性上:

  @JsonManagedReference
  @JsonBackReference
  private String password;

意思是忽略 password 字段的序列化,但是反序列化不忽略。业务场景是:注册时需要password,查看用户信息是不返回 password,即可用这两个注解作用在属性上。

  @JsonBackReference
  private String password;

这种就是不序列化、也不反序列化 password,和 @JsonIgnore一样。区别在于:使用了 @JsonIgnore 的属性就不能反序列化,而 @JsonManagedReference 和 @JsonBackReference 配合使用可规避这个问题。

注:1.6版本中提供了@JsonManagedReference和@JsonBackReference来解决循环嵌套问题,在2.0+ 后属于过时注解。

5. @JsonIdentityInfo

Jackson 2.0+ 版本新注解,作用于类或属性上,被用来在序列化/反序列化时为该对象或字段添加一个对象识别码,通常是用来解决循环嵌套的问题,比如数据库中的多对多关系,通过配置属性generator来确定识别码生成的方式,有简单的,配置属性property来确定识别码的名称,识别码名称没有限制。

a. 对象识别码可以是虚拟的,即存在在JSON中,但不是POJO的一部分,这种情况下我们可以如此使用注解

@JsonIdentityInfo(generator = ObjectIdGenerators.IntSequenceGenerator.class,property = "@id")

b. 对象识别码也可以是真实存在的,即以对象的属性为识别码,通常这种情况下我们一般以id属性为识别码,可以这么使用注解

@JsonIdentityInfo(generator = ObjectIdGenerators.PropertyGenerator.class,property = "id")

参考:https://blog.csdn.net/sdyy321/article/details/40298081

你可能感兴趣的:(解决jackson序列化hibernate实体类manytomany循环)