Spring Boot 中使用Spring Aop實現日志記錄功能
作者：編程課堂
本篇帶給大家Spring Boot 中使用Spring Aop實現日志記錄功能，希望對你有所幫助。
一、創建日志注解
1、日志類型枚舉類
import lombok.Getter;
/**
* 日志類型枚舉類
*/
@Getter
public enum LogType {
/**
* 登錄
*/
login("LoginLog");
/**
* 實現類名稱
*/
private final String implClassName;
LogType(String implClassName) {
this.implClassName = implClassName;
}
}
2、自定義日志注解
import java.lang.annotation.*;
import com.baige.enums.LogType;
/**
* 自定義日志注解
*
* 注解說明：
* @Documented：文檔注解
* @Retention(RetentionPolicy.RUNTIME)：生命周期注解，注解不僅被保存到class文件中，jvm加載class文件之后，仍然存在
* @Target({ ElementType.PARAMETER, ElementType.METHOD })：@Target說明了Annotation所修飾的對象范圍，ElementType.TYPE：接口、類、枚舉、注解，ElementType.METHOD：方法
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.PARAMETER, ElementType.METHOD })
public @interface Log {
/**
* 登錄類型
*/
LogType logType();
}
二、利用AOP實現日志切面統一處理
1、日志實現類創建工廠
import com.baige.enums.LogType;
import com.baige.util.SpringContextHolder;
import org.springframework.context.ApplicationContext;
/**
* 日志實現類創建工廠
*/
public class LogFactory {
public static ApplicationContext context;
public static IUserLog getInstance(LogType logType) {
return (IUserLog) SpringContextHolder.getBean(logType.getImplClassName());
}
}
2、切面類
import lombok.extern.slf4j.Slf4j;
import com.baige.aop.log.IUserLog;
import com.baige.aop.annotation.Log;
import com.baige.aop.log.LogFactory;
import org.aspectj.lang.annotation.*;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;
@Slf4j
@Aspect
@Component
public class LogAspect {
/**
* 定義切入點，切入點為com.baige.controller.AopController中的所有函數
* 通過@Pointcut注解聲明頻繁使用的切點表達式
*/
@Pointcut("execution(public * com.baige.controller.UserController.*(..)))")
public void pointcut() {
}
@Around("pointcut()")
public void doAround(ProceedingJoinPoint pjp) {
try {
MethodSignature methodSignature = (MethodSignature) pjp.getSignature();
Log log = methodSignature.getMethod().getAnnotation(Log.class);
IUserLog userLog = LogFactory.getInstance(log.logType());
userLog.addLog(pjp, log);
} catch (Throwable throwable) {
log.info("日志記錄異常，不影響正常業務", throwable);
}
}
}
三、創建日志實現類
1、添加日志接口
import com.baige.aop.annotation.Log;
import org.aspectj.lang.ProceedingJoinPoint;
import java.net.UnknownHostException;
public interface IUserLog {
/**
* 添加日志
*/
int addLog(ProceedingJoinPoint pjp, Log log) throws UnknownHostException;
}
2、添加日志接口實現類
import java.util.Date;
import java.net.InetAddress;
import java.net.UnknownHostException;
import lombok.AllArgsConstructor;
import org.aspectj.lang.ProceedingJoinPoint;
import org.springframework.stereotype.Component;
import com.baige.domain.User;
import com.baige.domain.UserLog;
import com.baige.aop.log.IUserLog;
import com.baige.mapper.UserMapper;
import com.baige.aop.annotation.Log;
import com.baige.mapper.UserLogMapper;
@AllArgsConstructor
@Component("LoginLog")
public class LoginLog implements IUserLog {
private final UserMapper userMapper;
private final UserLogMapper userLogMapper;
@Override
public int addLog(ProceedingJoinPoint pjp, Log log) throws UnknownHostException {
UserLog userLog = new UserLog();
Object[] params = pjp.getArgs();
if (params.length > 0) {
User param = (User) params[0];
User user = userMapper.getOne(param.getLoginName(), param.getLoginPassword());
if (user != null) {
userLog.setUserId(user.getId());
userLog.setContent("獲取用戶信息成功");
} else {
userLog.setContent("未獲取到用戶信息");
}
}
userLog.setIpAddress(InetAddress.getLocalHost().getHostAddress());
userLog.setCreateTime(new Date());
return userLogMapper.insert(userLog);
}
}
四、controller
package com.baige.controller;
import lombok.AllArgsConstructor;
import org.springframework.web.bind.annotation.*;
import com.baige.domain.User;
import com.baige.enums.LogType;
import com.baige.aop.annotation.Log;
import com.baige.service.UserService;
@RestController
@AllArgsConstructor
@RequestMapping("/user")
public class UserController {
private final UserService userService;
@PostMapping("/login")
@Log(logType = LogType.login)
public String login(@RequestBody User params) {
User user = userService.login(params.getLoginName(), params.getLoginPassword());
return user != null ? "登錄成功" : "登錄失敗";
}
}
責任編輯：姜華
來源：
今日頭條
