100字范文,内容丰富有趣,生活中的好帮手!
100字范文 > 如何在springboot项目中使用自定义注解实现系统操作日志的功能

如何在springboot项目中使用自定义注解实现系统操作日志的功能

时间:2019-01-09 13:41:11

相关推荐

如何在springboot项目中使用自定义注解实现系统操作日志的功能

通常我们的项目中都需要记录操作日志,方便回溯问题,找到根源。

因为给项目添加日志记录功能是属于系统级别的功能,所以这个问题我们马上会想到spring的AOP,可以通过切面的形式。那么怎么来实现呢?

先来回顾一下spring的AOP特性:

可以说是OOP(Object Oriented Programming,面向对象编程)的补充和完善。OOP引入封装、继承、多态等概念来建立一种对象层次结构,用于模拟公共行为的一个集合。不过OOP允许开发者定义纵向的关系,但并不适合定义横向的关系,例如日志功能。日志代码往往横向地散布在所有对象层次中,而与它对应的对象的核心功能毫无关系对于其他类型的代码,如安全性、异常处理和透明的持续性也都是如此,这种散布在各处的无关的代码被称为横切(cross cutting),在OOP设计中,它导致了大量代码的重复,而不利于各个模块的重用。

AOP技术恰恰相反,它利用一种称为"横切"的技术,剖解开封装的对象内部,并将那些影响了多个类的公共行为封装到一个可重用模块,并将其命名为"Aspect",即切面。所谓"切面",简单说就是那些与业务无关,却为业务模块所共同调用的逻辑或责任封装起来,便于减少系统的重复代码,降低模块之间的耦合度,并有利于未来的可操作性和可维护性。

AOP核心概念

1、横切关注点

对哪些方法进行拦截,拦截后怎么处理,这些关注点称之为横切关注点

2、切面(aspect)

类是对物体特征的抽象,切面就是对横切关注点的抽象

3、连接点(joinpoint)

被拦截到的点,因为Spring只支持方法类型的连接点,所以在Spring中连接点指的就是被拦截到的方法,实际上连接点还可以是字段或者构造器

4、切入点(pointcut)

对连接点进行拦截的定义

5、通知(advice)

所谓通知指的就是指拦截到连接点之后要执行的代码,通知分为前置、后置、异常、最终、环绕通知五类

6、目标对象

代理的目标对象

7、织入(weave)

将切面应用到目标对象并导致代理对象创建的过程

8、引入(introduction)

在不修改代码的前提下,引入可以在运行期为类动态地添加一些方法或字段

好了,基本特性已经介绍完了,下面看我们是如何实现的?

第一步,自定义注解。

/*** 系统日志注解*/@Target(ElementType.METHOD)@Retention(RetentionPolicy.RUNTIME)@Documentedpublic @interface SysLog {String value() default "";}

第二步,定义切面类

/*** 系统日志,切面处理类*/@Aspect@Componentpublic class SysLogAspect {//注入日志相关的service层@Autowiredprivate SysLogService sysLogService;//指定切入点,注意这种写法括号里面是刚刚定义的注解@Pointcut("@annotation(com.xxx.annotation.SysLog)")public void logPointCut() { }//对连接点进行拦截,可以记录方法执行时间@Around("logPointCut()")public Object around(ProceedingJoinPoint point) throws Throwable {long beginTime = System.currentTimeMillis();//执行方法Object result = point.proceed();//执行时长(毫秒)long time = System.currentTimeMillis() - beginTime;//被拦截的方法执行完成之后,保存日志saveSysLog(point, time);return result;}private void saveSysLog(ProceedingJoinPoint joinPoint, long time) {MethodSignature signature = (MethodSignature) joinPoint.getSignature();Method method = signature.getMethod();SysLogEntity sysLog = new SysLogEntity();SysLog syslog = method.getAnnotation(SysLog.class);if(syslog != null){//注解上的描述sysLog.setOperation(syslog.value());}//请求的方法名String className = joinPoint.getTarget().getClass().getName();String methodName = signature.getName();sysLog.setMethod(className + "." + methodName + "()");//请求的参数Object[] args = joinPoint.getArgs();try{String params = new Gson().toJson(args[0]);sysLog.setParams(params);}catch (Exception e){}//获取request//HttpServletRequest request = HttpContextUtils.getHttpServletRequest();//设置IP地址//sysLog.setIp(IPUtils.getIpAddr(request));//用户名//String username = ((SysUserEntity) SecurityUtils.getSubject().getPrincipal()).getUsername();//sysLog.setUsername(username);sysLog.setTime(time);sysLog.setCreateDate(new Date());//保存系统日志sysLogService.save(sysLog);}}

第三步,在需要记录操作日志的地方加入该注解即可

例如接口。

/*** 列表*/@GetMapping("/list")@SysLog(value = "查询")public Entity list(Request parm) {return ResponseUtil.buildResponse(parm);}

本内容不代表本网观点和政治立场,如有侵犯你的权益请联系我们处理。
网友评论
网友评论仅供其表达个人看法,并不表明网站立场。