json序列化时隐藏返回字段

后端提供给前端的接口中，有时候需要将一些字段忽略掉，不能作为对象的一部分传递到前端页面，这些字段大部分是敏感信息，比如用户身份信息中的password字段，数据加密的solt字段等。对于这种需求场景，我们可以通过相关的注解将敏感字段过滤掉。下面就介绍如何在三种常用的json框架下完成这种需求：
fastjson可以通过的在@JSONField注解中指定该字段是否进行序列化的：

import com.alibaba.fastjson.annotation.JSONField;
import lombok.Data;

/**
 * @Author xingo
 * @Date 2023/11/7
 */
@Data
public class UserVo {

    private Long id;

    private String userName;

    @JSONField(serialize = false, deserialize = false)
    private String password;
}

jackson中可以通过@JsonIgnore达到相同的目的：

import com.fasterxml.jackson.annotation.JsonIgnore;
import lombok.Data;

/**
 * @Author xingo
 * @Date 2023/11/7
 */
@Data
public class UserVo {

    private Long id;

    private String userName;

    @JsonIgnore
    private String password;
}

gson中有两种实现方式，一种是使用java序列化中的 transient 关键字忽略掉字段的序列化：

import lombok.Data;

/**
 * @Author xingo
 * @Date 2023/11/7
 */
@Data
public class UserVo {

    private Long id;

    private String userName;

    private transient String password;
}

另外一种是使用@Expose注解标识字段是否要序列化，但是这种方式要配合 excludeFieldsWithoutExposeAnnotation() 一起使用，而且实体类中的所有字段都要添加该注解，使用起来比较麻烦：

import com.google.gson.annotations.Expose;
import lombok.Data;

/**
 * @Author xingo
 * @Date 2023/11/7
 */
@Data
public class UserVo {

    @Expose
    private Long id;

    @Expose
    private String userName;

    // 不需要序列化的字段可以不添加该注解，或者添加注解并设置序列化和反序列化都为false
    @Expose(serialize = false, deserialize = false)
    private String password;
}

这时的gson创建要改成下面这样：

Gson gsonMapper = new GsonBuilder()
        .excludeFieldsWithoutExposeAnnotation()
        .create();