在springboot中使用AOP進(jìn)行全局日志記錄
前言
此前項(xiàng)目上需要對(duì)用戶的操作進(jìn)行日志記錄,以便后續(xù)追蹤問(wèn)題,所以就學(xué)習(xí)了使用 spring AOP 來(lái)進(jìn)行日志記錄。
1、 spring AOP 是什么?
spring 的兩大核心就是 IOC 和 AOP,AOP 是 spring 框架面向切面的編程思想,AOP是橫切性的技術(shù),將涉及多業(yè)務(wù)流程的通用功能抽取并單獨(dú)封裝,形成獨(dú)立的切面,再將這些切面橫向切入到業(yè)務(wù)流程指定的位置中。
2、spring AOP 能做什么?
AOP 主要是從切面入手,將日志記錄、安全控制、事務(wù)處理、全局異常處理等全局功能從我們的業(yè)務(wù)邏輯代碼中劃分出來(lái)。
3、spring AOP 我能用 AOP 解決什么問(wèn)題?
正好我這邊需要做一個(gè)全局的日志,如果每個(gè)方法都去寫(xiě)日志記錄,這樣代碼量非常大,而且代碼繁瑣冗余,全局記錄的話,只需要在方法上增加一個(gè)注解就可以實(shí)現(xiàn)日志記錄。
好了,不多bb,直接上代碼實(shí)現(xiàn)
一、引入依賴,增加自定義注解
1、引入 maven 依賴
<!--利用 AOP 做操作日志記錄-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
2、增加自定義注解 OperationLog
@Target(ElementType.METHOD) //注解放置的目標(biāo)位置,METHOD是可注解在方法級(jí)別上
@Retention(RetentionPolicy.RUNTIME) //注解執(zhí)行階段
@Documented
public @interface OperationLog {
String operDesc() default ""; // 操作說(shuō)明
}
二、為自定義注解編寫(xiě)切面實(shí)現(xiàn)
@Aspect //標(biāo)識(shí)一個(gè)切面類(lèi)
@Component
public class OperationLogAspect {
private static final Logger logger = LoggerFactory.getLogger(OperationLogAspect.class);
@Autowired
private OperatelogsService OperatelogsService;
@Autowired
private SysUserService userService;
/**
* 設(shè)置操作日志切入點(diǎn) 記錄操作日志 在注解的位置切入代碼
*/
@Pointcut("@annotation(com.wxw.annotation.OperationLog)")
public void operLogPoinCut() {
}
/**
* 正常返回通知,攔截用戶操作日志,連接點(diǎn)正常執(zhí)行完成后執(zhí)行, 如果連接點(diǎn)拋出異常,則不會(huì)執(zhí)行
*
* @param joinPoint 切入點(diǎn)
* @param keys 返回結(jié)果
*/
@AfterReturning(value = "operLogPoinCut()", returning = "keys")
public void saveOperLog(JoinPoint joinPoint, Object keys) {
// 獲取RequestAttributes
RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
// 從獲取RequestAttributes中獲取HttpServletRequest的信息
HttpServletRequest request = (HttpServletRequest) requestAttributes
.resolveReference(RequestAttributes.REFERENCE_REQUEST);
Operatelogs operlog = new Operatelogs();
try {
// 從切面織入點(diǎn)處通過(guò)反射機(jī)制獲取織入點(diǎn)處的方法
MethodSignature signature = (MethodSignature) joinPoint.getSignature();
// 獲取切入點(diǎn)所在的方法
Method method = signature.getMethod();
// 獲取操作
OperationLog opLog = method.getAnnotation(OperationLog.class);
if (opLog != null) {
String operDesc = opLog.operDesc();
operlog.setfDescript(operDesc); // 操作描述
}
// 獲取請(qǐng)求的類(lèi)名
String className = joinPoint.getTarget().getClass().getName();
// 獲取請(qǐng)求的方法名
String methodName = method.getName();
methodName = className + "." + methodName;
operlog.setfRequestMethod(methodName); // 請(qǐng)求方法
// 請(qǐng)求的參數(shù)
Object[] arguments = joinPoint.getArgs();
//判斷參數(shù)數(shù)組是否為空
Stream<?> stream = ArrayUtils.isEmpty(arguments) ? Stream.empty() : Arrays.asList(arguments).stream();
//過(guò)濾 joinPoint.getArgs()返回的數(shù)組中攜帶有Request或者Response對(duì)象
List<Object> logArgs = stream
.filter(arg -> (!(arg instanceof HttpServletRequest) && !(arg instanceof HttpServletResponse)))
.collect(Collectors.toList());
// 先將參數(shù)所在的list 轉(zhuǎn)換成json 數(shù)組
JSONArray jsonArray = JSONArray.parseArray(JSON.toJSONString(logArgs));
//再轉(zhuǎn) json 字符串
String params = jsonArray.toJSONString();
operlog.setfRequestData(params); // 請(qǐng)求參數(shù)
operlog.setfResponseData(JSON.toJSONString(keys)); // 返回結(jié)果
SysUser user = getUser();
operlog.setfOptby(user != null ? user.getfUserid() : 0); // 請(qǐng)求用戶ID
operlog.setfOptname(user != null ? user.getfUsercode() : "admin"); // 請(qǐng)求用戶名稱
operlog.setfOpton(new Date()); // 創(chuàng)建時(shí)間
operlog.setfIp(getIp()); // 請(qǐng)求IP
operlog.setfRequestUrl(request.getRequestURI()); // 請(qǐng)求URI
OperatelogsService.save(operlog);
} catch (Exception e) {
e.printStackTrace();
}
}
/**
* 異常返回通知,用于攔截異常日志信息 連接點(diǎn)拋出異常后執(zhí)行
*
* @param joinPoint 切入點(diǎn)
* @param e 異常信息
*/
@AfterThrowing(pointcut = "operLogPoinCut()", throwing = "e")
public void saveExceptionLog(JoinPoint joinPoint, Throwable e) {
// 獲取RequestAttributes
RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
// 從獲取RequestAttributes中獲取HttpServletRequest的信息
HttpServletRequest request = (HttpServletRequest) requestAttributes
.resolveReference(RequestAttributes.REFERENCE_REQUEST);
Operatelogs operlog = new Operatelogs();
try {
// 從切面織入點(diǎn)處通過(guò)反射機(jī)制獲取織入點(diǎn)處的方法
MethodSignature signature = (MethodSignature) joinPoint.getSignature();
// 獲取切入點(diǎn)所在的方法
Method method = signature.getMethod();
// 獲取請(qǐng)求的類(lèi)名
String className = joinPoint.getTarget().getClass().getName();
// 獲取請(qǐng)求的方法名
String methodName = method.getName();
methodName = className + "." + methodName;
// 請(qǐng)求的參數(shù)
Object[] arguments = joinPoint.getArgs();
//判斷參數(shù)數(shù)組是否為空
Stream<?> stream = ArrayUtils.isEmpty(arguments) ? Stream.empty() : Arrays.asList(arguments).stream();
//過(guò)濾 joinPoint.getArgs()返回的數(shù)組中攜帶有Request或者Response對(duì)象
List<Object> logArgs = stream
.filter(arg -> (!(arg instanceof HttpServletRequest) && !(arg instanceof HttpServletResponse)))
.collect(Collectors.toList());
// 先將參數(shù)所在的list 轉(zhuǎn)換成json 數(shù)組
JSONArray jsonArray = JSONArray.parseArray(JSON.toJSONString(logArgs));
//再轉(zhuǎn) json 字符串
String params = jsonArray.toJSONString();
operlog.setfRequestData(params); // 請(qǐng)求參數(shù)
operlog.setfRequestMethod(methodName); // 請(qǐng)求方法名
operlog.setfExceptionName(e.getClass().getName()); // 異常名稱
operlog.setfResponseData(stackTraceToString(e.getClass().getName(), e.getMessage(), e.getStackTrace())); // 異常信息
SysUser user = getUser();
operlog.setfOptby(user != null ? user.getfUserid() : 0); // 請(qǐng)求用戶ID
operlog.setfOptname(user != null ? user.getfUsercode() : "admin"); // 請(qǐng)求用戶名稱
operlog.setfOpton(new Date()); // 創(chuàng)建時(shí)間
operlog.setfRequestUrl(request.getRequestURI()); // 請(qǐng)求URI
operlog.setfIp(getIp()); // 請(qǐng)求IP
operatelogsService.save(operlog);
} catch (Exception e2) {
e2.printStackTrace();
}
}
/**
* 獲取用戶信息,由于我這邊 token 是使用 jwt 生成,所以可以從中獲取用戶id,再根據(jù)id獲取用戶數(shù)據(jù)
*
* @return
*/
public SysUser getUser() {
HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
SysUser sysUser = null;
String token = request.getHeader("token");// 從 http 請(qǐng)求頭中取出 token
if(token != null){
// 獲取 token 中的 user id
String userId = JWT.decode(token).getAudience().get(0);
sysUser = userService.getOne(new QueryWrapper<SysUser>().lambda().eq(SysUser::getfUserid,
userId));
}
return sysUser;
}
/**
* 獲取ip
*
* @return
*/
public String getIp() {
//獲得本機(jī)的ip和名稱
InetAddress addr = null;
try {
addr = InetAddress.getLocalHost();
} catch (UnknownHostException e) {
throw new CustomException(500,e.getMessage());
}
String ip = addr.getHostAddress();
// String hostname = addr.getHostName();
return ip;
}
/**
* 轉(zhuǎn)換異常信息為字符串
*
* @param exceptionName 異常名稱
* @param exceptionMessage 異常信息
* @param elements 堆棧信息
*/
public String stackTraceToString(String exceptionName, String exceptionMessage, StackTraceElement[] elements) {
StringBuffer strbuff = new StringBuffer();
for (StackTraceElement stet : elements) {
strbuff.append(stet + "\n");
}
String message = exceptionName + ":" + exceptionMessage + "\n\t" + strbuff.toString();
return message;
}
}
三、使用自定義日志注解

