一、AOP統一處理請求日志
也談AOP
1、AOP是一種編程范式
2、與語言無關，是一種程序設計思想
- 面向切面（AOP）Aspect Oriented Programming
- 面向對象（OOP）Object Oriented Programming
- 面向過程（POP） Procedure Oriented Programming
再談AOP
1、面向過程到面向對象
2、換個角度看世界，換個姿勢處理問題
3、將通用邏輯從業務邏輯中分離出來
二、處理過程
個人理解，其實就是日志體系為了方便使用，可以用log4j的思維去理解下。
三、Aop的實際應用
1、准備工作
在pom中添加aop依賴，具體示例如下：
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> <version>2.2.2.RELEASE</version> </dependency>
2、日志輸出
比如我們在實際項目中，期望我們操作的每一步都有日志輸出，那么我們該怎么做呢，還是用前面學生信息的源代碼，來進行演示。
首先創建一個切面，這里和spring中的aop其實都一樣的，可以說是更簡便了，具體示例代碼如下：
package com.rongrong.springboot.demo.aspect; import org.aspectj.lang.annotation.Aspect; import org.aspectj.lang.annotation.Before; import org.springframework.stereotype.Component; /** * @author rongrong * @version 1.0 * @description: * @date 2020/1/6 21:50 */ @Aspect @Component public class HttpAspect { @Before("execution(public * com.rongrong.springboot.demo.controller.StudentController.*(..))") public void log(){ System.out.println("我執行了！！"); } }
接着啟動項目，調用下查詢接口，控制台輸出如下圖打印內容，證明成功
3、日志輸出代碼優化
有before，肯定就會有after，即調用時有日志輸出，調用完也有結果輸出，一來方便自己調試，二來也方便查看報錯，那么after怎么寫呢？我猜一般同學肯定都這么干。
package com.rongrong.springboot.demo.aspect; import org.aspectj.lang.annotation.Aspect; import org.aspectj.lang.annotation.Before; import org.springframework.stereotype.Component; /** * @author rongrong * @version 1.0 * @description: * @date 2020/1/6 21:50 */ @Aspect @Component public class HttpAspect { @Before("execution(public * com.rongrong.springboot.demo.controller.StudentController.*(..))") public void log(){ System.out.println("我執行了！！"); } @After("execution(public * com.rongrong.springboot.demo.controller.StudentController.*(..))") public void afterlog(){ System.out.println("我執行了！！"); } }
這樣寫一點毛病也沒有，但是。。。。。。。。。。。。。。。。。。。。哇哈哈哈哈哈哈，你肯定會說，我肯定不這樣寫，可以不承認，但有些同學肯定是這樣干的。
寫代碼的原則，盡量少寫重復代碼，為啥呢？維護成本高呀，再就是讓人覺得你的代碼很low逼，看到這你肯定不會那么干了吧，哈哈哈哈哈。
好了玩笑開完了，我們可以這樣，聲明個切點，再切點里維護想要的切面，具體代碼示例如下：
package com.rongrong.springboot.demo.aspect; import org.aspectj.lang.annotation.Aspect; import org.aspectj.lang.annotation.Before; import org.springframework.stereotype.Component; /** * @author rongrong * @version 1.0 * @description: * @date 2020/1/6 21:50 */ @Aspect @Component public class HttpAspect { @Pointcut("execution(public * com.rongrong.springboot.demo.controller.StudentController.*(..))") public void log(){ } @Before("log()") public void doBefore(){ System.out.println("我執行了！！"); } @After("log()") public void doAfter(){ System.out.println("我執行了！！"); } }
4、Self4j的使用
改了下，發現似乎還是有點low，都用spring boot框架了，咋還能用System.out.println（）輸出呢，那么怎么優化呢？
現在僅僅滿足了，控制台輸出內容，但是如果我想要的日志不是這樣的，最基本的得上面一樣吧，有日期、端口、方法名之類的，即項目啟動時控制台這樣的日志才好看些吧，使用spring boot框架自帶日志self4j即可解決，具體代碼示例如下：
package com.rongrong.springboot.demo.aspect; import org.aspectj.lang.annotation.Aspect; import org.aspectj.lang.annotation.Before; import org.springframework.stereotype.Component; /** * @author rongrong * @version 1.0 * @description: * @date 2020/1/6 21:50 */ @Aspect @Component public class HttpAspect { /** * 使用self4j，此日志為spring boot自帶的日志框架 */ private final static Logger logger= LoggerFactory.getLogger(HttpAspect.class); @Pointcut("execution(public * com.rongrong.springboot.demo.controller.StudentController.*(..))") public void log(){ } @Before("log()") public void doBefore(){ logger.info("我執行了！！"); } @After("log()") public void doAfter(){ logger.info("我執行了！！"); } }
啟動項目后，如下圖所示，證明我們成功了
5、請求參數及響應信息控制台輸出
這似乎看起來好了很多，但是實際工作時候，為了方便調試需要把我們請求接口及請求后返回的響應信息，在控制台輸出，方便我們調試定位問題，下面我們來進行演示如何從控制台輸出這些信息。
5.1、輸出請求參數信息
使用RequestContextHolder來獲得請求參數相關屬性，這里需要強轉成ServletRequestAttributes對象，Joinpoint這個參數非必須，是在獲取“類方法”、“類名”、“方法參數”的時候會用到，如果用不到的話就不需要了。
具體示例代碼如下所示：
package com.rongrong.springboot.demo.aspect; import org.aspectj.lang.JoinPoint; import org.aspectj.lang.annotation.*; 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.jws.Oneway; import javax.servlet.http.HttpServletRequest; /** * @author rongrong * @version 1.0 * @description: * @date 2020/1/6 21:50 */ @Aspect @Component public class HttpAspect { /** * 使用self4j，此日志為spring boot自帶的日志框架 */ private final static Logger logger= LoggerFactory.getLogger(HttpAspect.class); /** *此處為了簡化代碼，提高維護性，還是需要提煉下的 @Before("execution(public * com.rongrong.springboot.demo.controller.StudentController.*(..))") public void log(){ System.out.println("我執行了！！"); } */ @Pointcut("execution(public * com.rongrong.springboot.demo.controller.StudentController.*(..))") public void log(){ } /** * 在接口執行操作時輸出相關參數 */ @Before("log()") public void doBefore(JoinPoint joinPoint){ //使用RequestContextHolder來獲得請求屬性，這里需要強轉成ServletRequestAttributes對象 ServletRequestAttributes servletRequestAttributes= (ServletRequestAttributes) RequestContextHolder.getRequestAttributes(); //獲取請求url String url = servletRequestAttributes.getRequest().getRequestURI(); //獲取請求IP String addr = servletRequestAttributes.getRequest().getRemoteAddr(); //獲取請求方法 String method = servletRequestAttributes.getRequest().getMethod(); //獲取類名 String pCName = joinPoint.getSignature().getDeclaringTypeName(); //獲取類方法 String cName = joinPoint.getSignature().getName(); //這里要說明下 logger.info("url={}",url)，url為{}自動填充部分 //url logger.info("url= {}",url); //ip logger.info("ip= {}",addr); //method logger.info("method= {}",method); //args //獲取請求參數 logger.info("args= {}",joinPoint.getArgs()); //類名和類方法 logger.info("類名和類方法= {}",pCName+"."+cName); } @After("log()") public void doAfter(){ logger.info("doAfter ：我執行了！！"); } }
重新啟動項目，我們調用下查詢所有學生接口，控制台顯示如下信息，證明日志成功！
5.2、輸出響應信息
接下來我們再來輸出響應結果信息，使用注解@AfterReturning，獲取返回相應信息，具體示例代碼如下：
package com.rongrong.springboot.demo.aspect; import org.aspectj.lang.JoinPoint; import org.aspectj.lang.annotation.*; 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.jws.Oneway; import javax.servlet.http.HttpServletRequest; /** * @author rongrong * @version 1.0 * @description: * @date 2020/1/6 21:50 */ @Aspect @Component public class HttpAspect { /** * 使用self4j，此日志為spring boot自帶的日志框架 */ private final static Logger logger= LoggerFactory.getLogger(HttpAspect.class); /** *此處為了簡化代碼，提高維護性，還是需要提煉下的 @Before("execution(public * com.rongrong.springboot.demo.controller.StudentController.*(..))") public void log(){ System.out.println("我執行了！！"); } */ @Pointcut("execution(public * com.rongrong.springboot.demo.controller.StudentController.*(..))") public void log(){ } /** * 在接口執行操作時輸出相關參數 */ @Before("log()") public void doBefore(JoinPoint joinPoint){ //使用RequestContextHolder來獲得請求屬性，這里需要強轉成ServletRequestAttributes對象 ServletRequestAttributes servletRequestAttributes= (ServletRequestAttributes) RequestContextHolder.getRequestAttributes(); //獲取請求url String url = servletRequestAttributes.getRequest().getRequestURI(); //獲取請求IP String addr = servletRequestAttributes.getRequest().getRemoteAddr(); //獲取請求方法 String method = servletRequestAttributes.getRequest().getMethod(); //獲取類名 String pCName = joinPoint.getSignature().getDeclaringTypeName(); //獲取類方法 String cName = joinPoint.getSignature().getName(); //這里要說明下 logger.info("url={}",url)，url為{}自動填充部分 //url logger.info("url= {}",url); //ip logger.info("ip= {}",addr); //method logger.info("method= {}",method); //args //獲取請求參數 logger.info("args= {}",joinPoint.getArgs()); //類名和類方法 logger.info("類名和類方法= {}",pCName+"."+cName); } @After("log()") public void doAfter(){ logger.info("doAfter ：我執行了！！"); } /** * 使用@AfterReturning，獲取返回相應信息 */ @AfterReturning(returning = "object",pointcut="log()") public void doAfterReturning(Object object){ logger.info("返回信息 ：{}",object.toString()); } }
再次重新啟動項目，我們調用下查詢所有學生接口，控制台顯示如下信息，證明日志成功！
到此，spring boot中Aop的使用分享完畢，有興趣的同學可以自行嘗試哦。