SpringBoot怎么自定義注解實現涉密字段脫敏

這篇文章主要講解了“SpringBoot怎么自定義注解實現涉密字段脫敏”，文中的講解內容簡單清晰，易于學習與理解，下面請大家跟著小編的思路慢慢深入，一起來研究和學習“SpringBoot怎么自定義注解實現涉密字段脫敏”吧！

關于數據脫敏，網上的文章都是硬編碼規則，比如對身份證，手機號，郵件地址等固定寫法脫敏。本文在此基礎上，拓展動態從數據庫查出涉密關鍵字執行脫敏操作。

數據脫敏：把系統里的一些敏感數據進行加密處理后再返回，達到保護隱私作用，實現效果圖如下：

其實要實現上面的效果，可能最先想到的方法是直接改每個controller接口，在返回數據前做一次加密處理，當然這個方法肯定是非常撈的。這里推薦用注解來實現，即高效又優雅，省時省力，支持擴展。

其實解決方案大體上分兩種：

• 在拿到數據時就已經脫敏了（如在 mysql 查詢時用 insert 函數進行隱藏）

• 拿到數據后在序列化的時候再進行脫敏（如用 fastjson、jackson）

這里我所選用的方案是第二種，即在接口返回數據前，在序列化的時候對敏感字段值進行處理，并且選用 jackson 的序列化來實現（推薦）

1. 創建隱私數據類型枚舉：PrivacyTypeEnum

import lombok.Getter;
 
/**
 * 隱私數據類型枚舉
 *
 */
@Getter
public 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 {
 
    /**
     * 脫敏數據類型（沒給默認值，所以使用時必須指定type）
     */
    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
@AllArgsConstructor
public 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, "*");
    }
 
/**
     * 隱藏關鍵字
     *
     * @param context
     * @return
     */
    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, "*");
//    }
 
    /**
     * 對字符串進行脫敏操作
     * @param origin          原始字符串
     * @param prefixNoMaskLen 左側需要保留幾位明文字段
     * @param suffixNoMaskLen 右側需要保留幾位明文字段
     * @param maskStr         用于遮罩的字符串, 如'*'
     * @return 脫敏后結果
     */
    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 值即可，如下：

@Data
public 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怎么自定義注解實現涉密字段脫敏這一問題有了更深刻的體會，具體使用情況還需要大家實踐驗證。這里是億速云，小編將為大家推送更多相關知識點的文章，歡迎關注！