前言
在实际的项目中,特别是管理系统中,对于那些重要的操作我们通常都会记录操作日志。比如对数据库的CRUD
操作,我们都会对每一次重要的操作进行记录,通常的做法是向数据库指定的日志表中插入一条记录。这里就产生了一个问题,难道要我们每次在 CRUD
的时候都手动的插入日志记录吗?这肯定是不合适的,这样的操作无疑是加大了开发量,而且不易维护,所以实际项目中总是利用AOP(Aspect Oriented Programming)
即面向切面编程这一技术来记录系统中的操作日志。
日志分类
这里我把日志按照面向的对象不同分为两类:
- 面向用户的日志:用户是指使用系统的人,这一类日志通常记录在数据库里边,并且通常是记录对数据库的一些
CRUD
操作。 - 面向开发者的日志:查看这一类日志的一般都是开发人员,这类日志通常保存在文件或者在控制台打印(开发的时候在控制台,项目上线之后之后保存在文件中),这一类日志主要用于开发者开发时期和后期维护时期定位错误。
面向不同对象的日志,我们采用不同的策略去记录。很容易看出,对于面向用户的日志具有很强的灵活性,需要开发者控制用户的哪些操作需要向数据库记录日志,所以这一类保存在数据库的日志我们在使用 AOP
记录时用自定义注解的方式去匹配;而面向开发者的日志我们则使用表达式去匹配就可以了(这里有可能叙述的有点模糊,看了下面去案例将会很清晰),下面分别介绍两种日志的实现。
实现AOP记录面向用户的日志
接下来分步骤介绍Spring boot
中怎样实现通过AOP
记录操作日志。
添加依赖
在pom.xml
文件中添加如下依赖:
修改配置文件
在项目的application.properties
文件中添加下面一句配置:
这里特别说明下,这句话不加其实也可以,因为默认就是
true
,只要我们在pom.xml
中添加了依赖就可以了,这里提出来是让大家知道有这个有这个配置。
自定义注解
上边介绍过了了,因为这类日志比较灵活,所以我们需要自定义一个注解,使用的时候在需要记录日志的方法上添加这个注解就可以了,首先在启动类的同级包下边新建一个config
包,在这个报下边新建new
一个名为Log
的Annotation
文件,文件内容如下:
准备数据库日志表以及实体类,sql接口,xml文件
既然是向数据库中插入记录,那么前提是需要创建一张记录日志的表,下面给出我的表sql
,由于是写样例,我这里这张表设计的很简单,大家可以自行设计。
当然还需要创建service
接口文件以及接口实现类,这里直接给出代码:
ISysLogServcie.java
SysLogServiceImpl.java
AOP的切面和切点
准备上边的相关文件后,下面来介绍重点--创建AOP
切面实现类,同样我们这里将该类放在config
包下,命名为LogAsPect.java
,内容如下:
这里简单介绍下关于AOP
的几个重要注解:
-
@Aspect
:这个注解表示将当前类视为一个切面类 -
@Component
:表示将当前类交由Spring
管理。 -
@Pointcut
:切点表达式,定义我们的匹配规则,上边我们使用@Pointcut("@annotation(com.web.springbootaoplog.config.Log)")
表示匹配带有我们自定义注解的方法。 -
@Around
:环绕通知,可以在目标方法执行前后执行一些操作,以及目标方法抛出异常时执行的操作。 - 下面看一段关键的代码:
其中result = point.proceed();
这句话表示执行目标方法,可以看出我们在这段代码执行之前打印了一句日志,并在执行之后调用了insertLog()
插入日志的方法,并且在方法中我们可以拿到目标方法所在的类名,方法名,参数等重要的信息。
测试控制器
在controller
包下新建一个HomeCOntroller.java
(名字大家随意),内容如下:
定义一个测试方法,带有两个参数,并且为该方法添加了我们自定义的@Log
注解,启动项目,浏览器访问localhost:8080/aop?name=xfr&nick=eran
,这时候查看eclipse
控制台的部分输出信息如下:
实现AOP记录面向开发者的日志
首先这里我列举一个使用该方式的应用场景,在项目中出现了bug
,我们想要知道前台的请求是否进入了我们控制器中,以及参数的获取情况,下面开始介绍实现步骤。
其实原理跟上边是一样的,只是切点的匹配规则变了而已,而且不用将日志记录到数据库,打印出来即可。
首先在LogAsPect.java
中定义一个新的切点表达式,如下:
@Pointcut("execution(public * com.web.springbootaoplog.controller..*.*(..))")
表示匹配com.web.springbootaoplog.controller
包及其子包下的所有公有方法。
再添加匹配到方法时我们要做的操作:
@Before
:表示目标方法执行之前执行以下方法体的内容。
再在控制器中添加一个测试方法:
可以看到这个方法我们并没有加上@Log
注解,重启项目,浏览器访问localhost:8080/testaop3?name=xfr&nick=eran,这时候查看eclipse控制台的部分输出信息如下:
打印出了关键日志,这样我们就能知道是不是进入了该方法,参数获取是否正确等关键信息。
这里有的朋友或许会有疑问这样会不会与添加了@Log
的方法重复了呢,的确会,所以在项目中我通常都将@Log
注解用在了Service
层的方法上,这样也更加合理。