將自定義注解加在方法上,請(qǐng)求方法之后,就可以將方法的日志記錄到自己的數(shù)據(jù)庫(kù)里面了。
以上為個(gè)人經(jīng)驗(yàn),希望能給大家一個(gè)參考,也希望大家多多支持腳本之家。
- SpringBoot使用AOP實(shí)現(xiàn)統(tǒng)一角色權(quán)限校驗(yàn)
- Spring AOP實(shí)現(xiàn)功能權(quán)限校驗(yàn)功能的示例代碼
- SpringBoot中使用AOP實(shí)現(xiàn)日志記錄功能
- SpringBoot使用AOP實(shí)現(xiàn)日志記錄功能詳解
- Spring AOP如何自定義注解實(shí)現(xiàn)審計(jì)或日志記錄(完整代碼)
- Spring AOP實(shí)現(xiàn)復(fù)雜的日志記錄操作(自定義注解)
- SpringAop實(shí)現(xiàn)操作日志記錄
- springMVC自定義注解,用AOP來(lái)實(shí)現(xiàn)日志記錄的方法
- 使用Spring AOP做接口權(quán)限校驗(yàn)和日志記錄
相關(guān)文章
SpringBoot整合MybatisPlus的簡(jiǎn)單教程實(shí)現(xiàn)(簡(jiǎn)單整合)
這篇文章主要介紹了SpringBoot整合MybatisPlus的簡(jiǎn)單教程實(shí)現(xiàn),文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2019-05-05
解決eclipse啟動(dòng)tomcat時(shí)不能加載web項(xiàng)目的問(wèn)題
這篇文章主要介紹了解決eclipse啟動(dòng)tomcat時(shí)不能加載web項(xiàng)目的問(wèn)題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-06-06
Java實(shí)現(xiàn)冒泡排序算法及對(duì)其的簡(jiǎn)單優(yōu)化示例
這篇文章主要介紹了Java實(shí)現(xiàn)冒泡排序算法及對(duì)其的簡(jiǎn)單優(yōu)化示例,冒泡排序的最差時(shí)間復(fù)雜度為O(n^2),最優(yōu)時(shí)間復(fù)雜度為O(n),存在優(yōu)化的余地,需要的朋友可以參考下2016-05-05
Spring Boot 2和Redis例子實(shí)現(xiàn)過(guò)程解析
這篇文章主要介紹了Spring Boot2發(fā)布與調(diào)用REST服務(wù)過(guò)程解析,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2019-11-11
SpringBoot+Redis海量重復(fù)提交問(wèn)題解決
在實(shí)際的開(kāi)發(fā)項(xiàng)目中,一個(gè)對(duì)外暴露的接口往往會(huì)面臨很多次請(qǐng)求,所以本文介紹一下SpringBoot+Redis海量重復(fù)提交問(wèn)題解決,感興趣的可以了解一下2023-12-12
RocketMQ?offset確認(rèn)機(jī)制示例詳解
這篇文章主要為大家介紹了RocketMQ?offset確認(rèn)機(jī)制示例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-09-09
SpringBoot任務(wù)之定時(shí)任務(wù)相關(guān)知識(shí)總結(jié)
今天給大家整理的文章是SpringBoot定時(shí)任務(wù)的相關(guān)知識(shí)點(diǎn),文中有非常詳細(xì)的介紹及代碼示例,對(duì)正在學(xué)習(xí)SpringBoot任務(wù)的小伙伴們很有幫助,需要的朋友可以參考下2021-06-06
Spring?Cloud?Alibaba?Nacos兩種檢查機(jī)制
這篇文章主要介紹了Spring?Cloud?Alibaba?Nacos兩種檢查機(jī)制,作為注冊(cè)中心不止提供了服務(wù)注冊(cè)和服務(wù)發(fā)現(xiàn)功能,它還提供了服務(wù)可用性監(jiān)測(cè)的機(jī)制,下面我們就一起進(jìn)入文章了解具體詳情吧2022-05-05

