AOP之操作记录浅谈

实战项目中,我们经常要跟 "统一处理" 打交道,比如权限认证、日志、事务处理．AOP将那些与业务无关，却为业务模块所共同调用的逻辑或责任封装起来，便于减少系统的重复代码，降低模块间的耦合度，并有利于未来的可操作性和可维护性．

本篇以操作记录为例,浅谈一下个人总结.分析不到位之处,还望各位游客大牛,给予宝贵建议及意见.

１.pom.xml引入AOP依赖

     

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

２.自定义注解annotation

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface OperateLog {
    
    //自定义属性
    String annotationDesc() default "";

    //根据自己业务所需定义属性  此属性个人定义是为了区分那个模块使用的
    int moduleType() default 0;

    //自定义属性
    String operatorContent() default "";
}

３.aspect切面处理

import com.karo.unicorn.annotation.OperateLog;
import com.karo.unicorn.common.service.CommonService;
import com.karo.unicorn.domain.mapper.OperationLogMapper;
import com.karo.unicorn.enums.BusinessCodeTypeEnum;
import com.karo.unicorn.enums.OperatorModuleEnum;
import com.karo.unicorn.utils.ObjectUtil;
import com.karo.unicorn.utils.date.DateUtils;
import com.karo.unicorn.utils.http.HttpContextUtils;
import com.karo.unicorn.utils.json.JSONUtil;
import lombok.extern.slf4j.Slf4j;
import net.sf.json.JSONObject;
import org.springframework.stereotype.Component;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import java.lang.reflect.Method;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.reflect.MethodSignature;
import com.jds.mall.jdsmall.domain.model.OperationLog;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.LocalVariableTableParameterNameDiscoverer;
import javax.servlet.http.HttpServletRequest;

/**
 * @ClassName OperationLogAspect
 * @Description TODO :              操作日志切面
 * @Author ：Panguaxe
 * @Date 2020-05-13 15:00
 * @Version V1.0
 */
@Slf4j
@Aspect
@Component
public class OperateLogAspect {

    @Autowired
    private CommonService commonService;
    @Autowired
    private OperationLogMapper operationLogMapper;

    @Pointcut("@annotation(com.karo.unicorn.annotation.OperateLog)")
    public void pointcut() {
    }

