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

最新推荐文章于 2023-09-05 21:12:53 发布
最新推荐文章于 2023-09-05 21:12:53 发布
阅读量522 收藏
点赞数
原文链接：https://my.oschina.net/u/2278977/blog/799786
版权

2019独角兽企业重金招聘Python工程师标准>>> hot3.png

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("--------------返回内容----------------");
   }

 

 

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

205323_iiNV_2278977.png

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

 

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

205459_Jsr7_2278977.png

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

 

以上就是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()));

   }

}

 

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

 

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

 

转载于:https://my.oschina.net/u/2278977/blog/799786

weixin_34195546
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
在SpringBoot中使用Aop功能实现日志功能
printfxgd的博客
07-27 320
实现背景 主要是为了熟悉Aop的主要注解及功能，给项目的Controller层加上日志 首先在pom文件里面加入aop依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</a...
Spring Boot中使用Spring Aop实现日志记录功能
记录工作开发中遇到的技术难点，方便自己查看，也希望可以帮助到他人...
08-30 346
1、创建日志注解 1.1、日志类型枚举类 import lombok.Getter; /** * 日志类型枚举类 */ @Getter public enum LogType { /** * 登录 */ login("LoginLog"); /** * 实现类名称 */ private final String implClassName; LogType(String implClassName) {
spring boot项目中使用aop处理日志
xiaojiejie01的博客
06-23 332
spring boot项目中使用aop处理日志 spring boot中使用aop处理日志 在我们日常的开发中日志对于我们来说是十分重要的，那么今天我们就来聊聊spring boot中如何使用aop来处理我们的日志 一.maven导入和数据库的连接 1…新建spring boot项目导入maven依赖 <dependency> <groupId>org.springframework.boot</groupId> <
SpringBoot利用AOP记录系统日志
jike11231的博客
05-07 4181
利用Spring框架中aop,我们可以实现业务代码与系统级服务进行解耦，例如日志记录、事务及其他安全业务等，可以使得我们的工程更加容易维护、优雅。 一、添加依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency> 二、自定义注解 @T
spring-boot aop
01-23
这个`spring-aop`示例项目很可能会包含上述步骤的实现，通过阅读源代码，我们可以更深入地理解Spring Boot AOP的使用。同时，它可能还会展示如何结合实际业务逻辑，比如服务层的方法调用，来演示AOP如何优雅地注入...
Spring Boot中使用AOP统一处理web层异常的方法
08-27
"Spring Boot中使用AOP统一处理web层异常的方法" 本文主要介绍了在Spring Boot中使用AOP（Aspect-Oriented Programming，面向方面编程）来统一处理web层异常的方法。该方法可以使得系统在出现异常时能够正确地处理...
spring boot如何使用AOP统一处理web请求
08-25
本文主要介绍了如何使用Spring Boot框架结合AOP（Aspect-Oriented Programming，面向切面编程）技术来统一处理Web请求日志。通过使用AOP，我们可以在不修改原有业务逻辑的情况下，对Web请求进行统一的日志记录，从而...
详解Spring Boot中使用AOP统一处理Web请求日志
08-30
Spring Boot 中使用 AOP 统一处理 Web 请求日志是指在 Spring Boot 应用程序中使用Aspect Oriented Programming（面向 Aspect 编程）技术来实现统一的 Web 请求日志处理机制。这种方法可以将日志记录功能从业务逻辑...
spring boot aop 统一处理日志
10-18
spring boot aop 统一处理日志 demo spring boot aop 统一处理日志 demo
Springboot接口项目如何使用AOP记录日志
08-19
主要介绍了Springboot接口项目如何使用AOP记录日志,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
详解基于SpringBoot使用AOP技术实现操作日志管理
08-25
主要介绍了详解基于SpringBoot使用AOP技术实现操作日志管理，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
使用Spring进行统一日志管理 + 统一异常管理
09-24
统一日志和异常管理配置好后，SSH项目中，代码以往散落的log.info() 和 try..catch..finally 再也不见踪影！
Springboot中使用aop记录日志
hauchun的博客
12-27 1512
aop面向切面编程
springboot 使用aop记录访问日志
f的博客
05-26 279
pom文件增加aop的依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency> 自定义注解 @Target(ElementType.METHOD) @Retentio
SpringBoot中使用AOP实现日志记录
weixin_49453135的博客
09-05 208
SpringBoot项目中使用AOP实现日志记录
springBoot通过aop实现日志记录
m0_49513507的博客
04-21 601
1. 注解类 import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** * 平台登录日志注解 * @author yangJing */ @Target(ElementType.METHOD) @Retention(Retenti
SpringBoot应用中使用AOP记录接口访问日志
qq_44075208的博客
07-08 763
利用AOP可以对业务逻辑的各个部分进行隔离，从而使得业务逻辑各部分之间的耦合度降低，提高程序的可重用性，同时提高了开发的效率。定义了一个日志切面，在环绕通知中获取日志需要的信息，并应用到controller层中所有的public方法中去。比如日志切面的应用范围就是所有接口，即所有controller层的接口方法。环绕通知（Around）：通知包裹了目标方法，在目标方法调用之前和之后执行自定义的行为。后置通知（After）：在目标方法调用之后调用通知功能，不关心方法的返回结果；通知功能被应用的时机。
spring-boot-starter-aop和spring-boot-starter-parent的区别
最新发布
03-17
spring-boot-starter-aop和spring-boot-starter-parent是Spring Boot框架的两个重要组件，它们有以下区别： 1. spring-boot-starter-aop： - spring-boot-starter-aop是一个用于支持面向切面编程（AOP）的Spring Boot启动器。 - 它提供了AOP所需的依赖项和配置，使得在Spring Boot应用中使用AOP变得更加简单。 - AOP可以帮助我们将横切关注点（如日志记录、事务管理等）与核心业务逻辑分离，提高代码的可维护性和复用性。 2. spring-boot-starter-parent： - spring-boot-starter-parent是一个用于管理Spring Boot项目的父级依赖项和配置的启动器。 - 它定义了一组默认的依赖项版本和插件配置，使得开发者可以更方便地创建和管理Spring Boot项目。 - 通过继承spring-boot-starter-parent，我们可以避免手动管理依赖项版本和插件配置的繁琐工作。 总结： spring-boot-starter-aop是用于支持AOP编程的启动器，而spring-boot-starter-parent是用于管理Spring Boot项目的父级依赖项和配置的启动器。它们在功能和作用上有明显的区别。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值