SpringBoot利用自定義注解實(shí)現(xiàn)隱私數(shù)據(jù)脫敏(加密顯示)的解決方案
前言
這兩天在整改等保測出的問題,里面有一個(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è)方法肯定是非常撈的。這里推薦用注解來實(shí)現(xiàn),即高效又優(yōu)雅,省時(shí)省力,支持?jǐn)U展。
其實(shí)解決方案大體上分兩種:
1、在拿到數(shù)據(jù)時(shí)就已經(jīng)脫敏了(如在 mysql 查詢時(shí)用 insert 函數(shù)進(jìn)行隱藏)
2、拿到數(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, }
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(); /** * 前置不需要打碼的長度 */ int prefixNoMaskLen() default 1; /** * 后置不需要打碼的長度 */ 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 { // 脫敏類型 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)過程,因?yàn)橐撁舻臄?shù)據(jù)都是 String 類型的,所以繼承 JsonSerializer 時(shí)的類型填 String
重寫的 serialize 方法是實(shí)現(xiàn)脫敏的核心,根據(jù)類型 type 的不同去設(shè)置序列化后的值
重寫的 createContextual 方法,就是去讀取我們自定義的 PrivacyEncrypt 注解,打造一個(gè)上下文的環(huán)境
【重要】上述代碼已經(jīng)優(yōu)化修改,解決了當(dāng)數(shù)據(jù)庫表里的字段值為空串、非null時(shí),Jackson序列化時(shí)報(bào)的異常問題
4. 隱私數(shù)據(jù)隱藏工具類: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"); } /** * 對字符串進(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è)工具類其實(shí)可以自己定,根據(jù)自己的業(yè)務(wù)去擴(kuò)展,提兩點(diǎn):
- 這個(gè)工具類不管脫敏什么,一定要先判斷參數(shù)是否為空,若為空,則直接返回null,這樣 jsonGenerator.writeString() 正常執(zhí)行
- 在自定義注解 PrivacyEncrypt 里,只有 type 的值為 PrivacyTypeEnum.CUSTOMER(自定義)時(shí),才需要指定脫敏范圍,即 prefixNoMaskLen 和 suffixNoMaskLen 的值,像郵箱、手機(jī)號(hào)這種隱藏格式都可以采用固定的
5. 注解使用
直接在需要脫敏的字段上加上注解,指定 type 值即可(一般在返回的VO實(shí)體類中的字段上使用),如下:
@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展,測試效果圖如下:
以上代碼已經(jīng)過測試,并已實(shí)際生產(chǎn)使用,所以可放心使用
以上就是SpringBoot利用自定義注解實(shí)現(xiàn)隱私數(shù)據(jù)脫敏(加密顯示)的解決方案的詳細(xì)內(nèi)容,更多關(guān)于SpringBoot數(shù)據(jù)脫敏的資料請關(guān)注腳本之家其它相關(guān)文章!
- SpringBoot使用自定義注解實(shí)現(xiàn)數(shù)據(jù)脫敏過程詳細(xì)解析
- SpringBoot實(shí)現(xiàn)返回值數(shù)據(jù)脫敏的步驟詳解
- Springboot+Jackson自定義注解數(shù)據(jù)脫敏的項(xiàng)目實(shí)踐
- Springboot+Hutool自定義注解實(shí)現(xiàn)數(shù)據(jù)脫敏
- SpringBoot利用自定義json序列化器實(shí)現(xiàn)敏感字段數(shù)據(jù)脫敏詳解
- 淺析如何在SpringBoot中實(shí)現(xiàn)數(shù)據(jù)脫敏
- SpringBoot數(shù)據(jù)脫敏的實(shí)現(xiàn)示例
- SpringBoot接口返回?cái)?shù)據(jù)脫敏(Mybatis、Jackson)
相關(guān)文章
Java實(shí)現(xiàn)高校教務(wù)系統(tǒng)
這篇文章主要為大家詳細(xì)介紹了Java實(shí)現(xiàn)高校教務(wù)系統(tǒng),文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2022-08-08springboot 2.0 mybatis mapper-locations掃描多個(gè)路徑的實(shí)現(xiàn)
這篇文章主要介紹了springboot 2.0 mybatis mapper-locations掃描多個(gè)路徑的實(shí)現(xiàn)方式,具有很好的參考價(jià)值,希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-07-07詳解Springboot @Cacheable 注解(指定緩存位置)
這篇文章主要介紹了詳解Springboot @Cacheable 注解(指定緩存位置),使用? @Cacheable ?注解就可以將運(yùn)行結(jié)果緩存,以后查詢相同的數(shù)據(jù),直接從緩存中取,不需要調(diào)用方法,需要的朋友可以參考下2023-09-09淺析mybatis和spring整合的實(shí)現(xiàn)過程
據(jù)官方的說法,在Mybatis3問世之前,Spring3的開發(fā)工作就已經(jīng)完成了,所以Spring3中還是沒有對Mybatis3的支持。因此由Mybatis社區(qū)自己開發(fā)了一個(gè)Mybatis-Spring用來滿足Mybatis用戶整合Spring的需求,下面通過Mybatis-Spring來整合Mybatis跟Spring的用法做介紹2015-10-10Spring Boot與Spring Security的跨域問題解決方案
跨域問題是指在Web開發(fā)中,瀏覽器出于安全考慮,限制了不同域名之間的資源訪問,本文重點(diǎn)給大家介紹Spring Boot與Spring Security的跨域問題解決方案,感興趣的朋友一起看看吧2023-09-09Java版C語言版簡單使用靜態(tài)語言實(shí)現(xiàn)動(dòng)態(tài)數(shù)組的方法
本文給大家分享java版和C語言版簡單使用靜態(tài)語言實(shí)現(xiàn)動(dòng)態(tài)數(shù)組的方法,非常不錯(cuò),具有參考借鑒價(jià)值,需要的朋友參考下吧2017-10-10Java 凍結(jié)或解除凍結(jié)Excel中的行和列的方法
這篇文章主要介紹了Java 凍結(jié)或解除凍結(jié)Excel中的行和列的方法,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-03-03Springboot導(dǎo)入本地jar后 打包依賴無法加入的解決方案
這篇文章主要介紹了Springboot導(dǎo)入本地jar后 打包依賴無法加入的解決方案,具有很好的參考價(jià)值,希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-11-11