SpringBoot整合AOP记录接口访问日志

参考：

SpringBoot整合AOP

AOP

AOP 为 Aspect Oriented Programming 的缩写，意为：面向切面编程，通过 预编译 方式和 运行期动态代理 实现程序功能的统一维护的一种技术。利用 AOP 可以对业务逻辑的个部分进行隔离，从而从而使得业务逻辑各部分之间的耦合度降低，提高程序的可重用性，同时提高了开发的效率。

AOP的相关术语

通知(Advice)

通知描述了切面要完成的工作以及何时执行。比如我们的日志切面需要记录每个接口调用时长，就需要在接口调用前后分别记录当前时间，再取差值。

• 前置通知（Before）：在目标方法调用前调用通知功能；
• 后置通知（After）：在目标方法调用之后调用通知功能，不关心方法的返回结果；
• 返回通知（AfterReturning）：在目标方法成功执行之后调用通知功能；
• 异常通知（AfterThrowing）：在目标方法抛出异常后调用通知功能；
• 环绕通知（Around）：通知包裹了目标方法，在目标方法调用之前和之后执行自定义的行为。

连接点(JoinPoint)

通知功能被应用的时机，比如接口方法被调用的时候就是日志切面的连接点

切点(Pointcut)

切点定义了通知功能被应用的范围。比如日志切面的应用范围就是所有接口，即所有controller层的接口方法。

切面(Aspect)

切面是通知和切点的结合，定义了何时，何地应用通知功能

引入(Introduction)

在无需修改现有类的情况下，向现有的类添加新方法或属性。

织入(Weaving)

把切面应用到目标对象并创建新的代理对象的过程。

Spring中使用注解创建切面

相关注解

• @Aspect：用于定义切面
• @Before：通知方法会在目标方法调用之前执行
• @After：通知方法会在目标方法返回或抛出异常后执行
• @AfterReturning：通知方法会在目标方法返回后执行
• @AfterThrowing：通知方法会在目标方法抛出异常后执行
• @Around：通知方法会将目标方法封装起来
• @Pointcut：定义切点表达式

切点表达式

指定了通知被应用的范围，表达式格式：

