Spring AOP实现复杂的日志记录操作(自定义注解)

2024-04-02 19:04:59 125人浏览独家记忆

Python 官方文档：入门教程 => 点击学习

摘要

目录spring aop复杂的日志记录(自定义注解)第一步第二步第三步第四步多个注解可以合并成一个，包括自定义注解比如说springMVC的注解Spring AOP复杂的日志记录(自

Spring AOP复杂的日志记录(自定义注解)

做项目中，业务逻辑要求只要对数据库数据进行改动的都需要记录日志（增删改），记录的内容有操作者、操作的表名及表名称、具体的操作，以及操作对应的数据。

首先想到的就是Spring 的AOP功能。可是经过一番了解过后，发现一般的日志记录，只能记录一些简单的操作，例如表名、表名称等记录不到。

于是想到了自定义注解的方法，把想要记录的内容放在注解中，通过切入点来获取注解参数，就能获取自己想要的数据，记录数据库中。顺着这个思路，在网上查找了一些相关资料，最终实现功能。话不多说，以下就是实现的思路及代码：

第一步

在代码中添加自定义注解，并且定义两个属性，一个是日志的描述（description），还有个是操作表类型（tableType），属性参数可按需求改变。代码如下：


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({ElementType.PARAMETER, ElementType.METHOD})    
@Retention(RetentionPolicy.RUNTIME)    
@Documented  
public @interface SystemServiceLog {

String description()  default ""; 
 

int tableType() default 0; 
}

第二步

定义切面类，获取切面参数，保存数据库具体代码如下：


import java.lang.reflect.Method;
import java.util.Date; 
import javax.annotation.Resource;
import javax.servlet.Http.httpservletRequest; 
import org.apache.log4j.Logger;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;
import org.springframework.WEB.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes; 
 
import com.iflytek.zhbs.common.annotation.SystemServiceLog;
import com.iflytek.zhbs.common.util.JacksonUtil;
import com.iflytek.zhbs.common.util.WebUtils;
import com.iflytek.zhbs.dao.BaseDaoI;
import com.iflytek.zhbs.domain.CmsAdmin;
import com.iflytek.zhbs.domain.CmsOperationLog; 
 
@Aspect
@Component
@SuppressWarnings("rawtypes")
public class SystemLogAspect {
 
@Resource
private BaseDaoI<CmsOperationLog> logDao;
 
    
    private static final Logger LOGGER = Logger.getLogger(SystemLogAspect.class);
 
     
     @Pointcut("@annotation(com.iflytek.zhbs.common.annotation.SystemServiceLog)")    
     public void serviceAspect() {         
     }
     
     
    @After("serviceAspect()") 
     public  void doServiceLog(JoinPoint joinPoint) {
    LOGGER.info("日志记录");
         HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
         //获取管理员用户信息
    CmsAdmin admin = WebUtils.getAdminInfo(request);
          try {
             //数据库日志
             CmsOperationLog log = new CmsOperationLog();
             log.setOperationType(getServiceMthodTableType(joinPoint));
             //获取日志描述信息
             String content = getServiceMthodDescription(joinPoint);
             log.setContent(admin.getRealName() + content);
             log.setRemarks(getServiceMthodParams(joinPoint));
             log.setAdmin(admin);
             log.setCreateTime(new Date());
             logDao.save(log);
         }  catch (Exception e) {  
             LOGGER.error("异常信息:{}", e);
         }    
     }     
     
    
    private String getServiceMthodDescription(JoinPoint joinPoint)
               throws Exception {
          String targetName = joinPoint.getTarget().getClass().getName();
          String methodName = joinPoint.getSignature().getName();
          Object[] arguments = joinPoint.getArgs();
          Class targetClass = Class.forName(targetName);
          Method[] methods = targetClass.getMethods();
          String description = "";
           for(Method method : methods) {
               if(method.getName().equals(methodName)) {
                  Class[] clazzs = method.getParameterTypes();
                   if(clazzs.length == arguments.length) {
                      description = method.getAnnotation(SystemServiceLog.class).description();
                       break;
                  }
              }
          }
          return description;
      }
    
    
    private nt getServiceMthodTableType(JoinPoint joinPoint)
            throws Exception {
       String targetName = joinPoint.getTarget().getClass().getName();
       String methodName = joinPoint.getSignature().getName();
       Object[] arguments = joinPoint.getArgs();
       Class targetClass = Class.forName(targetName);
       Method[] methods = targetClass.getMethods();
       int tableType = 0;
        for (Method method : methods) {
            if (method.getName().equals(methodName)) {
               Class[] clazzs = method.getParameterTypes();
                if (clazzs.length == arguments.length) {
                tableType = method.getAnnotation(SystemServiceLog.class).tableType();
                    break;
               }
           }
       }
        return tableType;
   }
    
    
    private String getServiceMthodParams(JoinPoint joinPoint)
            throws Exception {
       Object[] arguments = joinPoint.getArgs();
       String params = JacksonUtil.toJSON(arguments);
       return params;
   } 
}

需要注意的是，定义切点的时候，@Pointcut里面是自定义注解的路径

每个切面传递的数据的都不一样，最终决定，获取切面的所有参数，转成json字符串，保存到数据库中。

第三步

在service需要记录日志的地方进行注解，代码如下：


@SystemServiceLog(description=Constants.ADMIN_SAVE_OPTIONS,tableType=Constants.ADMIM_TABLE_TYPE)

代码图片：

在常量类里面配置自定义注解的参数内容:

第四步

把切面类所在的包路径添加到Spring注解自动扫描路径下，并且启动对@AspectJ注解的支持，代码如下：


<!-- 启动对@AspectJ注解的支持  --> 
<aop:aspectj-autoproxy proxy-target-class="true" />
<!-- 自动扫描包路径  --> 
<context:component-scan base-package="com.iflytek.zhbs.common.aoplog" />
<context:component-scan base-package="com.iflytek.zhbs.service" />

最后数据库记录数据的效果如图：

OK，功能已经实现，初次写博客，写的不好的地方请谅解。

多个注解可以合并成一个，包括自定义注解

spring中有时候一个类上面标记很多注解。

实际上Java注解可以进行继承(也就是把多个注解合并成1个)

比如说Springmvc的注解


@RestController
@RequestMapping("/person")

可以合并为一个


@PathRestController("/user")

实现是：


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;
import org.springframework.core.annotation.AliasFor;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@RestController
@RequestMapping
public @interface PathRestController {
@AliasFor("path")
String[] value() default {};
@AliasFor("value")
String[] path() default {};
}

以上为个人经验，希望能给大家一个参考，也希望大家多多支持编程网。

您可能感兴趣的文档:

点击免费下载>>软考高级考试备考技巧/历年真题/备考精华资料

--结束END--

本文标题: Spring AOP实现复杂的日志记录操作(自定义注解)

本文链接: https://www.lsjlt.com/news/136849.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑，方便收藏和打印～

下载Word文档

去做题

猜你喜欢

Spring AOP实现复杂的日志记录操作(自定义注解)

目录Spring AOP复杂的日志记录(自定义注解)第一步第二步第三步第四步多个注解可以合并成一个，包括自定义注解比如说SpringMVC的注解Spring AOP复杂的日志记录(自...

99+

2022-11-12
SpringBoot自定义注解异步记录复杂日志详解

目录1、背景2、技术方案-自定义注解2.1 注解介绍2.2 元注解2.3 实现自定义注解3、技术方案-AOP切面3.1 AOP术语解析3.2 切入点表达式3.3 ADVICE通知类型...

99+

2022-11-13
运用Spring Aop+注解实现日志记录

目录1. 介绍2. 实践2.1 定义注解2.2 切面类2.3 编写测试方法2.4 运行结果3. 总结4. 参考文章1. 介绍我们都知道Spring框架的两大特性分别是 IOC (控...

99+

2022-11-13
Java自定义注解@Log和AOP实现用户操作日志

1、实现前准备，MySQL数据库中创建表 CREATE TABLE `sys_log` ( `oper_id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '日志主键', `ti...

99+

2023-10-03

java spring boot mysql restful
springboot使用自定义注解实现aop切面日志

平时我们在开发过程中，代码出现bug时为了更好的在服务器日志中寻找问题根源，会在接口的首尾打印日志，看下参数和返回值是否有问题。但是手动的logger.info() 去编写时工作量较...

99+

2022-11-13
SpringBoot自定义注解之实现AOP切面日志详解

通过自定义注解的方式（如：@SysLog(obj = "操作对象", text = "操作内容"），在 SpringBoot 中来实现 AOP...

99+

2022-11-13
Spring AOP 实现自定义注解的示例

目录1. 注解如下：2. 切面自工作后，除了一些小项目配置事务使用过 AOP，真正自己写 AOP 机会很少，另一方面在工作后还没有写过自定义注解，一直很好奇注解是怎么实现他想要的功能...

99+

2022-11-12
springboot自定义日志注解的实现

前言在之前的日志记录的写法中，我们大多是写一个工具类，在这个类里面定义日志保存的方法，然后再controller中执行请求的时候调用即可，...

99+

2022-11-13
Spring AOP使用@Aspect注解面向切面实现日志横切的操作

引言： AOP为Aspect Oriented Programming的缩写，意为：面向切面编程，通过预编译方式和运行期动态代理实现程序功能的统一维护的一种技术.AOP是OOP的延续...

99+

2022-11-12
SpringAOP如何自定义注解实现审计或日志记录(完整代码)

目录环境准备项目结构自定义审计注解定义切面类定义返回值处理基类定义返回值处理子类定义功能模块类定义操作类定义审计信息实体类书写mapper文件开启AOP拦截注解配置总结环境准备 JD...

99+

2022-12-28

Spring AOP 自定义注解自定义注解实现审计注解实现日志记录