Springboot中Aspect切面的实现方式(以记录日志为例)

<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

<dependency>
 <groupId>com.Google.code.gson</groupId>
 <artifactId>gson</artifactId>
 <version>2.8.1</version>
</dependency>

<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-devtools</artifactId>
 <scope>runtime</scope>
</dependency>
<dependency>
 <groupId>org.projectlombok</groupId>
 <artifactId>lombok</artifactId>
 <optional>true</optional>
</dependency>

package com.space.aspect.bo; 
import lombok.Data; 

@Data
public class SysLogBO { 
    private String className;
    private String methodName; 
    private String params; 
    private Long exeuTime; 
    private String remark; 
    private String createDate;
}
package com.space.aspect.service; 
import com.space.aspect.bo.SysLogBO;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Service;
 

@Slf4j
@Service
public class SysLogService {
 
    public boolean save(SysLogBO sysLogBO){
        // 这里就不做具体实现了
        log.info(sysLogBO.getParams());
        return true;
    }
}

package com.space.aspect.anno;
import java.lang.annotation.*;
 

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface SysLog {
    String value() default "";
}

package com.space.aspect.aspect;
import com.google.gson.Gson;
import com.space.aspect.anno.SysLog;
import com.space.aspect.bo.SysLogBO;
import com.space.aspect.service.SysLogService;
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;
import java.text.SimpleDateFORMat;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
 

@Aspect  // 使用@Aspect注解声明一个切面
@Component
public class SysLogAspect {
    @Autowired
    private SysLogService sysLogService;
 
    
    @Pointcut("@annotation(com.space.aspect.anno.SysLog)")
    public void logPointCut() {}
 
    
    @Around("logPointCut()")
    public Object around(ProceedingJoinPoint point) throws Throwable {
        long beginTime = System.currentTimeMillis();
        Object result = point.proceed();
        long time = System.currentTimeMillis() - beginTime;
        try {
            saveLog(point, time);
        } catch (Exception e) {
        }
        return result;
    }
 
    
    private void saveLog(ProceedingJoinPoint joinPoint, long time) {
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method method = signature.getMethod();
        SysLogBO sysLogBO = new SysLogBO();
        sysLogBO.setExeuTime(time);
        SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd hh:mm:ss");
        sysLogBO.setCreateDate(dateFormat.format(new Date()));
        SysLog sysLog = method.getAnnotation(SysLog.class);
        if(sysLog != null){
            //注解上的描述
            sysLogBO.setRemark(sysLog.value());
        }
        //请求的 类名、方法名
        String className = joinPoint.getTarget().getClass().getName();
        String methodName = signature.getName();
        sysLogBO.setClassName(className);
        sysLogBO.setMethodName(methodName);
        //请求的参数
        Object[] args = joinPoint.getArgs();
        try{
            List<String> list = new ArrayList<String>();
            for (Object o : args) {
                list.add(new Gson().toJSON(o));
            }
            sysLogBO.setParams(list.toString());
        }catch (Exception e){ }
        sysLogService.save(sysLogBO);
    }
}

package com.space.aspect.controller;
import com.space.aspect.anno.SysLog;
import org.springframework.WEB.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
 

@RestController
public class TestController {
    @SysLog("测试")
    @GetMapping("/test")
    public String test(@RequestParam("name") String name){
        return name;
    }
}

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface LogMessage {
 
    
    String value() default "";
 
    
    @AliasFor("value")
    String description() default "";
 
    
    boolean parameterPrint() default true;
}

@Slf4j
@Aspect
@Component
public class LogAspect {
 
    
    @Before("within(com.xxx.xxx..*) && @annotation(logManage)")
    public void addBeforeLogger(JoinPoint joinPoint, LogMessage logManage) {
        log.info("[{}] Start", logManage.value());
        // 处理参数
        try {
            if (logManage.parameterPrint()) {
                Object[] args = joinPoint.getArgs(); // 参数值
                String[] argNames = ((MethodSignature) joinPoint.getSignature()).getParameterNames();
                Map<String, Object> paramsMap = new HashMap<>();
                StringBuilder sb = new StringBuilder();
                if (args != null && args.length > 0) {
                    for (int i = 0; i < args.length; i++) {
                        paramsMap.put(argNames[i], args[i] != null ? args[i].toString() : "");
                    }
 
                    for (Map.Entry<String, Object> entry : paramsMap.entrySet()) {
                        sb.append(entry.geTKEy()).append(":").append(entry.getValue()).append(";");
                    }
                }
                log.info("[方法名称：{}，方法参数：{}", ((MethodSignature) joinPoint.getSignature()).getMethod().getName(), sb.toString());
            }
        } catch (Exception e) {
            log.info("切面日志打印异常！");
        }
    }
 
    
    @AfterReturning("within(com.xxx.xxx..*) && @annotation(logManage)")
    public void addAfterReturningLogger(JoinPoint joinPoint, LogMessage logManage) {
        log.info("[{}] End", logManage.value());
    }
}

@LogMessage("测试日志打印")
@GetMapping(value = "/test", produces = MediaType.APPLICATION_jsON_UTF8_VALUE)
public void xxx() {
 log.info("test");
}