springboot自定义注解之操作日志

最新推荐文章于 2025-10-13 11:30:51 发布

原创最新推荐文章于 2025-10-13 11:30:51 发布 · 1.9k 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#springboot

java 专栏收录该内容

19 篇文章

订阅专栏

本文详细介绍了一个基于Spring框架的日志系统搭建过程，包括自定义注解、拦截器的创建及配置，实现了对系统操作的自动记录，特别关注了日志类型的区分、日志级别的设定以及操作人的身份验证。

创建注解类

import java.lang.annotation.*;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface SysLog {

    String value() default "";

}

创建拦截器

import com.alibaba.dubbo.config.annotation.Reference;
import com.rz.common.annotation.AuthToken;
import com.rz.common.annotation.SysLog;
import com.rz.common.ex.BusinessException;
import com.rz.entity.po.Employees;
import com.rz.entity.po.Logs;
import com.rz.service.ILogsService;
import com.rz.utils.Constant;
import org.apache.commons.lang3.StringUtils;
import org.apache.log4j.Logger;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Component;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.lang.reflect.Method;
import java.util.Date;
@Component
public class LogInterceptor implements HandlerInterceptor {
    private Logger logger = Logger.getLogger(getClass());

    private ThreadLocal<Long> startTime = new ThreadLocal<>();

    @Reference(version = "1.0.0")
    private ILogsService ilogService;
    @Autowired
    RedisTemplate redisTemplate;

    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws BusinessException {
        if (!(handler instanceof HandlerMethod)) {
            return true;
        }
        HandlerMethod handlerMethod = (HandlerMethod) handler;
        Method method = handlerMethod.getMethod();
        String token = request.getParameter(Constant.USER_TOKEN);
        String originTypeStr = request.getParameter(Constant.ORIGIN_TYPE);
        Integer originType = Integer.parseInt(StringUtils.isNotEmpty(originTypeStr)?originTypeStr:"4");
        Employees employees=(Employees)redisTemplate.opsForValue().get(token);
        SysLog sysLog = method.getAnnotation(SysLog.class);
        // 记录下请求内容
        if (sysLog != null || handlerMethod.getBeanType().getAnnotation(SysLog.class) != null) {
            Logs log = new Logs();
            //设置日志类型
            log.setLogType(originType);
            //设置日志等级
            log.setLogLevel(3);
            //设置日志时间
            log.setLogTime(new Date());
            //设置访问IP
            log.setSourceIp(request.getRemoteAddr());
            //设置操作人
            log.setOperatorId(employees==null?null:employees.getEmployeeId());
            //设置日志文本信息
            log.setLogtxt(sysLog.value()+"-"+request.getRequestURL().toString());
            ilogService.insert(log);
        }
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {

    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {

    }
}

配置

import com.rz.handler.LogInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

import javax.annotation.Resource;

@Configuration
public class WebAppConfig extends WebMvcConfigurerAdapter {
  
    @Resource
    private LogInterceptor logInterceptor;


    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(logInterceptor).addPathPatterns("/**");
    }
}