    @Around("pointcut()")
    public Object around(ProceedingJoinPoint point) {
        Object result = null;
        long beginTime = System.currentTimeMillis();
        try {
            result = point.proceed();// 执行方法
        } catch (Throwable e) {
            log.error("执行方法异常：{}",e.getMessage());
        }
        // 执行时长(毫秒)
        long time = System.currentTimeMillis() - beginTime;
        // 保存日志
        operationLogHandle(point, time);
        return result;
    }
    /**
     * @MethodName:   operationLogHandle
     * @Param:        [joinPoint, time] 
     * @Return:       void
     * @Author:       Panguaxe
     * @Date:         2020-05-13 15:50
     * @Description:  TODO                  操作日志处理
     */
    private void operationLogHandle(ProceedingJoinPoint joinPoint, long time) {
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();

        // 请求的方法参数值
        Object[] args = joinPoint.getArgs();

        JSONObject requestParams = ObjectUtil.isNotBlank(args) ? JSONObject.fromObject(args[0]) : null;
        log.warn("操作日志请求参数：{}",requestParams);


        HttpServletRequest request = HttpContextUtils.getHttpServletRequest();// 获取request

        //TODO 保存参数
        saveOperationLog(signature,request,requestParams);

    }
    /**
     * @MethodName:   saveOperationLog
     * @Param:        [signature, request, requestParams] 
     * @Return:       void
     * @Author:       Panguaxe
     * @Date:         2020-05-13 15:50
     * @Description:  TODO                  保存操作日志 数据保存到数据库 进行持久化
     */
    private void saveOperationLog(MethodSignature signature,HttpServletRequest request,JSONObject requestParams){
        Method method = signature.getMethod();

        String params = null != requestParams ? requestParams.toString() : "";//请求参数
        String mchId = JSONUtil.getValNetsf(requestParams,"mchId");
        String userId = JSONUtil.getValNetsf(requestParams,"userId ");
        //
        OperateLog annotation = method.getAnnotation(OperateLog.class);
        String annotationDesc = ObjectUtil.isNotBlank(annotation) ? annotation.annotationDesc() : "";// 注解上的描述
        Integer operatorModule = ObjectUtil.isNotBlank(annotation) ? annotation.moduleType() : 0;//模块类型
        String operatorContent = ObjectUtil.isNotBlank(annotation) ? annotation.operatorContent() : "";//操作内容

        String ipAddr = HttpContextUtils.getIpAddr(request);
        // 请求的方法名
        //String className = joinPoint.getTarget().getClass().getName();
        String methodName = signature.getName();
        //表的唯一标识 自定义生成规则生成id  根据自己业务 自增  uuid等等都可以
        Long operationLogId = commonService.idRuleGenerate(mchId, 9, BusinessCodeTypeEnum.LOG_OPERATION_ID.getSerialno(), 7);
        String operatorModuleName = OperatorModuleEnum.operatorModuleName(operatorModule);
        OperationLog operationLog = new OperationLog();//操作日志对象
        operationLog.setShopId(commonService.getShopId(mchId));
        operationLog.setOperationLogId(operationLogId);
        operationLog.setOperatorId(userId);
//      operationLog.setOperatorName();
//      operationLog.setOperatorMobile();
        operationLog.setOperatorModule(operatorModule);
        operationLog.setOperatorModuleName(operatorModuleName);
        operationLog.setOperatorContent(annotationDesc + "接口：" + operatorContent.replace("Operator",userId));
        operationLog.setMethod(methodName);
        operationLog.setParams(params);
        operationLog.setTerminalIp(ipAddr);
        operationLog.setCreateTime(DateUtils.getCurrentTime());
        log.warn("操作日志保存信息：{}", JSONObject.fromObject(operationLog));
        operationLogMapper.insertSelective(operationLog);
    }
}

数据库操作日志表SQL

/*
 Navicat Premium Data Transfer
*/

SET NAMES utf8mb4;
SET FOREIGN_KEY_CHECKS = 0;

-- ----------------------------
-- Table structure for tab_record_operation_log
-- ----------------------------
DROP TABLE IF EXISTS `tab_record_operation_log`;
CREATE TABLE `tab_record_operation_log`  (
  `id` int(11) NOT NULL AUTO_INCREMENT COMMENT 'ID',
  `shop_id` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '商户ID',
  `operation_log_id` bigint(20) NULL DEFAULT NULL COMMENT '操作记录ID',
  `operator_id` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '操作人ID',
  `operator_name` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '操作人姓名/昵称',
  `operator_mobile` varchar(20) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '操作人联系方式',
  `operator_module` int(3) NULL DEFAULT NULL COMMENT '操作模块：1-登录模块、2-订单模块…………',
  `operator_module_name` varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '操作模块名',
  `operator_content` text CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL COMMENT '操作内容',
  `method` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '请求方法',
  `params` text CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL COMMENT '请求参数',
  `terminal_ip` varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '终端IP',
  `create_time` datetime(0) NULL DEFAULT NULL COMMENT '操作时间',
  PRIMARY KEY (`id`) USING BTREE,
  INDEX `idx_shop_id`(`shop_id`) USING BTREE,
  INDEX `idx_operator_name`(`operator_name`) USING BTREE,
  INDEX `idx_create_time`(`create_time`) USING BTREE,
  INDEX `idx_operator_module`(`operator_module`) USING BTREE
) ENGINE = InnoDB AUTO_INCREMENT = 20 CHARACTER SET = utf8mb4 COLLATE = utf8mb4_general_ci ROW_FORMAT = Dynamic;

SET FOREIGN_KEY_CHECKS = 1;

需要保存操作记录的接口上加上注解．使用方法:

@OperateLog(annotationDesc = "权限设置",moduleType = 1,operatorContent = "Operator 进行了员工的权限设置")