Spring Boot - aop 切面对请求进行日志记录

你的名字 2023-10-12 15:11 74阅读 0赞

## 配置文件application ##

server:
      port: 8080
      servlet:
        context-path: /

## 日志文件logback-spring.xml ##

<?xml version="1.0" encoding="UTF-8"?>
    <configuration>
    	<include resource="org/springframework/boot/logging/logback/defaults.xml"/>
    	<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
    		<filter class="ch.qos.logback.classic.filter.LevelFilter">
    			<level>INFO</level>
    		</filter>
    		<encoder>
    			<pattern>%date [%thread] %-5level [%logger{
        50}] %file:%line - %msg%n</pattern>
    			<charset>UTF-8</charset>
    		</encoder>
    	</appender>
    
    	<appender name="FILE_INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
    		
    		<filter class="ch.qos.logback.classic.filter.LevelFilter">
    			
    			<level>ERROR</level>
    			
    			<onMatch>DENY</onMatch>
    			
    			<onMismatch>ACCEPT</onMismatch>
    		</filter>
    		
    		
    		
    		<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    			
    			<FileNamePattern>logs/demo-log-aop/info.created_on_%d{
        yyyy-MM-dd}.part_%i.log</FileNamePattern>
    			
    			<maxHistory>90</maxHistory>
    			
    			
    			<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
    				
    				<maxFileSize>2MB</maxFileSize>
    			</timeBasedFileNamingAndTriggeringPolicy>
    		</rollingPolicy>
    		
    		
    		
    		<encoder>
    			<pattern>%date [%thread] %-5level [%logger{
        50}] %file:%line - %msg%n</pattern>
    			<charset>UTF-8</charset> 
    		</encoder>
    	</appender>
    
    	<appender name="FILE_ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
    		
    		<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
    			<level>Error</level>
    		</filter>
    		
    		
    		
    		<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    			
    			<FileNamePattern>logs/demo-log-aop/error.created_on_%d{
        yyyy-MM-dd}.part_%i.log</FileNamePattern>
    			
    			<maxHistory>90</maxHistory>
    			<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
    				
    				<maxFileSize>2MB</maxFileSize>
    			</timeBasedFileNamingAndTriggeringPolicy>
    		</rollingPolicy>
    		<encoder>
    			<pattern>%date [%thread] %-5level [%logger{
        50}] %file:%line - %msg%n</pattern>
    			<charset>UTF-8</charset> 
    		</encoder>
    	</appender>
    
    	<root level="info">
    		<appender-ref ref="CONSOLE"/>
    		<appender-ref ref="FILE_INFO"/>
    		<appender-ref ref="FILE_ERROR"/>
    	</root>
    </configuration>

## 定义 controller ##

package com.lfsun.springbootlogaop.controller;
    
    import cn.hutool.core.lang.Dict;
    import cn.hutool.core.util.StrUtil;
    import cn.hutool.json.JSONUtil;
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.PostMapping;
    import org.springframework.web.bind.annotation.RequestBody;
    import org.springframework.web.bind.annotation.RestController;
    
    import java.util.Map;
    
    /**
     * <p>
     * 测试 Controller
     * </p>
     */
    @Slf4j
    @RestController
    public class TestController {
        
    
        /**
         * 测试方法 http://localhost:8080/test
         *
         * @param who 测试参数
         * @return {
        @link Dict}
         */
        @GetMapping("/test")
        public Dict test(String who) {
        
            return Dict.create().set("who", StrUtil.isBlank(who) ? "me" : who);
        }
    
        /**
         * 测试post json方法 http://localhost:8080/testJson
         *
         * @param map 请求的json参数
         * @return {
        @link Dict}
         */
        @PostMapping("/testJson")
        public Dict testJson(@RequestBody Map<String, Object> map) {
        
    
            final String jsonStr = JSONUtil.toJsonStr(map);
            log.info(jsonStr);
            return Dict.create().set("json", map);
        }
    }

## 定义切面 ##

