SpringBoot怎么自定义注解实现涉密字段脱敏

这篇文章主要讲解了“SpringBoot怎么自定义注解实现涉密字段脱敏”，文中的讲解内容简单清晰，易于学习与理解，下面请大家跟着小编的思路慢慢深入，一起来研究和学习“springBoot怎么自定义注解实现涉密字段脱敏”吧！

关于数据脱敏，网上的文章都是硬编码规则，比如对身份证，手机号，邮件地址等固定写法脱敏。本文在此基础上，拓展动态从数据库查出涉密关键字执行脱敏操作。

数据脱敏：把系统里的一些敏感数据进行加密处理后再返回，达到保护隐私作用，实现效果图如下：

其实要实现上面的效果，可能最先想到的方法是直接改每个controller接口，在返回数据前做一次加密处理，当然这个方法肯定是非常捞的。这里推荐用注解来实现，即高效又优雅，省时省力，支持扩展。

其实解决方案大体上分两种：

• 在拿到数据时就已经脱敏了（如在 mysql 查询时用 insert 函数进行隐藏）

• 拿到数据后在序列化的时候再进行脱敏（如用 fastJSON、jackson）

这里我所选用的方案是第二种，即在接口返回数据前，在序列化的时候对敏感字段值进行处理，并且选用 jackson 的序列化来实现（推荐）

1. 创建隐私数据类型枚举：PrivacyTypeEnum

import lombok.Getter; @Getterpublic enum PrivacyTypeEnum {         CUSTOMER,         NAME,         ID_CARD,         PHONE,         EMaiL,         KEYWord}

2. 创建自定义隐私注解：PrivacyEncrypt

import com.fasterxml.jackson.annotation.JacksonAnnotationsInside;import com.fasterxml.jackson.databind.annotation.jsonSerialize; import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target; @Target(ElementType.FIELD) // 作用在字段上@Retention(RetentionPolicy.RUNTIME) // class文件中保留，运行时也保留，能通过反射读取到@JacksonAnnotationsInside // 表示自定义自己的注解PrivacyEncrypt@JsonSerialize(using = PrivacySerializer.class) // 该注解使用序列化的方式public @interface PrivacyEncrypt {         PrivacyTypeEnum type();         int prefixNoMaskLen() default 1;         int suffixNoMaskLen() default 1;         String symbol() default "*";}

3. 创建自定义序列化器：PrivacySerializer

