利用java aop优雅的保存日志

目标

达到的目标通过自定义注解，注释到类上，将注解作为aop的切点，将这个方法执行耗时，方法名，参数，执行时间 ，记录到日志

demo

• 自定义注解

package com.jsong.wiki.backend.annotation;

import java.lang.annotation.*;

/**
 * @Author: Jsong
 * @Date: 2020/3/22 20:51
 * @Description:
 */
// 注解信息添加到java文档中
@Documented
// 注解生命周期，表示注解会被保留到什么阶段，可选择编译阶段，类加载阶段，运行阶段
@Retention(RetentionPolicy.RUNTIME)
// 注解作用的位置，ElementType.METHOD 作用在方法上
@Target(ElementType.METHOD)
public @interface LogAnnotation {
    String action() default "";
}

• aop切片

package com.jsong.wiki.backend.aop.aspect;

import com.alibaba.fastjson.JSON;
import com.jsong.wiki.backend.annotation.LogAnnotation;
import com.jsong.wiki.backend.entity.LogEntity;
import com.jsong.wiki.backend.service.LogService;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import java.lang.reflect.Method;

/**
 * @Author: Jsong
 * @Date: 2020/3/22 20:48
 * @Description:
 */
@Aspect
@Component
public class LogAspect {

    @Autowired
    private LogService logService;

    /***
     * 切点
     * @date 2020/3/22 21:07
     * @author Jsong
     * @param
     * @return void
     */
    @Pointcut("@annotation(com.jsong.wiki.backend.annotation.LogAnnotation)")
    public void logpointCut() {

    }

//    @Before("createTiemPointCut()")
//    public void before(ProceedingJoinPoint proceedingJoinPoint){
//        Object[] args = proceedingJoinPoint.getArgs();
//        for (Object arg : args) {
//
//        }
//    }

    /***
     * 环绕 执行方法前方法后
     * @date 2020/3/22 21:17
     * @author Jsong
     * @param proceedingJoinPoint
     * @return void
     */
    @Around("logpointCut()")
    public void around(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
        LogEntity logEntity = new LogEntity();
        // 执行开始时间
        Long beginTime = System.currentTimeMillis();
        proceedingJoinPoint.proceed();
        // 执行时长
        long time = System.currentTimeMillis() - beginTime;
        logEntity.setDuration((int) time);

        MethodSignature signature = (MethodSignature) proceedingJoinPoint.getSignature();
        Method method = signature.getMethod();

        LogAnnotation logAnnotation = method.getAnnotation(LogAnnotation.class);
        // 注解上的名字
        String action = logAnnotation.action();
        logEntity.setOperate(action);

        // 类名
        String className = proceedingJoinPoint.getTarget().getClass().getName();
        String methodName = signature.getName();
        logEntity.setMethod(className + "." + methodName);

        Object[] args = proceedingJoinPoint.getArgs();
        String params = null;
        if (args.length > 0) {
            // date对象 变json字符串
//            params = JSON.toJSONString(args);
            params = JSON.toJSONStringWithDateFormat(args, "yyyy-MM-dd HH:mm:ss");
        }
        logEntity.setParams(params);
        logService.saveLog(logEntity);
    }

}

• 测试
  在方法使用自定义注解，然后就可以将这个方法执行的耗时，参数的等信息记录到日志

 	@PostMapping("/newFolder")
    @LogAnnotation(action = "新增文件夹")
    public DataResult addFolder(@RequestBody FolderEntity folderEntity) {
        folderService.addFolder(folderEntity);
        return DataResult.success();
    }