小編給大家分享一下在springboot中怎么使用AOP進行全局日志記錄，希望大家閱讀完這篇文章之后都有所收獲，下面讓我們一起去探討吧！
spring 的兩大核心就是 IOC 和 AOP，AOP 是 spring 框架面向切面的編程思想，AOP是橫切性的技術，將涉及多業務流程的通用功能抽取并單獨封裝，形成獨立的切面，再將這些切面橫向切入到業務流程指定的位置中。
AOP 主要是從切面入手，將日志記錄、安全控制、事務處理、全局異常處理等全局功能從我們的業務邏輯代碼中劃分出來。
正好我這邊需要做一個全局的日志，如果每個方法都去寫日志記錄，這樣代碼量非常大，而且代碼繁瑣冗余，全局記錄的話，只需要在方法上增加一個注解就可以實現日志記錄。
好了，不多bb，直接上代碼實現
<!--利用 AOP 做操作日志記錄--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency>
@Target(ElementType.METHOD) //注解放置的目標位置,METHOD是可注解在方法級別上
@Retention(RetentionPolicy.RUNTIME) //注解執行階段
@Documented
public @interface OperationLog {
String operDesc() default ""; // 操作說明
}@Aspect //標識一個切面類
@Component
public class OperationLogAspect {
private static final Logger logger = LoggerFactory.getLogger(OperationLogAspect.class);
@Autowired
private OperatelogsService OperatelogsService;
@Autowired
private SysUserService userService;
/**
* 設置操作日志切入點 記錄操作日志 在注解的位置切入代碼
*/
@Pointcut("@annotation(com.wxw.annotation.OperationLog)")
public void operLogPoinCut() {
}
/**
* 正常返回通知，攔截用戶操作日志，連接點正常執行完成后執行， 如果連接點拋出異常，則不會執行
*
* @param joinPoint 切入點
* @param keys 返回結果
*/
@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 {
// 從切面織入點處通過反射機制獲取織入點處的方法
MethodSignature signature = (MethodSignature) joinPoint.getSignature();
// 獲取切入點所在的方法
Method method = signature.getMethod();
// 獲取操作
OperationLog opLog = method.getAnnotation(OperationLog.class);
if (opLog != null) {
String operDesc = opLog.operDesc();
operlog.setfDescript(operDesc); // 操作描述
}
// 獲取請求的類名
String className = joinPoint.getTarget().getClass().getName();
// 獲取請求的方法名
String methodName = method.getName();
methodName = className + "." + methodName;
operlog.setfRequestMethod(methodName); // 請求方法
// 請求的參數
Object[] arguments = joinPoint.getArgs();
//判斷參數數組是否為空
Stream<?> stream = ArrayUtils.isEmpty(arguments) ? Stream.empty() : Arrays.asList(arguments).stream();
//過濾 joinPoint.getArgs()返回的數組中攜帶有Request或者Response對象
List<Object> logArgs = stream
.filter(arg -> (!(arg instanceof HttpServletRequest) && !(arg instanceof HttpServletResponse)))
.collect(Collectors.toList());
// 先將參數所在的list 轉換成json 數組
JSONArray jsonArray = JSONArray.parseArray(JSON.toJSONString(logArgs));
//再轉 json 字符串
String params = jsonArray.toJSONString();
operlog.setfRequestData(params); // 請求參數
operlog.setfResponseData(JSON.toJSONString(keys)); // 返回結果
SysUser user = getUser();
operlog.setfOptby(user != null ? user.getfUserid() : 0); // 請求用戶ID
operlog.setfOptname(user != null ? user.getfUsercode() : "admin"); // 請求用戶名稱
operlog.setfOpton(new Date()); // 創建時間
operlog.setfIp(getIp()); // 請求IP
operlog.setfRequestUrl(request.getRequestURI()); // 請求URI
OperatelogsService.save(operlog);
} catch (Exception e) {
e.printStackTrace();
}
}
/**
* 異常返回通知，用于攔截異常日志信息 連接點拋出異常后執行
*
* @param joinPoint 切入點
* @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 {
// 從切面織入點處通過反射機制獲取織入點處的方法
MethodSignature signature = (MethodSignature) joinPoint.getSignature();
// 獲取切入點所在的方法
Method method = signature.getMethod();
// 獲取請求的類名
String className = joinPoint.getTarget().getClass().getName();
// 獲取請求的方法名
String methodName = method.getName();
methodName = className + "." + methodName;
// 請求的參數
Object[] arguments = joinPoint.getArgs();
//判斷參數數組是否為空
Stream<?> stream = ArrayUtils.isEmpty(arguments) ? Stream.empty() : Arrays.asList(arguments).stream();
//過濾 joinPoint.getArgs()返回的數組中攜帶有Request或者Response對象
List<Object> logArgs = stream
.filter(arg -> (!(arg instanceof HttpServletRequest) && !(arg instanceof HttpServletResponse)))
.collect(Collectors.toList());
// 先將參數所在的list 轉換成json 數組
JSONArray jsonArray = JSONArray.parseArray(JSON.toJSONString(logArgs));
//再轉 json 字符串
String params = jsonArray.toJSONString();
operlog.setfRequestData(params); // 請求參數
operlog.setfRequestMethod(methodName); // 請求方法名
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); // 請求用戶ID
operlog.setfOptname(user != null ? user.getfUsercode() : "admin"); // 請求用戶名稱
operlog.setfOpton(new Date()); // 創建時間
operlog.setfRequestUrl(request.getRequestURI()); // 請求URI
operlog.setfIp(getIp()); // 請求IP
operatelogsService.save(operlog);
} catch (Exception e2) {
e2.printStackTrace();
}
}
/**
* 獲取用戶信息,由于我這邊 token 是使用 jwt 生成，所以可以從中獲取用戶id，再根據id獲取用戶數據
*
* @return
*/
public SysUser getUser() {
HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
SysUser sysUser = null;
String token = request.getHeader("token");// 從 http 請求頭中取出 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() {
//獲得本機的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;
}
/**
* 轉換異常信息為字符串
*
* @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;
}
}
將自定義注解加在方法上，請求方法之后，就可以將方法的日志記錄到自己的數據庫里面了。
看完了這篇文章，相信你對“在springboot中怎么使用AOP進行全局日志記錄”有了一定的了解，如果想了解更多相關知識，歡迎關注億速云行業資訊頻道，感謝各位的閱讀！
免責聲明：本站發布的內容（圖片、視頻和文字）以原創、轉載和分享為主，文章觀點不代表本網站立場，如果涉及侵權請聯系站長郵箱：is@yisu.com進行舉報，并提供相關證據，一經查實，將立刻刪除涉嫌侵權內容。