import com.fasterxml.jackson.core.JsonGenerator;import com.fasterxml.jackson.databind.BeanProperty;import com.fasterxml.jackson.databind.JsonMappingException;import com.fasterxml.jackson.databind.JsonSerializer;import com.fasterxml.jackson.databind.SerializerProvider;import com.fasterxml.jackson.databind.ser.ContextualSerializer;import com.zk.common.core.domain.enumerate.PrivacyTypeEnum;import com.zk.common.core.utils.PrivacyUtil;import java.io.IOException;import java.util.Objects;import lombok.AllArgsConstructor;import lombok.NoArgsConstructor;import org.apache.commons.lang3.StringUtils; @NoArgsConstructor@AllArgsConstructorpublic class PrivacySerializer extends JsonSerializer<String> implements ContextualSerializer {   // 脱敏类型  private PrivacyTypeEnum privacyTypeEnum;  // 前几位不脱敏  private Integer prefixNoMaskLen;  // 最后几位不脱敏  private Integer suffixNoMaskLen;  // 用什么打码  private String symbol;   @Override  public void serialize(final String origin, final JsonGenerator jsonGenerator,      final SerializerProvider serializerProvider) throws IOException {    if (StringUtils.isNotBlank(origin) && null != privacyTypeEnum) {      switch (privacyTypeEnum) {        case CUSTOMER:          jsonGenerator.writeString(PrivacyUtil.desValue(origin, prefixNoMaskLen, suffixNoMaskLen, symbol));          break;        case NAME:          jsonGenerator.writeString(PrivacyUtil.hideChineseName(origin));          break;        case ID_CARD:          jsonGenerator.writeString(PrivacyUtil.hideIDCard(origin));          break;        case PHONE:          jsonGenerator.writeString(PrivacyUtil.hidePhone(origin));          break;        case EMAIL:          jsonGenerator.writeString(PrivacyUtil.hideEmail(origin));          break;        default:          throw new IllegalArgumentException("unknown privacy type enum " + privacyTypeEnum);      }    }  }   @Override  public JsonSerializer<?> createContextual(final SerializerProvider serializerProvider,      final BeanProperty beanProperty) throws JsonMappingException {    if (beanProperty != null) {      if (Objects.equals(beanProperty.getType().getRawClass(), String.class)) {        PrivacyEncrypt privacyEncrypt = beanProperty.getAnnotation(PrivacyEncrypt.class);        if (privacyEncrypt == null) {          privacyEncrypt = beanProperty.getContextAnnotation(PrivacyEncrypt.class);        }        if (privacyEncrypt != null) {          return new PrivacySerializer(privacyEncrypt.type(), privacyEncrypt.prefixNoMaskLen(),              privacyEncrypt.suffixNoMaskLen(), privacyEncrypt.symbol());        }      }      return serializerProvider.findValueSerializer(beanProperty.getType(), beanProperty);    }    return serializerProvider.findNullValueSerializer(null);  }}

这里是具体的实现过程，因为要脱敏的数据都是 String 类型的，所以继承 JsonSerializer 时的类型填 String

重写的 serialize 方法是实现脱敏的核心，根据类型 type 的不同去设置序列化后的值

重写的 createContextual 方法就是去读取我们自定义的 PrivacyEncrypt 注解，打造一个上下文的环境。

4. 隐私数据隐藏工具类：PrivacyUtil

public class PrivacyUtil {         public static String hidePhone(String phone) {        return phone.replaceAll("(\\d{3})\\d{4}(\\d{4})", "$1****$2");    }         public static String hideEmail(String email) {        return email.replaceAll("(\\w?)(\\w+)(\\w)(@\\w+\\.[a-z]+(\\.[a-z]+)?)", "$1****$3$4");    }         public static String hideIDCard(String idCard) {        return idCard.replaceAll("(\\d{4})\\d{10}(\\w{4})", "$1*****$2");    }         public static String hideChineseName(String chineseName) {        if (chineseName == null) {            return null;        }        return desValue(chineseName, 1, 0, "*");    }     public static String hideKeyWord(String context) {        // SpringUtil.getBean()方法来源于hutool提供的工具类。网上也有很多spring静态获取bean的方法，没有hutool依赖的，可自行实现。        //  实际项目中，请替换为自己的Mapper或者Dao。这里是为大家提供动态获取数据库的示例写法。        SysSecurityFieldMapper sysSecurityFieldMapper = SpringUtil.getBean(SysSecurityFieldMapper.class);        List<SysSecurityFieldEntity> privacyKeyWord = sysSecurityFieldMapper.selectList(new LambdaQueryWrapper<SysSecurityFieldEntity>()                .eq(SysSecurityFieldEntity::getStatus, SecurityFieldConstant.STATUS_NORMAL));        if (CollectionUtils.isEmpty(privacyKeyWord)) {            return context;        }        for (int i = 0; i < privacyKeyWord.size(); i++) {            if (context.contains(privacyKeyWord.get(i).geTKEyWord())) {                context = context.replaceAll(privacyKeyWord.get(i).getKeyWord(), "***");            }        }         return context;    } //    /     * 【身份证号】显示前4位, 后2位//     *///    public static String hideIdCard(String idCard) {//        return desValue(idCard, 4, 2, "*");//    } //    /     * 【手机号码】前三位，后四位，其他隐藏。//     *///    public static String hidePhone(String phone) {//        return desValue(phone, 3, 4, "*");//    }         public static String desValue(String origin, int prefixNoMaskLen, int suffixNoMaskLen, String maskStr) {        if (origin == null) {            return null;        }        StringBuilder sb = new StringBuilder();        for (int i = 0, n = origin.length(); i < n; i++) {            if (i < prefixNoMaskLen) {                sb.append(origin.charAt(i));                continue;            }            if (i > (n - suffixNoMaskLen - 1)) {                sb.append(origin.charAt(i));                continue;            }            sb.append(maskStr);        }        return sb.toString();    }     public static void main(String[] args) {        System.out.println(hideChineseName("张三三"));    }}

这个工具类其实可以自己定，根据自己的业务去扩展，提一点：

在自定义注解 PrivacyEncrypt 里，只有 type 的值为 PrivacyTypeEnum.CUSTOMER（自定义）时，才需要指定脱敏范围，即 prefixNoMaskLen 和 suffixNoMaskLen 的值，像邮箱、手机号这种隐藏格式都采用固定的
hideKeyWord() 方法中，SpringUtil.getBean()方法来源于hutool提供的工具类。网上也有很多spring静态获取bean的方法，没有hutool依赖的，可自行实现。实际项目中，请替换为自己的Mapper或者Dao。这里是为大家提供动态获取数据库的示例写法。

5. 注解使用

直接在需要脱敏的字段上加上注解，指定 type 值即可，如下：

@Datapublic class People {     private Integer id;     private String name;     private Integer sex;     private Integer age;     @PrivacyEncrypt(type = PrivacyTypeEnum.PHONE) // 隐藏手机号    private String phone;     @PrivacyEncrypt(type = PrivacyTypeEnum.EMAIL) // 隐藏邮箱    private String email;     private String sign;}

测试效果图如下：

感谢各位的阅读，以上就是“SpringBoot怎么自定义注解实现涉密字段脱敏”的内容了，经过本文的学习后，相信大家对SpringBoot怎么自定义注解实现涉密字段脱敏这一问题有了更深刻的体会，具体使用情况还需要大家实践验证。这里是编程网，小编将为大家推送更多相关知识点的文章，欢迎关注！