Aop实现webLog

向pom.xml添加依赖（也可以在SpringBoot中直接引用）

<!-- aop 依赖 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<!-- 用于日志切面中，以json格式打印出入参 -->
<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
    <version>2.8.5</version>
</dependency>

WebLog注解类

package com.kaer.mark85.aspect;
import org.springframework.core.annotation.AliasFor;

import java.lang.annotation.*;

/**
 * webLog 注解
 * <p>
 * 运行时、作用于方法上
 * </p>
 *
 * @author 卡尔
 * @date 2021/10/13 11:31
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
@Documented
public @interface WebLog {

    @AliasFor("description")
    String value() default "";

    /**
     * 日志描述信息
     *
     * @return java.lang.String
     * @author 卡尔
     * @date 2021/10/13 11:34
     */
    @AliasFor("value")
    String description() default "";
}

切面类WebLogAspect

package com.kaer.mark85.aspect;

import com.google.gson.Gson;
import com.youxiake.context.data.web.YXkApiResponse;
import com.youxiake.platform.base.auth.IAuthService;
import com.youxiake.security.context.SecurityContextHolder;
import com.youxiake.utils.IntegerUtil;
import lombok.RequiredArgsConstructor;
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.util.StringUtils;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;
import java.lang.reflect.Method;

/**
 * webLog切面类
 *
 * @author 卡尔
 * @date 2021/10/13 11:35
 */
@Slf4j
@Aspect
@Component
@Profile({"dev", "test"})
@AllArgsConstructor
public class WebLogAspect {

    private final IAuthService iAuthService;

    /**
     * 换行符
     */
    private static final String LINE_SEPARATOR = System.lineSeparator();

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

    /**
     * 在切点之前织入
     *
     * @param joinPoint
     * @return
     * @throws Throwable
     * @author 卡尔
     * @date 2021/10/13 11:49
     */
    @Before("webLog()")
    public void doBefore(JoinPoint joinPoint) throws Throwable {
        // 开始打印请求日志
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();

        // 获取 @WebLog 注解的描述信息
        String methodDescription = getAspectLogDescription(joinPoint);

        // 打印请求相关参数
        log.info("========================================== Start ==========================================");
        // 打印请求 url
        log.info("URL            : {}", request.getRequestURL().toString());
        // 打印描述信息
        log.info("Description    : {}", methodDescription);
        // 打印 Http method
        log.info("HTTP Method    : {}", request.getMethod());
        // 打印调用 controller 的全路径以及执行方法
        log.info("Class Method   : {}.{}", joinPoint.getSignature().getDeclaringTypeName(),
                joinPoint.getSignature().getName());
        // 打印请求的 IP
        log.info("IP             : {}", request.getRemoteAddr());
        // 打印请求入参
        log.info("Request Args   : {}", new Gson().toJson(joinPoint.getArgs()));
        // 打印请求用户 // TODO: 2021/10/13 kaer 根据实际修改
        // int uid = SecurityContextHolder.getSecurityContext().getSafeUid();
        // log.info("Request user   : {}", new Gson().toJson(uid + ":" + getAdminName(uid)));
    }

    /**
     * 在切点之后织入
     *
     * @param
     * @return void
     * @throws Throwable
     * @author 卡尔
     * @date 2021/10/13 11:49
     */
    @After("webLog()")
    public void doAfter() throws Throwable {
        // 接口结束后换行，方便分割查看
        log.info("=========================================== End ===========================================" + LINE_SEPARATOR);
    }

    /**
     * 环绕
     *
     * @param proceedingJoinPoint
     * @return java.lang.Object
     * @throws Throwable
     * @author 卡尔
     * @date 2021/10/13 11:49
     */
    @Around("webLog()")
    public Object doAround(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
        long startTime = System.currentTimeMillis();
        Object result = proceedingJoinPoint.proceed();
        // 打印出参
        log.info("Response Args  : {}", new Gson().toJson(result));
        // 执行耗时
        log.info("Time-Consuming : {} ms", System.currentTimeMillis() - startTime);
        return result;
    }

    /**
     * 获取切面注解的描述
     *
     * @param joinPoint 切点
     * @return 描述信息
     * @throws Exception
     * @author 卡尔
     * @date 2021/10/13 11:48
     */
    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) {
                    String des = method.getAnnotation(WebLog.class).description();
                    String value = method.getAnnotation(WebLog.class).value();
                    if (!StringUtils.isEmpty(des)) {
                        description.append(des);
                    } else {
                        description.append(value);
                    }
                    break;
                }
            }
        }
        return description.toString();
    }

    /**
     * 根据adminId获取adminName
     *
     * @param adminId
     * @return java.lang.String
     * @author 卡尔
     * @date 2021/8/31 18:27
     */
    private String getAdminName(Integer adminId) {
        String adminName = "";
        if (IntegerUtil.isNullOrZero(adminId)) {
            return adminName;
        }
        YXkApiResponse<String> apiResponse = iAuthService.getAdminNameById(adminId);
        if (apiResponse.hasSucc() && apiResponse.getData() != null) {
            adminName = apiResponse.getData();
        }
        return adminName;
    }
}

具体使用 在Controller的方法上加上@WebLog注解