springboot通过拦截器打印入口日志

 

      springboot使用拦截器打印入口日志有两种方法：（1）继承 HandlerInterceptorAdapter 类；（2）AOP拦截

       本文实现两种方法（本文展示实现过程和期间遇到的问题及解决方法）

 

第一种 继承 HandlerInterceptorAdapter 类

 

      1、新建BaseInterceptor类继承 HandlerInterceptorAdapter，实现拦截操作：

            这里拦截的内容比较简单。在实际业务中，可能需要对上传的数据进行拦截：这时 ，会发生一个问题，拦截器中获取到Request请求对象中的参数后，controller中便获取不到了。这个问题的具体描述和解决方法在另一篇文档中描述。

package ***;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.lang.Nullable;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Map;

/**
 * @author wangyan
 * @description  拦截后preHandle方法实现的操作（打印入口日志）
 * @date 2019/7/12 10:13
 */

@Component
public class BaseInterceptor extends HandlerInterceptorAdapter {

    protected final Logger logger = LoggerFactory.getLogger(this.getClass());

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
        info("******************【RequestBeginning】********************");
        info("----------------StartProcessingRequest----------------");
        try {
            Long currentTime = System.currentTimeMillis();
            SimpleDateFormat formatter = new SimpleDateFormat("yyyy/MM/dd HH:mm:ss");
            Date date = new Date(currentTime);
            info("CurrentTime：{}",formatter.format(date));
            info("ResponseTime:{}",(System.currentTimeMillis() - currentTime) + "ms");

            String requestURL = request.getRequestURI();
            info("RequestURL： {} ", requestURL);
            info("GetMethod: {}", handler);

        } catch (Exception e) {
            error("MVC业务处理-拦截器异常：", e);
        }
        info("-------------------------End-------------------------");
        return true;
    }

    /**
     * This implementation is empty.
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
                           @Nullable ModelAndView modelAndView) throws Exception {
        logger.info("after");
    }

    /**
     * This implementation is empty.
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler,
                                @Nullable Exception ex) throws Exception {
        logger.info("Completion");
    }
    /**
     * This implementation is empty.
     */
    @Override
    public void afterConcurrentHandlingStarted(HttpServletRequest request, HttpServletResponse response,
                                               Object handler) throws Exception {
        logger.info("Concurrent");
    }

    protected final void error(String msg, Object... objects) {
        logger.error(msg, objects);
    }
    protected final void info(String msg, Object... objects) {
        logger.info(msg, objects);
    }
}

 

2、config下新建BaseInterceptorConfig类，定义需要拦截的内容：

package io.transwarp.esb.config;

import io.transwarp.esb.aop.logging.BaseInterceptor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

/**
 * @author wangyan
 * @description  定义需要拦截的路径
 * @date 2019/7/12 10:19
 */

@Configuration
public class BaseInterceptorConfig extends WebMvcConfigurationSupport {

    @Autowired
    BaseInterceptor baseInterceptor;

    @Override
    protected void addInterceptors(InterceptorRegistry registry) {
        //排除此路径，其他都拦截
//        registry.addInterceptor(baseInterceptor).excludePathPatterns("/base/test");
        //指定路径，只拦截此路径
        registry.addInterceptor(baseInterceptor)
                .addPathPatterns("/base/test")
                .excludePathPatterns("/swagger-resources/**", "/webjars/**", "/v2/**", "/swagger-ui.html/**");
        //如果两个同时存在，排除生效，指定的路径会拦截两次
        //添加拦截器
        super.addInterceptors(registry);
    }

    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("swagger-ui.html")
                .addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
}

 

3、以上是实现拦截器的全部代码。这期间需要注意：引入拦截器后，swagger不能使用。这需要将swagger相关的路径都排除在拦截器外，是由BaseInterceptorConfig类里的

.excludePathPatterns("/swagger-resources/**", "/webjars/**", "/v2/**", "/swagger-ui.html/**");

来实现的。

 

4、最终结果如下：

***************************【RequestBeginning】***************************
----------------StartProcessingRequest----------------
CurrentTime：2019/07/15 10:35:34
ResponseTime:2ms
RequestURL： /base/test 

GetMethod: public java.lang.String io.transwarp.esb.controller.EsbController.test(java.lang.String)
 -------------------------End-------------------------

 

第二种 AOP拦截

 

      1、gradle 加入依赖：           

 

 compile group: 'org.aspectj', name: 'aspectjweaver', version: '1.9.2'

            maven 加入依赖：

<!-- https://mvnrepository.com/artifact/org.aspectj/aspectjweaver -->
<dependency>
    <groupId>org.aspectj</groupId>
    <artifactId>aspectjweaver</artifactId>
    <version>1.9.2</version>
</dependency>

      2、新建 LoggingAspect 类

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

/**
 * @description
 * @author wangyan
 * @date 2019/7/11 15:36
 */
@Aspect
@Component
public class LoggingAspect {

    protected final Logger logger = LoggerFactory.getLogger(this.getClass());

    // 定义一个 Pointcut, 使用 切点表达式函数 来描述对哪些 Join point 使用 advise.
    @Pointcut("within(io.transwarp.esb.controller.EsbController)")
    public void controllerLog(){
    }

    // 定义 advise
    @Before("controllerLog()")
    public void logMethodInvokeParam(JoinPoint joinPoint) {
        logger.info("---Before method {} invoke, param: {}---", joinPoint.getSignature().toShortString(), joinPoint.getArgs());
    }

    @AfterReturning(pointcut = "controllerLog()", returning = "retVal")
    public void logMethodInvokeResult(JoinPoint joinPoint, Object retVal) {
        logger.info("---After method {} invoke, result: {}---", joinPoint.getSignature().toShortString(), joinPoint.getArgs());
    }

    @AfterThrowing(pointcut = "controllerLog()", throwing = "exception")
    public void logMethodInvokeException(JoinPoint joinPoint, Exception exception) {
        logger.info("---method {} invoke exception: {}---", joinPoint.getSignature().toShortString(), exception.getMessage());
    }
}

     3、AOP的实现方式很简单，但需注意引入jar包

     

      下载地址：

       https://github.com/WangYanZ/esb/tree/master/src/main/java/io/transwarp/esb/aop/logging