1. 需求背景
需求背景：需要對(duì)用戶的某些行為進(jìn)行統(tǒng)計(jì)，故在對(duì)應(yīng)的接口上進(jìn)行埋點(diǎn)。
埋點(diǎn)：當(dāng)用戶點(diǎn)擊某個(gè)功能時(shí)，收集關(guān)鍵數(shù)據(jù)存儲(chǔ)到第三方平臺(tái)或者數(shù)據(jù)庫中。
一個(gè)埋點(diǎn)事件可能在多處被觸發(fā)（調(diào)用多個(gè)接口時(shí)，均觸發(fā)一個(gè)事件）
2. 設(shè)計(jì)方案
為了不侵入業(yè)務(wù)代碼，故采用Spring AOP注解的方式完成埋點(diǎn)操作。
在開發(fā)過程中遇到的問題：
2.1 模塊依賴問題
由于項(xiàng)目采用的多模塊的開發(fā)方式。
image.png
模塊依賴關(guān)系如上圖所示。
- 埋點(diǎn)注解可以用在web模塊，service1，2，3模塊。
- 埋點(diǎn)邏輯中組裝關(guān)鍵數(shù)據(jù)需要查詢數(shù)據(jù)庫或者調(diào)用feign接口。
最終方案：埋點(diǎn)注解、Aspect類和handler（埋點(diǎn)事件處理器）定義在config模塊，handler所有子類定義在service1模塊中。
在項(xiàng)目啟動(dòng)后，多個(gè)模塊的SpringBean均在一個(gè)Spring容器中，通過ApplicationContextAware（動(dòng)態(tài)獲取容器中Bean）來動(dòng)態(tài)獲取容器中的Bean。
2.2 復(fù)雜的業(yè)務(wù)邏輯
一個(gè)埋點(diǎn)事件可能在多處被觸發(fā)（調(diào)用多個(gè)接口時(shí)，均觸發(fā)一個(gè)事件），但是不同的接口請(qǐng)求入?yún)⒉煌?，響?yīng)結(jié)果對(duì)象也不同。若在Aspect僅僅將請(qǐng)求對(duì)象和響應(yīng)對(duì)象傳遞到Handler中，同一個(gè)Handler無法進(jìn)行公共處理。
最終方案：采用spEL表達(dá)式，在注解中組裝參數(shù)。
3. 項(xiàng)目實(shí)戰(zhàn)
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface BuryingPoint {
/**
* 事件處理器
*/
String eventHandler();
/**
* 事件名
*/
String eventName();
/**
* 觸發(fā)事件后，傳遞到aspect類的參數(shù)。
* <p>
* 格式:#{spEL}表達(dá)式
* 例如：#{#requestVo.name} 獲取請(qǐng)求對(duì)象requestVo中的name字段的值；
* #{#root.name} 獲取響應(yīng)對(duì)象name字段的值
* #{{name:#requestVo.name,age:#root.age,type:'字符串'}} 組裝map對(duì)象
*/
String remark() default "";
}
/**
* 事件處理器
*/
public interface EventHandler {
void eventHandler(BuryingPointDto scBuryingPointDto);
}
@Data
public class BuryingPointDto {
/**
* 請(qǐng)求的ip地址
*/
private String ipAddress;
/**
* 請(qǐng)求頭信息
*/
private Map<String, String> headers;
/**
* 事件名稱
*/
private String EventName;
/**
* 請(qǐng)求的uri地址
*/
private String uri;
private Object remark;
}
@Component
@Slf4j
@Aspect
public class BuryingPointAspect {
//定義解析器
private static final SpelExpressionParser PARSER = new SpelExpressionParser();
private static final TemplateParserContext PARSER_CONTEXT = new TemplateParserContext();
private static final LocalVariableTableParameterNameDiscoverer localVariableTable = new LocalVariableTableParameterNameDiscoverer();
/**
* 定義線程池。
* 拒絕策略：直接拒絕，不拋出異常
*/
private static final Executor executor = new ThreadPoolExecutor(Runtime.getRuntime().availableProcessors(),
Runtime.getRuntime().availableProcessors() * 2, 60, TimeUnit.SECONDS,
new LinkedBlockingQueue<>(500), new ThreadPoolExecutor.DiscardPolicy());
@Pointcut("@annotation(com.tellme.spel.BuryingPoint)")
public void permission() {
}
@Around(value = "permission();")
public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
BuryingPointDto scBuryingPointDto = new BuryingPointDto();
Signature signature = joinPoint.getSignature();
//參數(shù)值
Object[] args = joinPoint.getArgs();
MethodSignature methodSignature = (MethodSignature) signature;
Object target = joinPoint.getTarget();
//獲取到當(dāng)前執(zhí)行的方法
Method method = target.getClass().getDeclaredMethod(methodSignature.getName(), methodSignature.getParameterTypes());
//獲取注解信息
BuryingPoint buryingPoint = method.getAnnotation(BuryingPoint.class);
ServletRequestAttributes sra = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
scBuryingPointDto.setEventName(buryingPoint.eventName());
HttpServletRequest request;
if (sra != null) {
request = sra.getRequest();
//獲取請(qǐng)求的ip地址
String ipAddress = getIpAddress(request);
//獲取請(qǐng)求頭信息
Map<String, String> requestHeaders = getRequestHeaders(request);
scBuryingPointDto.setUri(request.getRequestURI());
scBuryingPointDto.setIpAddress(ipAddress);
scBuryingPointDto.setHeaders(requestHeaders);
}
Object proceed = joinPoint.proceed();
try {
//獲取上下文對(duì)象
StandardEvaluationContext evaluationContext = getEvaluationContext(args, method, proceed);
//判斷參數(shù)是否為EL表示式
String remark = buryingPoint.remark();
if (StringUtils.isNotBlank(remark)) {
//解析為EL表達(dá)式
if (remark.startsWith(PARSER_CONTEXT.getExpressionPrefix()) && remark.endsWith(PARSER_CONTEXT.getExpressionSuffix())) {
scBuryingPointDto.setRemark(PARSER.parseExpression(remark, PARSER_CONTEXT)
.getValue(evaluationContext, Object.class));
} else {
//作為普通參數(shù)
scBuryingPointDto.setRemark(remark);
}
}
String eventHandlerBeanName = buryingPoint.eventHandler();
Object bean = SpringUtils.getBean(eventHandlerBeanName);
//判斷bean是否是Hander的子類
if (bean instanceof EventHandler) {
//觸發(fā)事件
executor.execute(() -> {
((EventHandler) bean).eventHandler(scBuryingPointDto);
});
} else {
log.warn("eventHandlerBeanName is not instanceof SCBuryingPointEventHandler , This eventHandlerBeanName is {}", eventHandlerBeanName);
}
//數(shù)據(jù)轉(zhuǎn)換
} catch (Exception e) {
log.error("", e);
}
return proceed;
}
/**
* 填充spEL的評(píng)估上下文對(duì)象
*
* @param args 代理方法的請(qǐng)求參數(shù)
* @param method 目標(biāo)方法
* @param result 結(jié)果對(duì)象
* @return 填充請(qǐng)求參數(shù)的上下文對(duì)象
*/
private StandardEvaluationContext getEvaluationContext(Object[] args, Method method, Object result) {
//獲取參數(shù)名
String[] parameterNames = localVariableTable.getParameterNames(method);
StandardEvaluationContext context = new StandardEvaluationContext();
//填充spEL的上下文對(duì)象
if (parameterNames != null) {
//獲取參數(shù)信息
//對(duì)象信息
for (int i = 0; i < parameterNames.length; i++) {
context.setVariable(parameterNames[i], args[i]);
}
}
//填充根對(duì)象
context.setRootObject(result);
return context;
}
/**
* 獲取請(qǐng)求ip地址
*
* @param request 請(qǐng)求對(duì)象
* @return 請(qǐng)求者的ip地址
*/
public static String getIpAddress(HttpServletRequest request) {
String ipAddress = request.getHeader("x-forwarded-for");
if (ipAddress == null || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
ipAddress = request.getHeader("Proxy-Client-IP");
}
if (ipAddress == null || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
ipAddress = request.getHeader("WL-Proxy-Client-IP");
}
if (ipAddress == null || ipAddress.length() == 0 || "unknown".equalsIgnoreCase(ipAddress)) {
ipAddress = request.getRemoteAddr();
if ("127.0.0.1".equals(ipAddress) || "0:0:0:0:0:0:0:1".equals(ipAddress)) {
// 根據(jù)網(wǎng)卡取本機(jī)配置的IP
try {
ipAddress = InetAddress.getLocalHost().getHostAddress();
} catch (UnknownHostException e) {
log.error("buriedPoint getIpAddr error ", e);
}
}
}
// 對(duì)于通過多個(gè)代理的情況，第一個(gè)IP為客戶端真實(shí)IP,多個(gè)IP按照','分割
// "***.***.***.***".length()
if (ipAddress != null && ipAddress.length() > 15) {
// = 15
if (ipAddress.indexOf(",") > 0) {
ipAddress = ipAddress.substring(0, ipAddress.indexOf(","));
}
}
return ipAddress;
}
/**
* 獲取請(qǐng)求中的請(qǐng)求頭信息
*
* @param request 請(qǐng)求對(duì)象
* @return 請(qǐng)求頭信息
*/
public static Map<String, String> getRequestHeaders(HttpServletRequest request) {
Map<String, String> headers = new HashMap<>();
Enumeration headerNames = request.getHeaderNames();
while (headerNames.hasMoreElements()) {
String key = (String) headerNames.nextElement();
String value = request.getHeader(key);
headers.put(key, value);
}
return headers;
}
}
4. spEL表達(dá)式可以傳入的值
格式: remark="#{spEL}" 或者 remark="字符串"
例如：
- remark="#{#requestVo.name}" 獲取請(qǐng)求對(duì)象requestVo中的name字段的值；
- remark="#{#root.name}" 獲取響應(yīng)對(duì)象name字段的值
- remark="#{{name:#requestVo.name,age:#root.age,type:'字符串'}}" 組裝map對(duì)象，handler中可以強(qiáng)轉(zhuǎn)map對(duì)象。
- remark="字符串" 后端直接獲取字符串。
- 解決引用鏈上出現(xiàn)空指針異常，可以使用如下的方式：remark = "#{#root?.data?.itemAndAnswer?.get(0)?.name}"
在注解中使用spEL表達(dá)式，將分散在response或者request的對(duì)象的數(shù)據(jù)合并為一個(gè)map或者轉(zhuǎn)換為其他類型（String、Long），在handler中進(jìn)行強(qiáng)轉(zhuǎn)獲取到具體的參數(shù)。由此使得handler可以處理公共邏輯。
