自定注解，记录接口操作记录

最新推荐文章于 2024-07-20 23:55:03 发布

qq_28323343

最新推荐文章于 2024-07-20 23:55:03 发布

阅读量167

点赞数 1

分类专栏： Java aop 文章标签： java

本文链接：https://blog.csdn.net/qq_28323343/article/details/138218827

版权

Java aop 专栏收录该内容

1 篇文章 0 订阅

订阅专栏

本文介绍了如何在SpringBoot项目中使用自定义注解`@Log`记录API接口的操作日志，包括模块、功能、操作类型等，并展示了如何在控制器层和切面类中实现日志处理。

摘要由CSDN通过智能技术生成

一，自定义注解

package com.XXX.common.log.annotation;

import com.XXX.common.log.enums.BusinessType;
import com.XXX.common.log.enums.OperatorType;

import java.lang.annotation.*;

/**
 * 自定义操作日志记录注解
 *
 * @author XXX
 */
@Target({ElementType.PARAMETER, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Log {
    /**
     * 模块
     */
    public String title() default "";

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

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

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

    /**
     * 是否保存响应的参数
     */
    public boolean isSaveResponseData() default true;
}

二，在接口层（Controller）

package com.XXX.call.controller;

import cn.hutool.core.collection.CollUtil;
import com.XXX.call.domain.TBlackList;
import com.XXX.call.domain.vo.BlackErrorExportVO;
import com.XXX.call.domain.vo.BlacklistExportVO;
import com.XXX.common.core.utils.poi.ExcelUtil;
import com.XXX.common.core.web.controller.BaseController;
import com.XXX.common.core.web.domain.AjaxResult;
import com.XXX.common.log.annotation.Log;
import com.XXX.common.log.enums.BusinessType;
import lombok.extern.slf4j.Slf4j;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;

import javax.servlet.http.HttpServletResponse;
import java.io.ByteArrayInputStream;
import java.util.ArrayList;
import java.util.List;

@Slf4j
@RestController
@RefreshScope
@RequestMapping("/blacklist")
public class BlacklistController extends BaseController {

    /**
     * 删除黑名单
     */
    //@RequiresPermissions("blacklist:config:remove")
    @Log(title = "删除黑名单", businessType = BusinessType.DELETE)
    @PostMapping("/deleteBlacklist")
    public AjaxResult deleteBlacklist(@RequestBody TBlackList req) {
        return AjaxResult.success();
    }


    /**
     * 编辑黑名单
     */
    //@RequiresPermissions("blacklist:config:edit")
    @Log(title = "编辑黑名单", businessType = BusinessType.UPDATE)
    @PostMapping("/editBlacklist")
    public AjaxResult editBlacklist(@Validated @RequestBody TBlackList req) {
        return AjaxResult.success();
    }


    /**
     * 添加黑名单
     */
    //@RequiresPermissions("blacklist:config:add")
    @Log(title = "添加黑名单", businessType = BusinessType.INSERT)
    @PostMapping("/addBlacklist")
    public AjaxResult addBlacklist(@Validated @RequestBody TBlackList req) {
        return AjaxResult.success();
    }

    /**
     * 导出黑名单
     */
    @Log(title = "导出黑名单", businessType = BusinessType.EXPORT)
    //@RequiresPermissions("blacklist:config:export")
    @PostMapping("/blacklistExport")
    public void blacklistExport(HttpServletResponse response, @RequestBody TBlackList req) {
        ExcelUtil<BlacklistExportVO> util = new ExcelUtil<>(BlacklistExportVO.class);
        util.exportExcel(response, new ArrayList<>(), "黑名单列表");
    }


    /**
     * 导入黑名单
     */
    @Log(title = "导入黑名单", businessType = BusinessType.IMPORT)
    //@RequiresPermissions("blacklist:config:upload")
    @PostMapping("blackUpload")
    public AjaxResult blackUpload(HttpServletResponse response, MultipartFile file) {
        try {
            ExcelUtil<BlackErrorExportVO> excelUtil = new ExcelUtil<>(BlackErrorExportVO.class);
            //文件进行excel解析 , 空行是自动跳过的
            List<BlackErrorExportVO> inList = excelUtil.importExcel(new ByteArrayInputStream(file.getBytes()));
            if (CollUtil.isEmpty(inList)) {
                return AjaxResult.error("文件没有解析到数据");
            }
            return AjaxResult.success("导入成功");
        } catch (Exception e) {
            log.error("黑名单文件上传解析报错:", e);
            return AjaxResult.error("黑名单文件上传解析报错");
        }
    }
}

三，自定义注解实现

package com.XXX.common.log.aspect;

import com.alibaba.fastjson2.JSON;
import com.XXX.common.core.utils.ServletUtils;
import com.XXX.common.core.utils.StringUtils;
import com.XXX.common.core.utils.ip.IpUtils;
import com.XXX.common.log.annotation.Log;
import com.XXX.common.log.enums.BusinessStatus;
import com.XXX.common.log.filter.PropertyPreExcludeFilter;
import com.XXX.common.log.service.AsyncLogService;
import com.XXX.common.security.utils.SecurityUtils;
import com.XXX.system.api.domain.SysOperLog;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.AfterThrowing;
import org.aspectj.lang.annotation.Aspect;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpMethod;
import org.springframework.stereotype.Component;
import org.springframework.validation.BindingResult;
import org.springframework.web.multipart.MultipartFile;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Collection;
import java.util.Map;

/**
 * 操作日志记录处理
 *
 * @author XXX
 */
@Aspect
@Component
public class LogAspect {
    private static final Logger log = LoggerFactory.getLogger(LogAspect.class);

    /**
     * 排除敏感属性字段
     */
    public static final String[] EXCLUDE_PROPERTIES = {"password", "oldPassword", "newPassword", "confirmPassword"};

    @Autowired
    private AsyncLogService asyncLogService;

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

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

    protected void handleLog(final JoinPoint joinPoint, Log controllerLog, final Exception e, Object jsonResult) {
        try {
            // *========数据库日志=========*//
            SysOperLog operLog = new SysOperLog();
            operLog.setStatus(BusinessStatus.SUCCESS.ordinal());
            // 请求的地址
            String ip = IpUtils.getIpAddr(ServletUtils.getRequest());
            operLog.setOperIp(ip);
            operLog.setOperUrl(StringUtils.substring(ServletUtils.getRequest().getRequestURI(), 0, 255));
            String username = SecurityUtils.getUsername();
            if (StringUtils.isNotBlank(username)) {
                operLog.setOperName(username);
            }

            if (e != null) {
                operLog.setStatus(BusinessStatus.FAIL.ordinal());
                operLog.setErrorMsg(StringUtils.substring(e.getMessage(), 0, 2000));
            }
            // 设置方法名称
            String className = joinPoint.getTarget().getClass().getName();
            String methodName = joinPoint.getSignature().getName();
            operLog.setMethod(className + "." + methodName + "()");
            // 设置请求方式
            operLog.setRequestMethod(ServletUtils.getRequest().getMethod());
            // 处理设置注解上的参数
            getControllerMethodDescription(joinPoint, controllerLog, operLog, jsonResult);
            // 保存数据库
            asyncLogService.saveSysLog(operLog);
        } catch (Exception exp) {
            // 记录本地异常日志
            log.error("异常信息:{}", exp.getMessage());
            exp.printStackTrace();
        }
    }

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

    /**
     * 获取请求的参数，放到log中
     *
     * @param operLog 操作日志
     * @throws Exception 异常
     */
    private void setRequestValue(JoinPoint joinPoint, SysOperLog operLog) throws Exception {
        String requestMethod = operLog.getRequestMethod();
        if (HttpMethod.PUT.name().equals(requestMethod) || HttpMethod.POST.name().equals(requestMethod)) {
            String params = argsArrayToString(joinPoint.getArgs());
            operLog.setOperParam(StringUtils.substring(params, 0, 2000));
        } else {
            Map<?, ?> paramsMap = ServletUtils.getParamMap(ServletUtils.getRequest());
            operLog.setOperParam(StringUtils.substring(JSON.toJSONString(paramsMap, excludePropertyPreFilter()), 0, 2000));
        }
    }

    /**
     * 参数拼装
     */
    private String argsArrayToString(Object[] paramsArray) {
        String params = "";
        if (paramsArray != null && paramsArray.length > 0) {
            for (Object o : paramsArray) {
                if (StringUtils.isNotNull(o) && !isFilterObject(o)) {
                    try {
                        String jsonObj = JSON.toJSONString(o, excludePropertyPreFilter());
                        params += jsonObj.toString() + " ";
                    } catch (Exception e) {
                    }
                }
            }
        }
        return params.trim();
    }

    /**
     * 忽略敏感属性
     */
    public PropertyPreExcludeFilter excludePropertyPreFilter() {
        return new PropertyPreExcludeFilter().addExcludes(EXCLUDE_PROPERTIES);
    }

    /**
     * 判断是否需要过滤的对象。
     *
     * @param o 对象信息。
     * @return 如果是需要过滤的对象，则返回true；否则返回false。
     */
    @SuppressWarnings("rawtypes")
    public boolean isFilterObject(final Object o) {
        Class<?> clazz = o.getClass();
        if (clazz.isArray()) {
            return clazz.getComponentType().isAssignableFrom(MultipartFile.class);
        } else if (Collection.class.isAssignableFrom(clazz)) {
            Collection collection = (Collection) o;
            for (Object value : collection) {
                return value instanceof MultipartFile;
            }
        } else if (Map.class.isAssignableFrom(clazz)) {
            Map map = (Map) o;
            for (Object value : map.entrySet()) {
                Map.Entry entry = (Map.Entry) value;
                return entry.getValue() instanceof MultipartFile;
            }
        }
        return o instanceof MultipartFile || o instanceof HttpServletRequest || o instanceof HttpServletResponse
                || o instanceof BindingResult;
    }
}