SpringBoot利用自定義注解實(shí)現(xiàn)隱私數(shù)據(jù)脫敏(加密顯示)的解決方案
前言
這兩天在整改等保測(cè)出的問(wèn)題,里面有一個(gè)“用戶信息泄露”的風(fēng)險(xiǎn)項(xiàng)(就是后臺(tái)系統(tǒng)里用戶的一些隱私數(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)文章
SpringBoot+mail 輕松實(shí)現(xiàn)各類(lèi)郵件自動(dòng)推送
在實(shí)際的項(xiàng)目開(kāi)發(fā)過(guò)程中,經(jīng)常需要用到郵件通知功能,例如,通過(guò)郵箱注冊(cè),郵箱找回密碼,郵箱推送報(bào)表等等,實(shí)際的應(yīng)用場(chǎng)景非常的多,今天通過(guò)這篇文章,我們一起來(lái)學(xué)習(xí)如何在 Spring Boot 中快速實(shí)現(xiàn)一個(gè)自動(dòng)發(fā)送郵件的功能2024-07-07
SpringCloud中Sentinel基礎(chǔ)場(chǎng)景和異常處理方式
這篇文章主要介紹了SpringCloud中Sentinel基礎(chǔ)場(chǎng)景和異常處理方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2025-04-04
Spring AI集成DeepSeek三步搞定Java智能應(yīng)用的詳細(xì)過(guò)程
本文介紹了如何使用SpringAI集成DeepSeek,一個(gè)國(guó)內(nèi)頂尖的多模態(tài)大模型,SpringAI提供了一套統(tǒng)一的接口,簡(jiǎn)化了與不同AI模型的集成,通過(guò)配置文件和簡(jiǎn)單的接口調(diào)用,開(kāi)發(fā)者可以方便地使用DeepSeek進(jìn)行數(shù)學(xué)推理、代碼生成等任務(wù),感興趣的朋友一起看看吧2025-03-03
java通過(guò)poi解析word入門(mén)的操作方法
Apache POI 是一個(gè)處理Miscrosoft Office各種文件格式的開(kāi)源項(xiàng)目,可以使用POI在Java程序中對(duì)Miscrosoft Office各種文件進(jìn)行讀寫(xiě)操作,本文給大家介紹java通過(guò)poi解析word入門(mén)的操作方法,感興趣的朋友一起看看吧2024-08-08
SpringBoot核心配置文件bootstrap與application用法
Spring Boot中有兩種配置文件:bootstrap和application,bootstrap是應(yīng)用程序的父上下文,優(yōu)先加載,不能被本地相同配置覆蓋,bootstrap主要用于加載外部配置信息,如SpringCloudConfig配置中心的配置,application主要用于Spring Boot項(xiàng)目的自動(dòng)化配置2024-12-12
使用SpringBoot + Redis + Vue實(shí)現(xiàn)動(dòng)態(tài)路由加載頁(yè)面的示例代
在現(xiàn)代 Web 應(yīng)用開(kāi)發(fā)中,動(dòng)態(tài)路由加載能夠顯著提升應(yīng)用的靈活性和安全性,本文將深入探討如何利用 Spring Boot、Redis、Element UI 和 Vue 技術(shù)棧實(shí)現(xiàn)動(dòng)態(tài)路由加載,并通過(guò) Redis 生成和驗(yàn)證有效鏈接以實(shí)現(xiàn)頁(yè)面訪問(wèn)控制,需要的朋友可以參考下2024-09-09
Thread類(lèi)的基本用法及Java線程的幾種狀態(tài)示例詳解
Java線程的狀態(tài)是一個(gè)復(fù)雜的概念,它們之間的轉(zhuǎn)換關(guān)系也非常重要,這篇文章主要介紹了Thread類(lèi)的基本用法及Java線程幾種狀態(tài)的相關(guān)資料,文中通過(guò)代碼介紹的非常詳細(xì),需要的朋友可以參考下2026-02-02

