Spring boot学习（六）Spring boot实现AOP记录操做日志

时间  2021-08-12
标签 html java web spring sql 数据库 编程 浏览器 springboot bash 栏目 Spring 繁體版
原文   原文链接

前言

在实际的项目中，特别是管理系统中，对于那些重要的操做咱们一般都会记录操做日志。好比对数据库的CRUD操做，咱们都会对每一次重要的操做进行记录，一般的作法是向数据库指定的日志表中插入一条记录。这里就产生了一个问题，难道要咱们每次在 CRUD的时候都手动的插入日志记录吗？这确定是不合适的，这样的操做无疑是加大了开发量，并且不易维护，因此实际项目中老是利用AOP(Aspect Oriented Programming)即面向切面编程这一技术来记录系统中的操做日志。html

文章首发于我的博客:【www.xiongfrblog.cn】java

日志分类

这里我把日志按照面向的对象不一样分为两类：web

  • 面向用户的日志：用户是指使用系统的人，这一类日志一般记录在数据库里边，而且一般是记录对数据库的一些CRUD操做。
  • 面向开发者的日志：查看这一类日志的通常都是开发人员，这类日志一般保存在文件或者在控制台打印（开发的时候在控制台，项目上线以后以后保存在文件中），这一类日志主要用于开发者开发时期和后期维护时期定位错误。

面向不一样对象的日志，咱们采用不一样的策略去记录。很容易看出，对于面向用户的日志具备很强的灵活性，须要开发者控制用户的哪些操做须要向数据库记录日志，因此这一类保存在数据库的日志咱们在使用 AOP记录时用自定义注解的方式去匹配；而面向开发者的日志咱们则使用表达式去匹配就能够了（这里有可能叙述的有点模糊，看了下面去案例将会很清晰），下面分别介绍两种日志的实现。spring

实现AOP记录面向用户的日志

接下来分步骤介绍Spring boot中怎样实现经过AOP记录操做日志。sql

添加依赖

在pom.xml文件中添加以下依赖：数据库

<!-- aop依赖 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>
复制代码

修改配置文件

在项目的application.properties文件中添加下面一句配置：编程

spring.aop.auto=true
复制代码

这里特别说明下，这句话不加其实也能够，由于默认就是true，只要咱们在pom.xml中添加了依赖就能够了，这里提出来是让你们知道有这个有这个配置。浏览器

自定义注解

上边介绍过了了，由于这类日志比较灵活，因此咱们须要自定义一个注解，使用的时候在须要记录日志的方法上添加这个注解就能够了，首先在启动类的同级包下边新建一个config包，在这个报下边新建new一个名为Log的Annotation文件，文件内容以下：springboot

package com.web.springbootaoplog.config;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/** * @author Promise * @createTime 2018年12月18日 下午9:26:25 * @description 定义一个方法级别的@log注解 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Log {
	String value() default "";
}
复制代码

这里用到的是Java元注解的相关知识，不清楚相关概念的朋友能够去这篇博客get一下【传送门】。bash

准备数据库日志表以及实体类，sql接口，xml文件

既然是向数据库中插入记录，那么前提是须要建立一张记录日志的表，下面给出个人表sql,因为是写样例，我这里这张表设计的很简单，你们能够自行设计。

CREATE TABLE `sys_log` (
  `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '主键',
  `user_id` int(11) NOT NULL COMMENT '操做员id',
  `user_action` varchar(255) NOT NULL COMMENT '用户操做',
  `create_time` datetime DEFAULT NULL ON UPDATE CURRENT_TIMESTAMP COMMENT '建立时间',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=12 DEFAULT CHARSET=utf8 COMMENT='日志记录表';
复制代码

经过上篇博客介绍的MBG生成相应的实体类，sql接口文件，以及xml文件，这里再也不概述，不清楚的朋友请移步【传送门】

固然还须要建立service接口文件以及接口实现类，这里直接给出代码：

ISysLogServcie.java

package com.web.springbootaoplog.service;

import com.web.springbootaoplog.entity.SysLog;

/** * @author Promise * @createTime 2018年12月18日 下午9:29:48 * @description 日志接口 */
public interface ISysLogService {

	/** * 插入日志 * @param entity * @return */
	int insertLog(SysLog entity);
}

复制代码

SysLogServiceImpl.java

