注解实现json序列化的时候自动进行数据脱敏

news2024/11/24 17:40:43

最近在进行开发的时候遇到一个问题，需要对用户信息进行脱敏处理，原有的方式是写一个util类，在需要脱敏的字段查出数据后，显示掉用方法处理后再set回去，觉得这种方式能实现功能，但是不是特别优雅，想找个比较优雅的实现思考了一下，觉得数据只有在输出的时候进行脱敏处理即可，其它都是在内存阶段，相对来说都是比较安全的，输出阶段我想到了json序列化，因为我们用的restful接口输出json，于是去查询了一下相关的资源，jackson可以指定某个字段的自定义序列化类，那么还有一个问题，我指定了用某个类进行序列化，但是在序列化的时候如果判断脱敏的类型呢，翻看网上大神的文章得知，ContextualSerializer是 Jackson 提供的另一个序列化相关的接口，它的作用是通过字段已知的上下文信息定制JsonSerializer，只需要实现createContextual方法即可。废话少说，下面上代码：

用户信息实体：

@Data
public class UserDetailResponse {
 
  private Long useId;
 
  @ApiModelProperty(value = "用户编号")
  private String useNo;
 
  @ApiModelProperty(value = "用户姓名")
  private String useName;
 
  @SensitiveInfo(SensitiveType.MOBILE_PHONE)
  @ApiModelProperty(value = "用户手机号")
  private String mobile;
 
  @ApiModelProperty(value = "用户性别")
  private String sex;
 
  @ApiModelProperty(value = "用户年龄")
  private int age;
 
  @ApiModelProperty(value = "用户籍贯")
  private String nativePlace;
 
  @SensitiveInfo(SensitiveType.ID_CARD)
  @ApiModelProperty(value = "用户身份证号")
  private String idCard;
 
  @ApiModelProperty(value = "用户身份证号")
  private String borrowingLevel;
}

脱敏类型枚举类

public enum SensitiveType {
  /**
   * 中文名
   */
  CHINESE_NAME,
 
  /**
   * 身份证号
   */
  ID_CARD,
  /**
   * 座机号
   */
  FIXED_PHONE,
  /**
   * 手机号
   */
  MOBILE_PHONE,
  /**
   * 地址
   */
  ADDRESS,
  /**
   * 电子邮件
   */
  EMAIL,
  /**
   * 银行卡
   */
  BANK_CARD,
  /**
   * 公司开户银行联号
   */
  CNAPS_CODE
}

脱敏注解类

@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotationsInside
@JsonSerialize(using = SensitiveInfoSerialize.class)
public @interface SensitiveInfo {
 
  public SensitiveType value();
}

脱敏序列化类

public class SensitiveInfoSerialize extends JsonSerializer<String> implements
    ContextualSerializer {
 
  private SensitiveType type;
 
  public SensitiveInfoSerialize() {
  }
 
  public SensitiveInfoSerialize(final SensitiveType type) {
    this.type = type;
  }
 
  @Override
  public void serialize(final String s, final JsonGenerator jsonGenerator,
      final SerializerProvider serializerProvider) throws IOException, JsonProcessingException {
    switch (this.type) {
      case CHINESE_NAME: {
        jsonGenerator.writeString(SensitiveInfoUtils.chineseName(s));
        break;
      }
      case ID_CARD: {
        jsonGenerator.writeString(SensitiveInfoUtils.idCardNum(s));
        break;
      }
      case FIXED_PHONE: {
        jsonGenerator.writeString(SensitiveInfoUtils.fixedPhone(s));
        break;
      }
      case MOBILE_PHONE: {
        jsonGenerator.writeString(SensitiveInfoUtils.mobilePhone(s));
        break;
      }
      case ADDRESS: {
        jsonGenerator.writeString(SensitiveInfoUtils.address(s, 4));
        break;
      }
      case EMAIL: {
        jsonGenerator.writeString(SensitiveInfoUtils.email(s));
        break;
      }
      case BANK_CARD: {
        jsonGenerator.writeString(SensitiveInfoUtils.bankCard(s));
        break;
      }
      case CNAPS_CODE: {
        jsonGenerator.writeString(SensitiveInfoUtils.cnapsCode(s));
        break;
      }
    }
 
  }
 
  @Override
  public JsonSerializer<?> createContextual(final SerializerProvider serializerProvider,
      final BeanProperty beanProperty) throws JsonMappingException {
    if (beanProperty != null) { // 为空直接跳过
      if (Objects.equals(beanProperty.getType().getRawClass(), String.class)) { // 非 String 类直接跳过
        SensitiveInfo sensitiveInfo = beanProperty.getAnnotation(SensitiveInfo.class);
        if (sensitiveInfo == null) {
          sensitiveInfo = beanProperty.getContextAnnotation(SensitiveInfo.class);
        }
        if (sensitiveInfo != null) { // 如果能得到注解，就将注解的 value 传入 SensitiveInfoSerialize
 
          return new SensitiveInfoSerialize(sensitiveInfo.value());
        }
      }
      return serializerProvider.findValueSerializer(beanProperty.getType(), beanProperty);
    }
    return serializerProvider.findNullValueSerializer(beanProperty);
  }
}