execution(方法修饰符 返回类型 方法所属的包.类名.方法名称(方法参数)

//com.macro.mall.tiny.controller包中所有类的public方法都应用切面里的通知
execution(public * com.macro.mall.tiny.controller.*.*(..))
//com.macro.mall.tiny.service包及其子包下所有类中的所有方法都应用切面里的通知
execution(* com.macro.mall.tiny.service..*.*(..))
//com.macro.mall.tiny.service.PmsBrandService类中的所有方法都应用切面里的通知
execution(* com.macro.mall.tiny.service.PmsBrandService.*(..))

实例

添加日志信息封装类 WebLog

用于封装需要记录的日志信息，包括操作的描述、时间、消耗时间、url、请求参数和返回结果等信息。

package com.macro.mall.tiny.dto;

/**
 * Controller层的日志封装类
 * Created by macro on 2018/4/26.
 */
public class WebLog {
    /**
     * 操作描述
     */
    private String description;

    /**
     * 操作用户
     */
    private String username;

    /**
     * 操作时间
     */
    private Long startTime;

    /**
     * 消耗时间
     */
    private Integer spendTime;

    /**
     * 根路径
     */
    private String basePath;

    /**
     * URI
     */
    private String uri;

    /**
     * URL
     */
    private String url;

    /**
     * 请求类型
     */
    private String method;

    /**
     * IP地址
     */
    private String ip;

    /**
     * 请求参数
     */
    private Object parameter;

    /**
     * 请求返回的结果
     */
    private Object result;

    //省略了getter,setter方法
}

添加切面类 WebLogAspect

定义了一个日志切面，在环绕通知中获取日志需要的信息，并应用到controller层中所有的public方法中去。

/**
  * 统一日志处理切面
  *
  * @author yisheng.mikelv@foxmail.com 2020/3/12 17:22
  */
@Aspect
@Component
@Order(1)
public class WebLogAspect {

    private static final Logger logger = LoggerFactory.getLogger(WebLogAspect.class);

    @Pointcut("execution(public * org.developer.es.api.controller.*.*(..))")
    public void webLog(){

    }

    @Before("webLog()")
    public void doBefore(JoinPoint joinPoint) throws Throwable{

    }

    @AfterReturning(value = "webLog()", returning = "ret")
    public void doAfterReturning(Object ret) throws Throwable{

    }

    //环绕通知=前置 + 目标方法执行 + 后置通知
    @Around("webLog()")
    public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable{
        long startTime = System.currentTimeMillis();
        //获取当前请求对象
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        //记录请求信息
        WebLog webLog = new WebLog();
        //proceed 方法就是用于启动目标方法执行
        Object result = joinPoint.proceed();
        //获取被调用的签名
        Signature signature = joinPoint.getSignature();
        //转换为方法签名
        MethodSignature methodSignature = (MethodSignature) signature;
        //获取 controller 的方法
        Method method = methodSignature.getMethod();
        //如果存在 ApiOperation 注解，获取描述的值
        if(method.isAnnotationPresent(ApiOperation.class)){
            ApiOperation apiOperation = method.getAnnotation(ApiOperation.class);
            webLog.setDescription(apiOperation.value());
        }
        long endTime = System.currentTimeMillis();
        String urlStr = request.getRequestURL().toString();
        webLog.setBasePath(StrUtil.removeSuffix(urlStr, URLUtil.url(urlStr).getPath()));
        webLog.setIp(request.getRemoteUser());
        webLog.setMethod(request.getMethod());
        webLog.setParameter(getParameter(method, joinPoint.getArgs()));
        webLog.setResult(result);
        webLog.setSpendTime((int) (endTime - startTime));
        webLog.setStartTime(startTime);
        webLog.setUri(request.getRequestURI());
        webLog.setUrl(request.getRequestURL().toString());
        logger.info("{} \n", JSONUtil.parse(webLog));
        return result;


    }

    /**
     * 根据方法和传入的参数获取请求参数
     */
    private Object getParameter(Method method, Object[] args) {
        List<Object> argList = new ArrayList<>();
        //获取方法的参数
        Parameter[] parameters = method.getParameters();
        for (int i = 0; i < parameters.length; i++) {
            //将 RequestBody 注解修饰的参数作为请求参数
            RequestBody requestBody = parameters[i].getAnnotation(RequestBody.class);
            if(requestBody != null){
                argList.add(args[i]);
            }
            //将 RequestParam 注解修饰的参数作为请求参数
            RequestParam requestParam = parameters[i].getAnnotation(RequestParam.class);
            if (requestParam != null) {
                Map<String, Object> map = new HashMap<>();
                String key = parameters[i].getName();
                if (!StringUtils.isEmpty(requestParam.value())) {
                    key = requestParam.value();
                }
                map.put(key, args[i]);
                argList.add(map);
            }

        }
        if (argList.size() == 0) {
            return null;
        } else if (argList.size() == 1) {
            return argList.get(0);
        } else {
            return argList;
        }
    }
}

运行结果：


当执行遇到错误的时候，就会有以下信息

拓展

SpringBoot 官方建议使用 logback-spring.xml

logback.xml：应用启动时会直接被日志框架 logback 识别而被使用，不经过 SpringBoot

logback-spring.xml：logback日志框架就不能直接识别到，而会由 Spring Boot 解析此日志配置文件

SpringBoot 加载 logback-spring.xml

参考：

Spring Boot中logback配置文件加载过程

// org.springframework.boot.logging.logback.LogbackLoggingSystem
@Override
protected String[] getStandardConfigLocations() {
    return new String[] { "logback-test.groovy", "logback-test.xml", "logback.groovy",
                         "logback.xml" };
}

通过这里可以看到spring boot中支持的logback配置文件格式，就是在logback自配置文件（logback-test.xml, logback.xml等）基础上文件名后面加了“-spring”，如logback-test-spring, logback-spring等。

/**
 * Return the spring config locations for this system. By default this method returns
 * a set of locations based on {@link #getStandardConfigLocations()}.
 * @return the spring config locations
 * @see #getSpringInitializationConfig()
 */
protected String[] getSpringConfigLocations() {
    String[] locations = getStandardConfigLocations();
    for (int i = 0; i < locations.length; i++) {
        String extension = StringUtils.getFilenameExtension(locations[i]);
        locations[i] = locations[i].substring(0,
                                              locations[i].length() - extension.length() - 1) + "-spring."
            + extension;
    }
    return locations;
}

重点关注org.springframework.boot.logging.logback.LogbackLoggingSystem