springboot自定义日志注解-优快云博客

本文链接：https://blog.youkuaiyun.com/qiulingxin/article/details/80425552

本文介绍了一种利用Java注解和面向切面编程(AOP)技术实现系统日志记录的方法。通过自定义注解@SysLog并结合Spring AOP，在不修改业务逻辑代码的情况下记录操作日志。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

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;

/**
 * 系统日志注解
 * 
 * @Target 所有标注了指定注解的类
 * @Retention 注解说明,这种类型的注解会被保留到那个阶段. 
 * @Documented 注解表明这个注解应该被 javadoc工具记录. 
 * 
 * 
 * Retention(保留)注解说明,这种类型的注解会被保留到那个阶段. 有三个值:
 * 1.RetentionPolicy.SOURCE —— 这种类型的Annotations只在源代码级别保留,编译时就会被忽略
 * 2.RetentionPolicy.CLASS —— 这种类型的Annotations编译时被保留,在class文件中存在,但JVM将会忽略
 * 3.RetentionPolicy.RUNTIME —— 这种类型的Annotations将被JVM保留,所以他们能在运行时被JVM或其他使用反射机制的代码所读取和使用.
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface SysLog {

   String value() default "";

}

----------------------------------------------------------

import com.alibaba.fastjson.JSON;
import com.cf.entity.SysLogEntity;
import com.cf.service.SysLogService;
import com.cf.utils.HttpContextUtils;
import com.cf.utils.IPUtils;
import com.cf.utils.ShiroUtils;
import com.cf.utils.annotation.SysLog;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

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


/**
 * 系统日志，切面处理类
 * 
 */
@Aspect
@Component
public class SysLogAspect {
   
   @Autowired
   private SysLogService sysLogService;
   
   // 定义Pointcut，Pointcut的名称 就是simplePointcut，此方法不能有返回值，该方法只是一个标示 
   // @annotation 指定自定义注解
   @Pointcut("@annotation(com.cf.utils.annotation.SysLog)")
   public void logPointCut() {
      
   }
   
   @Before("logPointCut()")
   public void saveSysLog(JoinPoint joinPoint) {
      MethodSignature signature = (MethodSignature) joinPoint.getSignature();
      Method method = signature.getMethod();

      SysLogEntity sysLog = new SysLogEntity();
      SysLog syslog = method.getAnnotation(SysLog.class);
      if(syslog != null){
         //注解上的描述
         sysLog.setOperation(syslog.value());
      }
      
      //请求的方法名
      String className = joinPoint.getTarget().getClass().getName();
      String methodName = signature.getName();
      sysLog.setMethod(className + "." + methodName + "()");
      
      //请求的参数
      Object[] args = joinPoint.getArgs();
      String params = JSON.toJSONString(args[0]);
      sysLog.setParams(params);
      
      //获取request
      HttpServletRequest request = HttpContextUtils.getHttpServletRequest();
      //设置IP地址
      sysLog.setIp(IPUtils.getIpAddr(request));
      
      //用户名
      String username = ShiroUtils.getUserEntity().getUsername();
      sysLog.setUsername(username);
      
      sysLog.setCreateDate(new Date());
      //保存系统日志
      sysLogService.save(sysLog);
   }

   /*@AfterReturning(returning="rvt", pointcut="@annotation(com.cf.utils.annotation.SysLog)")
   public Object AfterExec(JoinPoint joinPoint,Object rvt){

   }*/
}

-----------------------------

使用

@SysLog("保存用户")
@RequestMapping("/save")
@RequiresPermissions("sys:user:save")
public R save(@RequestBody SysUserEntity user){
   ValidatorUtils.validateEntity(user, AddGroup.class);
   
   user.setCreateUserId(getUserId());
   sysUserService.save(user);
   
   return R.ok();
}