springboot 基于AOP注解的方式实现系统操作日志

目录

前言

思路

技术储备

java注解

Spring AOP

实现步骤

定义日志类

定义一个切面类编写切面

切面环绕通知

cotroller配置

附录(一个bug)

---

前言

先看需求，最近项目有个模块要求可以记录人员的每一步操作，并且后台可以查看记录。设计图如下：

思路

基于需求，思考了下，首先，每个模块需要可配置化，且需要灵活配置到各个类和方法上；其次，需要一个统一的模块去处理日志相关的东西。因此我选择了基于注解的方式，可以灵活配置到方法或者类上。然后基于springAOP实现统一的拦截和日志功能。

技术储备

java注解

注解同 classs 和 interface 一样，注解也属于一种类型。它是在 Java SE 5.0 版本中开始引入的概念。类似于标签的概念，基础用法如下

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

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

Spring AOP

AOP，即 Aspect Oriented Programming：面向切面编程，将程序抽象成各个切面，spring的核心概念之一，可以拦截指定的方法并且对方法增强，而且无需侵入到业务代码中，采取横向抽取机制（动态代理），取代了传统纵向继承机制的重复性代码，其应用主要体现在事务处理、日志管理、权限控制、异常处理等方面。

几个AOP的核心概念：

• 切面（Aspect）：切面是通知和切点的结合。
• 连接点（join point）: 连接点表示应用执行过程中能够插入切面的一个点，这个点可以是方法的调用、异常的抛出。在 Spring AOP 中，连接点总是方法的调用。
• 通知（Advice）: AOP 框架中的增强处理。通知描述了切面何时执行以及如何执行增强处理。
• 目标对象（Target）：目标对象指将要被增强的对象。
• 切点（PointCut）: 可以插入增强处理的连接点。
• 引入（Introduction）：引入允许我们向现有的类添加新的方法或者属性。
• 织入（Weaving）: 将增强处理添加到目标对象中，并创建一个被增强的对象，这个过程就是织入。
• 顾问（Advisor）：顾问是Advice的一种包装体现，Advisor是Pointcut以及Advice的一个结合，用来管理Advice和Pointcut。

相关解释

@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() {
}

实现步骤

定义日志类

有些使用了swagger的注解

@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;

}

定义一个切面类编写切面

具体代码如下：

@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() {

    }

}

切面环绕通知

需求为当调用方法后，如果方法正常需要插入操作日志，异常的话，需要记录异常信息，所以需要捕获异常信息，并且需要拿到相关的返回值及相关参数，具体实现都在下面方法注释

/**
     * 插入系统操作日志
     * @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;
    }

cotroller配置

@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)));
    }

controller如下，使用AOP捕获了swagger  @Api注解中的信息作为模块，@ApiOperation中的注解作为操作的数据，将自定义的@SystemLog注解加到了 类上

启动项目，调用方法类，可以看到日志数据成功插入

 最终的返回数据如下：

至此，操作日志的集成算是完成了 

附录(一个bug)

当controller类中的方法为private修饰时，会发生报错的情况

原因及解决：

Spring AOP使用的是CGLIB代理，该代理的原理是：

动态生成一个要代理类的子类，子类重写要代理的类的所有不是final的方法。在子类中采用方法拦截的技术拦截所有父类方法的调用，顺势织入横切逻辑。它比使用java反射的JDK动态代理要快。

换言之，由CGLIB创建的代理类，不会包含父类中的私有方法。另外由于CGLIB代理类的生成过程，决定了其成员(无论是private还是protected)均是null。

或者说调用private/public方法时，对象是代理对象还是实际的spring管理的controller对象。进入目标方法时，private类型时当前this是代理对象，public类型时当前this是际的spring管理的controller对象。

解决：将方法修饰符改为public