文档章节

Spring+SpringMVC+Mybatis 利用AOP自定义注解实现可配置日志快照记录

凯文加内特
 凯文加内特
发布于 2015/05/12 15:52
字数 1026
阅读 6965
收藏 14

目的:

需要对一些事物的操作进行日志记录,如果在service内进行记录,大量的代码重复,并且维护比较麻烦。所以采用AOP的方式对service进行拦截。使用自定义注解的目的则是判断是否需要记录日志和传递额外的信息。

方式

本次解决方案十分感谢博主-跳刀的兔子的博文 本文绝大部分参考与本文,略有不同,所以做一些整理,博主的文章更详细一些。

1.首先新建自定义注解

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented  
@Inherited
public @interface LogWrite {
    /**
     *@param 模块名字 
     */
    String modelName() default "";
    
    /**
     *@param 操作类型 
     */
    String option();
}
  • 其中@Target注解用于描述该注解的范围,我们需要注解的方法,所以值为METHOD,相关含义如下表:

取值 含义

CONSTRUCTOR 描述构造器

FIELD 描述域

LOCAL_VARIABLE 用于描述局部变量

METHOD 用于描述方法

PACKAGE 用于描述包

PARAMETER 用于描述参数

TYPE 用于描述类或接口

  • @Retention 用于描述注解的生命周期(即:被描述的注解在什么范围内有效),其取值有:

取值 含义

SOURCE 在源文件中有效(即源文件保留)

CLASS 在 class 文件中有效(即 class 保留)

RUNTIME 在运行时有效(即运行时保留)

  • @Documented 在默认的情况下javadoc命令不会将我们的annotation生成再doc中去的,所以使用该标记就是告诉jdk让它也将annotation生成到doc中去

  • @Inherited 比如有一个类A,在他上面有一个标记annotation,那么A的子类B是否不用再次标记annotation就可以继承得到呢,答案是肯定的

2.利用AOP方式拦截

  • 配置AOP,我使用的是利用注解的方式来配置AOP,方法有很多,就不详细说了。

  • 使用的是@Around 环绕通知,因为需要记录该方法是否被执行成功了。

  • 实现@Around方法中,记录日志: 获取拦截的方法,判断该方法是否含有自定义注解,如果没有的则不进行记录,否则,按照自己的方式进行记录。 我主要记录的是操作的方法,所属模块,以及所有参数所构成的Json字符串。

@Aspect
@Component
public class SnapshotLogWriteService {
	private LogService logService;
	public LogService getLogService() {
		return logService;
	}

	//自动注入日志记录service
	@Autowired
	public void setLogService(LogService logService) {
		this.logService = logService;
	}
	//环绕通知方法
	@Around("execution(* unkeltao.service.*.*(..))")
	public Object doWriteLog(ProceedingJoinPoint pjp) throws Throwable {
		System.err.println("拦截方法,进入日志记录");
		// 拦截的实体类
		Object target = pjp.getTarget();
		// 拦截的方法名称
		String methodName = pjp.getSignature().getName();
		// 拦截的方法参数
		Object[] args = pjp.getArgs();
		
		// 拦截的放参数类型
		Class[] parameterTypes = ((MethodSignature) pjp.getSignature())
				.getMethod().getParameterTypes();

		Object object = null;
		
		//需要转换成Json的HashMap
		Map<String, Object> maps = new HashMap<String, Object>();
		Map<String, Object> parammaps = new HashMap<String, Object>();
		// 获得被拦截的方法
		Method method = target.getClass().getMethod(methodName, parameterTypes);
		if (null != method) {
			// 判断是否包含自定义的注解
			if (method.isAnnotationPresent(MyAnnotation.class)) {
				// 获取自定义注解实体
				MyAnnotation myAnnotation = method
						.getAnnotation(MyAnnotation.class);
				//日志类实体类
				OptionLog log = new OptionLog();
				
				log.setUserid(myAnnotation.userid());
				log.setModelname(myAnnotation.modelName());
				log.setOp(myAnnotation.option());
				maps.put("方法名", method.getName());
				parammaps.put("方法名", method.getName());
                //循环获得所有参数对象
				for(int i=0; i<args.length; i++){
					if (null != args[i]) {
						parammaps.put("args["+i+"]", args[i]);
					}
					else {
						parammaps.put("args["+i+"]", "空参数");
					}
				}
				maps.put("参数", parammaps);
				SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");  
				maps.put("操作时间", sdf.format(new Date()));
				// 获取服务运行结果
				try {
					object = pjp.proceed();// 执行该方法
					maps.put("状态", "成功");
					log.setStatus(1);
				} catch (Exception e) {
					System.err.println(e.getMessage());
					maps.put("状态", "失败");
					log.setStatus(0);
					log.setComments(e.getMessage());
				}
				//将参数转化为Json字符串
				log.setJs(new JSONObject(maps).toJSONString());
				log.setOptime(new Date());
				System.err.println(new JSONObject(maps).toJSONString());  
				
				//记录相关日志
				if (null != logService) {
					try {
						if(1 == logService.Save(log)){
							System.err.println("日志记录成功");
						}
						else{
							System.err.println("日志记录失败");
						}
						
					} catch (Exception e) {
						e.printStackTrace();
					}
				}
				else{
					System.err.println("自动注入失败,日志未记录");
				}

			} else { // 没有包含该注解则不进行其他处理
				object = pjp.proceed();// 执行该方法
			}

		} else { // 不需要拦截,直接运行
			object = pjp.proceed(); // 执行该方法
		}
		return object;
	}
}

