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

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

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;
 /**
 * ClassName: SystemServiceLog <br/>
 * Function: AOP日志记录,自定义注解 <br/>
 * date: 2016年6月7日 上午9:29:01 <br/>
 * @author lcma
 * @version
 * @since JDK 1.7
 */
@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);

     /**
      * Service层切点
      */
     @Pointcut("@annotation(com.iflytek.zhbs.common.annotation.SystemServiceLog)")
     public void serviceAspect() {
     }

     /**
     * doServiceLog:获取注解参数,记录日志. <br/>
     * @author lcma
     * @param joinPoint 切入点参数
     * @since JDK 1.7
     */
    @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);
         }
     }     

    /**
     * getServiceMthodDescription:获取注解中对方法的描述信息 用于service层注解  . <br/>
     * @author lcma
     * @param joinPoint 切点
     * @return 方法描述
     * @throws Exception
     * @since JDK 1.7
     */
    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;
      }

    /**
     * getServiceMthodTableType:获取注解中对方法的数据表类型 用于service层注解 . <br/>
     * @author lcma
     * @param joinPoint
     * @return
     * @throws Exception
     * @since JDK 1.7
     */
    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;
   }

    /**
     * getServiceMthodParams:获取json格式的参数. <br/>
     * @author lcma
     * @param joinPoint
     * @return
     * @throws Exception
     * @since JDK 1.7
     */
    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 {};
}

以上为个人经验,希望能给大家一个参考,也希望大家多多支持我们。

(0)

