我們在項目中會處理敏感數據(如手機號、身份證號、姓名、地址等)時,通常需要對這些數據進行脫敏,以確保數據隱私和安全。
我們本次使用 Hutool 庫來輕松實現數據脫敏,如果項目中不讓使用,可以自己防著hutool來寫一些工具類。
本次使用Springboot整合Hutool來自定義注解實現數據脫敏!
數據脫敏(Data Masking),也稱為數據遮蔽或數據隱藏,是一種數據保護技術,用于處理和存儲敏感數據時,以減少或消除數據中的敏感信息,從而保護數據的隱私和安全。數據脫敏的主要目的是在保持數據可用性的同時,減少數據泄露和濫用的風險。
「數據脫敏一般指數據庫正常存儲,返回前端時進行數據庫處理!」
Hutool是一個小而全的Java工具類庫,通過靜態方法封裝,降低相關API的學習成本,提高工作效率,使Java擁有函數式語言般的優雅,讓Java語言也可以“甜甜的”。
Hutool是項目中“util”包友好的替代,它節省了開發人員對項目中公用類和公用工具方法的封裝時間,使開發專注于業務,同時可以最大限度的避免封裝不完善帶來的bug。
雖然Hutool可能會有一些bug,比起小編寫的還是強上不少的,所以選定它來!
現在最新版為:5.8.16,我們直接使用最新的,bug會少一些,功能會完善一些!
支持的脫敏規則:
<dependency> <groupId>cn.hutool</groupId> <artifactId>hutool-all</artifactId> <version>5.8.16</version></dependency>
@JsonSerialize(using = SensitiveInfoSerializer.class)用于指定在序列化時應該使用哪個自定義序列化器類
「需要和下面的注解搭配使用SensitiveInfoSerializer我們自定義的序列化器才會生效」
@JacksonAnnotationsInside 主要用于標記其他自定義注解,這意味著你可以在一個 Jackson 注解內部使用其他自定義注解,以組合各種注解來實現更復雜的序列化和反序列化邏輯。
/** * @author wangzhenjun * @date 2023/9/11 14:15 */@JacksonAnnotationsInside@JsonSerialize(using = SensitiveInfoSerializer.class)@Retention(RetentionPolicy.RUNTIME)@Target(ElementType.FIELD)public @interface Desensitization { DesensitizationType type() default DesensitizationType.DEFAULT; /** * 前置不需要打碼的長度 */ int prefixLen() default 0; /** * 后置不需要打碼的長度 */ int suffixLen() default 0; /** * 遮罩字符 */ String maskingChar() default "*";}
/** * @author wangzhenjun * @date 2023/9/11 14:43 */public enum DesensitizationType { // 自定義規則 CUSTOMIZE_RULE, // 默認的 DEFAULT, //用戶id USER_ID, //中文名 CHINESE_NAME, //身份證號 ID_CARD, //座機號 FIXED_PHONE, //手機號 MOBILE_PHONE, //地址 ADDRESS, //電子郵件 EMAIL, //密碼 PASSWORD, //中國大陸車牌,包含普通車輛、新能源車輛 CAR_LICENSE, //銀行卡 BANK_CARD}
關于自定義的規則,大家可以根據自己的需求來寫工具類,我這里簡單使用Hutool的工具來了!
StrUtil.replace(value, prefixLen, suffixLen, maskingChar)StrUtil.hide(value, prefixLen, suffixLen)
createContextual 方法首先在序列化過程開始時被調用,返回的序列化器實例將用于后續的序列化過程。
serialize 方法負責實際的序列化邏輯,將字段的值轉換為JSON,并可以在其中執行自定義的脫敏邏輯。
/** * 數據脫敏序列化器 * * @author wangzhenjun * @date 2023/9/11 14:16 */public class SensitiveInfoSerializer extends JsonSerializer<String> implements ContextualSerializer { private boolean useMasking = false; private DesensitizationType type; private int prefixLen; private int suffixLen; private String maskingChar; @Override public void serialize(String value, JsonGenerator gen, SerializerProvider serializers) throws IOException { if (useMasking && value != null) { switch (type) { case MOBILE_PHONE: gen.writeString(DesensitizedUtil.mobilePhone(value)); break; case ID_CARD: gen.writeString(DesensitizedUtil.idCardNum(value, prefixLen, suffixLen)); break; case CUSTOMIZE_RULE:// gen.writeString(StrUtil.replace(value, prefixLen, suffixLen, maskingChar)); gen.writeString(StrUtil.hide(value, prefixLen, suffixLen)); break; case CHINESE_NAME: gen.writeString(DesensitizedUtil.chineseName(value)); break; case DEFAULT: gen.writeString(value); default: gen.writeString(value); } } else { gen.writeObject(value); } } @Override public JsonSerializer<?> createContextual(SerializerProvider prov, BeanProperty property) { if (property != null) { Desensitization desensitization = property.getAnnotation(Desensitization.class); if (desensitization != null) { this.type = desensitization.type(); this.prefixLen = desensitization.prefixLen(); this.suffixLen = desensitization.suffixLen(); this.maskingChar = desensitization.maskingChar(); useMasking = true; } } return this; }}
/** * @author wangzhenjun * @date 2023/9/12 9:15 */@Datapublic class User { @Desensitization(type = DesensitizationType.ID_CARD,prefixLen = 6,suffixLen = 16) private String cardId; @Desensitization(type = DesensitizationType.CHINESE_NAME) private String name; @Desensitization(type = DesensitizationType.MOBILE_PHONE) private String phone; @Desensitization(type = DesensitizationType.CUSTOMIZE_RULE,prefixLen = 3,suffixLen = 6) private String info;}
@GetMapping("/getUser")public Result getUser(){ User user = new User(); user.setCardId("372911111111111111"); user.setPhone("15822229999"); user.setName("趙飛燕"); user.setInfo("這是機密文件,該打碼打碼"); return Result.success(user);}
完美脫敏,此次應該有掌聲!
本文通過Spring Boot與Hutool庫的結合使用自定義注解,提供了一個簡單而強大的方式來實現數據脫敏。希望能幫助到你,成功地實現數據脫敏功能,并提高應用程序的安全性。
本次例子脫敏選項沒有演示全,大家可以自行補充完成,成為你們需要的數據脫敏策略,從而完美的處理用戶數據脫敏問題!
可以試著使用AOP來完成脫敏,有興趣的可以試一下哈!
本文鏈接:http://www.www897cc.com/showinfo-26-12748-0.htmlSpringboot整合Hutool自定義注解實現數據脫敏
聲明:本網頁內容旨在傳播知識,若有侵權等問題請及時與本網聯系,我們將在第一時間刪除處理。郵件:2376512515@qq.com