SpringBoot项目自定义注解与切面拦截 增强业务功能

前言

业务需求 需要针对某些敏感请求,把其请求日志记录到mysql数据库当中,于是我打算采用自定义注解标记需要记录的接口,然后通过AOP切面拦截请求 进行业务的增强处理 话不多说 直接上代码

需要引入的依赖

这个依赖是开启SpringBoot项目的aop切面功能

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

整体的业务代码

切面注解代码

/**
 * @Description
 * <p>
 *   自定义操作日志记录注解  在需要记录日志的接口上增加此注解即可
 * </p>
 * @author liang
 * @date 2021/5/31 17:28
 */
@Target({ ElementType.PARAMETER, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Log
{
    /**
     * 模块 
     */
    String title() default "";

    /**
     * 功能
     */
    BusinessType businessType() default BusinessType.OTHER;

    /**
     * 操作人类别
     */
    OperatorType operatorType() default OperatorType.MANAGE;

    /**
     * 是否保存请求的参数
     */
    boolean isSaveRequestData() default true;
}

注解用到的枚举类

BusinessType

/**
 * @Description
 * <p>
 *     业务类型（0其它 1新增 2修改 3删除 4导入） 存入数据库的值就是他在此枚举类中的排序顺序 请注意此点
 * </p>
 * @author liang
 * @date 2021/5/31 17:27
 */
public enum BusinessType
{
    /**
     * 其它
     */
    OTHER,

    /**
     * 新增
     */
    INSERT,

    /**
     * 修改
     */
    UPDATE,

    /**
     * 删除
     */
    DELETE,

    /**
     * 导入
     */
    IMPORT,
}

OperatorType

/**
 * @Description
 * <p>
 *    日志的操作类别（0其它 1后台用户 2手机端用户） 存入数据库的值就是他在此枚举类中的排序顺序 请注意此点
 * </p>
 * @author liang
 * @date 2021/5/31 17:25
 */
public enum OperatorType
{
    /**
     * 0 其它
     */
    OTHER,

    /**
     * 后台用户
     */
    MANAGE,

    /**
     * 手机端用户
     */
    MOBILE
}

注解的拦截处理类

相关注解介绍：

@Aspect:作用是把当前类标识为一个切面供容器读取
@Pointcut：表示此切面配置的织入点,可以在此用表达式把注解配置为切面的织入点
@Around：环绕增强，相当于MethodInterceptor
@AfterReturning：后置增强，相当于AfterReturningAdvice，方法正常退出时执行
@Before：标识一个前置增强方法，相当于BeforeAdvice的功能
@AfterThrowing：异常抛出增强，相当于ThrowsAdvice
@After: final增强，不管是抛出异常或者正常退出都会执行

import com.alibaba.fastjson.JSONObject;
import org.apache.commons.lang3.StringUtils;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.Signature;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.AfterThrowing;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.multipart.MultipartFile;

import javax.annotation.Resource;
import javax.servlet.http.HttpServletRequest;
import java.lang.reflect.Method;
import java.util.Date;


/**
 * @Description
 * <p>
 *    记录日志操作的切面
 * </p>
 * @author liang
 * @date 2021/5/31 17:55
 */
@Aspect
@Component
public class LogAspect
{
    private static final Logger log = LoggerFactory.getLogger(LogAspect.class);

    @Resource
    private OperateLogMapper operateLogMapper;

    // 配置织入点
    @Pointcut("@annotation(***.aspect.annotation.Log)")
    public void logPointCut()
    {
    }

    /**
     * 处理完请求后执行
     *
     * @param joinPoint 切点
     */
    @AfterReturning(pointcut = "logPointCut()", returning = "jsonResult")
    public void doAfterReturning(JoinPoint joinPoint, Object jsonResult)
    {
        handleLog(joinPoint, null, jsonResult);
    }

    /**
     * 拦截异常操作
     * 
     * @param joinPoint 切点
     * @param e 异常
     */
    @AfterThrowing(value = "logPointCut()", throwing = "e")
    public void doAfterThrowing(JoinPoint joinPoint, Exception e)
    {
        handleLog(joinPoint, e, null);
    }

    protected void handleLog(final JoinPoint joinPoint, final Exception e, Object jsonResult)
    {
        try
        {
            // 获得注解
            Log controllerLog = getAnnotationLog(joinPoint);
            if (controllerLog == null)
            {
                return;
            }
            // *========数据库日志=========*//
            HttpServletRequest request = ServletUtils.getRequest();
            OperateLog operateLog = new OperateLog();
            operateLog.setStatus(BusinessStatus.SUCCESS.ordinal());
            // 请求的地址
            operateLog.setOperateIp(CommonUtils.getIpAddress(request));
            // 返回参数
            if (jsonResult instanceof ResultVO){
                operateLog.setJsonResult(StringUtils.substring(((ResultVO) jsonResult).toString(),
                        0, 2000));
            }
            operateLog.setOperateUrl(ServletUtils.getRequest().getRequestURI());
            if (e != null)
            {
                operateLog.setStatus(BusinessStatus.FAIL.ordinal());
                operateLog.setErrorMsg(StringUtils.substring(e.getMessage(), 0, 2000));
            }
            // 设置方法名称
            String className = joinPoint.getTarget().getClass().getName();
            String methodName = joinPoint.getSignature().getName();
            operateLog.setMethod(className + "." + methodName + "()");
            // 设置请求方式
            operateLog.setRequestMethod(request.getMethod());
            operateLog.setOperateTime(new Date());
            // 处理设置注解上的参数
            getControllerMethodDescription(controllerLog, operateLog,joinPoint);
            // 保存数据库
            operateLogMapper.insert(operateLog);
        }
        catch (Exception exp)
        {
            // 记录本地异常日志
            log.error("==前置通知异常==");
            log.error("异常信息:{}", exp.getMessage());
            log.error("exception:", exp);
        }
    }

    /**
     * 获取注解中对方法的描述信息 用于Controller层注解
     * 
     * @param log 日志
     * @param operateLog 操作日志
     */
    public void getControllerMethodDescription(Log log, OperateLog operateLog,JoinPoint joinPoint) {
        // 设置action动作
        operateLog.setBusinessType(log.businessType().ordinal());
        // 设置标题
        operateLog.setTitle(log.title());
        // 设置操作人类别
        operateLog.setOperatorType(log.operatorType().ordinal());
        // 是否需要保存request，参数和值
        if (log.isSaveRequestData())
        {
            // 获取参数的信息，传入到数据库中。
            setRequestValue(operateLog,joinPoint);
        }
    }

    /**
     * 获取请求的参数，放到log中
     */
    private void setRequestValue(OperateLog operateLog,JoinPoint joinPoint)
    {
        // 参数值
        Object[] args = joinPoint.getArgs();
        // 参数名
        String[] argNames = ((MethodSignature)joinPoint.getSignature()).getParameterNames();
        JSONObject params = new JSONObject();
        for (int i = 0; i < args.length; i++) {
            if (null==args[i] || args[i] instanceof MultipartFile || args[i] instanceof HttpServletRequest){
                continue;
            }
            params.put(argNames[i],args[i]);
        }
        if (params.containsKey("vuId")){
            operateLog.setOperateName(Convert.toStr(params.get("vuId")));
        }
        operateLog.setOperateParam(StringUtils.substring(params.toJSONString(), 0, 2000));
    }

    /**
     * 是否存在注解，如果存在就获取
     */
    private Log getAnnotationLog(JoinPoint joinPoint) {
        Signature signature = joinPoint.getSignature();
        MethodSignature methodSignature = (MethodSignature) signature;
        Method method = methodSignature.getMethod();
        if (method != null)
        {
            return method.getAnnotation(Log.class);
        }
        return null;
    }
}

operate_log表结构

-- auto-generated definition
create table operate_log
(
    operate_id       int auto_increment comment '日志主键'
        primary key,
    title            varchar(50)   default '' null comment '模块标题',
    business_type    int           default 0  null comment '业务类型（0其它 1新增 2修改 3删除 4导入）',
    method           varchar(100)  default '' null comment '方法名称',
    request_method   varchar(10)   default '' null comment '请求方式',
    operator_type    int           default 0  null comment '操作类别（0其它 1后台用户 2手机端用户）',
    operate_name     varchar(50)   default '' null comment '操作人员',
    operate_url      varchar(255)  default '' null comment '请求URL',
    operate_ip       varchar(50)   default '' null comment '主机地址',
    operate_location varchar(255)  default '' null comment '操作地点',
    operate_param    varchar(2000) default '' null comment '请求参数',
    json_result      varchar(2000) default '' null comment '返回参数',
    status           int           default 0  null comment '操作状态（0正常 1异常）',
    error_msg        varchar(2000) default '' null comment '错误消息',
    operate_time     datetime                 null comment '操作时间'
)
    comment '操作日志记录表';

create index operate_log_business_type_index
    on operate_log (business_type);

create index operate_log_operate_time_index
    on operate_log (operate_time);

create index operate_log_operate_url_index
    on operate_log (operate_url);