spring-boot使用AOP统一处理日志

aop我想大家都很清楚,有时候我们需要处理一些请求日志,或者对某些方法进行一些监控,如果出现例外情况应该进行怎么样的处理,现在,我们从spring-boot中引入aop.

[开发环境:jdk版本号为1.8,spring
boot的版本号为1.4.1]{style=”background-color:#ff0000”}

首先,我们先引入jar包,

pom文件添加如下内容:

<!--引用aop-->
<dependency>
  <groupid>org.springframework.boot</groupid>
  <artifactid>spring-boot-starter-aop</artifactid>
</dependency>
<!--引用gson,用于打印-->
<dependency>
  <groupid>com.google.code.gson</groupid>
  <artifactid>gson</artifactid>
  <version>2.7</version>
</dependency>

引入jar包后,我们在boot的启动方法,增加两个简单的请求处理方法:

@springbootapplication(scanbasepackages = {"com"})
@restcontroller
public class demoapplication{
  public static void main(string[] args) {
   springapplication.run(demoapplication.class, args);
  }
  //测试无参的get请求
  @requestmapping(value = "/testaspect",method = requestmethod.get)
  public uservo test(){
   uservo uservo = new uservo();
   uservo.setage("23");
   uservo.setname("贺小五");
   uservo.setsex("男");
   return uservo;
  }
  //测试有参的get请求,让aop打印参数内容
  @requestmapping(value = "/testaspectargs",method = requestmethod.get)
  public uservo test(string name,string age,string sex){
   uservo uservo = new uservo();
   uservo.setname(name);
   uservo.setage(age);
   uservo.setsex(sex);
   return uservo;
  }

增加了两个简单的处理请求方法后,我们来增加我们的aop

/**
 * 项目名:springbootdemo
 * 创建人:贺小五
 * 创建时间:16/12/4 下午7:05
 * 类名:aspectdemo
 * 类描述:
 */
//申明是个切面
@aspect
//申明是个spring管理的bean
@component
@order(1)
public class aspectdemo {
  private logger log = logger.getlogger(getclass());
  private gson gson = new gson();
  //申明一个切点 里面是 execution表达式
  @pointcut("execution(public * com.example.demoapplication.*(..))")
  private void controlleraspect(){}
  //请求method前打印内容
  @before(value = "controlleraspect()")
  public void methodbefore(joinpoint joinpoint){
   servletrequestattributes requestattributes = (servletrequestattributes) requestcontextholder.getrequestattributes();
   httpservletrequest request = requestattributes.getrequest();
   //打印请求内容
   log.info("===============请求内容===============");
   log.info("请求地址:"+request.getrequesturl().tostring());
   log.info("请求方式:"+request.getmethod());
   log.info("请求类方法:"+joinpoint.getsignature());
   log.info("请求类方法参数:"+ arrays.tostring(joinpoint.getargs()));
   log.info("===============请求内容===============");
  }
  //在方法执行完结后打印返回内容
  @afterreturning(returning = "o",pointcut = "controlleraspect()")
  public void methodafterreturing(object o ){
   log.info("--------------返回内容----------------");
   log.info("response内容:"+gson.tojson(o));
   log.info("--------------返回内容----------------");
  }

两者配置好之后,接下来,我们请求,然后查看打印日志,首先,启动我们的容器,然后我们先请求有参的处理请求方法的,打印日志如下:

{width=”1232”
height=”132”}

可以发现,请求的url,method,以及args参数的值,还有类型,以及返回的内容都打印出来了,说明,这是aop拦截成功了.

接下来,我们测试下请求无参的处理请求方法,打印日志如下:

{width=”1100”
height=”130”}

我们可以发现,这个方法,打印的方法参数是个空数组,是因为方法不需要参数传递.

以上就是springboot引用aop进行处理web的日志处理,下面将添加aop切面的主要几个注解,下面只是对注解的描述跟使用,具体测试,作者就不进行测试了,各位看官有兴趣的话,可以自己测试一下:

类注解:

@aspect将一个类定义为一个切面类
@order(i)标记切面类的处理优先级,i值越小,优先级别越高.ps:可以注解类,也能注解到方法上

方法注解:

@pointcut定义一个方法为切点里面的内容为一个表达式,下面详细介绍
@before 在切点前执行方法,内容为指定的切点
@after 在切点后,return前执行,
@afterreturning在切入点,return后执行,如果想对某些方法的返回参数进行处理,可以在这操作
@around 环绕切点,在进入切点前,跟切点后执行
@afterthrowing 在切点后抛出异常进行处理
@order(i) 标记切点的优先级,i越小,优先级越高

@pointcut注解组合使用:

上面代码中,我们定义了一个切点,该切点只进行处理指定路径的:

@pointcut("execution(public * com.example.demoapplication.*(..))")
private void controlleraspect(){}

现在,我们在定义一个处理其他路径下的切点:

@pointcut("execution(public * com.demo.*.*(..))")
private void controllerdemo(){}

以上切点,都是分别处理不同的内容,如果我们需要一个切点来处理他们两者,我们可以这么配置:

@pointcut(value = "controlleraspect()||controllerdemo()")
private void all(){}

在@pointcut注解内,直接引用其它被@pointcut注解过的方法名称,这样,该切点就可以处理两个路径下的方法

@pointcut注解中的execution表达式: public * com.demo.*.*(..)

第一个 public 表示方法的修饰符,可以用*代替
第一个 * 表示 返回值,*代表所有
com.demo.* 包路径,.*表示路径下的所有包
第三个.* 表示路径下,所有包下的所有类的方法
(..) 表示不限方法参数

关于@order(i)注解的一些注意事项:

注解类,i值是,值越小,优先级越高
注解方法,分两种情况
注解的是 @before 是i值越小,优先级越高
注解的是 @after或者@afterreturning 中,i值越大,优先级越高

总结两者的概括就是:
在切入点前的操作，按order的值由小到大执行
在切入点后的操作，按order的值由大到小执行

延伸:

有看官可能会问,如果我要打印请求从进来,到结束,所需要的时间,定义一个成员变量,用来统计时间,同时给@before跟@afterreturning访问,可能会有同步的问题,所以我们引用一个threadlocal指定泛型的对象,在@before记录请求的时间,在@afterreturning扣除记录的时间,就是消耗的时间,代码如下:

/**
 * 项目名:springbootdemo
 * 创建人:贺小五
 * 创建时间:16/12/4 下午7:05
 * 类名:aspectdemo
 * 类描述:
 */
//申明是个切面
@aspect
//申明是个spring管理的bean
@component
@order(1)
public class aspectdemo {
  private logger log = logger.getlogger(getclass());
  private gson gson = new gson();
  threadlocal<long> starttime = new threadlocal<long>();
  //申明一个切点 里面是 execution表达式
  @pointcut("execution(public * com.example.demoapplication.*(..))")
  private void controlleraspect() {
  }
  //请求method前打印内容
  @before(value = "controlleraspect()")
  public void methodbefore(joinpoint joinpoint) {
   starttime.set(system.currenttimemillis());
   servletrequestattributes requestattributes = (servletrequestattributes) requestcontextholder.getrequestattributes();
   httpservletrequest request = requestattributes.getrequest();
   //打印请求内容
   log.info("===============请求内容===============");
   log.info("请求地址:" + request.getrequesturl().tostring());
   log.info("请求方式:" + request.getmethod());
   log.info("请求类方法:" + joinpoint.getsignature());
   log.info("请求类方法参数:" + arrays.tostring(joinpoint.getargs()));
   log.info("===============请求内容===============");
  }
  //在方法执行完结后打印返回内容
  @afterreturning(returning = "o", pointcut = "controlleraspect()")
  public void methodafterreturing(object o) {
   log.info("--------------返回内容----------------");
   log.info("response内容:" + gson.tojson(o));
   log.info("--------------返回内容----------------");
   log.info("请求处理时间为:"+(system.currenttimemillis() - starttime.get()));
  }
}

以上,均为本人测试而得出的结果,可能会有出入,或者错误,欢迎指正.

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。