脱敏处理util类

public class SensitiveInfoUtils {
 
  /**
   * [中文姓名] 只显示第一个汉字，其他隐藏为2个星号<例子：李**>
   */
  public static String chineseName(final String fullName) {
    if (StringUtils.isBlank(fullName)) {
      return "";
    }
    final String name = StringUtils.left(fullName, 1);
    return StringUtils.rightPad(name, StringUtils.length(fullName), "*");
  }
 
  /**
   * [中文姓名] 只显示第一个汉字，其他隐藏为2个星号<例子：李**>
   */
  public static String chineseName(final String familyName, final String givenName) {
    if (StringUtils.isBlank(familyName) || StringUtils.isBlank(givenName)) {
      return "";
    }
    return chineseName(familyName + givenName);
  }
 
  /**
   * [身份证号] 显示最后四位，其他隐藏。共计18位或者15位。<例子：*************5762>
   */
  public static String idCardNum(final String id) {
    if (StringUtils.isBlank(id)) {
      return "";
    }
 
    return StringUtils.left(id, 3).concat(StringUtils
        .removeStart(StringUtils.leftPad(StringUtils.right(id, 3), StringUtils.length(id), "*"),
            "***"));
  }
 
  /**
   * [固定电话] 后四位，其他隐藏<例子：****1234>
   */
  public static String fixedPhone(final String num) {
    if (StringUtils.isBlank(num)) {
      return "";
    }
    return StringUtils.leftPad(StringUtils.right(num, 4), StringUtils.length(num), "*");
  }
 
  /**
   * [手机号码] 前三位，后四位，其他隐藏<例子:138******1234>
   */
  public static String mobilePhone(final String num) {
    if (StringUtils.isBlank(num)) {
      return "";
    }
    return StringUtils.left(num, 2).concat(StringUtils
        .removeStart(StringUtils.leftPad(StringUtils.right(num, 2), StringUtils.length(num), "*"),
            "***"));
 
  }
 
  /**
   * [地址] 只显示到地区，不显示详细地址；我们要对个人信息增强保护<例子：北京市海淀区****>
   *
   * @param sensitiveSize 敏感信息长度
   */
  public static String address(final String address, final int sensitiveSize) {
    if (StringUtils.isBlank(address)) {
      return "";
    }
    final int length = StringUtils.length(address);
    return StringUtils.rightPad(StringUtils.left(address, length - sensitiveSize), length, "*");
  }
 
  /**
   * [电子邮箱] 邮箱前缀仅显示第一个字母，前缀其他隐藏，用星号代替，@及后面的地址显示<例子:g**@163.com>
   */
  public static String email(final String email) {
    if (StringUtils.isBlank(email)) {
      return "";
    }
    final int index = StringUtils.indexOf(email, "@");
    if (index <= 1) {
      return email;
    } else {
      return StringUtils.rightPad(StringUtils.left(email, 1), index, "*")
          .concat(StringUtils.mid(email, index, StringUtils.length(email)));
    }
  }
 
  /**
   * [银行卡号] 前六位，后四位，其他用星号隐藏每位1个星号<例子:6222600**********1234>
   */
  public static String bankCard(final String cardNum) {
    if (StringUtils.isBlank(cardNum)) {
      return "";
    }
    return StringUtils.left(cardNum, 6).concat(StringUtils.removeStart(
        StringUtils.leftPad(StringUtils.right(cardNum, 4), StringUtils.length(cardNum), "*"),
        "******"));
  }
 
  /**
   * [公司开户银行联号] 公司开户银行联行号,显示前两位，其他用星号隐藏，每位1个星号<例子:12********>
   */
  public static String cnapsCode(final String code) {
    if (StringUtils.isBlank(code)) {
      return "";
    }
    return StringUtils.rightPad(StringUtils.left(code, 2), StringUtils.length(code), "*");
  }
 
}