springboot + springbootMVC + springAOP 基于注解的方式实现系统操作日志功能（附带源码及bug解决）

1
2
3
4
5
6
7
8
9
10
11
12
13
@Target 加在注解上，限定该注解的使用位置。
@Retention（注解的保留策略）  RetentionPolicy.(SOURCE/ClASS/RUNTIME)  源文件、类、运行时
@Inherited：说明子类可以继承父类中的该注解
@Repeatable 表示注解可以重复使用。
 

    
@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface SystemLog {
    
    String msg() default null;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
@Aspect：用于定义切面
@Before：通知方法会在目标方法调用之前执行
@After：通知方法会在目标方法返回或抛出异常后执行
@AfterReturning：通知方法会在目标方法返回后执行
@AfterThrowing：通知方法会在目标方法抛出异常后执行
@Around：通知方法会将目标方法封装起来
@Pointcut：定义切点表达式

切点表达式：指定了通知被应用的范围，表达式格式：
execution(方法修饰符 返回类型 方法所属的包.类名.方法名称(方法参数)
//com.hs.demo.controller包中所有类的public方法都应用切面里的通知
execution(public * com.demo.controller.*.*(..))
//com.hs.demo.service包及其子包下所有类中的所有方法都应用切面里的通知
execution(* com.demo.service..*.*(..))
//com.hs.demo.service.EmployeeService类中的所有方法都应用切面里的通知
execution(* com.demo.service..*(..))


切面定义示例

示例 
@within 拦截类下面所有方法
@annotation  拦截方法
  
第一种方式
@Pointcut(value = "execution(public * com.train.aop.controller.AopController.*(..))")
public void SystemLog() {
}

第二种
@Pointcut("@within(com..user.domain.annotation.SystemLog)" +
        "|| @annotation(com..user.domain.annotation.SystemLog)")
public void SystemLog() {
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

@ApiModel("系统操作日志")
@Data
public class OperationLog{

    @ApiModelProperty(notes = "用户名", value = "用户名")
    private String username;
    
    @ApiModelProperty(notes = "姓名", value = "姓名")
    private String name;
    
    @ApiModelProperty(notes = "操作模块", value = "操作模块")
    private String module;
    
    @ApiModelProperty(notes = "操作功能", value = "操作功能")
    private String functionName;
    
    @ApiModelProperty(notes = "请求地址", value = "请求地址")
    private String url;
    
    @ApiModelProperty(notes = "请求方式", value = "请求方式")
    private String method;
    
    @ApiModelProperty(notes = "请求结果", value = "请求结果")
    private String result;

    @ApiModelProperty(notes = "请求参数", value = "请求参数")
    private String parameter;
    
    @ApiModelProperty(notes = "调用方法", value = "调用方法")
    private String methodInfo;
    
    @ApiModelProperty(notes = "用户ip", value = "用户ip")
    private String ip;
    
    @ApiModelProperty(notes = "返回结果", value = "返回结果")
    private String resultInfo;
    
    @ApiModelProperty(notes = "信息", value = "信息")
    private String message;

}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
@Aspect
@Slf4j
@Component
public class SystemLogAspect { 

    @Autowired
    private OperationLogService operationLogService;

    @Pointcut("@within(com.user.domain.annotation.SystemLog)" +
            "|| @annotation(com.user.domain.annotation.SystemLog)")
    public void SystemLog() {

    }

}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
/**
     * 插入系统操作日志
     * @param joinPoint
     * @return
     */
    @Around(value = "SystemLog()")
    private Object handleLog(ProceedingJoinPoint joinPoint) {

        OperationLog operationLog = new OperationLog();

        Object returnVO;

        //拿到 HttpServletRequest
        ServletRequestAttributes sra = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = sra.getRequest();

        //记录请求方法、ip、uri
        operationLog.setMethod(request.getMethod());
        operationLog.setIp(RequestUtil.realIP(request));
        operationLog.setUrl(request.getRequestURI());

        //拿到 用户信息，使用的是项目内部的方法，此处可以去掉
        UserInfo userInfo = UserUtil.getUserInfo();
        Optional.of(userInfo).ifPresent(v -> {
            operationLog.setUsername(userInfo.getUsername());
            operationLog.setName(userInfo.getName());
        });
        CommonDomainUtil.setAddBaseParam(operationLog);


        try {
            //拿到类及方法信息
            Class<?> clazz = joinPoint.getTarget().getClass();
            Signature signature = joinPoint.getSignature();
            String methodName = signature.getName();
            
            Class<?>[] parameterTypes = ((MethodSignature)     
            signature).getMethod().getParameterTypes();
            Method method = clazz.getMethod(methodName, parameterTypes);
            Object[] arguments = joinPoint.getArgs();

            //模块及方法注解，获取 swagger的注解消息
            Api api = clazz.getAnnotation(Api.class);
            ApiOperation apiOperation = method.getAnnotation(ApiOperation.class);

            //设置类及方法信息
            operationLog.setModule(StringUtils.join(api.tags(), ","));
            operationLog.setFunctionName(apiOperation.value());
            operationLog.setParameter(Arrays.toString(arguments));
            operationLog.setMethodInfo(method.toString());

            returnVO = joinPoint.proceed(arguments);
        } catch (Throwable e) {
            //如果发生异常，则保存异常信息
            operationLog.setResult(Result.FAIL);
            operationLog.setMessage(e.getMessage());
            operationLogService.save(operationLog);
            throw new RuntimeException(e);
        }

        operationLog.setResult(Result.SUCCESS);
        operationLog.setResultInfo(JSON.toJSONString(returnVO));

        operationLogService.save(operationLog);
        return returnVO;
    }

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
@SystemLog
@Api(tags = "用户管理-用户信息")
@Slf4j
@RestController
@RequestMapping("/api/v1/sys/user")
public class SysUserController {

    @Autowired
    private SysUserService sysUserService;

    @SystemLog
    @ApiOperation(value = "分页查询用户列表")
    @PostMapping("/page")
    public ReturnVO<PageInfo<UserInfo>> pageList(@Validated @RequestBody UserSearchVo searchVo) {
        return ReturnVO.success(new PageInfo<>(sysUserService.pageList(searchVo)));
    }