Springboot中Aspect切面的實現(xiàn)方式(以記錄日志為例)
更新時間：2021年06月17日 10:53:20 作者：朱_哲
這篇文章主要介紹了Springboot中Aspect切面的實現(xiàn)方式(以記錄日志為例)，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教
Springboot Aspect切面的實現(xiàn)
今天我們來說說spring中的切面Aspect，這是Spring的一大優(yōu)勢。面向切面編程往往讓我們的開發(fā)更加低耦合，也大大減少了代碼量，同時呢讓我們更專注于業(yè)務模塊的開發(fā)，把那些與業(yè)務無關的東西提取出去，便于后期的維護和迭代。
好了，廢話少說！我們直接步入正題
以系統(tǒng)日志為例
首先，我們先做一些準備工作。
1、新建一個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>
個人喜好
<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、日志實體類和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){
// 這里就不做具體實現(xiàn)了
log.info(sysLogBO.getParams());
return true;
}
}
4、定義日志注解
這里呢，我們記錄日志使用注解的形式。所以，先定義一個注解
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點我們的準備工作已經(jīng)完成。接下來就是重點了
這里需要你對AOP有一定的了解。起碼知道切點表達式、環(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注解聲明一個切面
@Component
public class SysLogAspect {
@Autowired
private SysLogService sysLogService;
/**
* 這里我們使用注解的形式
* 當然，我們也可以通過切點表達式直接指定需要攔截的package,需要攔截的class 以及 method
* 切點表達式: execution(...)
*/
@Pointcut("@annotation(com.space.aspect.anno.SysLog)")
public void logPointCut() {}
/**
* 環(huán)繞通知 @Around ， 當然也可以使用 @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());
}
//請求的 類名、方法名
String className = joinPoint.getTarget().getClass().getName();
String methodName = signature.getName();
sysLogBO.setClassName(className);
sysLogBO.setMethodName(methodName);
//請求的參數(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、測試
接下來，我們就來測試一下吧
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("測試")
@GetMapping("/test")
public String test(@RequestParam("name") String name){
return name;
}
}
啟動項目，訪問我們的test方法。
我們在service里打一個斷點
可以看到，我們所需要的值都成功拿到了。
這樣，我們就成功實現(xiàn)了使用Aspect實現(xiàn)切面記錄日志。
源碼：https://github.com/zhuzhegithub/springboot-aop-aspect
Springboot Aspect切面實現(xiàn)方法日志打印
項目每次寫controller方法，都要在開始和結束打印一行日志表示方法開始和結束，每個方法都要寫，太過于麻煩和重復，想到了spring的aop切面，所以使用@Aspect切面和自定義log注解實現(xiàn)了下切面日志打印.
AOP
AOP（Aspect Orient Programming）,直譯過來就是 面向切面編程。AOP 是一種編程思想，是面向?qū)ο缶幊蹋∣OP）的一種補充,在程序開發(fā)中主要用來解決一些系統(tǒng)層面上的問題，比如日志，事務，權限等等，這里主要是做一下方法的日志打印。
aop相關注解：
@Aspect:作用是把當前類標識為一個切面供容器讀取
@Pointcut：Pointcut是植入Advice的觸發(fā)條件。每個Pointcut的定義包括2部分，一是表達式，二是方法簽名。方法簽名必須是 public及void型。可以將Pointcut中的方法看作是一個被Advice引用的助記符，因為表達式不直觀，因此我們可以通過方法簽名的方式為 此表達式命名。因此Pointcut中的方法只需要方法簽名，而不需要在方法體內(nèi)編寫實際代碼。
@Around：環(huán)繞增強，相當于MethodInterceptor
@AfterReturning：后置增強，相當于AfterReturningAdvice，方法正常退出時執(zhí)行
@Before：標識一個前置增強方法，相當于BeforeAdvice的功能，相似功能的還有
@AfterThrowing：異常拋出增強，相當于ThrowsAdvice
@After: final增強，不管是拋出異?；蛘哒Ｍ顺龆紩?zhí)行
自定義注解
聲明一個注解要用到的東西
修飾符：訪問修飾符必須為public,不寫默認為pubic；
關鍵字：關鍵字為@interface；
注解名稱：注解名稱為自定義注解的名稱，使用時還會用到；
注解類型元素：注解類型元素是注解中內(nèi)容，可以理解成自定義接口的實現(xiàn)部分；
代碼：
自定義log注解代碼
/**
* 日志注解
*
* Target：用于明確注解用于目標類的哪個位置
* Retention：用于標識自定義注解的生命周期
* RUNTIME:生命周期持續(xù)到運行時，能夠通過反射獲取到
* Documented：用于標識自定義注解能夠使用javadoc命令生成關于注解的文檔
*
* @author xxx
* @date 2020/xx/xx
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface LogMessage {
/**
* 使用value值，在使用注解的時候，不需要寫@LogMessage(value=xxx）,直接寫@LogMessage(xxx）即可
*/
String value() default "";
/**
* 別名使用value，所以在使用注解時，既可以寫@LogMessage(xxx），也可以寫@LogMessage(description=xxx）
*/
@AliasFor("value")
String description() default "";
/**
* 是否打印參數(shù)
*/
boolean parameterPrint() default true;
}
apsect切面類注解
/**
* 日志切面類
* Aspect ：作用是把當前類標識為一個切面供容器讀取
*
* @author xxx
* @date 2020/xx/xx
*/
@Slf4j
@Aspect
@Component
public class LogAspect {
/**
* 前置增強，目標方法執(zhí)行之前執(zhí)行
* within:用于匹配所以持有指定注解類型內(nèi)的方法
* annotation:用于匹配當前執(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("切面日志打印異常！");
}
}
/**
* 返回增強，目標方法正常執(zhí)行完畢時執(zhí)行
*
* within:用于匹配所以持有指定注解類型內(nèi)的方法
* annotation:于匹配當前執(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("測試日志打印")
@GetMapping(value = "/test", produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
public void xxx() {
log.info("test");
}
這樣在方法執(zhí)行前和返回后都會打印日志，只需要在想要打印日志的方法上添加@LogMessage("")注解就可以了。
以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關文章
這篇文章主要介紹了Flowable流程引擎API與服務,引擎API是與Flowable交互的最常用手段,總入口點是ProcessEngine,使用ProcessEngine,可以獲得各種提供工作流或BPM方法的服務,下面我們來詳細了解2023-10-10
jq是一個輕量級的命令行工具，讓你可以非常方便地處理JSON數(shù)據(jù)，如切分、過濾、映射、轉(zhuǎn)化等，就像sed、awk、grep文本處理三劍客一樣，這篇文章主要介紹了超級好用的輕量級JSON處理命令jq,需要的朋友可以參考下2023-01-01
SpringCloud Gateway自動裝配實現(xiàn)流程詳解
Spring Cloud Gateway旨在為微服務架構提供一種簡單有效的、統(tǒng)一的 API 路由管理方式。Spring Cloud Gateway 作為 Spring Cloud 生態(tài)系中的網(wǎng)關，它不僅提供統(tǒng)一的路由方式，并且基于 Filter 鏈的方式提供了網(wǎng)關基本的功能，例如：安全、監(jiān)控/埋點和限流等2022-10-10
這篇文章主要介紹了Java中的類加載器詳解,從概念上來講, 自定義類加載器一般指的是程序中由開發(fā)人員自定義的類加載器,但是Java虛擬機規(guī)范卻沒有這么定義,而是將所有派生于抽象類ClassLoader的類加載器都劃分為自定義類加載器,需要的朋友可以參考下2023-07-07
今天帶大家復習Java基礎知識,文中對Java運算符相關知識作了詳細總結,對正在學習java基礎的小伙伴們很有幫助,需要的朋友可以參考下2021-05-05
IDEA自帶的注釋模板不是太好用,我本人到網(wǎng)上搜集了很多資料系統(tǒng)的整理了一下制作了一份比較完整的模板來分享給大家,下面這篇文章主要給大家介紹了IDEA個性化設置注釋模板的相關資料,需要的朋友可以參考下2024-01-01
SpEL簡稱Spring表達式語言,在Spring 3中引入,SpEL能在運行時構建復雜表達式、存取對象圖屬性、對象方法調(diào)用等等,可以與基于XML和基于注解的Spring配置還有bean定義一起使用,本文給大家介紹Java SPEL表達式注入漏洞原理研究,感興趣的朋友一起看看吧2023-10-10
SpringBoot?注解?@AutoConfiguration?在?2.7?版本中被新增的使用方法詳解
這篇文章主要介紹了SpringBoot?注解?@AutoConfiguration?在?2.7?版本中被新增（使用方法）,本文給大家介紹的非常詳細,需要的朋友可以參考下2024-09-09
java中hashmap的底層數(shù)據(jù)結構與實現(xiàn)原理
Hashmap是java面試中經(jīng)常遇到的面試題，大部分都會問其底層原理與實現(xiàn)，本人也是被這道題問慘了，為了能夠溫故而知新，特地寫了這篇文章，以便時時學習2021-08-08
Java程序生成exe可執(zhí)行文件詳細教程(圖文說明)
這篇文章主要介紹了Java程序生成exe可執(zhí)行文件詳細教程，有需要的朋友可以參考一下2013-12-12