本文提綱
一邑雅、AOP超簡介紹
二定躏、實(shí)例
三痒留、最后
本文運(yùn)行環(huán)境
Ubuntu 16.04 LTS
JDK 8 +
IntelliJ IDEA ULTIMATE 2017.2
Maven 3.5.0
Spring Boot 1.5.8.RELEASE
一贯涎、AOP超簡介紹
首先強(qiáng)調(diào)听哭,AOP
并不僅僅是在Java
中才有的。
網(wǎng)上有很多對(duì)AOP
的詳細(xì)介紹塘雳,也有很多講的很好的陆盘,這里就不再贅述。一句話描述就是:每當(dāng)調(diào)用某些方法的過程中败明,都想做同樣的事A
隘马,用一種盡量不重復(fù)代碼的方式把A
插入到這些方法中,這就是AOP
妻顶,其中被插入的方法的某個(gè)過程(方法執(zhí)行前酸员、執(zhí)行后、返回值時(shí)讳嘱、拋出異常時(shí)等)即為切點(diǎn)幔嗦。
AOP
最大的好處就在于:不用修改已有的代碼,即每個(gè)想做A
的方法都單獨(dú)把A
寫進(jìn)去呢燥,同時(shí)減少了代碼的重復(fù)崭添,降低了與業(yè)務(wù)邏輯無關(guān)的代碼的耦合。
二叛氨、實(shí)例
本文就以在控制臺(tái)輸出每個(gè)客戶端請(qǐng)求的詳細(xì)信息為例展示AOP
的便利之處呼渣。
2.1 添加依賴
要使用AOP
,需要在pom.xml
中添加如下依賴:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
2.2 橫切類
新建類HttpAspect.java
:
package com.zyr.demo.aspect;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import javax.servlet.http.HttpServletRequest;
@Aspect
@Component
public class HttpAspect {
private static final Logger logger = LoggerFactory.getLogger(HttpAspect.class);
@Pointcut("execution(public * com.zyr.demo.controller..*.*(..))")
public void logRequest() {
//no-op
}
@Before("logRequest()")
public void doBefore(JoinPoint joinPoint) {
ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
HttpServletRequest request = attributes.getRequest();
logger.info("-------------------------------Request Log Begin----------------------------------------------");
logger.info("url={}", request.getRequestURL());
logger.info("method={}", request.getMethod());
logger.info("ip={}", request.getRemoteAddr());
logger.info("class_method={}", joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
logger.info("args={}", joinPoint.getArgs());
logger.info("-------------------------------Request Log End------------------------------------------------");
}
@AfterReturning(returning = "object", pointcut = "logRequest()")
public void doAfterReturning(Object object) {
if (object != null) {
logger.info("response={}", object.toString());
}
}
}
@Aspect
:表示該類是一個(gè)橫切類寞埠;@Component
:表示將該類放入Spring
容器中屁置;@Pointcut
:表示切入的地方,括號(hào)內(nèi)execution
的括號(hào)中表示com.zyr.demo.controller
包中的所有public
方法仁连;logRequest()
:由@Pointcut
表示該方法即為上文提到的事A
蓝角,方法名自定義,方法體內(nèi)為空饭冬,表示該方法單純指定切入點(diǎn)使鹅,具體內(nèi)容在引用它的地方寫,如下面的doBefore
和doAfterReturning
昌抠;@Before
:括號(hào)中引用了上面的logRequest()
患朱,表示該方法的切入點(diǎn)與它相同,@Before
表示在被切入的方法開始執(zhí)行前炊苫,需要先執(zhí)行該方法體內(nèi)的代碼裁厅,此處即為打印請(qǐng)求信息冰沙,方法名自定義;@AfterReturning
:括號(hào)中的object
必須與方法的參數(shù)名相同执虹,表示被切入的方法的返回值拓挥。pointcut
即同上,表示切入點(diǎn)與logRequest()
的切入點(diǎn)相同袋励,@AfterReturning
表示在被切入的方法返回值時(shí)侥啤,執(zhí)行該方法中的內(nèi)容;除了@Before
和
@AfterReturning插龄,還有
@After愿棋、
AfterThrowing科展、
@Around`等切入方式均牢。
2.3 測試
運(yùn)行項(xiàng)目,打開REST Client
才睹,測試上一節(jié)中的localhost:8080/user/register
徘跪,提交成功后,可以看到控制臺(tái)輸出以下信息琅攘,說明切入成功垮庐,相應(yīng)的可以測試其它方法:
2017-11-22 16:46:23.591 INFO 10526 --- [nio-8080-exec-1] com.zyr.demo.aspect.HttpAspect : -------------------------------Request Log Begin----------------------------------------------
2017-11-22 16:46:23.591 INFO 10526 --- [nio-8080-exec-1] com.zyr.demo.aspect.HttpAspect : url=http://localhost:8080/user/register
2017-11-22 16:46:23.592 INFO 10526 --- [nio-8080-exec-1] com.zyr.demo.aspect.HttpAspect : method=POST
2017-11-22 16:46:23.592 INFO 10526 --- [nio-8080-exec-1] com.zyr.demo.aspect.HttpAspect : ip=127.0.0.1
2017-11-22 16:46:23.592 INFO 10526 --- [nio-8080-exec-1] com.zyr.demo.aspect.HttpAspect : class_method=com.zyr.demo.controller.UserController.register
2017-11-22 16:46:23.592 INFO 10526 --- [nio-8080-exec-1] com.zyr.demo.aspect.HttpAspect : args=User{name='bob', age=22, password='123456'}
2017-11-22 16:46:23.592 INFO 10526 --- [nio-8080-exec-1] com.zyr.demo.aspect.HttpAspect : -------------------------------Request Log End------------------------------------------------
2017-11-22 16:46:23.595 INFO 10526 --- [nio-8080-exec-1] com.zyr.demo.aspect.HttpAspect : response=<200 OK,success,{}>
三、最后
本文介紹了Spring Boot
中使用AOP
的一個(gè)簡單例子坞琴,可以看見哨查,在Spring Boot
中很輕松就能使用AOP
。
本文代碼已上傳至我的GitHub倉庫剧辐,進(jìn)入以后將branches切換為5-AOP即可看見寒亥。
前篇:
Spring Boot實(shí)際應(yīng)用講解(一):Hello World
Spring Boot實(shí)際應(yīng)用講解(二):配置詳解
Spring Boot實(shí)際應(yīng)用講解(三):表單驗(yàn)證
Spring Boot實(shí)際應(yīng)用講解(四):RESTful API
后續(xù)將推出以下文章,敬請(qǐng)關(guān)注荧关!
Spring Boot實(shí)際應(yīng)用講解(六):MySQL + Spring-data-jpa(Hibernate)
Spring Boot實(shí)際應(yīng)用講解(七):統(tǒng)一異常處理
Spring Boot實(shí)際應(yīng)用講解(八):MySQL + Mybatis
Spring Boot實(shí)際應(yīng)用講解(九):MySQL + Mybatis + Redis
文中若有錯(cuò)之處溉奕,還請(qǐng)各位批評(píng)指正,謝謝忍啤!
原文作者/ZYRzyr
原文鏈接:http://www.reibang.com/p/93216bf41182
請(qǐng)進(jìn)入這里獲取授權(quán):https://101709080007647.bqy.mobi