文档章节

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

贺小五
 贺小五
发布于 2016/12/04 21:38
字数 1592
阅读 3595
收藏 114

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

 

开发环境:jdk版本号为1.8,spring boot的版本号为1.4.1

 

首先,我们先引入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("--------------返回内容----------------");
   }

 

 

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

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

 

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

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

 

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

 

类注解:

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

 

 

方法注解:

  1. @Pointcut 定义一个方法为切点里面的内容为一个表达式,下面详细介绍
  2. @Before 在切点前执行方法,内容为指定的切点
  3. @After 在切点后,return前执行,
  4. @AfterReturning 在切入点,return后执行,如果想对某些方法的返回参数进行处理,可以在这操作
  5. @Around 环绕切点,在进入切点前,跟切点后执行
  6. @AfterThrowing 在切点后抛出异常进行处理
  7. @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.*.*(..)

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

 

 

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

  1. 注解类,i值是,值越小,优先级越高
  2. 注解方法,分两种情况 
  • 注解的是 @Before 是i值越小,优先级越高
  • 注解的是 @After或者@AfterReturning 中,i值越大,优先级越高

总结两者的概括就是:

  • 在切入点前的操作,按order的值由小到大执行
  • 在切入点后的操作,按order的值由大到小执行

 

 

延伸:

        有看官可能会问,如果我要打印请求从进来,到结束,所需要的时间,定义一个成员变量,用来统计时间,同时给@Before跟@AfterReturning访问,可能会有同步的问题,所以我们引用一个ThreadLocal<Long>指定泛型的对象,在@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()));

   }

}

 

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

 

欢迎转载,请注明出处跟作者,谢谢!

 

© 著作权归作者所有

贺小五

贺小五

粉丝 73
博文 47
码字总数 48425
作品 0
海淀
程序员
私信 提问
加载中

评论(10)

老虎是个蛋蛋
老虎是个蛋蛋

引用来自“戢冠生”的评论

AOP 打印日志 和spring boot 没有关系。 抢热点呢
确实,这种日志其实没太大意义
Y
Y292450104
自己玩玩还行,日志还是需要手动写,大量的五意义的日志只会拖慢系统,对问题的定位还无任何帮助。
魔法王者安琪拉
魔法王者安琪拉

引用来自“小兵成长记”的评论

日志格式太难看了,参考JFinal的好看https://my.oschina.net/u/136848/blog/785550

引用来自“Ambitor”的评论

事实上运行起来也不会有你这么漂亮的格式输出。
开发环境用于不用于生产
贺小五
贺小五 博主

引用来自“Ambitor”的评论

你应该需要这个吧?AbstractRequestLoggingFilter ,还用AOP?spring自己都有了~
确实比我的demo打印的更详细,学习了,谢谢😊
贺小五
贺小五 博主

引用来自“Ambitor”的评论

你应该需要这个吧?AbstractRequestLoggingFilter ,还用AOP?spring自己都有了~
学习了,谢谢告知
Ambitor
Ambitor
你应该需要这个吧?AbstractRequestLoggingFilter ,还用AOP?spring自己都有了~
Ambitor
Ambitor

引用来自“小兵成长记”的评论

日志格式太难看了,参考JFinal的好看https://my.oschina.net/u/136848/blog/785550
事实上运行起来也不会有你这么漂亮的格式输出。
魔法王者安琪拉
魔法王者安琪拉
日志格式太难看了,参考JFinal的好看https://my.oschina.net/u/136848/blog/785550
贺小五
贺小五 博主

引用来自“戢冠生”的评论

AOP 打印日志 和spring boot 没有关系。 抢热点呢

我没说有关系吧?我说的是使用
戢冠生
戢冠生
AOP 打印日志 和spring boot 没有关系。 抢热点呢
220.详细整理学习spring boot

1.springboot是什么? 有什么用? 1.1 是什么 一个整合常用第三方框架,简化xml配置,完全采用注解形式,内置tomcat容器,帮助开发者快速实现项目搭建,spring boot 的web组件默认集成的是spr...

Lucky_Me
04/23
130
1
SpringBoot(四)之优雅地日志处理

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

郑加威
2018/12/23
524
0
Spring Boot 使用AOP统一处理Web请求日志

AOP为Aspect Oriented Programming的缩写,意为:面向切面编程,通过预编译方式和运行期动态代理实现程序功能的统一维护的一种技术。AOP是Spring框架中的一个重要内容,它通过对既有程序定义...

小致dad
2018/08/08
288
0
springboot + shiro 权限注解、请求乱码解决、统一异常处理

springboot + shiro 权限注解、请求乱码解决、统一异常处理 前篇 后台权限管理系统 相关: spring boot + mybatis + layui + shiro后台权限管理系统 springboot + shiro之登录人数限制、登录...

wyait
2018/06/06
0
0
SpringBoot | 第二十四章:日志管理之AOP统一日志

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

oKong
2018/08/24
1K
4

没有更多内容

加载失败,请刷新页面

加载更多

java通过ServerSocket与Socket实现通信

首先说一下ServerSocket与Socket. 1.ServerSocket ServerSocket是用来监听客户端Socket连接的类,如果没有连接会一直处于等待状态. ServetSocket有三个构造方法: (1) ServerSocket(int port);...

Blueeeeeee
今天
6
0
用 Sphinx 搭建博客时,如何自定义插件?

之前有不少同学看过我的个人博客(http://python-online.cn),也根据我写的教程完成了自己个人站点的搭建。 点此:使用 Python 30分钟 教你快速搭建一个博客 为防有的同学不清楚 Sphinx ,这...

王炳明
昨天
5
0
黑客之道-40本书籍助你快速入门黑客技术免费下载

场景 黑客是一个中文词语,皆源自英文hacker,随着灰鸽子的出现,灰鸽子成为了很多假借黑客名义控制他人电脑的黑客技术,于是出现了“骇客”与"黑客"分家。2012年电影频道节目中心出品的电影...

badaoliumang
昨天
15
0
很遗憾,没有一篇文章能讲清楚线程的生命周期!

(手机横屏看源码更方便) 注:java源码分析部分如无特殊说明均基于 java8 版本。 简介 大家都知道线程是有生命周期,但是彤哥可以认真负责地告诉你网上几乎没有一篇文章讲得是完全正确的。 ...

彤哥读源码
昨天
15
0
jquery--DOM操作基础

本文转载于:专业的前端网站➭jquery--DOM操作基础 元素的访问 元素属性操作 获取:attr(name);$("#my").attr("src"); 设置:attr(name,value);$("#myImg").attr("src","images/1.jpg"); ......

前端老手
昨天
7
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部