spring-AOP+自定義註解實現日誌管理（註解方式實現）
阿新 • • 發佈：2018-11-12
一、場景
後臺管理系統中，管理員作業系統時生成日誌儲存在資料庫中。
二、實現
1、jar包依賴
<!-- https://mvnrepository.com/artifact/org.springframework/spring-aop --> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-aop</artifactId> <version>4.3.14.RELEASE</version> </dependency>
2、spring_mvc配置
啟動對aop支援。
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xmlns:aop="http://www.springframework.org/schema/aop" 3、Log.java類
用於日誌持久化操作。
import java.io.Serializable;
import java.util.Date;
public class Log implements Serializable{
private String id;
private String operationName;//操作name
private String methodName;//執行方法名
private String className;//類名
private String operationType;//操作型別
private String exceptionDetail;//異常資訊
private String params;//引數
private String adminName;//操作人姓名
private Date createDate;//操作日期
private float time;//執行時間
}4、自定義註解@Log
import java.lang.annotation.*;
//表示該註解用於什麼地方。預設值為任何元素，表示該註解用於什麼地方,引數和方法
//(包 方法)
@Target({ElementType.PACKAGE, ElementType.METHOD})
//定義該註解的生命週期
//(始終不會被丟棄執行期也保留)
@Retention(RetentionPolicy.RUNTIME)
@Documented//表示是否將註解資訊新增在java文件中
public @interface Log {
// 要執行的操作型別 add
String operationType() default "";
// 要執行的具體操作比如：新增使用者
String operationName() default "";
}5、切面LogAspect.java
import com.manage.anno.Log;
import com.manage.model.Result;
import com.manage.service.LogService;
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.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;
import javax.servlet.http.HttpServletRequest;
import java.lang.reflect.Method;
import java.util.Date;
import java.util.UUID;
@Component
@Aspect
public class LogAspect {
// 注入日誌操作service
@Autowired
private LogService logService;
private static final Logger logger = (Logger) LoggerFactory.getLogger(LogAspect.class);
@Pointcut("within(com.manage.controller.*) && @annotation(com.manage.anno.Log)")//controller包下的帶Log註解的方法
public void controllerAspect() {
}
//配置controller環繞通知,使用在方法aspect()上註冊的切入點
// 環繞通知：環繞目標方式執行
@Around("controllerAspect()")
public Result around(ProceedingJoinPoint pjp) throws Throwable {
long startTime = System.currentTimeMillis();//開始時間
Result result = null;
com.manage.model.Log log = new com.manage.model.Log();
// 獲取操作使用者
HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
String userName = (String) request.getSession().getAttribute("username");
System.out.println("獲取session內容" + request.getSession().getAttribute("username"));
if (userName == null) {
log.setAdminName("非登入使用者");
} else {
log.setAdminName(userName);//操作使用者
}
// 執行目標方法
try {
// 前置通知
String methodName1 = pjp.getSignature().getName();
System.out.println("前置通知=>" + "方法名：" + methodName1 + "");
Object[] params = pjp.getArgs();
StringBuilder stringBuilder = new StringBuilder();
for (int i = 0; i < params.length - 1; i++) {
stringBuilder.append(params[i] + ",");
System.out.println("引數為：" + params[i]);
}
System.out.println("stringBuilder" + stringBuilder);
MethodSignature methodName = (MethodSignature) pjp.getSignature();
Method method = methodName.getMethod();
String name = method.getAnnotation(Log.class).operationName();
String type = method.getAnnotation(Log.class).operationType();
System.out.println(name + "========================");
System.out.println(type + "========================");
String className = pjp.getTarget().getClass().getName();
log.setCreateDate(new Date());
log.setId(UUID.randomUUID().toString().replaceAll("\\-", ""));//去掉橫線 32位
log.setMethodName(methodName1);
log.setClassName(className);
log.setParams(stringBuilder.toString());
log.setOperationName(name);
log.setOperationType(type);
result = (Result) pjp.proceed();
// 返回通知
System.out.println("返回通知" + result);
log.setExceptionDetail("無異常");
} catch (Throwable e) {
System.out.println("異常通知" + e);
log.setExceptionDetail(e.toString());
}
//後置通知
System.out.println("後置通知");
long endTime = System.currentTimeMillis();//結束時間
float excTime = (float) (endTime - startTime) / 1000;
System.out.println("執行時間:" + excTime + "s");
log.setTime(excTime);
System.out.println(log);
logService.insert(log);
return result;
}
}
6、在controller層使用
@RequestMapping("/login")
@ResponseBody
@Log(operationName = "管理員登入",operationType = "select")
public Result login(@RequestParam("name") String name,
@RequestParam("pass") String pass,
HttpSession session) {
boolean b = adminService.login(name, pass);
Result result = new Result();
if (b) {//登陸成功
session.setAttribute("username", name);
result.setCode(1);
result.setError(false);
result.setMessage("登陸成功！");
result.setData(name);//返回管理員name
} else {
result.setCode(0);
result.setError(true);
result.setMessage("密碼不正確!");
result.setData(null);
}
return result;
}三、測試
四、問題與解決
1、萬用字元的匹配很全面, 但無法找到元素 'aop:aspectj-autoproxy' 的宣告
為AOP新增名稱空間。
2、自定義註解使用
https://www.cnblogs.com/acm-bingzi/p/javaAnnotation.html
3、切點表示式的使用
https://blog.csdn.net/keda8997110/article/details/50747923
4、java在非servlet的普通類中獲取session
HttpServletRequest request = ((ServletRequestAttributes)RequestContextHolder.getRequestAttributes()).getRequest();
request.getSession();