使用切面在controller层记录操作日志

原创已于 2023-01-29 17:39:26 修改 · 809 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#java #spring #开发语言

于 2023-01-29 17:27:40 首次发布

日志切面

package com.feedback.service.common.aop.log;

import cn.hutool.core.exceptions.ExceptionUtil;
import cn.hutool.json.JSONUtil;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.Signature;
import org.aspectj.lang.annotation.AfterThrowing;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

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

/**
 * 日志aop
 */
@Slf4j
@Aspect
@Component
public class LogAop {

    @Resource
    private OperationLogClient operationLogClient;

    @Value("${spring.application.name}")
    private String applicationName;


    @Pointcut(value = "@annotation(com.haier.hopm.feedback.api.common.annotations.Log)")
    public void cutService() {
    }

    @Around("cutService()")
    public Object recordSysLog(ProceedingJoinPoint point) throws Throwable {
        long startTime = System.currentTimeMillis();
        //先执行业务
        Object result = point.proceed();
        long endTime = System.currentTimeMillis();
        try {
            handle(point, endTime - startTime, UserUtil.getUserInfo(), JSONUtil.toJsonStr(result), null);
        } catch (Exception e) {
            log.error("日志记录出错!", e);
        }
        return result;
    }

    @AfterThrowing(pointcut = "cutService()", throwing = "e")
    public void doAfterThrowing(JoinPoint point, Throwable e) {
        try {
            handle(point, null, UserUtil.getUserInfo(), null, e);
        } catch (Exception ex) {
            log.error("日志记录出错!", ex);
        }
    }

    private void handle(JoinPoint point, Long methodProcessTime, SysUserDTO sysUserDTO, String outParamStr, Throwable e) throws Exception {
        //获取拦截的方法名
        Signature sig = point.getSignature();
        MethodSignature msig = null;
        if (!(sig instanceof MethodSignature)) {
            throw new IllegalArgumentException("该注解只能用于方法");
        }
        msig = (MethodSignature) sig;
        Object target = point.getTarget();
        Method currentMethod = target.getClass().getMethod(msig.getName(), msig.getParameterTypes());
        String methodName = currentMethod.getName();
        //获取拦截方法的参数
        Object[] params = point.getArgs();
        //获取操作名称
        Log annotation = currentMethod.getAnnotation(Log.class);
        String moduleName = annotation.moduleName();
        String operationName = annotation.value();
        OperationLogDTO operationLog = new OperationLogDTO();
        operationLog.setModuleName(applicationName);
        operationLog.setOperationName(operationName);
        operationLog.setMethodName(methodName);
        //sysLog.setParams(Arrays.toString(params));
        operationLog.setParamJson(JSONUtil.toJsonStr(params));
        operationLog.setResultJson(outParamStr);
        operationLog.setTime(methodProcessTime);
        operationLog.setRequestUrl(RequestContextHolderUtil.requestUrl());
        operationLog.setRequestMethod(RequestContextHolderUtil.requestMethod());
        operationLog.setUserAgent(RequestContextHolderUtil.getUserAgent());
        operationLog.setIp(RequestContextHolderUtil.getRemoteAddr());
        operationLog.setSuccess(Boolean.TRUE);
        operationLog.setCreateTime(new Date());
        if (sysUserDTO != null) {
            operationLog.setCreateBy(sysUserDTO.getUserAccount());
            operationLog.setCreateByName(sysUserDTO.getUserName());
        }
        if (e != null) {
            operationLog.setSuccess(Boolean.FALSE);
            operationLog.setErrorMsg(ExceptionUtil.getMessage(e));
        }
        operationLogClient.save(operationLog);
    }

}

日志注解

package com.feedback.api.common.annotations;

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

/**
 * 系统日志注解
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface Log {
    String value() default "";

    String moduleName() default "";

}

保存日志实体类

package com.feedback.api.dto;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import lombok.EqualsAndHashCode;

@Data
@EqualsAndHashCode(callSuper = false)
@ApiModel(value = "OperationLogDTO", description = "系统操作日志表")
public class OperationLogDTO extends BaseDTO {

    @ApiModelProperty(value = "操作名称")
    private String operationName;

    @ApiModelProperty(value = "方法名称")
    private String methodName;

    @ApiModelProperty(value = "微服务名称")
    private String moduleName;

    @ApiModelProperty(value = "成功失败标记:0-失败;1-成功")
    private Boolean success;

    @ApiModelProperty(value = "请求参数")
    private String paramJson;

    @ApiModelProperty(value = "返回参数")
    private String resultJson;


    @ApiModelProperty(value = "异常信息")
    private String errorMsg;


    @ApiModelProperty(value = "执行时长(毫秒)")
    private Long time;


    @ApiModelProperty(value = "IP地址")
    private String ip;

    @ApiModelProperty(value = "请求地址")
    private String requestUrl;


    @ApiModelProperty(value = "请求方法")
    private String requestMethod;


    @ApiModelProperty(value = "浏览器信息")
    private String userAgent;


    @ApiModelProperty(value = "创建人姓名")
    protected String createByName;


}