1. 項(xiàng)目緣起為什么我們需要攔截ApiOperation的傳參日志在日常的后端開發(fā)中尤其是在使用Spring Boot這類框架時(shí)我們經(jīng)常會(huì)用ApiOperation這樣的注解通常來自Swagger/OpenAPI來給接口添加描述。同時(shí)為了調(diào)試和問題排查我們也會(huì)在接口層或切面中打印請(qǐng)求的入?yún)⑷罩尽＿@看起來是個(gè)好習(xí)慣對(duì)吧但最近我就遇到了一個(gè)頭疼的問題一個(gè)查詢用戶詳情的接口日志里赫然打印出了用戶的身份證號(hào)、手機(jī)號(hào)等敏感信息。雖然開發(fā)環(huán)境大家睜一只眼閉一只眼但一想到這些日志可能被采集到ELKElasticsearch, Logstash, Kibana等日志分析系統(tǒng)甚至被運(yùn)維、測(cè)試同學(xué)無意間看到心里就一陣發(fā)毛。更別提萬(wàn)一日志泄露帶來的安全合規(guī)風(fēng)險(xiǎn)了。所以“攔截ApiOperation打印傳參日志”這個(gè)需求就浮出水面了。它的核心目標(biāo)不是不打印日志而是智能地、有選擇性地打印。對(duì)于敏感接口我們希望日志在記錄必要信息如用戶ID、操作類型的同時(shí)自動(dòng)過濾或脫敏掉像密碼、身份證號(hào)、銀行卡號(hào)這類敏感字段。這不僅僅是安全要求很多時(shí)候也是《網(wǎng)絡(luò)安全法》、《個(gè)人信息保護(hù)法》等法規(guī)下的合規(guī)性剛需。這個(gè)需求背后其實(shí)涉及幾個(gè)層面的問題日志框架的使用如Logback、Log4j2、AOP面向切面編程技術(shù)的應(yīng)用、注解的元數(shù)據(jù)解析以及數(shù)據(jù)脫敏的策略設(shè)計(jì)。下面我就結(jié)合一次完整的實(shí)踐來拆解如何實(shí)現(xiàn)這個(gè)功能。2. 核心思路從何處攔截又如何識(shí)別要實(shí)現(xiàn)攔截首先得找到“打印傳參日志”這個(gè)動(dòng)作發(fā)生在哪里。通常有以下幾種位置Controller方法內(nèi)部開發(fā)者在方法第一行手動(dòng)寫log.info(request params: {}, param)。Spring AOP切面使用Around注解編寫一個(gè)全局的Controller層日志切面統(tǒng)一打印入?yún)⒑统鰠ⅰ＿@是目前最主流、最優(yōu)雅的方式。Filter或Interceptor在更早的請(qǐng)求處理鏈路中記錄但這里獲取到的通常是HttpServletRequest對(duì)象對(duì)于已經(jīng)反序列化成Java對(duì)象的復(fù)雜參數(shù)處理起來不方便。第三方庫(kù)或框架有些監(jiān)控或?qū)徲?jì)框架會(huì)自動(dòng)記錄請(qǐng)求數(shù)據(jù)。對(duì)于與ApiOperation關(guān)聯(lián)的攔截第2種方式——AOP切面——是最合適的切入點(diǎn)。因?yàn)锳piOperation注解通常就放在Controller方法上AOP可以輕松獲取到該方法及其所有注解信息。我們的思路是在AOP切面中在執(zhí)行目標(biāo)方法前先檢查該方法上是否標(biāo)有ApiOperation或我們自定義的某個(gè)注解然后根據(jù)一定的規(guī)則對(duì)即將要打印的參數(shù)對(duì)象進(jìn)行過濾或脫敏處理。那么如何識(shí)別哪些參數(shù)需要脫敏呢這里就需要一套規(guī)則。我設(shè)計(jì)了一個(gè)簡(jiǎn)單的規(guī)則匹配方案基于注解的精確匹配在DTOData Transfer Object對(duì)象的字段上使用自定義注解如SensitiveField切面通過反射識(shí)別這些字段并進(jìn)行脫敏。這種方式最精確但需要修改所有模型對(duì)象。基于字段名的模糊匹配維護(hù)一個(gè)敏感關(guān)鍵詞列表如password,idCard,mobile,email等通過反射檢查參數(shù)字段的名稱是否包含這些關(guān)鍵詞。這種方式無需修改模型但可能存在誤傷例如一個(gè)字段叫mobilePlatform它可能不是手機(jī)號(hào)。基于字段類型的匹配對(duì)特定類型的值進(jìn)行脫敏例如對(duì)所有String類型的password字段進(jìn)行處理。這種方式需要結(jié)合字段名。組合策略在實(shí)際項(xiàng)目中我推薦使用“注解優(yōu)先字段名兜底”的策略。即優(yōu)先查找SensitiveField注解如果找不到再判斷字段名是否在敏感詞列表中。確定了攔截點(diǎn)和識(shí)別策略接下來就是技術(shù)選型和具體實(shí)現(xiàn)了。3. 技術(shù)選型與基礎(chǔ)環(huán)境搭建3.1 核心依賴這是一個(gè)典型的Spring Boot項(xiàng)目我們需要以下核心依賴Spring Boot Starter AOP提供AOP支持。Spring Boot Starter Web提供Web環(huán)境。Swagger/OpenAPI Annotation為了識(shí)別ApiOperation需要引入Swagger注解包。這里使用springdoc-openapi-ui它包含了io.swagger.v3.oas.annotations.Operation相當(dāng)于ApiOperation。日志框架Spring Boot默認(rèn)使用Logback我們直接使用即可。pom.xml 關(guān)鍵依賴dependency groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter-aop/artifactId /dependency dependency groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter-web/artifactId /dependency dependency groupIdorg.springdoc/groupId artifactIdspringdoc-openapi-ui/artifactId version1.7.0/version !-- 請(qǐng)使用最新穩(wěn)定版 -- /dependency3.2 自定義敏感信息注解為了方便在DTO上標(biāo)記敏感字段我們先定義一個(gè)注解package com.example.demo.annotation; import java.lang.annotation.*; /** * 標(biāo)記字段為敏感信息用于日志脫敏 */ Target(ElementType.FIELD) Retention(RetentionPolicy.RUNTIME) Documented public interface SensitiveField { /** * 脫敏類型默認(rèn)通用脫敏 */ SensitiveType type() default SensitiveType.DEFAULT; /** * 自定義脫敏規(guī)則正則表達(dá)式優(yōu)先級(jí)高于type */ String pattern() default ; /** * 替換字符默認(rèn)為* */ char maskChar() default *; }同時(shí)定義一個(gè)脫敏類型的枚舉支持常見的幾種package com.example.demo.annotation; public enum SensitiveType { /** 默認(rèn)對(duì)字符串中間部分進(jìn)行脫敏 */ DEFAULT, /** 中文名顯示第一個(gè)字其余用*代替 */ CHINESE_NAME, /** 身份證號(hào)顯示前6后4 */ ID_CARD, /** 手機(jī)號(hào)顯示前3后4 */ MOBILE, /** 郵箱符號(hào)前的部分脫敏 */ EMAIL, /** 銀行卡號(hào)顯示前6后4 */ BANK_CARD }這個(gè)注解提供了靈活性既可以通過type指定預(yù)設(shè)的脫敏策略也可以通過pattern和maskChar完全自定義。4. 核心實(shí)現(xiàn)可配置的日志脫敏切面這是整個(gè)功能的核心。我們將創(chuàng)建一個(gè)切面它負(fù)責(zé)攔截所有Controller的請(qǐng)求。判斷是否需要處理例如可以通過配置指定只處理帶有Operation注解的方法。在打印入?yún)⑷罩厩皩?duì)參數(shù)進(jìn)行深度脫敏。執(zhí)行原方法。在打印出參日志前對(duì)返回值進(jìn)行脫敏可選根據(jù)需求決定。4.1 脫敏工具類首先創(chuàng)建一個(gè)工具類它根據(jù)SensitiveField注解或字段名規(guī)則來對(duì)對(duì)象進(jìn)行脫敏。這里使用遞歸來處理嵌套對(duì)象和集合。package com.example.demo.util; import com.example.demo.annotation.SensitiveField; import com.example.demo.annotation.SensitiveType; import org.springframework.util.ReflectionUtils; import java.lang.reflect.Field; import java.util.*; public class SensitiveDataMasker { private static final SetString SENSITIVE_KEYWORDS new HashSet(Arrays.asList( password, pwd, pass, secret, token, key, idCard, identity, 身份證, cardNo, mobile, phone, tel, 手機(jī), 電話, email, mail, 郵箱, bankCard, bankAccount, cardNumber, 銀行卡, 賬號(hào), realName, name, 姓名 )); /** * 對(duì)單個(gè)對(duì)象進(jìn)行脫敏 */ public static Object mask(Object object) { if (object null) { return null; } // 如果是基本類型、字符串、枚舉或JDK內(nèi)置類型直接返回除非是字符串且需要脫敏這里在字段級(jí)別處理 if (isSimpleType(object.getClass())) { return object; } // 處理集合和數(shù)組 if (object instanceof Collection) { return maskCollection((Collection?) object); } if (object instanceof Map) { return maskMap((Map?, ?) object); } if (object.getClass().isArray()) { return maskArray(object); } // 處理自定義對(duì)象 return maskPojo(object); } private static boolean isSimpleType(Class? clazz) { return clazz.isPrimitive() || clazz.isEnum() || CharSequence.class.isAssignableFrom(clazz) || Number.class.isAssignableFrom(clazz) || Boolean.class.equals(clazz) || Date.class.isAssignableFrom(clazz) || clazz.getPackage() ! null clazz.getPackage().getName().startsWith(java.); } private static Object maskPojo(Object pojo) { try { // 這里不修改原對(duì)象創(chuàng)建一個(gè)同類型的新對(duì)象并復(fù)制值。簡(jiǎn)化起見我們使用反射修改原對(duì)象生產(chǎn)環(huán)境慎用或使用深拷貝。 // 本例為了演示直接修改原對(duì)象。實(shí)際項(xiàng)目中如果對(duì)象被多處引用應(yīng)考慮深拷貝。 Class? clazz pojo.getClass(); ListField fields getAllFields(clazz); for (Field field : fields) { ReflectionUtils.makeAccessible(field); Object fieldValue field.get(pojo); if (fieldValue null) { continue; } SensitiveField sensitiveAnnotation field.getAnnotation(SensitiveField.class); boolean isSensitiveByKeyword SENSITIVE_KEYWORDS.stream() .anyMatch(keyword - field.getName().toLowerCase().contains(keyword.toLowerCase())); if (sensitiveAnnotation ! null || isSensitiveByKeyword) { // 執(zhí)行脫敏 Object maskedValue doMask(fieldValue, sensitiveAnnotation, field.getName()); field.set(pojo, maskedValue); } else if (!isSimpleType(fieldValue.getClass())) { // 遞歸處理嵌套的非簡(jiǎn)單類型對(duì)象 field.set(pojo, mask(fieldValue)); } } } catch (IllegalAccessException e) { // 日志記錄異常但不影響主流程 System.err.println(脫敏處理反射異常: e.getMessage()); } return pojo; } private static Object doMask(Object value, SensitiveField annotation, String fieldName) { if (!(value instanceof CharSequence)) { // 非字符串類型暫不處理或按需擴(kuò)展 return value; } String str value.toString(); if (str.isEmpty()) { return str; } // 1. 優(yōu)先使用自定義正則表達(dá)式 if (annotation ! null !annotation.pattern().isEmpty()) { // 這里簡(jiǎn)化處理實(shí)際應(yīng)用需根據(jù)正則替換 return str.replaceAll(annotation.pattern(), String.valueOf(annotation.maskChar())); } // 2. 使用預(yù)設(shè)的脫敏類型 SensitiveType type (annotation ! null) ? annotation.type() : SensitiveType.DEFAULT; // 3. 如果沒有注解根據(jù)字段名推斷一個(gè)類型 if (annotation null) { type inferSensitiveType(fieldName); } switch (type) { case CHINESE_NAME: return maskChineseName(str); case ID_CARD: return maskIdCard(str); case MOBILE: return maskMobile(str); case EMAIL: return maskEmail(str); case BANK_CARD: return maskBankCard(str); case DEFAULT: default: return maskDefault(str); } } private static SensitiveType inferSensitiveType(String fieldName) { String lowerName fieldName.toLowerCase(); if (lowerName.contains(idcard) || lowerName.contains(identity) || lowerName.contains(cardno)) { return SensitiveType.ID_CARD; } else if (lowerName.contains(mobile) || lowerName.contains(phone) || lowerName.contains(tel)) { return SensitiveType.MOBILE; } else if (lowerName.contains(email) || lowerName.contains(mail)) { return SensitiveType.EMAIL; } else if (lowerName.contains(bank) || lowerName.contains(card)) { return SensitiveType.BANK_CARD; } else if (lowerName.contains(name)) { return SensitiveType.CHINESE_NAME; } return SensitiveType.DEFAULT; } // 具體的脫敏方法實(shí)現(xiàn)示例 private static String maskChineseName(String name) { if (name.length() 1) return name; return name.charAt(0) *.repeat(Math.max(0, name.length() - 1)); } private static String maskIdCard(String idCard) { if (idCard.length() 10) return ****; return idCard.substring(0, 6) ******** idCard.substring(idCard.length() - 4); } private static String maskMobile(String mobile) { if (mobile.length() ! 11) return ****; return mobile.substring(0, 3) **** mobile.substring(7); } private static String maskEmail(String email) { int atIndex email.indexOf(); if (atIndex 1) return email; String prefix email.substring(0, 1); return prefix *** email.substring(atIndex); } private static String maskBankCard(String card) { if (card.length() 8) return ****; return card.substring(0, 6) ****** card.substring(card.length() - 4); } private static String maskDefault(String str) { if (str.length() 2) return **; int maskLen Math.max(2, str.length() / 2); int start (str.length() - maskLen) / 2; char[] chars str.toCharArray(); for (int i start; i start maskLen i chars.length; i) { chars[i] *; } return new String(chars); } // 處理集合、Map、數(shù)組的輔助方法略需遞歸調(diào)用mask方法 private static Collection? maskCollection(Collection? collection) { /* ... */ } private static Map?, ? maskMap(Map?, ? map) { /* ... */ } private static Object maskArray(Object array) { /* ... */ } private static ListField getAllFields(Class? clazz) { /* ... */ } }注意這個(gè)工具類直接通過反射修改了原對(duì)象的值。這在很多場(chǎng)景下是可行的因?yàn)镃ontroller層的參數(shù)對(duì)象通常只在本次請(qǐng)求中使用。但如果你的參數(shù)對(duì)象在后續(xù)流程中還會(huì)被用到且不希望它被修改那么你需要實(shí)現(xiàn)一個(gè)深度拷貝Deep Copy邏輯對(duì)拷貝后的對(duì)象進(jìn)行脫敏。可以使用BeanUtils.copyProperties淺拷貝結(jié)合遞歸或者使用序列化/反序列化如Jackson來實(shí)現(xiàn)深拷貝。4.2 日志切面實(shí)現(xiàn)現(xiàn)在我們來編寫核心的AOP切面。我們將創(chuàng)建一個(gè)Around切面攔截所有RestController中的方法。package com.example.demo.aspect; import com.example.demo.util.SensitiveDataMasker; import io.swagger.v3.oas.annotations.Operation; import lombok.extern.slf4j.Slf4j; import org.aspectj.lang.ProceedingJoinPoint; import org.aspectj.lang.annotation.Around; import org.aspectj.lang.annotation.Aspect; import org.aspectj.lang.reflect.MethodSignature; import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; import org.springframework.stereotype.Component; import org.springframework.web.context.request.RequestContextHolder; import org.springframework.web.context.request.ServletRequestAttributes; import javax.servlet.http.HttpServletRequest; import java.util.Arrays; Aspect Component Slf4j // 可以通過配置控制切面是否開啟 ConditionalOnProperty(name sensitive.log.mask.enabled, havingValue true, matchIfMissing true) public class SensitiveLogAspect { /** * 切入點(diǎn)所有RestController中的public方法。 * 你也可以更精確地定義為帶有Operation注解的方法annotation(io.swagger.v3.oas.annotations.Operation) */ Around(execution(public * com.example.demo.controller..*.*(..))) public Object aroundApi(ProceedingJoinPoint joinPoint) throws Throwable { MethodSignature signature (MethodSignature) joinPoint.getSignature(); String className joinPoint.getTarget().getClass().getSimpleName(); String methodName signature.getName(); // 判斷是否需要處理這里我們配置為只處理帶有Operation注解的方法 // 可以通過配置文件動(dòng)態(tài)調(diào)整策略 Operation apiOperation signature.getMethod().getAnnotation(Operation.class); boolean needMask apiOperation ! null; // 或者從配置中心讀取規(guī)則 Object[] args joinPoint.getArgs(); Object[] maskedArgs args; // 如果需要脫敏則處理入?yún)?if (needMask) { maskedArgs Arrays.stream(args).map(SensitiveDataMasker::mask).toArray(); } // 獲取請(qǐng)求信息可選 HttpServletRequest request null; try { ServletRequestAttributes attributes (ServletRequestAttributes) RequestContextHolder.getRequestAttributes(); if (attributes ! null) { request attributes.getRequest(); } } catch (Exception e) { // 忽略 } // 打印脫敏后的入?yún)⑷罩?if (log.isInfoEnabled()) { String requestInfo (request ! null) ? String.format([%s] %s, request.getMethod(), request.getRequestURI()) : ; log.info(API請(qǐng)求開始 {} - {}.{} 入?yún)⒁衙撁? {}, requestInfo, className, methodName, Arrays.toString(maskedArgs)); } long startTime System.currentTimeMillis(); Object result; try { // 使用原始參數(shù)執(zhí)行原方法因?yàn)槊撁糁挥糜谌罩敬蛴〔挥绊憣?shí)際業(yè)務(wù)邏輯。 // 如果你希望業(yè)務(wù)邏輯也接收脫敏后的數(shù)據(jù)通常不需要?jiǎng)t傳入maskedArgs。 result joinPoint.proceed(args); } catch (Throwable e) { long costTime System.currentTimeMillis() - startTime; log.error(API執(zhí)行異常 {}.{} 耗時(shí): {}ms, className, methodName, costTime, e); throw e; } long costTime System.currentTimeMillis() - startTime; // 對(duì)返回值進(jìn)行脫敏根據(jù)需求決定是否開啟 Object maskedResult result; if (needMask isMaskReturnValueEnabled()) { maskedResult SensitiveDataMasker.mask(result); } // 打印脫敏后的出參日志 if (log.isInfoEnabled()) { log.info(API請(qǐng)求結(jié)束 {}.{} 耗時(shí): {}ms 出參已脫敏: {}, className, methodName, costTime, maskedResult); } // 返回原始結(jié)果確保業(yè)務(wù)邏輯正確 return result; } private boolean isMaskReturnValueEnabled() { // 可以從配置文件中讀取例如Value(${sensitive.log.mask.return:false}) return false; // 默認(rèn)關(guān)閉因?yàn)榉祷刂得撁艨赡苡绊懬岸藬?shù)據(jù) } }關(guān)鍵點(diǎn)解析切入點(diǎn)表達(dá)式execution(public * com.example.demo.controller..*.*(..))攔截了controller包及其子包下所有類的所有public方法。你可以根據(jù)需要調(diào)整使其更精確。觸發(fā)條件本例中我們通過Operation注解的存在來判斷是否需要脫敏。你可以將其改為讀取配置文件實(shí)現(xiàn)更靈活的規(guī)則例如根據(jù)URL路徑匹配、根據(jù)自定義注解等。脫敏時(shí)機(jī)非常重要我們?cè)趌og.info打印日志時(shí)傳入的是脫敏后的參數(shù)副本maskedArgs。但是在調(diào)用joinPoint.proceed()執(zhí)行實(shí)際業(yè)務(wù)方法時(shí)我們傳入的是原始參數(shù)args。這確保了日志是安全的而業(yè)務(wù)邏輯使用的是原始、未篡改的數(shù)據(jù)。這是最安全、最推薦的做法。返回值脫敏isMaskReturnValueEnabled()方法控制是否對(duì)返回值也進(jìn)行脫敏。默認(rèn)建議關(guān)閉因?yàn)榉祷亟o前端的數(shù)據(jù)通常需要保持完整脫敏應(yīng)該在更上層的展示層或前端完成。日志中的返回值脫敏主要用于記錄一些內(nèi)部接口的返回防止敏感信息寫入日志系統(tǒng)。性能考慮反射和遞歸遍歷對(duì)象會(huì)有一定的性能開銷。建議在切面中加入開關(guān)在生產(chǎn)環(huán)境可以關(guān)閉詳細(xì)的入?yún)?出參日志只記錄異常和耗時(shí)。對(duì)于特別復(fù)雜的對(duì)象或高頻接口可以考慮緩存字段的反射結(jié)果如哪些字段需要脫敏。使用ConditionalOnProperty讓切面可配置。5. 實(shí)戰(zhàn)測(cè)試與踩坑記錄5.1 準(zhǔn)備測(cè)試Controller和DTOpackage com.example.demo.controller; import com.example.demo.annotation.SensitiveField; import com.example.demo.annotation.SensitiveType; import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.tags.Tag; import lombok.Data; import org.springframework.web.bind.annotation.*; RestController RequestMapping(/api/user) Tag(name 用戶管理) public class UserController { PostMapping(/create) Operation(summary 創(chuàng)建用戶) public UserDTO createUser(RequestBody UserDTO userDTO) { // 模擬業(yè)務(wù)處理 userDTO.setUserId(System.currentTimeMillis()); return userDTO; } GetMapping(/detail) Operation(summary 查詢用戶詳情) public UserDTO getUserDetail(RequestParam String idCard, RequestParam String mobile) { // 模擬根據(jù)證件和手機(jī)號(hào)查詢 UserDTO dto new UserDTO(); dto.setUserId(1001L); dto.setRealName(張三); dto.setIdCard(idCard); dto.setMobile(mobile); dto.setEmail(zhangsanexample.com); dto.setPassword(this_is_secret); return dto; } } Data class UserDTO { private Long userId; SensitiveField(type SensitiveType.CHINESE_NAME) private String realName; SensitiveField(type SensitiveType.ID_CARD) private String idCard; SensitiveField(type SensitiveType.MOBILE) private String mobile; SensitiveField(type SensitiveType.EMAIL) private String email; // 沒有加注解但字段名包含password會(huì)被關(guān)鍵字規(guī)則匹配 private String password; private Integer age; }5.2 發(fā)送請(qǐng)求與觀察日志啟動(dòng)應(yīng)用后我們發(fā)送一個(gè)創(chuàng)建用戶的POST請(qǐng)求curl -X POST http://localhost:8080/api/user/create \ -H Content-Type: application/json \ -d { realName: 李四, idCard: 110101199001011234, mobile: 13800138000, email: lisicompany.com, password: MySuperSecret123, age: 30 }觀察控制臺(tái)日志輸出2023-10-27 10:00:00.123 INFO com.example.demo.aspect.SensitiveLogAspect - API請(qǐng)求開始 [POST] /api/user/create - UserController.createUser 入?yún)⒁衙撁? [UserDTO(userIdnull, realName李*, idCard110101********1234, mobile138****8000, emaill***company.com, passwordMySu***********123, age30)] 2023-10-27 10:00:00.456 INFO com.example.demo.aspect.SensitiveLogAspect - API請(qǐng)求結(jié)束 UserController.createUser 耗時(shí): 333ms 出參已脫敏: UserDTO(userId1698379200123, realName李*, idCard110101********1234, mobile138****8000, emaill***company.com, passwordMySu***********123, age30)可以看到所有標(biāo)記了SensitiveField注解的字段姓名、身份證、手機(jī)、郵箱都按照預(yù)設(shè)規(guī)則脫敏了。password字段雖然沒有注解但字段名命中了敏感關(guān)鍵詞列表也被進(jìn)行了默認(rèn)脫敏中間部分替換為*。而userId和age字段則正常顯示。5.3 遇到的坑與解決方案坑1循環(huán)引用導(dǎo)致棧溢出當(dāng)對(duì)象之間存在雙向關(guān)聯(lián)例如User對(duì)象里有一個(gè)ListOrder而Order對(duì)象里又有一個(gè)User屬性時(shí)遞歸脫敏會(huì)陷入死循環(huán)最終導(dǎo)致StackOverflowError。解決方案在SensitiveDataMasker.mask()方法中引入一個(gè)ThreadLocalSetObject來記錄當(dāng)前遞歸路徑上已經(jīng)處理過的對(duì)象。在開始處理一個(gè)對(duì)象前先檢查它是否已在集合中如果在就跳過或只處理其原始類型的字段。處理完后將其從集合中移除。這類似于對(duì)象序列化時(shí)處理循環(huán)引用的方式。坑2性能瓶頸在高并發(fā)場(chǎng)景下對(duì)每個(gè)請(qǐng)求的復(fù)雜參數(shù)對(duì)象進(jìn)行深度遞歸反射可能會(huì)成為性能瓶頸。解決方案緩存反射結(jié)果對(duì)于每個(gè)Class可以緩存其需要脫敏的Field列表及對(duì)應(yīng)的脫敏策略。這樣只需要在第一次訪問時(shí)進(jìn)行反射和規(guī)則匹配。采樣日志不是每個(gè)請(qǐng)求都打印完整的入?yún)⒊鰠ⅰ？梢越Y(jié)合SLF4J/MDCMapped Diagnostic Context設(shè)置一個(gè)采樣率或者只為特定用戶、特定接口開啟詳細(xì)日志。異步日志使用Logback或Log4j2的異步Appender避免日志IO阻塞業(yè)務(wù)線程。關(guān)閉非核心日志生產(chǎn)環(huán)境可以將切面的日志級(jí)別調(diào)整為DEBUG默認(rèn)不打印。坑3與參數(shù)校驗(yàn)Validation的沖突我們是在AOP切面里打印日志時(shí)對(duì)參數(shù)副本進(jìn)行脫敏業(yè)務(wù)方法拿到的是原始數(shù)據(jù)。這本身沒問題。但如果你的脫敏工具類修改了原始對(duì)象像我們示例中那樣而后續(xù)有基于Valid的參數(shù)校驗(yàn)校驗(yàn)器看到的將是脫敏后的數(shù)據(jù)可能導(dǎo)致校驗(yàn)失敗例如郵箱格式不正確。解決方案務(wù)必確保業(yè)務(wù)邏輯使用原始參數(shù)。我們的示例切面在joinPoint.proceed(args)時(shí)傳入的是原始args這是正確的。確保你的SensitiveDataMasker.mask方法不修改傳入的原始對(duì)象而是返回一個(gè)脫敏后的新對(duì)象深拷貝。示例中為了簡(jiǎn)化直接修改了原對(duì)象在生產(chǎn)環(huán)境中應(yīng)改為深拷貝邏輯。坑4忽略某些特定類型有些類型我們不希望被遞歸遍歷比如HttpServletRequest、HttpServletResponse、MultipartFile等。這些對(duì)象結(jié)構(gòu)復(fù)雜且通常不包含需要脫敏的業(yè)務(wù)數(shù)據(jù)遍歷它們既沒必要又容易出錯(cuò)。解決方案在isSimpleType方法中將這些特定類型也加入排除列表。private static boolean isSimpleType(Class? clazz) { // ... 原有判斷 ... return ... || javax.servlet.ServletRequest.class.isAssignableFrom(clazz) || javax.servlet.ServletResponse.class.isAssignableFrom(clazz) || org.springframework.web.multipart.MultipartFile.class.isAssignableFrom(clazz); }6. 進(jìn)階更靈活的規(guī)則配置與動(dòng)態(tài)策略上面的實(shí)現(xiàn)將敏感詞和脫敏策略硬編碼在了工具類中。在實(shí)際項(xiàng)目中我們可能希望這些規(guī)則是可配置的甚至能從數(shù)據(jù)庫(kù)或配置中心如Nacos、Apollo動(dòng)態(tài)加載。6.1 基于配置文件的規(guī)則管理我們可以創(chuàng)建一個(gè)配置類將敏感詞列表和字段名到脫敏類型的映射關(guān)系放在application.yml中。sensitive: log: mask: enabled: true mask-return-value: false rules: field-patterns: - pattern: .*[Pp]assword.* type: DEFAULT - pattern: .*[Ii]d[Cc]ard.* type: ID_CARD - pattern: .*[Mm]obile.* type: MOBILE - pattern: .*[Ee]mail.* type: EMAIL - pattern: .*[Rr]eal[Nn]ame.* type: CHINESE_NAME # 也可以配置基于類名字段名的精確規(guī)則 class-field-rules: - class: com.example.demo.dto.UserDTO field: bankAccount type: BANK_CARD然后在SensitiveDataMasker中注入這些配置并使用Pattern進(jìn)行正則匹配優(yōu)先級(jí)高于簡(jiǎn)單的關(guān)鍵詞包含判斷。6.2 結(jié)合Spring EL表達(dá)式實(shí)現(xiàn)條件脫敏有時(shí)脫敏規(guī)則可能更復(fù)雜。例如只有當(dāng)一個(gè)用戶的userType為VIP時(shí)才對(duì)其email進(jìn)行脫敏。我們可以設(shè)計(jì)一個(gè)支持SpELSpring Expression Language的注解。Target(ElementType.FIELD) Retention(RetentionPolicy.RUNTIME) public interface ConditionalSensitive { String condition(); // SpEL表達(dá)式例如: “#root.userType ‘VIP‘” SensitiveType type(); }在切面中我們需要獲取到根對(duì)象即參數(shù)對(duì)象本身然后使用Spring的StandardEvaluationContext來解析SpEL表達(dá)式根據(jù)結(jié)果決定是否脫敏。這大大增加了靈活性但同時(shí)也增加了復(fù)雜度和性能開銷需謹(jǐn)慎使用。6.3 集成日志審計(jì)框架如果你的項(xiàng)目已經(jīng)使用了像Spring Boot Audit或自定義的審計(jì)日志框架那么更好的做法是將脫敏邏輯集成到審計(jì)事件發(fā)布的過程中而不是自己再造一個(gè)AOP輪子。你可以實(shí)現(xiàn)一個(gè)AuditEventRepository的定制版本在保存審計(jì)事件到數(shù)據(jù)庫(kù)或發(fā)送到消息隊(duì)列之前對(duì)事件中的數(shù)據(jù)進(jìn)行脫敏處理。這樣更符合架構(gòu)規(guī)范也能統(tǒng)一管理所有的審計(jì)日志脫敏策略。7. 總結(jié)與個(gè)人心得實(shí)現(xiàn)“攔截ApiOperation打印傳參日志”的功能本質(zhì)上是在日志的實(shí)用性和數(shù)據(jù)安全性之間尋找平衡。AOP技術(shù)為我們提供了無侵入式的解決方案而靈活的策略設(shè)計(jì)注解規(guī)則則讓這個(gè)方案能適應(yīng)多變的業(yè)務(wù)需求。在整個(gè)實(shí)踐過程中我最大的體會(huì)是安全無小事細(xì)節(jié)定成敗。以下幾點(diǎn)是你在落地類似功能時(shí)需要特別注意的影響評(píng)估上線前務(wù)必在測(cè)試環(huán)境進(jìn)行充分測(cè)試。不僅要測(cè)試脫敏是否正確還要測(cè)試是否會(huì)影響正常的參數(shù)綁定、數(shù)據(jù)校驗(yàn)、序列化/反序列化如Redis緩存、MQ消息等。性能監(jiān)控在切面中加入耗時(shí)統(tǒng)計(jì)并接入你的APM應(yīng)用性能監(jiān)控系統(tǒng)。觀察引入脫敏邏輯后接口的P99響應(yīng)時(shí)間是否有明顯變化。對(duì)于性能敏感的接口考慮優(yōu)化或豁免。日志級(jí)別管理生產(chǎn)環(huán)境建議將入?yún)?出參的詳細(xì)日志級(jí)別設(shè)為DEBUG或TRACE通過開關(guān)動(dòng)態(tài)控制。錯(cuò)誤日志ERROR級(jí)別可以保留必要的上下文但也要注意脫敏。團(tuán)隊(duì)共識(shí)與團(tuán)隊(duì)所有成員明確日志脫敏的規(guī)范和邊界。最好將SensitiveField注解的使用和DTO字段命名規(guī)范寫入開發(fā)手冊(cè)確保新的敏感字段能被自動(dòng)識(shí)別和處理。不要過度設(shè)計(jì)初期可以從簡(jiǎn)單的字段名關(guān)鍵詞匹配開始滿足大部分場(chǎng)景。隨著業(yè)務(wù)復(fù)雜化再逐步引入注解、配置化等高級(jí)特性。避免一開始就設(shè)計(jì)一個(gè)龐大而笨重的規(guī)則引擎。最后記住一點(diǎn)日志脫敏是防護(hù)的最后一道防線而不是唯一一道。敏感信息的安全更應(yīng)該從源頭控制比如在數(shù)據(jù)庫(kù)存儲(chǔ)時(shí)加密、在接口設(shè)計(jì)時(shí)最小化傳輸范圍、在前端展示時(shí)即時(shí)脫敏。多管齊下才能構(gòu)建真正可靠的數(shù)據(jù)安全體系。