package com.web.springbootaoplog.service.impl;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import com.web.springbootaoplog.config.Log;
import com.web.springbootaoplog.dao.SysLogMapper;
import com.web.springbootaoplog.entity.SysLog;
import com.web.springbootaoplog.service.ISysLogService;


/** * @author Promise * @createTime 2018年12月18日 下午9:30:57 * @description */
@Service("sysLogService")
public class SysLogServiceImpl implements ISysLogService{

	@Autowired
	private SysLogMapper sysLogMapper;
	
	@Override
	public int insertLog(SysLog entity) {
		// TODO Auto-generated method stub
		return sysLogMapper.insert(entity);
	}
}

复制代码

AOP的切面和切点

准备上边的相关文件后，下面来介绍重点--建立AOP切面实现类，一样咱们这里将该类放在config包下，命名为LogAsPect.java,内容以下：

package com.web.springbootaoplog.config;

import java.lang.reflect.Method;
import java.util.Arrays;
import java.util.Date;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
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.hibernate.validator.internal.util.logging.LoggerFactory;
import org.slf4j.Logger;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.LocalVariableTableParameterNameDiscoverer;
import org.springframework.stereotype.Component;

import com.web.springbootaoplog.entity.SysLog;
import com.web.springbootaoplog.service.ISysLogService;


/** * @author Promise * @createTime 2018年12月18日 下午9:33:28 * @description 切面日志配置 */
@Aspect
@Component
public class LogAsPect {
	
	private final static Logger log = org.slf4j.LoggerFactory.getLogger(LogAsPect.class);

	@Autowired
	private ISysLogService sysLogService;
	
	//表示匹配带有自定义注解的方法
	@Pointcut("@annotation(com.web.springbootaoplog.config.Log)")
	public void pointcut() {}
	
	@Around("pointcut()")
	public Object around(ProceedingJoinPoint point) {
		Object result =null;
		long beginTime = System.currentTimeMillis();
		
		try {
		    log.info("我在目标方法以前执行！");
			result = point.proceed();
			long endTime = System.currentTimeMillis();
			insertLog(point,endTime-beginTime);
		} catch (Throwable e) {
			// TODO Auto-generated catch block
		}
		return result;
	}
	
	private void insertLog(ProceedingJoinPoint point ,long time) {
		MethodSignature signature = (MethodSignature)point.getSignature();
		Method method = signature.getMethod();
		SysLog sys_log = new SysLog();
		
		Log userAction = method.getAnnotation(Log.class);
		if (userAction != null) {
			// 注解上的描述
			sys_log.setUserAction(userAction.value());
		}
		
		// 请求的类名
		String className = point.getTarget().getClass().getName();
		// 请求的方法名
		String methodName = signature.getName();
		// 请求的方法参数值
		String args = Arrays.toString(point.getArgs());
		
		//从session中获取当前登录人id
// Long useride = (Long)SecurityUtils.getSubject().getSession().getAttribute("userid");
		
		Long userid = 1L;//应该从session中获取当前登陆人的id，这里简单模拟下
		
		sys_log.setUserId(userid);
		
		sys_log.setCreateTime(new java.sql.Timestamp(new Date().getTime()));
		
		log.info("当前登录人：{},类名:{},方法名:{},参数：{},执行时间：{}",userid, className, methodName, args, time);
		
		sysLogService.insertLog(sys_log);
	}
}
复制代码

这里简单介绍下关于AOP的几个重要注解：

  • @Aspect:这个注解表示将当前类视为一个切面类
  • @Component：表示将当前类交由Spring管理。
  • @Pointcut:切点表达式,定义咱们的匹配规则，上边咱们使用@Pointcut("@annotation(com.web.springbootaoplog.config.Log)")表示匹配带有咱们自定义注解的方法。
  • @Around:环绕通知，能够在目标方法执行先后执行一些操做，以及目标方法抛出异常时执行的操做。

咱们用到的注解就这几个，固然还有其余的注解，这里我就不一一介绍了，想要深刻了解AOP相关知识的朋友能够移步官方文档【传送门】

下面看一段关键的代码：

log.info("我在目标方法以前执行！");
result = point.proceed();
long endTime = System.currentTimeMillis();
insertLog(point,endTime-beginTime);
复制代码

其中result = point.proceed();这句话表示执行目标方法,能够看出咱们在这段代码执行以前打印了一句日志，并在执行以后调用了insertLog()插入日志的方法，而且在方法中咱们能够拿到目标方法所在的类名，方法名，参数等重要的信息。

