為什么要用AOP？
答案是解耦！
Aspect Oriented Programming 面向切面編程。解耦是程序員編碼開發(fā)過程中一直追求的。AOP也是為了解耦所誕生。
具體思想是：定義一個切面，在切面的縱向定義處理方法，處理完成之后，回到橫向業(yè)務(wù)流。
AOP 主要是利用代理模式的技術(shù)來實(shí)現(xiàn)的。
具體的代理實(shí)現(xiàn)可以參考這篇文章，講解的非常詳細(xì)。http://www.ythuaji.com.cn/article/144188.html
通過預(yù)編譯方式和運(yùn)行期動態(tài)代理實(shí)現(xiàn)程序功能的統(tǒng)一維護(hù)的一種技術(shù)。利用 AOP 可以對業(yè)務(wù)邏輯的各個部分進(jìn)行隔離，從而使得業(yè)務(wù)邏輯各部分之間的耦合度降低，提高程序的可重用性，同時提高了開發(fā)的效率。
常用的工作場景
事務(wù)控制
日志記錄
本文沒有過度深度學(xué)習(xí)原理，因?yàn)槭遣锁B一個，先學(xué)會怎么不加班。
必須知道的概念
AOP 的相關(guān)術(shù)語
通知（Advice）
通知描述了切面要完成的工作以及何時執(zhí)行。比如我們的日志切面需要記錄每個接口調(diào)用時長，就需要在接口調(diào)用前后分別記錄當(dāng)前時間，再取差值。
- 前置通知（Before）：在目標(biāo)方法調(diào)用前調(diào)用通知功能；
- 后置通知（After）：在目標(biāo)方法調(diào)用之后調(diào)用通知功能，不關(guān)心方法的返回結(jié)果；
- 返回通知（AfterReturning）：在目標(biāo)方法成功執(zhí)行之后調(diào)用通知功能；
- 異常通知（AfterThrowing）：在目標(biāo)方法拋出異常后調(diào)用通知功能；
- 環(huán)繞通知（Around）：通知包裹了目標(biāo)方法，在目標(biāo)方法調(diào)用之前和之后執(zhí)行自定義的行為。
連接點(diǎn)（JoinPoint）
通知功能被應(yīng)用的時機(jī)。比如接口方法被調(diào)用的時候就是日志切面的連接點(diǎn)。
切點(diǎn)（Pointcut）
切點(diǎn)定義了通知功能被應(yīng)用的范圍。比如日志切面的應(yīng)用范圍就是所有接口，即所有 controller 層的接口方法。
切面（Aspect）
切面是通知和切點(diǎn)的結(jié)合，定義了何時、何地應(yīng)用通知功能。
引入（Introduction）
在無需修改現(xiàn)有類的情況下，向現(xiàn)有的類添加新方法或?qū)傩浴?/p>
織入（Weaving）
把切面應(yīng)用到目標(biāo)對象并創(chuàng)建新的代理對象的過程。
Spring 中使用注解創(chuàng)建切面
相關(guān)注解
@Aspect：用于定義切面
@Before：通知方法會在目標(biāo)方法調(diào)用之前執(zhí)行
@After：通知方法會在目標(biāo)方法返回或拋出異常后執(zhí)行
@AfterReturning：通知方法會在目標(biāo)方法返回后執(zhí)行
@AfterThrowing：通知方法會在目標(biāo)方法拋出異常后執(zhí)行
@Around：通知方法會將目標(biāo)方法封裝起來
@Pointcut：定義切點(diǎn)表達(dá)式
切點(diǎn)表達(dá)式
指定了通知被應(yīng)用的范圍，表達(dá)式格式：
|
1
2
3
4
5
6
7
8
9
10
11
12
|
execution(方法修飾符 返回類型 方法所屬的包.類名.方法名稱(方法參數(shù))//com.ninesky.study.tiny.controller包中所有類的public方法都應(yīng)用切面里的通知execution(public * com.ninesky.study.tiny.controller.*.*(..))//com.ninesky.study.tiny.service包及其子包下所有類中的所有方法都應(yīng)用切面里的通知execution(* com.ninesky.study.tiny.service..*.*(..))//com.ninesky.study.tiny.service.PmsBrandService類中的所有方法都應(yīng)用切面里的通知execution(* com.macro.ninesky.study.service.PmsBrandService.*(..)) |
實(shí)戰(zhàn)應(yīng)用-利用AOP記錄日志
從傳統(tǒng)行業(yè)轉(zhuǎn)行，以前都沒想過打日志埋點(diǎn)，第一份工作，真的應(yīng)該選擇一個好的平臺比較重要。
定義日志信息封裝
用于封裝需要記錄的日志信息，包括操作的描述、時間、消耗時間、url、請求參數(shù)和返回結(jié)果等信息
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
|
public class WebLog { /** * 操作描述 */ private String description; /** * 操作用戶 */ private String username; /** * 操作時間 */ private Long startTime; /** * 消耗時間 */ private Integer spendTime; /** * 根路徑 */ private String basePath; /** * URI */ private String uri; /** * URL */ private String url; /** * 請求類型 */ private String method; /** * IP地址 */ private String ip; /** * 請求參數(shù) */ private Object parameter; /** * 請求返回的結(jié)果 */ private Object result; //省略了getter,setter方法} |
定義注解,通過注解減少代碼量
|
1
2
3
4
5
6
7
8
|
@Documented@Retention(RetentionPolicy.RUNTIME)@Target(ElementType.METHOD)public @interface OperationLog { String name();//調(diào)用接口的名稱 boolean intoDb() default false;//該條操作日志是否需要持久化存儲} |
統(tǒng)一日志處理切面
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
@Aspect@Component@Order(1)@Slf4jpublic class WebLogAspect { private static final Logger controlLog = LoggerFactory.getLogger("tmall_control"); @Pointcut("execution(public * com.yee.walnut.*.*.*(..))") public void webLog() { } @Before(value = "webLog()&& @annotation(OperationLog)") public void doBefore(ControllerWebLog controllerWebLog) throws Throwable { } @AfterReturning(value = "webLog()&& @annotation(OperationLog)", returning = "ret") public void doAfterReturning(Object ret, ControllerWebLog controllerWebLog) throws Throwable { } @Around(value = "webLog()&& @annotation(OperationLog)") public Object doAround(ProceedingJoinPoint joinPoint, OperationLog operationLog) throws Throwable { long startTime = System.currentTimeMillis(); //獲取當(dāng)前請求對象 ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes(); HttpServletRequest request = attributes.getRequest(); //記錄請求信息 Object[] objs = joinPoint.getArgs(); WebLog webLog = new WebLog(); Object result = joinPoint.proceed();//返回的結(jié)果，這是一個進(jìn)入方法和退出方法的一個分界 Signature signature = joinPoint.getSignature(); MethodSignature methodSignature = (MethodSignature) signature; Method method = methodSignature.getMethod(); long endTime = System.currentTimeMillis(); String urlStr = request.getRequestURL().toString(); webLog.setBasePath(StrUtil.removeSuffix(urlStr, URLUtil.url(urlStr).getPath())); webLog.setIp(request.getRemoteUser()); webLog.setMethod(request.getMethod()); webLog.setParameter(getParameter(method, joinPoint.getArgs())); webLog.setResult(JSONUtil.parse(result)); webLog.setSpendTime((int) (endTime - startTime)); webLog.setStartTime(startTime); webLog.setUri(request.getRequestURI()); webLog.setUrl(request.getRequestURL().toString()); controlLog.info("RequestAndResponse {}", JSONObject.toJSONString(webLog)); //必須有這個返回值。可以這樣理解，Around方法之后，不再是被織入的函數(shù)返回值，而是Around函數(shù)返回值 return result; } /** * 根據(jù)方法和傳入的參數(shù)獲取請求參數(shù) */ private Object getParameter(Method method, Object[] args) { List<Object> argList = new ArrayList<>(); Parameter[] parameters = method.getParameters(); for (int i = 0; i < parameters.length; i++) { //將RequestBody注解修飾的參數(shù)作為請求參數(shù) RequestBody requestBody = parameters[i].getAnnotation(RequestBody.class); if (requestBody != null) { argList.add(args[i]); } //將RequestParam注解修飾的參數(shù)作為請求參數(shù) RequestParam requestParam = parameters[i].getAnnotation(RequestParam.class); if (requestParam != null) { Map<String, Object> map = new HashMap<>(); String key = parameters[i].getName(); if (!StringUtils.isEmpty(requestParam.value())) { key = requestParam.value(); } map.put(key, args[i]); argList.add(map); } else { argList.add(args[i]); } } if (argList.size() == 0) { return null; } else if (argList.size() == 1) { return argList.get(0); } else { return argList; } }} |
在方法上加上自定義注解即可
|
1
2
3
|
@OperationLog(name = "TurnOnOffStrategy")public String doOperation(GlobalDto globalDto, DeviceOperator deviceOperator) {} |
以上就是SpringBoot開發(fā)技巧之利用AOP記錄日志示例解析的詳細(xì)內(nèi)容，更多關(guān)于SpringBoot開發(fā)AOP記錄日志的資料請關(guān)注服務(wù)器之家其它相關(guān)文章！
原文鏈接：https://jianzh5.blog.csdn.net/article/details/106110691