相关推荐

  • Spring Boot之AOP配自定义注解的最佳实践过程

    前言 AOP(Aspect Oriented Programming),即面向切面编程,是Spring框架的大杀器之一. 首先,我声明下,我不是来系统介绍什么是AOP,更不是照本宣科讲解什么是连接点.切面.通知和切入点这些让人头皮发麻的概念. 今天就来说说AOP的一些应用场景以及如何通过和其他特性的结合提升自己的灵活性.下面话不多说了,来一起看看详细的介绍吧 AOP应用举例 AOP的一大好处就是解耦.通过切面,我们可以将那些反复出现的代码抽取出来,放在一个地方统一处理. 同时,抽出来的代码很多是

  • Spring AOP 实现自定义注解的示例

    自工作后,除了一些小项目配置事务使用过 AOP,真正自己写 AOP 机会很少,另一方面在工作后还没有写过自定义注解,一直很好奇注解是怎么实现他想要的功能的,刚好做项目的时候,经常有人日志打得不够全,经常出现问题了,查日志的才发现忘记打了,所以趁此机会,搜了一些资料,用 AOP + 自定义注解,实现请求拦截,自定义打日志,玩一下这两个东西,以下是自己完的一个小例子,也供需要的同学参考. 1. 注解如下: package cn.bridgeli.demo.annotation;   import j

  • springMVC自定义注解,用AOP来实现日志记录的方法

    需求背景 最近的一个项目,在项目基本完工的阶段,客户提出要将所有业务操作的日志记录到数据库中,并且要提取一些业务的关键信息(比如交易单号)体现在日志中. 为了保证工期,在查阅了资料以后,决定用AOP+自定义注解的方式来完成这个需求. 准备工作 自定义注解需要依赖的jar包有 aspectjrt-XXX.jar ,aspectjweaver-XXX.jar,XXX代表版本号. 自定义注解 在项目下单独建立了一个log包,来存放日志相关的内容 **.common.log.annotation //自

  • spring AOP自定义注解方式实现日志管理的实例讲解

    今天继续实现AOP,到这里我个人认为是最灵活,可扩展的方式了,就拿日志管理来说,用Spring AOP 自定义注解形式实现日志管理.废话不多说,直接开始!!! 关于配置我还是的再说一遍. 在applicationContext-mvc.xml中要添加的 <mvc:annotation-driven /> <!-- 激活组件扫描功能,在包com.gcx及其子包下面自动扫描通过注解配置的组件 --> <context:component-scan base-package=&qu

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

    目录 Spring AOP复杂的日志记录(自定义注解) 第一步 第二步 第三步 第四步 多个注解可以合并成一个,包括自定义注解 比如说SpringMVC的注解 Spring AOP复杂的日志记录(自定义注解) 做项目中,业务逻辑要求只要对数据库数据进行改动的都需要记录日志(增删改),记录的内容有操作者.操作的表名及表名称.具体的操作,以及操作对应的数据. 首先想到的就是Spring 的AOP功能.可是经过一番了解过后,发现一般的日志记录,只能记录一些简单的操作,例如表名.表名称等记录不到. 于是

  • 使用Spring MVC拦截器实现日志记录的方法

    最近在研究Spring MVC拦截器,那么今天也算个学习笔记吧!有需要了解使用Spring MVC拦截器实现日志记录的朋友可参考.希望此文章对各位有所帮助. 1.  定义一个类实现HandlerInterceptor,比如: public class MyInterceptors implements HandlerInterceptor{ /** * 在渲染视图之后被调用: * 可以用来释放资源 */ public void afterCompletion(HttpServletRequest

  • Python使用修饰器进行异常日志记录操作示例

    本文实例讲述了Python使用修饰器进行异常日志记录操作.分享给大家供大家参考,具体如下: 当脚本中需要进行的的相同的异常操作很多的时候,可以用修饰器来简化代码.比如我需要记录抛出的异常: 在log_exception.py文件中, import functools import logging def create_logger(): logger = logging.getLogger("test_log") logger.setLevel(logging.INFO) fh = l

  • Spring AOP访问目标方法的参数操作示例

    本文实例讲述了Spring AOP访问目标方法的参数操作.分享给大家供大家参考,具体如下: 一 配置 <?xml version="1.0" encoding="GBK"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns

  • .Net Core日志记录之自定义日志组件

    一.前言 回顾:日志记录之日志核心要素揭秘 在上一篇中,我们通过学习了解在.net core 中内置的日志记录中的几大核心要素,在日志工厂记录器(ILoggerFactory)中实现将日志记录提供器(ILoggerProvider)对象都可以集成到Logger对象组合中,这样的话,我们就可以通过基于ILoggerProvider自定义日志记录程序集成到Logger中,再创建写日志定义Ilogger,自定义日志记录器实现日志的输出方式,这样实现自定义日志记录工具. 在这个过程中,日志记录器ILog

  • springboot 实现记录业务日志和异常业务日志的操作

    日志记录到redis展现形式 1.基于注解的方式实现日志记录,扫描对应的方法实现日志记录 @Inherited @Retention(RetentionPolicy.RUNTIME) @Target({ElementType.METHOD}) public @interface BussinessLog { /** * 业务的名称,例如:"修改菜单" */ String value() default ""; /** * 被修改的实体的唯一标识,例如:菜单实体的唯一

  • 详解Spring Aop实例之AspectJ注解配置

    上篇<Spring Aop实例之xml配置>中,讲解了xml配置方式,今天来说说AspectJ注解方式去配置spring aop. 依旧采用的jdk代理,接口和实现类代码请参考上篇博文.主要是将Aspect类分享一下: package com.tgb.aop; import org.aspectj.lang.JoinPoint; import org.aspectj.lang.ProceedingJoinPoint; import org.aspectj.lang.annotation.Aft

  • 详解Spring Aop实例之xml配置

    AOP的配置方式有2种方式:xml配置和AspectJ注解方式.今天我们就来实践一下xml配置方式. 我采用的jdk代理,所以首先将接口和实现类代码附上 package com.tgb.aop; public interface UserManager { public String findUserById(int userId); } package com.tgb.aop; public class UserManagerImpl implements UserManager { publ

  • Spring AOP如何整合redis(注解方式)实现缓存统一管理详解

    前言 项目使用redis作为缓存数据,但面临着问题,比如,项目A,项目B都用到redis,而且用的redis都是一套集群,这样会带来一些问题. 问题:比如项目A的开发人员,要缓存一些热门数据,想到了redis,于是乎把数据放入到了redis,自定义一个缓存key:hot_data_key,数据格式是项目A自己的数据格式,项目B也遇到了同样的问题,也要缓存热门数据,也是hot_data_key,数据格式是项目B是自己的数据格式,由于用的都是同一套redis集群,这样key就是同一个key,有的数据

  • Spring AOP对嵌套方法不起作用的解决

    目录 Spring AOP对嵌套方法不起作用 要解决这个问题 Spring AOP.嵌套调用失效及解决 加入注解 获取当前代理的接口 需要嵌套调用的Service实现它 调用的时候改写代码 Spring AOP对嵌套方法不起作用 今天在调研系统操作记录日志时,好多教程都是借助于Spring AOP机制来实现.于是也采用这种方法来实现.在Service中的删除日志方法上注解自定义的切点,但是执行没有生效. 代码如下: //尝试删除溢出日志     public synchronized void

随机推荐

其他