一八孝、AOP相關(guān)注解
- 前置通知 -- @Before
- 后置通知 -- @After
- 返回通知 -- @AfterReturning
- 異常通知 -- @AfterThrowing
- 環(huán)繞通知 -- @Around
- @PointCut -- 公共切入點(diǎn)表達(dá)式
- @Aspect -- 指定切面類
- JoinPoint -- 作為函數(shù)的參數(shù)傳入切面方法，可以得到目標(biāo)方法的相關(guān)信息
二鸠项、實(shí)現(xiàn)效果
??基于Spring Boot框架唆阿，使用AOP相關(guān)特性記錄日志信息。完整代碼見：https://github.com/just-right/logaop
- 將日志信息存入數(shù)據(jù)庫
- 當(dāng)請求發(fā)生異常時(shí)自定義返回的提示信息
- 將日志信息存入本地日志文件锈锤，發(fā)生異常時(shí)存儲完整的堆棧信息
- 自定義攔截器結(jié)合自定義注解，模擬驗(yàn)證請求信息是否有正確的Token參數(shù)
- 配置druid連接池
三、關(guān)鍵邏輯
3.1 使用AOP跟蹤請求
??@Before獲取請求數(shù)據(jù)久免，核心代碼如下：
@Before( value = "pointCutMethod()")
public void doBefore(JoinPoint joinPoint) {
ServletRequestAttributes requestAttributes = (ServletRequestAttributes)
RequestContextHolder.getRequestAttributes();
HttpServletRequest request = requestAttributes.getRequest();
//請求SessionID
String sessionID = request.getRequestedSessionId();
//請求路徑
String requestURI = request.getRequestURI();
//獲取請求參數(shù)信息
Map<String, String[]> parameterMap = request.getParameterMap();
String jsonStr = JSONObject.toJSONString(parameterMap);
//獲取IP地址
String ipAddress = IPUtils.getIpAddr(request);
//獲取請求方法
String method = request.getMethod();
//訪問時(shí)間
LocalDateTime dateTime = LocalDateTime.now();
... ...
}
??@doAfter獲取返回狀態(tài)浅辙，核心代碼如下：
@After(value = "pointCutMethod()")
public void doAfter(JoinPoint joinPoint) {
ServletRequestAttributes requestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
HttpServletResponse response = requestAttributes.getResponse();
HttpServletRequest request = requestAttributes.getRequest();
LogAopInfo logEntity = (LogAopInfo) request.getAttribute(ILogAspectConst.REQUEST_ATTRIBUTE);
//返回狀態(tài)
int status = response.getStatus();
//請求結(jié)束時(shí)間
LocalDateTime endDateTime = LocalDateTime.now();
Duration duration = Duration.between(logEntity.getBeginDateTime(),endDateTime);
//請求耗時(shí)
long spendTimes = duration.getSeconds();
... ...
}
??@AfterReturning獲取返回?cái)?shù)據(jù)，核心代碼如下：
@AfterReturning(value = "pointCutMethod()", returning = "keys")
public void doAfterReturning(JoinPoint joinPoint, Object keys) {
ServletRequestAttributes requestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
HttpServletRequest request = requestAttributes.getRequest();
//返回?cái)?shù)據(jù)信息
String responseInfo = JSONObject.toJSONString(keys);
... ...
}
??@Around可以處理請求的所有階段阎姥，本例主要用于處理錯(cuò)誤信息记舆，核心代碼如下：
@Around(value = "pointCutMethod()")
public Object doAround(ProceedingJoinPoint proceedingJoinPoint) {
Object object = null;
try {
//執(zhí)行方法-返回值
object = proceedingJoinPoint.proceed();
} catch (Throwable ex) {
//打印錯(cuò)誤堆棧信息
this.printErrorStackTraceInfo(ex);
//設(shè)置返回值
object = ErrorInfoEnum.getErrorByCode(100).getErrorInfo();
}
return object;
}
//打印錯(cuò)誤堆棧信息
private void printErrorStackTraceInfo(Throwable ex){
if(ex != null){
StringBuffer buffer = new StringBuffer();
for (StackTraceElement element:ex.getStackTrace()) {
buffer.append("\t at "+element.getClassName());
buffer.append("."+element.getMethodName());
buffer.append("("+element.getFileName()+":"+element.getLineNumber()+")\n");
}
logger.info(ex.getMessage()+"\n"+buffer.toString());
}
}
3.2 自定義攔截器過濾請求
??自定義注解@LogAop，標(biāo)志是否需要過濾請求呼巴。
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface LogAop {
boolean logFlag() default true;
}
??自定義攔截器LoggerInterceptor 泽腮，結(jié)合@LogAop注解過濾請求。
public class LoggerInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
if (!(handler instanceof HandlerMethod)) {
return true;
}
HandlerMethod handlerMethod = (HandlerMethod)handler;
LogAop loginCheck = handlerMethod.getMethod().getAnnotation(LogAop.class);
if (loginCheck !=null && loginCheck.logFlag()){
Map<String, String[]> parameterMap = request.getParameterMap();
//查看請求參數(shù)是否攜帶token且token信息以hello為開頭
Optional<Boolean> optional = parameterMap.entrySet().stream()
.filter(e-> e.getKey().equals(ILogAspectConst.REQUEST_TOKEN_FIELD)).findFirst()
.map(e->e.getValue()[0].startsWith(ILogAspectConst.TOKEN_INFO));
if(optional.orElse(false)){
return true;
}
//設(shè)置提示信息
response.setContentType(ILogAspectConst.CONTENT_TYPE);
response.getWriter().println(ILogAspectConst.TIP_MSG);
return false;
}
return true;
}
}
??注冊LoggerInterceptor攔截器衣赶。
@Configuration
public class LoggerInterceptorConfigurer implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new LoggerInterceptor()).addPathPatterns("/**");
}
}
四诊赊、測試
??測試控制器類如下所示：
@RestController
@RequestMapping(value = "/logaop")
public class LogAopController {
@LogAop
@GetMapping(value = "/test")
public String logAopTest() {
int a = 1/0; //異常測試
return "hello wolrd!";
}
@LogAop(logFlag = false)
@GetMapping(value = "/test2")
public String logAopTest2() {
return "hello wolrd!";
}
}
??自定義攔截器請求測試：
圖4-1 自定義攔截器請求測試.png
??請求測試（攜帶正確的Token信息），發(fā)生異常時(shí)返回自定義提示信息：
圖4-2 請求異常返回自定義提示信息.png
??請求發(fā)生異常時(shí)府瞄，查看本地日志文件：
圖4-3 本地日志文件.png
??查看數(shù)據(jù)庫日志記錄信息碧磅，如下所示：
圖4-4 查看數(shù)據(jù)庫日志記錄信息.png
