SpringBoot利用自定義注解實(shí)現(xiàn)隱私數(shù)據(jù)脫敏(加密顯示)的解決方案
前言
這兩天在整改等保測(cè)出的問(wèn)題,里面有一個(gè)“用戶(hù)信息泄露”的風(fēng)險(xiǎn)項(xiàng)(就是后臺(tái)系統(tǒng)里用戶(hù)的一些隱私數(shù)據(jù)直接明文顯示了),其實(shí)指的就是要做數(shù)據(jù)脫敏。
數(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è)方法肯定是非常撈的。這里推薦用注解來(lái)實(shí)現(xiàn),即高效又優(yōu)雅,省時(shí)省力,支持?jǐn)U展。
其實(shí)解決方案大體上分兩種:
1、在拿到數(shù)據(jù)時(shí)就已經(jīng)脫敏了(如在 mysql 查詢(xún)時(shí)用 insert 函數(shù)進(jìn)行隱藏)
2、拿到數(shù)據(jù)后在序列化的時(shí)候再進(jìn)行脫敏(如用 fastjson、jackson)
這里我所選用的方案是第二種,即在接口返回?cái)?shù)據(jù)前,在序列化的時(shí)候?qū)γ舾凶侄沃颠M(jìn)行處理,并且選用 jackson 的序列化來(lái)實(shí)現(xiàn)(推薦)
1. 創(chuàng)建隱私數(shù)據(jù)類(lèi)型枚舉:PrivacyTypeEnum
import lombok.Getter;
/**
* 隱私數(shù)據(jù)類(lèi)型枚舉
*/
@Getter
public enum PrivacyTypeEnum {
/** 自定義(此項(xiàng)需設(shè)置脫敏的范圍)*/
CUSTOMER,
/** 姓名 */
NAME,
/** 身份證號(hào) */
ID_CARD,
/** 手機(jī)號(hào) */
PHONE,
/** 郵箱 */
EMAIL,
}
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í)也保留,能通過(guò)反射讀取到
@JacksonAnnotationsInside // 表示自定義自己的注解PrivacyEncrypt
@JsonSerialize(using = PrivacySerializer.class) // 該注解使用序列化的方式
public @interface PrivacyEncrypt {
/**
* 脫敏數(shù)據(jù)類(lèi)型(沒(méi)給默認(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 cn.hutool.core.util.StrUtil;
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 lombok.AllArgsConstructor;
import lombok.NoArgsConstructor;
import java.io.IOException;
import java.util.Objects;
@NoArgsConstructor
@AllArgsConstructor
public class PrivacySerializer extends JsonSerializer<String> implements ContextualSerializer {
// 脫敏類(lèi)型
private PrivacyTypeEnum privacyTypeEnum;
// 前幾位不脫敏
private Integer prefixNoMaskLen;
// 最后幾位不脫敏
private Integer suffixNoMaskLen;
// 用什么打碼
private String symbol;
@Override
public void serialize(String origin, final JsonGenerator jsonGenerator,
final SerializerProvider serializerProvider) throws IOException {
if (StrUtil.isEmpty(origin)) {
origin = null;
}
if (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 (null != beanProperty) {
if (Objects.equals(beanProperty.getType().getRawClass(), String.class)) {
PrivacyEncrypt privacyEncrypt = beanProperty.getAnnotation(PrivacyEncrypt.class);
if (null == privacyEncrypt) {
privacyEncrypt = beanProperty.getContextAnnotation(PrivacyEncrypt.class);
}
if (null != privacyEncrypt) {
return new PrivacySerializer(privacyEncrypt.type(), privacyEncrypt.prefixNoMaskLen(),
privacyEncrypt.suffixNoMaskLen(), privacyEncrypt.symbol());
}
}
return serializerProvider.findValueSerializer(beanProperty.getType(), beanProperty);
}
return serializerProvider.findNullValueSerializer(null);
}
}
這里是具體的實(shí)現(xiàn)過(guò)程,因?yàn)橐撁舻臄?shù)據(jù)都是 String 類(lèi)型的,所以繼承 JsonSerializer 時(shí)的類(lèi)型填 String
重寫(xiě)的 serialize 方法是實(shí)現(xiàn)脫敏的核心,根據(jù)類(lèi)型 type 的不同去設(shè)置序列化后的值
重寫(xiě)的 createContextual 方法,就是去讀取我們自定義的 PrivacyEncrypt 注解,打造一個(gè)上下文的環(huán)境
【重要】上述代碼已經(jīng)優(yōu)化修改,解決了當(dāng)數(shù)據(jù)庫(kù)表里的字段值為空串、非null時(shí),Jackson序列化時(shí)報(bào)的異常問(wèn)題
4. 隱私數(shù)據(jù)隱藏工具類(lèi):PrivacyUtil
public class PrivacyUtil {
/**
* 中文名脫敏
*/
public static String hideChineseName(String chineseName) {
if (StrUtil.isEmpty(chineseName)) {
return null;
}
if (chineseName.length() <= 2) {
return desValue(chineseName, 1, 0, "*");
}
return desValue(chineseName, 1, 1, "*");
}
/**
* 手機(jī)號(hào)脫敏
*/
public static String hidePhone(String phone) {
if (StrUtil.isEmpty(phone)) {
return null;
}
return phone.replaceAll("(\\d{3})\\d{4}(\\d{4})", "$1****$2"); // 隱藏中間4位
// return desValue(phone, 3, 4, "*"); // 隱藏中間4位
// return desValue(phone, 7, 0, "*"); // 隱藏末尾4位
}
/**
* 郵箱脫敏
*/
public static String hideEmail(String email) {
if (StrUtil.isEmpty(email)) {
return null;
}
return email.replaceAll("(\\w?)(\\w+)(\\w)(@\\w+\\.[a-z]+(\\.[a-z]+)?)", "$1****$3$4");
}
/**
* 身份證號(hào)脫敏
*/
public static String hideIDCard(String idCard) {
if (StrUtil.isEmpty(idCard)) {
return null;
}
return idCard.replaceAll("(\\d{4})\\d{10}(\\w{4})", "$1*****$2");
}
/**
* 對(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 (StrUtil.isEmpty(origin)) {
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();
}
}
這個(gè)工具類(lèi)其實(shí)可以自己定,根據(jù)自己的業(yè)務(wù)去擴(kuò)展,提兩點(diǎn):
- 這個(gè)工具類(lèi)不管脫敏什么,一定要先判斷參數(shù)是否為空,若為空,則直接返回null,這樣 jsonGenerator.writeString() 正常執(zhí)行
- 在自定義注解 PrivacyEncrypt 里,只有 type 的值為 PrivacyTypeEnum.CUSTOMER(自定義)時(shí),才需要指定脫敏范圍,即 prefixNoMaskLen 和 suffixNoMaskLen 的值,像郵箱、手機(jī)號(hào)這種隱藏格式都可以采用固定的
5. 注解使用
直接在需要脫敏的字段上加上注解,指定 type 值即可(一般在返回的VO實(shí)體類(lèi)中的字段上使用),如下:
@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è)注解即可,一勞永逸,支持?jǐn)U展,測(cè)試效果圖如下:

以上代碼已經(jīng)過(guò)測(cè)試,并已實(shí)際生產(chǎn)使用,所以可放心使用
以上就是SpringBoot利用自定義注解實(shí)現(xiàn)隱私數(shù)據(jù)脫敏(加密顯示)的解決方案的詳細(xì)內(nèi)容,更多關(guān)于SpringBoot數(shù)據(jù)脫敏的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章!
- Springboot敏感字段脫敏的實(shí)現(xiàn)思路
- SpringBoot?自定義注解之脫敏注解詳解
- SpringBoot使用jasypt實(shí)現(xiàn)數(shù)據(jù)庫(kù)信息脫敏的方法詳解
- Springboot+Hutool自定義注解實(shí)現(xiàn)數(shù)據(jù)脫敏
- SpringBoot實(shí)現(xiàn)返回值數(shù)據(jù)脫敏的步驟詳解
- 淺析如何在SpringBoot中實(shí)現(xiàn)數(shù)據(jù)脫敏
- SpringBoot數(shù)據(jù)脫敏的實(shí)現(xiàn)示例
- SpringBoot實(shí)現(xiàn)接口返回?cái)?shù)據(jù)脫敏的代碼示例
- SpringBoot實(shí)現(xiàn)數(shù)據(jù)加密脫敏的示例代碼
- SpringBoot敏感數(shù)據(jù)脫敏的處理方式
- SpringBoot常用脫敏方案小結(jié)
相關(guān)文章
使用ProGuard混淆JavaWeb項(xiàng)目代碼的操作步驟
在開(kāi)發(fā)JavaWeb應(yīng)用時(shí),為了保護(hù)源代碼不被輕易反編譯和閱讀,通常會(huì)采用代碼混淆技術(shù),ProGuard是一個(gè)廣泛使用的免費(fèi)工具,可以用來(lái)優(yōu)化、縮小和混淆Java字節(jié)碼,本文將詳細(xì)介紹如何使用ProGuard對(duì)JavaWeb項(xiàng)目進(jìn)行代碼混淆,需要的朋友可以參考下2025-05-05
Java?生成透明圖片的設(shè)置實(shí)現(xiàn)demo
這篇文章主要為大家介紹了Java?生成透明圖片的設(shè)置實(shí)現(xiàn)demo,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-02-02
解決idea中javaweb的mysql8.0.15配置問(wèn)題
這篇文章主要介紹了idea中javaweb的mysql8.0.15配置問(wèn)題 ,本文通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì),具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2019-05-05
httpclient getPoolEntryBlocking連接池方法源碼解讀
這篇文章主要為大家介紹了httpclient getPoolEntryBlocking連接池方法源碼解讀,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-11-11
Java適配器模式的實(shí)現(xiàn)及應(yīng)用場(chǎng)景
適配器模式是Java中一種常用的設(shè)計(jì)模式,它通過(guò)將一個(gè)類(lèi)的接口轉(zhuǎn)換成客戶(hù)端所期望的另一種接口來(lái)實(shí)現(xiàn)不同接口之間的兼容性。適配器模式主要應(yīng)用于系統(tǒng)的接口不兼容、需要擴(kuò)展接口功能以及需要適應(yīng)不同環(huán)境的場(chǎng)景2023-04-04
java 數(shù)據(jù)結(jié)構(gòu)之棧與隊(duì)列
這篇文章主要介紹了java 數(shù)據(jù)結(jié)構(gòu)之棧與隊(duì)列的相關(guān)資料,這里對(duì)java中的棧和隊(duì)列都做出實(shí)現(xiàn)實(shí)例來(lái)幫助大家理解學(xué)習(xí)數(shù)據(jù)結(jié)構(gòu),需要的朋友可以參考下2017-07-07
SpringBoot實(shí)現(xiàn)簡(jiǎn)單的登錄注冊(cè)的項(xiàng)目實(shí)戰(zhàn)
本文主要介紹了SpringBoot實(shí)現(xiàn)簡(jiǎn)單的登錄注冊(cè)的項(xiàng)目實(shí)戰(zhàn),文中通過(guò)示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2022-03-03