测试控制器

在controller包下新建一个HomeCOntroller.java(名字你们随意),内容以下：

package com.web.springbootaoplog.controller;

import java.util.HashMap;
import java.util.Map;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;

import com.web.springbootaoplog.config.Log;
import com.web.springbootaoplog.entity.SysLog;
import com.web.springbootaoplog.service.ISysLogService;

/** * @author Promise * @createTime 2019年1月2日 下午10:35:30 * @description 测试controller */
@Controller
public class HomeController {

    private final static Logger log = org.slf4j.LoggerFactory.getLogger(HomeController.class);
	
	@Autowired
	private ISysLogService logService;

	@RequestMapping("/aop")
	@ResponseBody
	@Log("测试aoplog")
	public Object aop(String name, String nick) {
		Map<String, Object> map =new HashMap<>();
		log.info("我被执行了！");
		map.put("res", "ok");
		return map;
	}
}

复制代码

定义一个测试方法，带有两个参数，而且为该方法添加了咱们自定义的@Log注解，启动项目，浏览器访问localhost:8080/aop?name=xfr&nick=eran,这时候查看eclipse控制台的部分输出信息以下：

2019-01-24 22:02:17.682  INFO 3832 --- [nio-8080-exec-1] c.web.springbootaoplog.config.LogAsPect  : 我在目标方法以前执行！
2019-01-24 22:02:17.688  INFO 3832 --- [nio-8080-exec-1] c.w.s.controller.HomeController          : 我被执行了！
2019-01-24 22:02:17.689  INFO 3832 --- [nio-8080-exec-1] c.web.springbootaoplog.config.LogAsPect  : 当前登录人：1,类名:com.web.springbootaoplog.controller.HomeController,方法名:aop,参数：[xfr, eran],执行时间：6
复制代码

能够看到咱们成功在目标方法执行先后插入了一些逻辑代码，如今再看数据库里边的数据：

在这里插入图片描述

成功记录了一条数据。

实现AOP记录面向开发者的日志

首先这里我列举一个使用该方式的应用场景，在项目中出现了bug，咱们想要知道前台的请求是否进入了咱们控制器中，以及参数的获取状况，下面开始介绍实现步骤。

其实原理跟上边是同样的，只是切点的匹配规则变了而已，并且不用将日志记录到数据库，打印出来便可。

首先在LogAsPect.java中定义一个新的切点表达式，以下：

@Pointcut("execution(public * com.web.springbootaoplog.controller..*.*(..))")
public void pointcutController() {}

复制代码

@Pointcut("execution(public * com.web.springbootaoplog.controller..*.*(..))")表示匹配com.web.springbootaoplog.controller包及其子包下的全部公有方法。

关于这个表达式详细的使用方法能够移步这里，【传送门】

再添加匹配到方法时咱们要作的操做：

@Before("pointcutController()")
public void around2(JoinPoint point) {
	//获取目标方法
	String methodNam = point.getSignature().getDeclaringTypeName() + "." + point.getSignature().getName();
	
	//获取方法参数
	String params = Arrays.toString(point.getArgs());
	
	log.info("get in {} params :{}",methodNam,params);
}
复制代码

@Before:表示目标方法执行以前执行如下方法体的内容。

再在控制器中添加一个测试方法：

@RequestMapping("/testaop3")
@ResponseBody
public Object testAop3(String name, String nick) {
	Map<String, Object> map = new HashMap<>();
	
	map.put("res", "ok");
	return map;
}
复制代码

能够看到这个方法咱们并无加上@Log注解，重启项目，浏览器访问localhost:8080/testaop3?name=xfr&nick=eran,这时候查看eclipse控制台的部分输出信息以下：

2019-01-24 23:19:49.108  INFO 884 --- [nio-8080-exec-1] c.web.springbootaoplog.config.LogAsPect  : get in com.web.springbootaoplog.controller.HomeController.testAop3 params :[xfr, eran]
复制代码

打印出了关键日志，这样咱们就能知道是否是进入了该方法，参数获取是否正确等关键信息。

这里有的朋友或许会有疑问这样会不会与添加了@Log的方法重复了呢，的确会，因此在项目中我一般都将@Log注解用在了Service层的方法上，这样也更加合理。

结语

好了，关于Aop记录日志的内容就介绍这么多了，下一篇博客再见。bye~

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程