Springboot中Aspect切面的實(shí)現(xiàn)方式(以記錄日志為例)
Springboot Aspect切面的實(shí)現(xiàn)
今天我們來(lái)說(shuō)說(shuō)spring中的切面Aspect，這是Spring的一大優(yōu)勢(shì)。面向切面編程往往讓我們的開(kāi)發(fā)更加低耦合，也大大減少了代碼量，同時(shí)呢讓我們更專注于業(yè)務(wù)模塊的開(kāi)發(fā)，把那些與業(yè)務(wù)無(wú)關(guān)的東西提取出去，便于后期的維護(hù)和迭代。
好了，廢話少說(shuō)！我們直接步入正題
以系統(tǒng)日志為例
首先，我們先做一些準(zhǔn)備工作。
1、新建一個(gè)Springboot工程
2、添加必要的依賴
AOP 必須
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency>
gson主要是我用于數(shù)據(jù)的處理，不是必須的
<dependency> <groupId>com.google.code.gson</groupId> <artifactId>gson</artifactId> <version>2.8.1</version> </dependency>
個(gè)人喜好
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-devtools</artifactId> <scope>runtime</scope> </dependency> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <optional>true</optional> </dependency>
3、日志實(shí)體類和service
package com.space.aspect.bo;
import lombok.Data;
/**
* 系統(tǒng)日志bo
* @author zhuzhe
* @date 2018/6/4 9:36
* @email 1529949535@qq.com
*/
@Data
public class SysLogBO {
private String className;
private String methodName;
private String params;
private Long exeuTime;
private String remark;
private String createDate;
}
package com.space.aspect.service;
import com.space.aspect.bo.SysLogBO;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Service;
/**
* @author zhuzhe
* @date 2018/6/4 9:41
* @email 1529949535@qq.com
*/
@Slf4j
@Service
public class SysLogService {
public boolean save(SysLogBO sysLogBO){
// 這里就不做具體實(shí)現(xiàn)了
log.info(sysLogBO.getParams());
return true;
}
}
4、定義日志注解
這里呢，我們記錄日志使用注解的形式。所以，先定義一個(gè)注解
package com.space.aspect.anno;
import java.lang.annotation.*;
/**
* 定義系統(tǒng)日志注解
* @author zhuzhe
* @date 2018/6/4 9:24
* @email 1529949535@qq.com
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface SysLog {
String value() default "";
}
5、聲明切面，完成日志記錄
以上4點(diǎn)我們的準(zhǔn)備工作已經(jīng)完成。接下來(lái)就是重點(diǎn)了
這里需要你對(duì)AOP有一定的了解。起碼知道切點(diǎn)表達(dá)式、環(huán)繞通知、前置通知、后置通知等。。。
package com.space.aspect.aspect;
import com.google.gson.Gson;
import com.space.aspect.anno.SysLog;
import com.space.aspect.bo.SysLogBO;
import com.space.aspect.service.SysLogService;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import java.lang.reflect.Method;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
/**
* 系統(tǒng)日志切面
* @author zhuzhe
* @date 2018/6/4 9:27
* @email 1529949535@qq.com
*/
@Aspect // 使用@Aspect注解聲明一個(gè)切面
@Component
public class SysLogAspect {
@Autowired
private SysLogService sysLogService;
/**
* 這里我們使用注解的形式
* 當(dāng)然，我們也可以通過(guò)切點(diǎn)表達(dá)式直接指定需要攔截的package,需要攔截的class 以及 method
* 切點(diǎn)表達(dá)式: execution(...)
*/
@Pointcut("@annotation(com.space.aspect.anno.SysLog)")
public void logPointCut() {}
/**
* 環(huán)繞通知 @Around ， 當(dāng)然也可以使用 @Before (前置通知) @After (后置通知)
* @param point
* @return
* @throws Throwable
*/
@Around("logPointCut()")
public Object around(ProceedingJoinPoint point) throws Throwable {
long beginTime = System.currentTimeMillis();
Object result = point.proceed();
long time = System.currentTimeMillis() - beginTime;
try {
saveLog(point, time);
} catch (Exception e) {
}
return result;
}
/**
* 保存日志
* @param joinPoint
* @param time
*/
private void saveLog(ProceedingJoinPoint joinPoint, long time) {
MethodSignature signature = (MethodSignature) joinPoint.getSignature();
Method method = signature.getMethod();
SysLogBO sysLogBO = new SysLogBO();
sysLogBO.setExeuTime(time);
SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd hh:mm:ss");
sysLogBO.setCreateDate(dateFormat.format(new Date()));
SysLog sysLog = method.getAnnotation(SysLog.class);
if(sysLog != null){
//注解上的描述
sysLogBO.setRemark(sysLog.value());
}
//請(qǐng)求的 類名、方法名
String className = joinPoint.getTarget().getClass().getName();
String methodName = signature.getName();
sysLogBO.setClassName(className);
sysLogBO.setMethodName(methodName);
//請(qǐng)求的參數(shù)
Object[] args = joinPoint.getArgs();
try{
List<String> list = new ArrayList<String>();
for (Object o : args) {
list.add(new Gson().toJson(o));
}
sysLogBO.setParams(list.toString());
}catch (Exception e){ }
sysLogService.save(sysLogBO);
}
}
6、測(cè)試
接下來(lái)，我們就來(lái)測(cè)試一下吧
package com.space.aspect.controller;
import com.space.aspect.anno.SysLog;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
/**
* @author zhuzhe
* @date 2018/6/4 9:47
* @email 1529949535@qq.com
*/
@RestController
public class TestController {
@SysLog("測(cè)試")
@GetMapping("/test")
public String test(@RequestParam("name") String name){
return name;
}
}
啟動(dòng)項(xiàng)目，訪問(wèn)我們的test方法。
我們?cè)趕ervice里打一個(gè)斷點(diǎn)
可以看到，我們所需要的值都成功拿到了。
這樣，我們就成功實(shí)現(xiàn)了使用Aspect實(shí)現(xiàn)切面記錄日志。
源碼：https://github.com/zhuzhegithub/springboot-aop-aspect
Springboot Aspect切面實(shí)現(xiàn)方法日志打印
項(xiàng)目每次寫controller方法，都要在開(kāi)始和結(jié)束打印一行日志表示方法開(kāi)始和結(jié)束，每個(gè)方法都要寫，太過(guò)于麻煩和重復(fù)，想到了spring的aop切面，所以使用@Aspect切面和自定義log注解實(shí)現(xiàn)了下切面日志打印.
AOP
AOP（Aspect Orient Programming）,直譯過(guò)來(lái)就是 面向切面編程。AOP 是一種編程思想，是面向?qū)ο缶幊蹋∣OP）的一種補(bǔ)充,在程序開(kāi)發(fā)中主要用來(lái)解決一些系統(tǒng)層面上的問(wèn)題，比如日志，事務(wù)，權(quán)限等等，這里主要是做一下方法的日志打印。
aop相關(guān)注解：
@Aspect:作用是把當(dāng)前類標(biāo)識(shí)為一個(gè)切面供容器讀取
@Pointcut：Pointcut是植入Advice的觸發(fā)條件。每個(gè)Pointcut的定義包括2部分，一是表達(dá)式，二是方法簽名。方法簽名必須是 public及void型?？梢詫ointcut中的方法看作是一個(gè)被Advice引用的助記符，因?yàn)楸磉_(dá)式不直觀，因此我們可以通過(guò)方法簽名的方式為 此表達(dá)式命名。因此Pointcut中的方法只需要方法簽名，而不需要在方法體內(nèi)編寫實(shí)際代碼。
@Around：環(huán)繞增強(qiáng)，相當(dāng)于MethodInterceptor
@AfterReturning：后置增強(qiáng)，相當(dāng)于AfterReturningAdvice，方法正常退出時(shí)執(zhí)行
@Before：標(biāo)識(shí)一個(gè)前置增強(qiáng)方法，相當(dāng)于BeforeAdvice的功能，相似功能的還有
@AfterThrowing：異常拋出增強(qiáng)，相當(dāng)于ThrowsAdvice
@After: final增強(qiáng)，不管是拋出異?；蛘哒Ｍ顺龆紩?huì)執(zhí)行
自定義注解
聲明一個(gè)注解要用到的東西
修飾符：訪問(wèn)修飾符必須為public,不寫默認(rèn)為pubic；
關(guān)鍵字：關(guān)鍵字為@interface；
注解名稱：注解名稱為自定義注解的名稱，使用時(shí)還會(huì)用到；
注解類型元素：注解類型元素是注解中內(nèi)容，可以理解成自定義接口的實(shí)現(xiàn)部分；
代碼：
自定義log注解代碼
/**
* 日志注解
*
* Target：用于明確注解用于目標(biāo)類的哪個(gè)位置
* Retention：用于標(biāo)識(shí)自定義注解的生命周期
* RUNTIME:生命周期持續(xù)到運(yùn)行時(shí)，能夠通過(guò)反射獲取到
* Documented：用于標(biāo)識(shí)自定義注解能夠使用javadoc命令生成關(guān)于注解的文檔
*
* @author xxx
* @date 2020/xx/xx
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface LogMessage {
/**
* 使用value值，在使用注解的時(shí)候，不需要寫@LogMessage(value=xxx）,直接寫@LogMessage(xxx）即可
*/
String value() default "";
/**
* 別名使用value，所以在使用注解時(shí)，既可以寫@LogMessage(xxx），也可以寫@LogMessage(description=xxx）
*/
@AliasFor("value")
String description() default "";
/**
* 是否打印參數(shù)
*/
boolean parameterPrint() default true;
}
apsect切面類注解
/**
* 日志切面類
* Aspect ：作用是把當(dāng)前類標(biāo)識(shí)為一個(gè)切面供容器讀取
*
* @author xxx
* @date 2020/xx/xx
*/
@Slf4j
@Aspect
@Component
public class LogAspect {
/**
* 前置增強(qiáng)，目標(biāo)方法執(zhí)行之前執(zhí)行
* within:用于匹配所以持有指定注解類型內(nèi)的方法
* annotation:用于匹配當(dāng)前執(zhí)行方法持有指定注解的方法
* within(com.xxx.xxx..*) com.xxx.xxx包及子包下的任何方法執(zhí)行
*
* @param joinPoint
* @param logManage
* @return void
* @author xxx
* @date 2020/xx/xx
*/
@Before("within(com.xxx.xxx..*) && @annotation(logManage)")
public void addBeforeLogger(JoinPoint joinPoint, LogMessage logManage) {
log.info("[{}] Start", logManage.value());
// 處理參數(shù)
try {
if (logManage.parameterPrint()) {
Object[] args = joinPoint.getArgs(); // 參數(shù)值
String[] argNames = ((MethodSignature) joinPoint.getSignature()).getParameterNames();
Map<String, Object> paramsMap = new HashMap<>();
StringBuilder sb = new StringBuilder();
if (args != null && args.length > 0) {
for (int i = 0; i < args.length; i++) {
paramsMap.put(argNames[i], args[i] != null ? args[i].toString() : "");
}
for (Map.Entry<String, Object> entry : paramsMap.entrySet()) {
sb.append(entry.getKey()).append(":").append(entry.getValue()).append(";");
}
}
log.info("[方法名稱：{}，方法參數(shù)：{}", ((MethodSignature) joinPoint.getSignature()).getMethod().getName(), sb.toString());
}
} catch (Exception e) {
log.info("切面日志打印異常！");
}
}
/**
* 返回增強(qiáng)，目標(biāo)方法正常執(zhí)行完畢時(shí)執(zhí)行
*
* within:用于匹配所以持有指定注解類型內(nèi)的方法
* annotation:于匹配當(dāng)前執(zhí)行方法持有指定注解的方法
* within(com.xxx.xxx..*) com.xxx.xxx 包及子包下的任何方法執(zhí)行
*
* @param joinPoint
* @param logManage
* @return void
* @author xxx
* @date 2020/xx/xx
*/
@AfterReturning("within(com.xxx.xxx..*) && @annotation(logManage)")
public void addAfterReturningLogger(JoinPoint joinPoint, LogMessage logManage) {
log.info("[{}] End", logManage.value());
}
}
controller中使用
@LogMessage("測(cè)試日志打印")
@GetMapping(value = "/test", produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
public void xxx() {
log.info("test");
}
這樣在方法執(zhí)行前和返回后都會(huì)打印日志，只需要在想要打印日志的方法上添加@LogMessage("")注解就可以了。
以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。
相關(guān)文章
Spring事件監(jiān)聽(tīng)基本原理與使用詳解
這篇文章主要介紹了Spring事件監(jiān)聽(tīng)基本原理與使用詳解,Spring的事件監(jiān)聽(tīng)機(jī)制和發(fā)布訂閱機(jī)制是很相似的：發(fā)布了一個(gè)事件后,監(jiān)聽(tīng)該類型事件的所有監(jiān)聽(tīng)器會(huì)觸發(fā)相應(yīng)的處理邏輯,需要的朋友可以參考下2024-01-01
springboot集成mqtt的實(shí)踐開(kāi)發(fā)
本篇文章主要介紹了springboot集成mqtt的實(shí)踐開(kāi)發(fā)，小編覺(jué)得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2017-08-08
SpringBoot+Redis大量重復(fù)提交問(wèn)題的解決方案
Spring Boot Redis重復(fù)提交是指在使用Spring Boot框架和Redis緩存時(shí),為了防止用戶重復(fù)提交表單或者請(qǐng)求,采取的一種解決方案,本文通過(guò)代碼示例給大家介紹了SpringBoot+Redis大量重復(fù)提交問(wèn)題的解決方案,需要的朋友可以參考下2024-03-03
SpringBoot自定義工具類實(shí)現(xiàn)Excel數(shù)據(jù)存入MySQL數(shù)據(jù)庫(kù)
這篇文章主要為大家詳細(xì)介紹了如何使用EasyExcel讀取Excel內(nèi)數(shù)據(jù)并轉(zhuǎn)換為csv格式數(shù)據(jù),然后實(shí)現(xiàn)字符串分割,分割出屬性名和屬性值建表插入MySQL數(shù)據(jù)庫(kù)中,感興趣的可以了解下2024-03-03
EasyExcel實(shí)現(xiàn)讀取excel中的日期單元格并自動(dòng)判定終止讀取
這篇文章主要為大家詳細(xì)介紹了EasyExcel如何實(shí)現(xiàn)讀取excel中的日期單元格并自動(dòng)判定終止讀取,感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下2024-11-11
SpringBoot如何實(shí)現(xiàn)調(diào)用controller和Service層方法
文章介紹了在SpringBoot中如何在工具類中調(diào)用Controller和Service層的方法,通過(guò)創(chuàng)建一個(gè)工具類SpringUtil,并在Spring?Boot啟動(dòng)類中進(jìn)行配置掃描注入,工具類就可以訪問(wèn)Controller和Service層的方法2025-03-03
maven package后Idea項(xiàng)目中找不到target文件的解決
在Idea中執(zhí)行mavenpackage打包后,target文件不顯示,點(diǎn)擊「ShowinExplore」可以在本地文件夾中查到,解決方法：在Idea的Maven工具窗口中,右鍵點(diǎn)擊項(xiàng)目,選擇Reimport,刷新項(xiàng)目即可2024-11-11
Spring Boot + Mybatis多數(shù)據(jù)源和動(dòng)態(tài)數(shù)據(jù)源配置方法
最近做項(xiàng)目遇到這樣的應(yīng)用場(chǎng)景，項(xiàng)目需要同時(shí)連接兩個(gè)不同的數(shù)據(jù)庫(kù)A, B，并且它們都為主從架構(gòu)，一臺(tái)寫庫(kù)，多臺(tái)讀庫(kù)。下面小編給大家?guī)?lái)了Spring Boot + Mybatis多數(shù)據(jù)源和動(dòng)態(tài)數(shù)據(jù)源配置方法，需要的朋友參考下吧2018-01-01
Eclipse新建項(xiàng)目不可選擇Java Project問(wèn)題解決方案
這篇文章主要介紹了Eclipse新建項(xiàng)目不可選擇Java Project問(wèn)題解決方案,文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-07-07
如何在IDEA上安裝scala插件并創(chuàng)建工程(圖文教程)
這篇文章主要介紹了一文教你如何在IDEA上安裝scala插件并創(chuàng)建工程，本文通過(guò)圖文并茂的形式給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2020-07-07