记录结果

记录结果

最终的Json效果图

效果图

原文地址: http://www.UnkelTao.com/blog/2014/07/22/spring-plus-springmvc-plus-mybatis-aop/


本文转载自:http://unkeltao.com/blog/2014/07/22/spring-plus-springmvc-plus-mybatis-aop/

凯文加内特
粉丝 340
博文 698
码字总数 110557
作品 0
青岛
后端工程师
私信 提问
加载中

评论(2)

凯文加内特
凯文加内特 博主

引用来自“soft5200”的评论

能否提供下完整代码,谢谢
Q:464281868

木有啊,只是转帖
s
soft5200
能否提供下完整代码,谢谢
Q:464281868
SpringBoot | 第二十四章:日志管理之AOP统一日志

前言 上一章节,介绍了目前开发中常见的及日志框架的整合知识。在很多时候,我们在开发一个系统时,不管出于何种考虑,比如是审计要求,或者防抵赖,还是保留操作痕迹的角度,一般都会有个全...

oKong
2018/08/24
1K
4
springAOP自定义注解方式实现日志管理

今天继续实现AOP,到这里我个人认为是最灵活,可扩展的方式了,就拿日志管理来说,用SPRing AOP 自定义注解形式实现日志管理。废话不多说,直接开始!!! 关于配置我还是的再说一遍。 在app...

嘻哈开发者
2016/04/11
110
0
springboot aop 自定义注解方式实现一套完善的日志记录

一:功能简介 本文主要记录如何使用aop切面的方式来实现日志记录功能。 主要记录的信息有: 操作人,方法名,参数,运行时间,操作类型(增删改查),详细描述,返回值。 二:项目结构图 如果想...

编程SHA
01/30
453
0
SpringBoot(四)之优雅地日志处理

一、简介 日志功能在j2ee项目中是一个相当常见的功能,在一个小项目中或许你可以在一个个方法中,使用日志表的Mapper生成一条条的日志记录,但这无非是最烂的做法之一,因为这种做法会让日志...

郑加威
2018/12/23
355
0
aop + annotation 实现统一日志记录

aop + annotation 实现统一日志记录 在开发中,我们可能需要记录异常日志。由于异常比较分散,每个 service 方法都可能发生异常,如果我们都去做处理,会出现很多重复编码,也不好维护。这种...

长安一梦
2018/07/22
46
0

没有更多内容

加载失败,请刷新页面

加载更多

OSChina 周二乱弹 —— 开发语言和语言开发的能一样么

Osc乱弹歌单(2019)请戳(这里) 【今日歌曲】 @花间小酌:#今日歌曲推荐# 分享The Score的单曲《Revolution》 《Revolution》- The Score 手机党少年们想听歌,请使劲儿戳(这里) @批判派...

小小编辑
11分钟前
35
3
oracle ORA-39700: database must be opened with UPGRADE option

ORA-01092: ORACLE instance terminated. Disconnection forced ORA-00704: bootstrap process failure ORA-39700: database must be opened with UPGRADE option 进程 ID: 3650 会话 ID: 29......

Tank_shu
今天
3
0
分布式协调服务zookeeper

ps.本文为《从Paxos到Zookeeper 分布式一致性原理与实践》笔记之一 ZooKeeper ZooKeeper曾是Apache Hadoop的一个子项目,是一个典型的分布式数据一致性的解决方案,分布式应用程序可以基于它...

ls_cherish
今天
4
0
聊聊DubboDefaultPropertiesEnvironmentPostProcessor

序 本文主要研究一下DubboDefaultPropertiesEnvironmentPostProcessor DubboDefaultPropertiesEnvironmentPostProcessor dubbo-spring-boot-project-2.7.3/dubbo-spring-boot-compatible/au......

go4it
昨天
2
0
redis 学习2

网站 启动 服务端 启动redis 服务端 在redis 安装目录下 src 里面 ./redis-server & 可以指定 配置文件或者端口 客户端 在 redis 的安装目录里面的 src 里面 ./redis-cli 可以指定 指定 连接...

之渊
昨天
2
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部