package com.lfsun.springbootlogaop.aspectj;
    
    import cn.hutool.core.util.ArrayUtil;
    import cn.hutool.json.JSONUtil;
    import com.google.common.collect.Maps;
    import eu.bitwalker.useragentutils.UserAgent;
    import lombok.AllArgsConstructor;
    import lombok.Builder;
    import lombok.Data;
    import lombok.NoArgsConstructor;
    import lombok.extern.slf4j.Slf4j;
    import org.aspectj.lang.ProceedingJoinPoint;
    import org.aspectj.lang.Signature;
    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.springframework.stereotype.Component;
    import org.springframework.web.context.request.RequestContextHolder;
    import org.springframework.web.context.request.ServletRequestAttributes;
    
    import javax.servlet.http.HttpServletRequest;
    import java.net.InetAddress;
    import java.net.UnknownHostException;
    import java.util.Collections;
    import java.util.Map;
    import java.util.Objects;
    
    /**
     * <p>
     * 使用 aop 切面记录请求日志信息
     * </p>
     */
    @Aspect
    @Component
    @Slf4j
    public class AopLog {
        
        /**
         * 切入点
         */
        @Pointcut("execution(public * com.lfsun.springbootlogaop.controller.*Controller.*(..))")
        public void log() {
        
    
        }
    
        /**
         * 环绕操作
         *
         * @param point 切入点
         * @return 原方法返回值
         * @throws Throwable 异常信息
         */
        @Around("log()")
        public Object aroundLog(ProceedingJoinPoint point) throws Throwable {
        
    
            // 开始打印请求日志
            ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
            HttpServletRequest request = Objects.requireNonNull(attributes).getRequest();
    
            // 打印请求相关参数
            long startTime = System.currentTimeMillis();
            Object result = point.proceed();
            String header = request.getHeader("User-Agent");
            UserAgent userAgent = UserAgent.parseUserAgentString(header);
    
            final Log l = Log.builder()
                    .threadId(Long.toString(Thread.currentThread().getId()))
                    .threadName(Thread.currentThread().getName())
                    .ip(getIp(request))
                    .url(request.getRequestURL().toString())
                    .classMethod(String.format("%s.%s", point.getSignature().getDeclaringTypeName(),
                            point.getSignature().getName()))
                    .httpMethod(request.getMethod())
                    .requestParams(getNameAndValue(point))
                    .result(result)
                    .timeCost(System.currentTimeMillis() - startTime)
                    .userAgent(header)
                    .browser(userAgent.getBrowser().toString())
                    .os(userAgent.getOperatingSystem().toString()).build();
    
            log.info("Request Log Info : {}", JSONUtil.toJsonStr(l));
    
            return result;
        }
    
        /**
         * 获取方法参数名和参数值
         *
         * @param joinPoint
         * @return
         */
        private Map<String, Object> getNameAndValue(ProceedingJoinPoint joinPoint) {
        
    
            final Signature signature = joinPoint.getSignature();
            MethodSignature methodSignature = (MethodSignature) signature;
            final String[] names = methodSignature.getParameterNames();
            final Object[] args = joinPoint.getArgs();
    
            if (ArrayUtil.isEmpty(names) || ArrayUtil.isEmpty(args)) {
        
                return Collections.emptyMap();
            }
            if (names.length != args.length) {
        
                log.warn("{}方法参数名和参数值数量不一致", methodSignature.getName());
                return Collections.emptyMap();
            }
            Map<String, Object> map = Maps.newHashMap();
            for (int i = 0; i < names.length; i++) {
        
                map.put(names[i], args[i]);
            }
            return map;
        }
    
        private static final String UNKNOWN = "unknown";
    
        /**
         * 获取ip地址
         */
        public static String getIp(HttpServletRequest request) {
        
            String ip = request.getHeader("x-forwarded-for");
            if (ip == null || ip.length() == 0 || UNKNOWN.equalsIgnoreCase(ip)) {
        
                ip = request.getHeader("Proxy-Client-IP");
            }
            if (ip == null || ip.length() == 0 || UNKNOWN.equalsIgnoreCase(ip)) {
        
                ip = request.getHeader("WL-Proxy-Client-IP");
            }
            if (ip == null || ip.length() == 0 || UNKNOWN.equalsIgnoreCase(ip)) {
        
                ip = request.getRemoteAddr();
            }
            String comma = ",";
            String localhost = "127.0.0.1";
            if (ip.contains(comma)) {
        
                ip = ip.split(",")[0];
            }
            if (localhost.equals(ip)) {
        
                // 获取本机真正的ip地址
                try {
        
                    ip = InetAddress.getLocalHost().getHostAddress();
                } catch (UnknownHostException e) {
        
                    log.error(e.getMessage(), e);
                }
            }
            return ip;
        }
    
        @Data
        @Builder
        @NoArgsConstructor
        @AllArgsConstructor
        static class Log {
        
            // 线程id
            private String threadId;
            // 线程名称
            private String threadName;
            // ip
            private String ip;
            // url
            private String url;
            // http方法 GET POST PUT DELETE PATCH
            private String httpMethod;
            // 类方法
            private String classMethod;
            // 请求参数
            private Object requestParams;
            // 返回参数
            private Object result;
            // 接口耗时
            private Long timeCost;
            // 操作系统
            private String os;
            // 浏览器
            private String browser;
            // user-agent
            private String userAgent;
        }
    }

\#完整代码地址  
https://gitee.com/lfsun666/springboot-study-2023/tree/master/spring-boot-log-aop