Springboot聯結萬物學習筆記--Springboot微服務基礎搭建篇（八)--AOP實現（日誌切面為例）
阿新 • • 發佈：2021-08-08
部落格說明：撰寫部落格目的是在記錄自己所學知識、在工作中使用技術遇到的技術問題、一些技術感悟，因此避免不了涉及到和其他文章有相似之處。本文從作者自己的實踐中指出相關踩坑問題，著重指出學習過程中遇到的相關問題。如果存在相關侵權問題請聯絡博主刪除，同時有技術上的見解可以在評論去裡發出，會不定期回覆，謝謝。
gitee地址：https://gitee.com/woniurunfast/springbootwitheverything
01背景
AOP為Aspect Oriented Programming的縮寫，意為：面向切面程式設計，通過預編譯方式和執行期動態代理實現程式功能的統一維護的一種技術。AOP是OOP的延續，是軟體開發中的一個熱點，也是Spring框架中的一個重要內容，是函數語言程式設計的一種衍生範型。利用AOP可以對業務邏輯的各個部分進行隔離，從而使得業務邏輯各部分之間的耦合度降低，提高程式的可重用性，同時提高了開發的效率。(來自百度百科)
02目標
1、建立aop類指定介面切面完成日誌列印
03 第一種方式aop掃包實現
1、引入依賴
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
2、建立切面類
package com.hkx.demo.aop; import org.aspectj.lang.JoinPoint; import org.aspectj.lang.ProceedingJoinPoint; import org.aspectj.lang.annotation.*; 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; import java.util.HashMap; import java.util.Map; @Component @Aspect public class LogAspect { //掃描包路徑 @Pointcut("execution(public * com.hkx.demo.controller.AopController.*(..))") public void webLog(){} @Before("webLog()") public void deBefore(JoinPoint joinPoint) throws Throwable { // 接收到請求，記錄請求內容 ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes(); HttpServletRequest request = attributes.getRequest(); // 記錄下請求內容 System.out.println("URL : " + request.getRequestURL().toString()); System.out.println("HTTP_METHOD : " + request.getMethod()); System.out.println("IP : " + request.getRemoteAddr()); System.out.println("CLASS_METHOD : " + joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName()); System.out.println("ARGS : " + Arrays.toString(joinPoint.getArgs())); } @AfterReturning(returning = "ret", pointcut = "webLog()") public void doAfterReturning(Object ret) throws Throwable { // 處理完請求，返回內容 System.out.println("方法的返回值 : " + ret); } //後置異常通知 @AfterThrowing("webLog()") public void throwss(JoinPoint jp){ System.out.println("方法異常時執行....."); } //後置最終通知,final增強，不管是丟擲異常或者正常退出都會執行 @After("webLog()") public void after(JoinPoint jp){ System.out.println("方法最後執行....."); } //環繞通知,環繞增強，相當於MethodInterceptor @Around("webLog()") public Object arround(ProceedingJoinPoint pjp) { System.out.println("方法環繞start....."); try { Object o = pjp.proceed(); System.out.println("方法環繞proceed，結果是 :" + o); return o; } catch (Throwable e) { e.printStackTrace(); return null; } } }
3、建立掃描控制層
package com.hkx.demo.controller; import io.swagger.annotations.Api; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; @RestController @RequestMapping("/aop") @Api("異常返回結果") public class AopController { @GetMapping("/test") public void test(){ System.out.println("切面測試"); } }
測試結果：
4第二種註解aop方式
1、引入依賴
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
2、建立aop掃描註解
package com.hkx.demo.aop;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface LogTrack {
String value() default "logTracking";
}
3、建立aop日誌掃描類
package com.hkx.demo.aop;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
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
public class LogTrackAspect {
@Pointcut(value = "@annotation(com.hkx.demo.aop.LogTrack)")
public void webLog(){}
@Before("webLog()")
public void deBefore(JoinPoint joinPoint) throws Throwable {
// 接收到請求，記錄請求內容
ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
HttpServletRequest request = attributes.getRequest();
// 記錄下請求內容
System.out.println("URL : " + request.getRequestURL().toString());
System.out.println("HTTP_METHOD : " + request.getMethod());
System.out.println("IP : " + request.getRemoteAddr());
System.out.println("CLASS_METHOD : " + joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
System.out.println("ARGS : " + Arrays.toString(joinPoint.getArgs()));
}
@AfterReturning(returning = "ret", pointcut = "webLog()")
public void doAfterReturning(Object ret) throws Throwable {
// 處理完請求，返回內容
System.out.println("方法的返回值 : " + ret);
}
//後置異常通知
@AfterThrowing("webLog()")
public void throwss(JoinPoint jp){
System.out.println("方法異常時執行.....");
}
//後置最終通知,final增強，不管是丟擲異常或者正常退出都會執行
@After("webLog()")
public void after(JoinPoint jp){
System.out.println("方法最後執行.....");
}
//環繞通知,環繞增強，相當於MethodInterceptor
@Around("webLog()")
public Object arround(ProceedingJoinPoint pjp) {
System.out.println("方法環繞start.....");
try {
Object o = pjp.proceed();
System.out.println("方法環繞proceed，結果是 :" + o);
return o;
} catch (Throwable e) {
e.printStackTrace();
return null;
}
}
}
4、建立測試控制層，並給測試介面新增@LogTrack()註解
package com.hkx.demo.controller;
import com.hkx.demo.aop.LogTrack;
import io.swagger.annotations.Api;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/logtrack")
@Api("異常返回結果")
public class AopLogTrackController {
@ResponseBody
@GetMapping("/test")
@LogTrack()
public void test(){
System.out.println("切面測試");
}
}
測試結果：
5、AOP引數詳解
概念定義：
Aspect（切面）： Aspect 宣告類似於 Java 中的類宣告，在 Aspect 中會包含著一些 Pointcut 以及相應的 Advice。
Joint point（連線點）：表示在程式中明確定義的點，典型的包括方法呼叫，對類成員的訪問以及異常處理程式塊的執行等等，它自身還可以巢狀其它 joint point。
Pointcut（切點）：表示一組 joint point，這些 joint point 或是通過邏輯關係組合起來，或是通過通配、正則表示式等方式集中起來，它定義了相應的 Advice 將要發生的地方。
Advice（增強）：Advice 定義了在 Pointcut 裡面定義的程式點具體要做的操作，它通過 before、after 和 around 來區別是在每個 joint point 之前、之後還是代替執行的程式碼。
Target（目標物件）：織入 Advice 的目標物件.。
Weaving（織入）：將 Aspect 和其他物件連線起來, 並建立 Adviced object 的過程