springcloud项目搭建（五）----使用Spring aop完成统一日志和异常管理

左手的ㄟ右手 2022-05-31 23:56 289阅读 0赞

项目地址：[https://gitee.com/lwydyby/springcloud-adplatform][https_gitee.com_lwydyby_springcloud-adplatform]  
注：由于项目初期搭建，暂未使用springcloud-sleuth进行追踪分析，而是使用AOP进行统一的日志记录  
1.编写切面类  
1）.DisableGameleyLog为自定义注解，为了可以通过该注解跳过一些不必记录的操作  
2）目前只记录controller层日志  
3）该拦截器除日志记录功能外，也进行了统一的异常处理，如抛出异常，统一返回给接口500  
4）由于将该配置保存在公共的基础common包中，只要引入common的所有项目都会默认在启动时加载该配置，无需再进行单独的配置。

package com.gameley.common.Interceptor;
    
    import com.gameley.common.exception.BaseException;
    import com.gameley.common.util.ClientUtil;
    import org.aspectj.lang.JoinPoint;
    import org.aspectj.lang.ProceedingJoinPoint;
    import org.aspectj.lang.annotation.*;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.core.annotation.Order;
    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.util.Arrays;
    
    @Aspect
    @Component
    public class HttpAspect {
    
        private final static Logger logger = LoggerFactory.getLogger(HttpAspect.class);
    
    
        @SuppressWarnings("unchecked")
        @Pointcut("execution(public * com.gameley.controller.*.*(..)) && !@annotation(com.gameley.common.DisableGameleyLog))")
        public void log(){
    
        }
    
        @Before("log()")
        public void doBefore(JoinPoint joinPoint){
            ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
            HttpServletRequest request = attributes.getRequest();
    
            // 记录下请求内容
            logger.info("请求地址 : " + request.getRequestURL().toString());
            logger.info("HTTP METHOD : " + request.getMethod());
            // 获取真实的ip地址
            logger.info("IP : " + ClientUtil.getClientIp(request));
            logger.info("CLASS_METHOD : " + joinPoint.getSignature().getDeclaringTypeName() + "."
                    + joinPoint.getSignature().getName());
            logger.info("参数 : " + Arrays.toString(joinPoint.getArgs()));
        }
    
        @Around("log()")
        public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
            try {
                long startTime = System.currentTimeMillis();
                Object ob= proceedingJoinPoint.proceed();
                logger.info("耗时 : " + (System.currentTimeMillis() - startTime));
                return ob;
            } catch (Exception e) {
                logger.error("error:",e);
                return new BaseException("后台操作异常",500);
    
            }
    
    
        }
    
        @AfterReturning(pointcut = "log()",returning = "object")//打印输出结果
        public void doAfterReturing(Object object){
            logger.info("response={}",object.toString());
        }
    }

2.编写DisableGameleyLog自定义注解

package com.gameley.common;
    
    
    import java.lang.annotation.*;
    
    @Documented
    @Retention(RetentionPolicy.RUNTIME)
    @Target({ElementType.METHOD})
    public @interface DisableGameleyLog { 
    }

3.创建logback配置文件（目前为从网上下载的模板，待使用后再修改）

<?xml version="1.0" encoding="UTF-8"?>
    <configuration>
        
        <contextName>userservice</contextName>
        <property name="LOG_PATH" value="/home" />
        
        <property name="APPDIR" value="userService" />
    
        
        <appender name="FILEERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <file>${LOG_PATH}/${APPDIR}/log_error.log</file>
            
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                
                <fileNamePattern>${LOG_PATH}/${APPDIR}/error/log-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>2MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
            </rollingPolicy>
            
            <append>true</append>
            
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                <pattern>===%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger Line:%-3L - %msg%n</pattern>
                <charset>utf-8</charset>
            </encoder>
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>error</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        
        <appender name="FILEWARN" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <file>${LOG_PATH}/${APPDIR}/log_warn.log</file>
            
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                
                <fileNamePattern>${LOG_PATH}/${APPDIR}/warn/log-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>2MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
            </rollingPolicy>
            
            <append>true</append>
            
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                <pattern>===%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger Line:%-3L - %msg%n</pattern>
                <charset>utf-8</charset>
            </encoder>
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>warn</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        
        <appender name="FILEINFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <file>${LOG_PATH}/${APPDIR}/log_info.log</file>
            
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                
                <fileNamePattern>${LOG_PATH}/${APPDIR}/info/log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>2MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
            </rollingPolicy>
            
            <append>true</append>
            
            <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
                <pattern>===%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger Line:%-3L - %msg%n</pattern>
                <charset>utf-8</charset>
            </encoder>
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>info</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
    
        <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
            
            <encoder>
                <pattern>===%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger Line:%-3L - %msg%n</pattern>
                <charset>utf-8</charset>
            </encoder>
            
            <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
                <level>debug</level>
            </filter>
        </appender>
    
        <logger name="org.springframework" level="WARN" />
        <logger name="org.hibernate" level="WARN" />
    
        
        <root level="INFO">
            <appender-ref ref="FILEERROR" />
            <appender-ref ref="FILEWARN" />
            <appender-ref ref="FILEINFO" />
    
            
            <appender-ref ref="STDOUT" />
        </root>
    </configuration>

[https_gitee.com_lwydyby_springcloud-adplatform]: https://gitee.com/lwydyby/springcloud-adplatform