前言

温馨提醒:阅读本文需要5分钟

切面介绍

面向切面编程是一种编程范式,它作为 OOP 面向对象编程的一种补充,用于处理系统中分布于各个模块的横切关注点,比如事务管理、权限控制、缓存控制、日志打印等等。AOP 把软件的功能模块分为两个部分:核心关注点和横切关注点。业务处理的主要功能为核心关注点,而非核心、需要拓展的功能为横切关注点。AOP 的作用在于分离系统中的各种关注点,将核心关注点和横切关注点进行分离,使用切面有以下好处:

  • 集中处理某一关注点 / 横切逻辑
  • 可以很方便的添加 / 删除关注点
  • 侵入性少,增强代码可读性及可维护性 因此当想打印请求日志时很容易想到切面,对控制层代码 0 侵入

自定义日志注解

让我们来自定义一个日志注解,如下所示:

//定义为运行时使用该注解,;
@Retention(RetentionPolicy.RUNTIME)
//注解定义为作用于方法上;
@Target({ElementType.METHOD})
//注解是否将包含在JavaDoc中;
@Documented
public @interface WebLog {
    /**
     * 日志描述信息
     * 定义一个属性,默认为空字符串;
     * @return
     */
    String description() default "";
}

配置 AOP 切面

在配置 AOP 切面之前,我们需要了解下 aspectj 相关注解的作用:

  • @Aspect:声明该类为一个注解类;
  • @Pointcut:定义一个切点,后面跟随一个表达式,表达式可以定义为切某个注解,也可以切某个 package 下的方法;

切点定义好后,就是围绕这个切点做文章了:

  • @Before: 在切点之前,织入相关代码;
  • @After: 在切点之后,织入相关代码;
  • @AfterReturning: 在切点返回内容后,织入相关代码,一般用于对返回值做些加工处理的场景;
  • @AfterThrowing: 用来处理当织入的代码抛出异常后的逻辑处理;
  • @Around: 环绕,可以在切入点前后织入代码,并且可以自由的控制何时执行切点;

aop.png

定义WebLogAspect.java 切面类

先定义一个 WebLogAspect.java 切面类,完整代码如下:

package com.bywin.kkgs.component;

import com.alibaba.fastjson.JSON;
import com.bywin.kkgs.dto.RequestInfo;
import com.bywin.kkgs.util.IpUtil;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.springframework.context.annotation.Profile;
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.lang.reflect.Method;


/**
 * @Author thy
 * @Date 2020/7/31 17:22
 * @Description:
 */
@Aspect
@Component
//只在dev本地环境使用
@Profile({"dev", "local"})
@Slf4j
public class WebLogAspect {
    /** 换行符 */
    private static final String LINE_SEPARATOR = System.lineSeparator();

    /** 以自定义 @WebLog 注解为切点 */
    @Pointcut("@annotation(com.bywin.kkgs.component.WebLog)")
    public void webLog() {}

    /**
     * 在切点之前织入
     * @param joinPoint
     * @throws Throwable
     */
    @Before("webLog()")
    public void doBefore(JoinPoint joinPoint) throws Throwable {
        // 打印请求相关参数
        log.info("========================================== Start ==========================================");
    }

    /**
     * 在切点之后织入
     * @throws Throwable
     */
    @After("webLog()")
    public void doAfter() throws Throwable {
        // 接口结束后换行,方便分割查看
        log.info("=========================================== End ===========================================" + LINE_SEPARATOR);
    }

    /**
     * 环绕
     * @param proceedingJoinPoint
     * @return
     * @throws Throwable
     */
    @Around("webLog()")
    public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
        // 开始打印请求日志
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        // 获取 @WebLog 注解的描述信息
        String methodDescription = getAspectLogDescription(proceedingJoinPoint);
        long startTime = System.currentTimeMillis();
        Object result = proceedingJoinPoint.proceed();
        //通过构造请求信息的对象,将信息封装到对象中,防止请求并发的时候日志窜行
        RequestInfo requestInfo = RequestInfo.builder().url(request.getRequestURL().toString())
                .methodDescription(methodDescription)
                .httpMethod(request.getMethod())
                .classMethod(String.format("%s.%s", proceedingJoinPoint.getSignature().getDeclaringTypeName(),
                        proceedingJoinPoint.getSignature().getName()))
                .ip(IpUtil.getIpAddr(request))
                .requestParams(JSON.toJSON(proceedingJoinPoint.getArgs()))
                .result(JSON.toJSON(result))
                .timeCost(System.currentTimeMillis() - startTime)
                .build();
        log.info("接口请求信息: {}",requestInfo.toString());
        return result;
    }


    /**
     * 获取切面注解的描述
     *
     * @param joinPoint 切点
     * @return 描述信息
     * @throws Exception
     */
    public String getAspectLogDescription(JoinPoint joinPoint)
            throws Exception {
        String targetName = joinPoint.getTarget().getClass().getName();
        String methodName = joinPoint.getSignature().getName();
        Object[] arguments = joinPoint.getArgs();
        Class targetClass = Class.forName(targetName);
        Method[] methods = targetClass.getMethods();
        StringBuilder description = new StringBuilder("");
        for (Method method : methods) {
            if (method.getName().equals(methodName)) {
                Class[] clazzs = method.getParameterTypes();
                if (clazzs.length == arguments.length) {
                    description.append(method.getAnnotation(WebLog.class).description());
                    break;
                }
            }
        }
        return description.toString();
    }
}

怎么使用呢?

因为我们的切点是自定义注解 @WebLog, 所以我们仅仅需要在 Controller 控制器的每个接口方法添加 @WebLog 注解即可,如果我们不想某个接口打印出入参日志,不加注解就可以了:

@WebLog(description = "获取预警管理")
    @ApiOperation("获取预警管理查询信息")
    @PostMapping("getManageEarlyWarn")
    public Result getManageEarlyWarn(@RequestBody ManageEarlyWarnBo manageEarlyWarnBo) {
        return ResultUtil.success(manageEarlyWarnService.getManageEarlyWarn(manageEarlyWarnBo));
    }

只想在开发环境和测试环境中使用?

对于那些性能要求较高的应用,不想在生产环境中打印日志,只想在开发环境或者测试环境中使用,要怎么做呢?我们只需为切面添加 @Profile 就可以了,如下图所示:

@Aspect
@Component
//只在dev本地环境使用
@Profile({"dev", "local"})
@Slf4j
public class WebLogAspect {
    /** 换行符 */
    private static final String LINE_SEPARATOR = System.lineSeparator();

这样就指定了只能作用于 dev 开发环境和 test 测试环境,生产环境 prod 是不生效的!

总结

知识只有分享出来才有价值。如果有问题的话,可以在关于我的页面,通过我的邮箱联系我进行探讨。

Q.E.D.


Remain true to our original aspiration.