AOP实现日志记录

1、自定义的注解

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Retention(RetentionPolicy.RUNTIME)//表明注解生效时期 
@Target(ElementType.METHOD)//表面注解使用范围 方法
public @interface LogData {

}

2、实现的aop切面

import com.example.demo.entity.LogData;
import com.example.demo.service.LogDataService;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.annotation.Resource;
import javax.servlet.http.HttpServletRequest;
import java.util.Arrays;

@Aspect
@Component
public class LogAop {
    private final Logger logger = LoggerFactory.getLogger(LogAop.class);
    @Resource
    LogDataService logDataService;
    /**
     * 定义切入点，切入点为com.example.demo.myannotation.LogData注解类
     *通过@Pointcut注解声明频繁使用的切点表达式
     */
    @Pointcut("@annotation(com.example.demo.myannotation.LogData))")
    public void LogData(){

    }

    /**
     * @description  在连接点执行之后执行的通知（返回通知和异常通知的异常）
     */
    @After("LogData()")
    public void doAfterGame(JoinPoint joinPoint){
        //这个RequestContextHolder是Springmvc提供来获得请求的东西
        RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = ((ServletRequestAttributes)requestAttributes).getRequest();
        // 记录下请求内容
        logger.info("请求路径:" + request.getRequestURL().toString());
        logger.info("请求方试: " + request.getMethod());
        logger.info("请求ip: " + request.getRemoteAddr());
        logger.info("请求参数: " + Arrays.toString(joinPoint.getArgs()));
        logger.info("请求类方法: " + joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
    }

    /**
     * @description  在连接点执行之后执行的通知（返回通知）
     */
    @AfterReturning(value = "LogData()",returning = "keys")
    public void doReturn(JoinPoint joinPoint, Object keys){
       logger.info("返回结果："+keys.toString());
        //这个RequestContextHolder是Springmvc提供来获得请求的东西
        RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = ((ServletRequestAttributes)requestAttributes).getRequest();
        LogData logData=new LogData();
        logData.setRequestAddr(request.getRemoteAddr());
        logData.setRequestArgs(Arrays.toString(joinPoint.getArgs()));
        logData.setRequestMethod(request.getMethod());
        logData.setRequestUrl(request.getRequestURL().toString());
        logData.setResponse(keys.toString());
        logData.setRequestTypeName( joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
        logDataService.insert(logData);
    }

    /**
     * @description  在连接点执行之后执行的通知（异常通知）
     */
    @AfterThrowing(value = "LogData()",throwing  = "ex")
    public void doAfterThrowingGame(JoinPoint joinPoint,Exception ex){
        logger.error("异常信息："+ex.toString());
        RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = ((ServletRequestAttributes)requestAttributes).getRequest();
        // 记录下请求内容
        LogData logData=new LogData();
        logData.setRequestAddr(request.getRemoteAddr());
        logData.setRequestArgs(Arrays.toString(joinPoint.getArgs()));
        logData.setRequestMethod(request.getMethod());
        logData.setRequestUrl(request.getRequestURL().toString());
        logData.setEx(ex.toString());
        logData.setStatus(1);
        logData.setRequestTypeName( joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());
        logDataService.insert(logData);
    }
}

3、日志记录的实体类

@Data
public class LogData implements Serializable {

    
    private Long id;
    
    private String requestUrl;
    
    private String requestMethod;
    
    private String requestAddr;
    
    private String requestArgs;
    
    private String requestTypeName;
    
    private String response;
    
    private String ex;
    
    private Integer status;


}

4、依赖的maven

        <dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-aop</artifactId>
		</dependency>
		<dependency>
			<groupId>org.slf4j</groupId>
			<artifactId>slf4j-api</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
		
		<!--mysql数据库驱动-->
		<dependency>
			<groupId>mysql</groupId>
			<artifactId>mysql-connector-java</artifactId>
			<scope>runtime</scope>
		</dependency>
		<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
			<version>1.16.12</version>
		</dependency>
		<!--mybatis-->
		<dependency>
			<groupId>org.mybatis.spring.boot</groupId>
			<artifactId>mybatis-spring-boot-starter</artifactId>
			<version>1.3.2</version>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
		<dependency>
			<groupId>org.apache.commons</groupId>
			<artifactId>commons-pool2</artifactId>
			<version>2.5.0</version>
			<!--<version>2.4.2</version>-->
		</dependency>

5、数据库表sql语句

SET FOREIGN_KEY_CHECKS=0;

-- ----------------------------
-- Table structure for log_data
-- ----------------------------
DROP TABLE IF EXISTS `log_data`;
CREATE TABLE `log_data` (
  `id` bigint(20) NOT NULL AUTO_INCREMENT,
  `request_url` varchar(255) DEFAULT NULL,
  `request_method` varchar(25) DEFAULT NULL,
  `request_addr` varchar(25) DEFAULT NULL,
  `request_args` varchar(255) DEFAULT NULL,
  `request_type_name` varchar(255) DEFAULT NULL,
  `response` varchar(2550) DEFAULT NULL,
  `ex` varchar(255) DEFAULT NULL,
  `status` int(11) DEFAULT '0',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8mb4;