SpringBoot?自定義注解實(shí)現(xiàn)涉密字段脫敏
關(guān)于數(shù)據(jù)脫敏,網(wǎng)上的文章都是硬編碼規(guī)則,比如對(duì)身份證,手機(jī)號(hào),郵件地址等固定寫法脫敏。本文在此基礎(chǔ)上,拓展動(dòng)態(tài)從數(shù)據(jù)庫(kù)查出涉密關(guān)鍵字執(zhí)行脫敏操作。
數(shù)據(jù)脫敏:把系統(tǒng)里的一些敏感數(shù)據(jù)進(jìn)行加密處理后再返回,達(dá)到保護(hù)隱私作用,實(shí)現(xiàn)效果圖如下:

其實(shí)要實(shí)現(xiàn)上面的效果,可能最先想到的方法是直接改每個(gè)controller接口,在返回?cái)?shù)據(jù)前做一次加密處理,當(dāng)然這個(gè)方法肯定是非常撈的。這里推薦用注解來實(shí)現(xiàn),即高效又優(yōu)雅,省時(shí)省力,支持?jǐn)U展。
其實(shí)解決方案大體上分兩種:
- 在拿到數(shù)據(jù)時(shí)就已經(jīng)脫敏了(如在 mysql 查詢時(shí)用 insert 函數(shù)進(jìn)行隱藏)
- 拿到數(shù)據(jù)后在序列化的時(shí)候再進(jìn)行脫敏(如用 fastjson、jackson)
這里我所選用的方案是第二種,即在接口返回?cái)?shù)據(jù)前,在序列化的時(shí)候?qū)γ舾凶侄沃颠M(jìn)行處理,并且選用 jackson 的序列化來實(shí)現(xiàn)(推薦)
1. 創(chuàng)建隱私數(shù)據(jù)類型枚舉:PrivacyTypeEnum
import lombok.Getter;
/**
* 隱私數(shù)據(jù)類型枚舉
*
*/
@Getter
public enum PrivacyTypeEnum {
/**
* 自定義(此項(xiàng)需設(shè)置脫敏的范圍)
*/
CUSTOMER,
/**
* 姓名
*/
NAME,
/**
* 身份證號(hào)
*/
ID_CARD,
/**
* 手機(jī)號(hào)
*/
PHONE,
/**
* 郵箱
*/
EMAIL,
/**
* 關(guān)鍵字
*/
KEYWORD
}2. 創(chuàng)建自定義隱私注解: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;
/**
* 自定義數(shù)據(jù)脫敏注解
*/
@Target(ElementType.FIELD) // 作用在字段上
@Retention(RetentionPolicy.RUNTIME) // class文件中保留,運(yùn)行時(shí)也保留,能通過反射讀取到
@JacksonAnnotationsInside // 表示自定義自己的注解PrivacyEncrypt
@JsonSerialize(using = PrivacySerializer.class) // 該注解使用序列化的方式
public @interface PrivacyEncrypt {
/**
* 脫敏數(shù)據(jù)類型(沒給默認(rèn)值,所以使用時(shí)必須指定type)
*/
PrivacyTypeEnum type();
/**
* 前置不需要打碼的長(zhǎng)度
*/
int prefixNoMaskLen() default 1;
/**
* 后置不需要打碼的長(zhǎng)度
*/
int suffixNoMaskLen() default 1;
/**
* 用什么打碼
*/
String symbol() default "*";
}3. 創(chuàng)建自定義序列化器: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);
}
}這里是具體的實(shí)現(xiàn)過程,因?yàn)橐撁舻臄?shù)據(jù)都是 String 類型的,所以繼承 JsonSerializer 時(shí)的類型填 String
重寫的 serialize 方法是實(shí)現(xiàn)脫敏的核心,根據(jù)類型 type 的不同去設(shè)置序列化后的值
重寫的 createContextual 方法就是去讀取我們自定義的 PrivacyEncrypt 注解,打造一個(gè)上下文的環(huán)境。
4. 隱私數(shù)據(jù)隱藏工具類:PrivacyUtil
public class PrivacyUtil {
/**
* 隱藏手機(jī)號(hào)中間四位
*/
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");
}
/**
* 【中文姓名】只顯示第一個(gè)漢字,其他隱藏為星號(hào),比如:任**
*/
public static String hideChineseName(String chineseName) {
if (chineseName == null) {
return null;
}
return desValue(chineseName, 1, 0, "*");
}
/**
* 隱藏關(guān)鍵字
*
* @param context
* @return
*/
public static String hideKeyWord(String context) {
// SpringUtil.getBean()方法來源于hutool提供的工具類。網(wǎng)上也有很多spring靜態(tài)獲取bean的方法,沒有hutool依賴的,可自行實(shí)現(xiàn)。
// 實(shí)際項(xiàng)目中,請(qǐng)?zhí)鎿Q為自己的Mapper或者Dao。這里是為大家提供動(dòng)態(tài)獲取數(shù)據(jù)庫(kù)的示例寫法。
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;
}
// /**
// * 【身份證號(hào)】顯示前4位, 后2位
// */
// public static String hideIdCard(String idCard) {
// return desValue(idCard, 4, 2, "*");
// }
// /**
// * 【手機(jī)號(hào)碼】前三位,后四位,其他隱藏。
// */
// public static String hidePhone(String phone) {
// return desValue(phone, 3, 4, "*");
// }
/**
* 對(duì)字符串進(jìn)行脫敏操作
* @param origin 原始字符串
* @param prefixNoMaskLen 左側(cè)需要保留幾位明文字段
* @param suffixNoMaskLen 右側(cè)需要保留幾位明文字段
* @param maskStr 用于遮罩的字符串, 如'*'
* @return 脫敏后結(jié)果
*/
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("張三三"));
}
}這個(gè)工具類其實(shí)可以自己定,根據(jù)自己的業(yè)務(wù)去擴(kuò)展,提一點(diǎn):
在自定義注解 PrivacyEncrypt 里,只有 type 的值為 PrivacyTypeEnum.CUSTOMER(自定義)時(shí),才需要指定脫敏范圍,即 prefixNoMaskLen 和 suffixNoMaskLen 的值,像郵箱、手機(jī)號(hào)這種隱藏格式都采用固定的
hideKeyWord() 方法中,SpringUtil.getBean()方法來源于hutool提供的工具類。網(wǎng)上也有很多spring靜態(tài)獲取bean的方法,沒有hutool依賴的,可自行實(shí)現(xiàn)。實(shí)際項(xiàng)目中,請(qǐng)?zhí)鎿Q為自己的Mapper或者Dao。這里是為大家提供動(dòng)態(tài)獲取數(shù)據(jù)庫(kù)的示例寫法。
5. 注解使用
直接在需要脫敏的字段上加上注解,指定 type 值即可,如下:
@Data
public class People {
private Integer id;
private String name;
private Integer sex;
private Integer age;
@PrivacyEncrypt(type = PrivacyTypeEnum.PHONE) // 隱藏手機(jī)號(hào)
private String phone;
@PrivacyEncrypt(type = PrivacyTypeEnum.EMAIL) // 隱藏郵箱
private String email;
private String sign;
}到這里,脫敏工作就已經(jīng)結(jié)束了,全局使用這一個(gè)注解即可,一勞永逸,測(cè)試效果圖如下:

到此這篇關(guān)于SpringBoot 自定義注解實(shí)現(xiàn)涉密字段脫敏的文章就介紹到這了,更多相關(guān)SpringBoot 自定義注解內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
如何利用SpringBoot搭建WebService服務(wù)接口
之前項(xiàng)目經(jīng)理想要開發(fā)一個(gè)webservice的協(xié)議,給我一個(gè)星期的時(shí)間,后面用springboot開發(fā)了webservice,這篇文章主要給大家介紹了關(guān)于如何利用SpringBoot搭建WebService服務(wù)接口的相關(guān)資料,需要的朋友可以參考下2023-11-11
SpringMVC中解決@ResponseBody注解返回中文亂碼問題
這篇文章主要介紹了SpringMVC中解決@ResponseBody注解返回中文亂碼問題, 小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧2017-04-04
java操作excel導(dǎo)入導(dǎo)出的3種方式
項(xiàng)目需要,要實(shí)現(xiàn)一個(gè)導(dǎo)入導(dǎo)出excel的功能,于是任務(wù)驅(qū)動(dòng)著我學(xué)習(xí)到了POI、easypoi和easyexcel這3個(gè)java操作Excel的工具,下面這篇文章主要給大家介紹了關(guān)于java操作excel導(dǎo)入導(dǎo)出的3種方式,需要的朋友可以參考下2023-05-05
java使用WatchService監(jiān)控文件夾示例
本篇文章主要介紹了java使用WatchService監(jiān)控文件夾示例的資料,這里整理了詳細(xì)的代碼,有需要的小伙伴可以參考下。2017-02-02
HttpClient 請(qǐng)求 URL字符集轉(zhuǎn)碼問題
這篇文章主要介紹了HttpClient 請(qǐng)求 URL字符集轉(zhuǎn)碼問題,本文給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2021-01-01
JSR303校驗(yàn)注解和自定義校驗(yàn)注解的使用
這篇文章主要介紹了JSR303校驗(yàn)注解和自定義校驗(yàn)注解的使用,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-09-09
Java中Lambda表達(dá)式和函數(shù)式接口的使用和特性
Java Lambda表達(dá)式是一種函數(shù)式編程的特性,可簡(jiǎn)化匿名內(nèi)部類的寫法,與函數(shù)式接口搭配使用,實(shí)現(xiàn)代碼簡(jiǎn)潔、可讀性高、易于維護(hù)的特點(diǎn),適用于集合操作、多線程編程等場(chǎng)景2023-04-04

