SpringBoot使用自定义注解加AOP记录业务日志

分手后的思念是犯贱 2023-10-10 09:31 47阅读 0赞

在项目开发中，相信不管什么类型的项目，多多少少都会有涉及到业务日志的记录需求，即将用户对数据的新增、修改、甚至某些特殊的查询进行日志记录。今天，日月将教大家一种使用自定义注解+AOP的方式对接口进行记录日志，做到日志代码和业务代码分离解耦，OK，话不多说，直接上代码。

**本次示例将对用户的注册登陆进行日志记录**

## 1、创建自定义注解 ##

import java.lang.annotation.Retention;
    import java.lang.annotation.RetentionPolicy;
    import java.lang.annotation.Target;
    
    /**
     * @Author chenqi
     * @Description 自定义元注解--用于记录日志
     **/
    @Target({ java.lang.annotation.ElementType.METHOD })//字段注解 , 用于描述方法
    @Retention(RetentionPolicy.RUNTIME)//在运行期保留注解信息  
    public @interface PartnerLog {
    	public abstract int value();
    }

## 2、创建日志枚举类 ##

/**
     * @Author chenqi
     * @Description 日志枚举
     **/
    public enum PartnerLogEnum {
    
    	/**===  用户相关【10001-10200】  ===**/
    	LOGTYPE_USER_10001(10001,"注册"),
    	LOGTYPE_USER_10002(10002,"登录"),
    
    	;
    	/*两个属性*/
        private Integer logType;
        private String name;
    
        /*构造函数*/
        private PartnerLogEnum(Integer logType , String name) {
        	this.logType =  logType;
        	this.name = name;
        }
    
        /*属性的setter和getter*/
    	public Integer getLogType() {
    		return logType;
    	}
    
    	public void setLogType(Integer logType) {
    		this.logType = logType;
    	}
    
    	public String getName() {
    		return name;
    	}
    
    	public void setName(String name) {
    		this.name = name;
    	}
    
    
    }

## 3、定义AOP-Aspect ##

/**
     * @Author chenqi
     * @Description 日志记录 AOP
     **/
    @Aspect
    @Component
    @Slf4j
    public class PartnerLogAspect {
    
    	@Pointcut("@annotation(自定义注解类的包路径.PartnerLog)")
    	public void partnerLogPointCut() {}
    
    	@Around("partnerLogPointCut()")
    	public Object around(ProceedingJoinPoint point) throws Throwable {
    		//方法执行并返回结果result
    		Object result = point.proceed();
    		//记录日志
    		savePartnerLog(point,result);
    		//返回结果
    		return result;
    	}
    
    	private void savePartnerLog(ProceedingJoinPoint joinPoint,Object result) {
    		MethodSignature signature = (MethodSignature) joinPoint.getSignature();
    		Method method = signature.getMethod();
    		PartnerLog partnerlog = (PartnerLog) method.getAnnotation(PartnerLog.class);
    		if (partnerlog != null) {
    			Object[] args = joinPoint.getArgs();
    			if(partnerlog.value() == PartnerLogEnum.LOGTYPE_USER_10001.getLogType().intValue()) {//注册
    				PartnerUserRegisterDTO dto = (PartnerUserRegisterDTO)args[0];//可以获取到接口方法的入参对象
    				R<Boolean> r = (R<Boolean>)result;
    				//执行成功记录日志
    				if(!CheckUtils.objCheckNull(r) && r.getCode() == 0 && r.getData()) {
    					//记录日志  日志的打印可以配合logback输出到日志文件中进行存储。 
    					log.info("【注册】：用户[{}]完成注册，邀请码为[{}]",
    							dto.getUserName(),
    							dto.getRecommenderCode());
    				}
    			}
    			if(partnerlog.value() == PartnerLogEnum.LOGTYPE_USER_10002.getLogType().intValue()) {//登录
    				PartnerUserLoginDTO dto = (PartnerUserLoginDTO)args[0];
    				R<PartnerUserLoginVO> r = (R<PartnerUserLoginVO>)result;
    				//执行成功记录日志
    				if(!CheckUtils.objCheckNull(r) && r.getCode() == 0 &&
    						!CheckUtils.objCheckNull(r.getData()) &&
    						!CheckUtils.strCheckNull(r.getData().getToken())) {
    					//记录日志
    					String loginTypeStr = dto.getType().intValue() == 1 ? "账号密码登录" : "短信登录";
    					log.info("【登录】：用户[{}]成功登录了XXX系统，登录方式为[{}]",
    							dto.getUserName(),loginTypeStr);
    				}
    			}
    		}
    	}
    
    
    
    }

## 4、业务接口方法添加日志注解 ##

/**
     * @Author chenqi
     * @Description 注册
     **/
    @PartnerLog(10001)
    @Transactional(rollbackFor = Exception.class)
    @Override
    public R<Boolean> register(PartnerUserRegisterDTO partnerUserRegisterDTO) {
    	//此处省略业务代码
       	。。。。。。
        return synRegisterDataToApp(dto);
    }

OK，到这里就完成了，登陆的示例我就不贴了，大家可以看到，我们最终只需要将自定义的日志注解添加到需要记录日志的接口方法上即可**实现日志代码与业务代码完全分离**。

如果该文章有帮助到您，就留言点个赞吧！您的支持与肯定是我持续更新最大的动力。