SpringBoot使⽤aop切⾯做⽇志收集、处理
1. 在项⽬开发中,⽇志收集处理是⼀个必不可少的功能,会做⽇志收集处理的⼈很多,但是却没有⽐较详细的说明和注解⽀持⼩⽩去学
习,于是,就诞⽣了这篇博客,可能这边博客也不是最好的,但我相信,对未来的⼤佬们来说,这个多少还是有点料的
2. SpringBoot中做⽇志的⽅法有很多,⽐如⽤,在中进⾏处理需要进⾏收集⽇志的⽅法,同时也可以将⽇志存库,但是这
种⽅法可能会有⼀个弊端,在中进⾏处理⽇志的话,对于请求量过⼤的系统,或者处理次数过多的,以及并发过⾼的项⽬来说,都是⼀个可怕的性能消耗。⽅法⼆,使⽤elk加kafka来做我们的⽇志,但是这种东西对于⼩⽩们来说,确实⽐较费劲,(我要是_
会⽤kafka还会是⼩⽩吗)同时,对于⼩项⽬来说,使⽤kafka的成本太⾼(不是经济成本哦!),所以杀鸡⽤⽜⼑,太浪费了。⽅法三,使⽤aop做切⾯,实现⽇志的收集处理,(也就是本篇⽂章的get点了)
3. aop做⽇志处理的关键原因,量级⼩,简单,适合⼩型项⽬且并发量不是特别⼤的(对于如何使⽤aop可以去看博主的其他博客,⾥⾯
有aop注解使⽤的详细介绍和使⽤⽅法)
4. 各位新星们,下⾯上⼤菜了!
5. 需要使⽤aop的话,我们需要引⼊aop的jar包,(怎么引⼊就不告诉你,这是武功秘籍,3元⼀本,欢迎选购!)
<dependency>
<groupId>org.springfarmework.boot</groupId>
<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
够意思吧,这都能给你写出来,你要问我放在哪,我⼩声告诉你,放到pom⽂件⾥⾯哦!
6. 引⼊完成jar包之后,需要去我们的配置⽂件中进⾏开启aop注解⽀持,否则的话,你的注解是不管⽤的
spring:
#切⾯启⽤
aop:
proxy-target-class: true #默认为false
auto: true #默认为false
proxy-target-class属性值决定是基于接⼝的还是基于类的代理被创建。⾸先说明下proxy-target-class="true"和proxy-target-
class="false"的区别,为true则是基于类的代理将起作⽤(需要cglib库),为false或者省略这个属性,则标准的JDK 基于接⼝的代理将起作⽤。
proxy-target-class在spring事务、aop、缓存这⼏块都有设置,其作⽤都是⼀样的。
auto为开启aop注解,如同SpringBoot的⾃动配置⼀般
7. 开启注解⽀持后,我们就可以开始进⾏个⼈秀了!
8. 我们可以⾃定义⼀个注解,通过注解实现我们都controller或者service的⽇志收集
controller的⾃定义注解,对于如何使⽤SpringBoot的⾃定义注解以及如何定义可以查看博主的其他博客
package cn.annotation;
import java.lang.annotation.*;
/**
* @version V1.0
* Description: ⾃定义注解,拦截controller
*/
@Target({ElementType.PARAMETER, ElementType.METHOD})//作⽤在参数和⽅法上
@Retention(RetentionPolicy.RUNTIME)//运⾏时注解
@Documented//表明这个注解应该被 javadoc⼯具记录
public @interface SystemControllerLog {
String description() default "";
}
service的⾃定义注解
package cn.annotation;
import java.lang.annotation.*;
/**
* @version V1.0
* Description: ⾃定义注解,拦截service
*/
@Target({ElementType.PARAMETER, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface SystemServiceLog {
String description() default "";
}
9. 这⾥就需要去写aop的切⾯类了
package cn.annotation;
import cn.pojo.Action;
import cn.pojo.User;
import cn.service.ActionService;
import cn.utils.IpUtils;
import cn.utils.JsonUtils;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterThrowing;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.t.request.RequestContextHolder;
import org.t.request.ServletRequestAttributes;
import javax.annotation.Resource;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
spring aop应用场景import flect.Method;
import java.util.Date;
/**
* Title: SystemControllerLog
* @date 2018年8⽉31⽇
* @version V1.0
* Description: 切点类
*/
@Aspect
@Component
@SuppressWarnings("all")
public class SystemLogAspect {
//注⼊Service⽤于把⽇志保存数据库,实际项⽬⼊库采⽤队列做异步
@Resource
private ActionService actionService;
//本地异常⽇志记录对象
private static final Logger logger = Logger(SystemLogAspect.class); //Service层切点
@Pointcut("@annotation(cn.annotation.SystemServiceLog)")
public void serviceAspect(){
}
//Controller层切点
@Pointcut("@annotation(cn.oa.annotation.SystemControllerLog)")
public void controllerAspect(){
/**
* @Description 前置通知⽤于拦截Controller层记录⽤户的操作
*/
@Before("controllerAspect()")
public void doBefore(JoinPoint joinPoint){
HttpServletRequest request = ((ServletRequestAttributes) RequestAttributes()).getRequest();
HttpSession session = Session();
/
/读取session中的⽤户,需要在请求同中携带⽤户的信息才能获取到数据,博主的token使⽤中有介绍如何携带使⽤
//User user = (User) Attribute("user");
try {
System.out.println("==============前置通知开始==============");
System.out.println("请求⽅法" + (Target().getClass().getName() + "." + Signature().getName()));
System.out.println("⽅法描述:" + getControllerMethodDescription(joinPoint));
// System.out.println("请求⼈:"+Username());
//*========数据库⽇志=========*//
//保存数据库(这⾥可以直接调⽤service将收集到的⽇志信息存到数据库中)
}catch (Exception e){
//记录本地异常⽇志
<("==前置通知异常==");
<("异常信息:{}",e.getMessage());
}
}
/**
* @Description 异常通知⽤于拦截service层记录异常⽇志
*/
@AfterThrowing(pointcut = "serviceAspect()",throwing = "e")
public void doAfterThrowing(JoinPoint joinPoint,Throwable e){
HttpServletRequest request = ((ServletRequestAttributes) RequestAttributes()).getRequest();
HttpSession session = Session();
//读取session中的⽤户
User user = (User) Attribute("user");
//获取⽤户请求⽅法的参数并序列化为JSON格式字符串
String params = "";
if (Args()!=null&&Args().length>0){
for (int i = 0; i < Args().length; i++) {
params+= JsonUtils.Args()[i])+";";
}
}
try{
System.out.println("异常代码:" + e.getClass().getName());
System.out.println("异常信息:" + e.getMessage());
System.out.println("异常⽅法:" + (Target().getClass().getName() + "." + Signature().getName() + "()")); System.out.println("⽅法描述:" + getServiceMethodDescription(joinPoint));
System.out.println("请求⼈:" + Username());
System.out.println("请求IP:" + ip);
System.out.println("请求参数:" + params);
Action action = new Action();
action.setActionDes(getServiceMethodDescription(joinPoint));
action.setActionType("1");
action.Id());
action.setActionIp(ip);
action.setActionTime(new Date());
//保存到数据库
actionService.add(action);
}catch (Exception ex){
//记录本地异常⽇志
<("==异常通知异常==");
<("异常信息:{}", ex.getMessage());
}
}
* @Description 获取注解中对⽅法的描述信息⽤于service层注解
*/
public static String getServiceMethodDescription(JoinPoint joinPoint)throws Exception{
String targetName = Target().getClass().getName();
String methodName = Signature().getName();
Object[] arguments = Args();
Class targetClass = Class.forName(targetName);
Method[] methods = Methods();
String description = "";
for (Method method:methods) {
if (Name().equals(methodName)){
Class[] clazzs = ParameterTypes();
if (clazzs.length==arguments.length){
description = Annotation(SystemServiceLog.class).description();
break;
}
}
}
return description;
}
/**
* @Description 获取注解中对⽅法的描述信息⽤于Controller层注解
*/
public static String getControllerMethodDescription(JoinPoint joinPoint) throws Exception {
String targetName = Target().getClass().getName();
String methodName = Signature().getName();//⽬标⽅法名
Object[] arguments = Args();
Class targetClass = Class.forName(targetName);
Method[] methods = Methods();
String description = "";
for (Method method:methods) {
if (Name().equals(methodName)){
Class[] clazzs = ParameterTypes();
if (clazzs.length==arguments.length){
description = Annotation(SystemControllerLog.class).description();
break;
}
}
}
return description;
}
}
这⾥有两个⼯具类是获取ip和进⾏json格式转换的,⼤家注意⼀下哦
10. 到这⾥我们的aop就已经完成了,需要使⽤就的话就在你需要的controller或service中进⾏添加我们⾃⼰定义的注解就⾏了
@SystemControllerLog(description = "")
注解加在控制器中⽅法上⾯,括号⾥写上操作描述
@SystemServiceLog(description = "")
注解加在service层⽅法上⾯,括号⾥写上操作描述
这个博客也是博主去了⼀些资料,然后通过⾃⼰使⽤进⾏修改后出来的⼀个demo,是个⼈的⽚⾯理解,如果不到的地⽅,欢迎批评指正参考博客
转载记得加我的来源哦 !
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论