SpringBoot AOP+自定义注解实现日志功能

1.创建系统日志数据库表

2.maven坐标

<dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>aspectjrt</artifactId>
            <version>1.9.7</version>
            <scope>runtime</scope>
        </dependency>

        <dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>aspectjweaver</artifactId>
            <version>1.9.7</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>

3.创建系统日志实体类

@Data
public class SysLog implements Serializable {
    private String id;
    /**日志类型(1登录日志，2操作日志)*/
    private int logType;
    /**日志内容*/
    private String logContent;
    /**操作类型（1添加2修改3删除）*/
    private int operateType;
    /**操作用户账号*/
    private String userid;
    /**操作用户姓名*/
    private String username;
    /**ip*/
    private String ip;
    /**请求Java 方法*/
    private String method;
    /**请求路径*/
    private String requestUrl;
    /**请求参数*/
    private String requestParam;
    /**请求类型*/
    private String requestType;
    /**耗时*/
    private long costTime;
    private String createBy;
    private Date createTime;
    private String updateBy;
    private Date updateTime;
}

4.创建系统日志注解

@Target(ElementType.METHOD)  //target用于标识此注解能标记在方法上还是类上
@Retention(RetentionPolicy.RUNTIME) //retention用于决定此注解的生命周期
@Documented
public @interface AutoLog {
    /**日志内容*/
    String value() default "";

    /**日志类型(1登录日志，2操作日志)*/
    int logType() default 2;

    /**操作日志类型 1查询2添加3修改4删除*/
    int operateType() default 0;
}

5.创建日志注解切面类

@Aspect
@Component
public class AutoLogAspect {

    @Autowired
    SysLogService sysLogService;

    private static Logger logger = LoggerFactory.getLogger(AutoLogAspect.class);

    @Pointcut("@annotation(com.example.demo.commit.annotation.AutoLog)")
    public void logPointCut(){}

    @Around("logPointCut()")
    public Object around(ProceedingJoinPoint point) throws Throwable {
        long beginTime = System.currentTimeMillis();
        System.out.println("日志");
        //执行方法
        Object result = point.proceed();
        //执行时长
        long time = System.currentTimeMillis()-beginTime;

        //保存日志
        saveSysLog(point,time,result);

        return result;
    }

    private void saveSysLog(ProceedingJoinPoint point,long time,Object obj){
        MethodSignature signature = (MethodSignature) point.getSignature();
        Method method = signature.getMethod();
        SysLog dto = new SysLog();
        AutoLog syslog = method.getAnnotation(AutoLog.class);
        if (syslog != null){
            String content = syslog.value();
            dto.setLogType(syslog.logType());
            dto.setLogContent(content);
        }
        //请求的方法名
        String className = point.getTarget().getClass().getName();
        String methodName = signature.getName();
        dto.setMethod(className+"."+methodName+"()");
        //设置操作类型
        if (dto.getLogType() == 2){
            dto.setOperateType(getOperateType(methodName,syslog.operateType()));
        }
        //获取request
        HttpServletRequest request = getHttpServletRequest();
        //请求的参数
        dto.setRequestParam(getRequestParams(request,point));
        //设置ip地址
        dto.setIp(getIpAddr(request));
        //获取用户登录信息
        TUser user = (TUser) SecurityUtils.getSubject().getPrincipal();
        if (user != null){
            dto.setUserid(user.getUserName());
            dto.setUsername(user.getPassWord());
        }
        dto.setCostTime(time);
        dto.setCreateTime(new Date());

        sysLogService.save(dto);
    }

    private int getOperateType(String methodName , int operateType){
        if (operateType>0){
            return operateType;
        }
        if (methodName.startsWith("list")){
            return 1;
        }
        if (methodName.startsWith("add")){
            return 2;
        }
        if (methodName.startsWith("edit")){
            return 3;
        }
        if (methodName.startsWith("delete")){
            return 4;
        }
        if (methodName.startsWith("import")){
            return 5;
        }
        if (methodName.startsWith("export")){
            return 6;
        }
        return 1;
    }

    private HttpServletRequest getHttpServletRequest(){
        return ((ServletRequestAttributes)RequestContextHolder.getRequestAttributes()).getRequest();
    }

    private String getRequestParams(HttpServletRequest request, JoinPoint joinPoint){
        String httpMethod = request.getMethod();
        String param = "";
        if ("POST".equals(httpMethod) || "PUT".equals(httpMethod) || "PATCH".equals(httpMethod)){
            Object[] paramArray = joinPoint.getArgs();
            Object[] arguments = new Object[paramArray.length];
            for (int i = 0; i < paramArray.length; i++) {
                if (paramArray[i] instanceof BindingResult || paramArray[i] instanceof ServletRequest || paramArray[i] instanceof ServletResponse || paramArray[i] instanceof MultipartFile){
                    continue;
                }
                arguments[i] = paramArray[i];
            }
            PropertyFilter propertyFilter = new PropertyFilter() {
                @Override
                public boolean apply(Object object, String name, Object value) {
                    if (value!=null && value.toString().length()>500){
                        return false;
                    }
                    return true;
                }
            };
            param = JSONObject.toJSONString(arguments,propertyFilter);
        }else {
            MethodSignature signature = (MethodSignature) joinPoint.getSignature();
            Method method = signature.getMethod();
            //请求的方法参数值
            Object[] args = joinPoint.getArgs();
            //请求的方法名称
            LocalVariableTableParameterNameDiscoverer u = new LocalVariableTableParameterNameDiscoverer();
            String[] parameterNames = u.getParameterNames(method);
            if (args != null && parameterNames !=null){
                for (int i = 0; i < args.length; i++) {
                    param += " " + parameterNames[i] +": " + args[i];
                }
            }
        }
        return param;
    }

    public String getIpAddr(HttpServletRequest request){
        String ip = null;
        try {
            ip = request.getHeader("x-forwarded-for");
            if (StringUtils.isEmpty(ip) || "unknown".equalsIgnoreCase(ip)){
                ip = request.getHeader("Proxy-Client-IP");
            }
            if (StringUtils.isEmpty(ip) || ip.length()==0 || "unknown".equalsIgnoreCase(ip)){
                ip = request.getHeader("WL-Proxy-Client-IP");
            }
            if (StringUtils.isEmpty(ip) || "unknown".equalsIgnoreCase(ip)){
                ip = request.getHeader("HTTP_CLIENT-IP");
            }
            if (StringUtils.isEmpty(ip) || "unknown".equalsIgnoreCase(ip)){
                ip = request.getHeader("HTTP_X-FORWARDED-FOR");
            }
            if (StringUtils.isEmpty(ip) || "unknown".equalsIgnoreCase(ip)){
                ip = request.getRemoteAddr();
            }
        }catch (Exception e){
            logger.error("IP error",e);
        }
        return ip;
    }
}

6.在controller层的方法添加系统日志注解

    @AutoLog(value = "easyPoi导入")
    @ApiOperation("easyPoi导入")
    @GetMapping("/importEasyPoi")
    @ResponseBody
    public Result<TUser> easyPoiImport(@RequestParam("file")MultipartFile file) {
        try {
            userService.easyPoiImport(file);
            return ResultUtil.success();
        }catch(Exception e){
            e.printStackTrace();
            return ResultUtil.fail(201,"导入失败");
        }

    }

gitee地址