Spring Boot之AOP配自定义注解的最佳实践过程

前言

AOP(Aspect Oriented Programming),即面向切面编程,是Spring框架的大杀器之一。

首先,我声明下,我不是来系统介绍什么是AOP,更不是照本宣科讲解什么是连接点、切面、通知和切入点这些让人头皮发麻的概念。

今天就来说说AOP的一些应用场景以及如何通过和其他特性的结合提升自己的灵活性。下面话不多说了,来一起看看详细的介绍吧

AOP应用举例

AOP的一大好处就是解耦。通过切面,我们可以将那些反复出现的代码抽取出来,放在一个地方统一处理。

同时,抽出来的代码很多是与业务无关的,这样可以方便开发者更加专注自己的业务逻辑的开发。

一个AOP的典型应用场景就是日志打印。

下面是一个极端情况的Controller

@RestController
@RequestMapping("/")
public class HelloController {
 private static final Logger LOG = LoggerFactory.getLogger(HelloController.class);

 @GetMapping(value = "/index")
 public String index(HttpServletRequest request) {
  LOG.info("============打印日志开始============");
  LOG.info("URL: " + request.getRequestURL().toString());
  LOG.info("============打印日志结束============");
  return "hello jackie";
 }

 @GetMapping(value = "/test1")
 public String test1(HttpServletRequest request, String var1) {
  LOG.info("============打印日志开始============");
  LOG.info("URL: " + request.getRequestURL().toString());
  LOG.info("============打印日志结束============");
  return "test1";
 }

 @DemoAnnotation
 @GetMapping(value = "/test2")
 public String test2(HttpServletRequest request, String var1, String var2) {
  LOG.info("============打印日志开始============");
  LOG.info("URL: " + request.getRequestURL().toString());
  LOG.info("============打印日志结束============");
//  int i = 1/0;
  if (1<2)
   throw new IllegalArgumentException("exception");
  return "test2";
 }
}

HelloController中提供了三个Http接口,由于业务需要,所以每次进入某个方法的时候都需要打印请求的相关信息。

当然,如果只是上面的例子,我们完全可以通过其他手段让代码看着并不这么糟糕。我们可以抽象一个打印方法,将相同的代码封装在这个方法中,之后在各个方法中每次调用即可。

但是,这种处理方法似乎抽象的还不够,因为我们在每个Http接口中还是要调用这个抽象的函数。而且,比较要命的是,这打印日志的代码与其他业务代码显得有些格格不入。

所以,这时候,我们想到了AOP。

如何使用AOP

在Spring Boot项目中,只需要如下几步,就可以轻松上手AOP。

添加maven依赖

<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

编写切面类

@Aspect
@Component
public class DemoAspect {
 private static final Logger LOG = LoggerFactory.getLogger(DemoAspect.class);

 @Pointcut("execution(public * com.jackie.springbootdemo.controller.HelloController.test*(..))")
 public void addAdvice(){}

 @Before("addAdvice()")
 public void before(JoinPoint joinPoint){
  Object[] args = joinPoint.getArgs();
  HttpServletRequest requests = (HttpServletRequest) args[0];
  LOG.info("============打印日志开始============");
  LOG.info("URL: " + requests.getRequestURL().toString());
  LOG.info("============打印日志结束============");
//  LOG.info("before....");
 }
}

结果验证对比

启动SpringBootDemoApplication,访问url:http://localhost:8080/test2?var1=1&var2=2

未使用切面功能打印日志

使用切面功能打印日志

从上面的结果展示发现,最终的效果是一样的,但是使用切面更加简洁,而且可复用。

如上访问的是test2接口,如果访问test1接口也可以走切面类实现打印日志的需求,但是如果走index请求就不会打印日志了。

这是为什么呢?

AOP的局限

在切面类DemoAspect中,我们看到了切入点的设置

@Pointcut("execution(public * com.jackie.springbootdemo.controller.HelloController.test*(..))")
public void addAdvice(){}

其中Pointcut后面的表达式是用于控制切面的有效影响范围。

**表达式中,第一个表示返回任意类型,第二个表示任意方法名,后面的小括号表示任意参数值,这里是以test为前缀的,所以可以匹配上test1和test2方法。

注意,在第二个之前也可以再有个,即HelloController所在位置,表示任意类名,假如这里是有两个*.则表示包括包里面的子包。**

好了,明白了表达式的含义,我们自然就看到了AOP的局限性。

当我们要使用切面前,就要写好表达式,但是项目一直在做,代码一直在加,那谁能保证后面接收代码的兄弟也正好知道这个test前缀的意义这么重大呢?

如果他非要用hello作为前缀,那么本应该匹配到的接口就匹配不上了,日志也就不能正常打印了。

这时候,自定义注解,就能够很好的解决这个问题。

自定义注解配合AOP

新建一个自定义注解

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface DemoAnnotation {

}

自定义注解的花样也很多,比如可以在注解中声明变量等,但这些不是我们这次讨论的重点。

将该注解添加到Http接口test2方法上

 @DemoAnnotation
 @GetMapping(value = "/test2")
 public String test2(HttpServletRequest request, String var1, String var2) {
//  LOG.info("============打印日志开始============");
//  LOG.info("URL: " + request.getRequestURL().toString());
//  LOG.info("============打印日志结束============");
//  int i = 1/0;
  if (1<2)
   throw new IllegalArgumentException("exception");
  return "test2";
 }

在切面类中将切入点的表达式改为

@Pointcut("execution(public * com.jackie.springbootdemo.controller.*.*(..)) && @annotation(com.jackie.springbootdemo.annotation.DemoAnnotation)")
public void addAdvice(){}

这样,我们不需要限制在controller类中是以test作为前缀了,只要是在上面定义的类路径下,并且扫描到注解DemoAnnotation就可以让切面生效。

从结果可以看出,访问http://localhost:8080/test1?var1=1并没有经过切面处理,因为不满足切入点中的表达式要求。

这样做的好处在于,控制的粒度更细,也更加灵活,方便切面功能的实现和细分。

代码已提交至rome

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对我们的支持。

(0)

相关推荐

  • SpringBoot2.0整合SpringCloud Finchley @hystrixcommand注解找不到解决方案

    hystrix参数使用方法 通过注解@HystrixCommand的commandProperties去配置, 如下就是hystrix命令超时时间命令执行超时时间,为1000ms和执行是不启用超时 @RestController public class MovieController { @Autowired private RestTemplate restTemplate; @GetMapping("/movie/{id}") @HystrixCommand(commandPro

  • 彻底搞明白Spring中的自动装配和Autowired注解的使用

    一.自动装配 当Spring装配Bean属性时,有时候非常明确,就是需要将某个Bean的引用装配给指定属性.比如,如果我们的应用上下文中只有一个org.mybatis.spring.SqlSessionFactoryBean类型的Bean,那么任意一个依赖SqlSessionFactoryBean的其他Bean就是需要这个Bean.毕竟这里只有一个SqlSessionFactoryBean的Bean. 为了应对这种明确的装配场景,Spring提供了自动装配(autowiring).与其显式的装配

  • JSP 中Spring组合注解与元注解实例详解

    JSP 中Spring组合注解与元注解实例详解 摘要: 注解(Annotation),也叫元数据.一种代码级别的说明.它与类.接口.枚举是在同一个层次.它可以声明在包.类.字段.方法.局部变量.方法参数等的前面,用来对这些元素进行说明 1. 可以注解到别的注解上的注解称为元注解,被注解的注解称为组合注解,通过组合注解可以很好的简化好多重复性的注解操作 2. 示例组合注解 import org.springframework.context.annotation.ComponentScan; im

  • 通过实例解析Spring组合注解与元注解

    这篇文章主要介绍了通过实例解析Spring组合注解与元注解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下 1.概述 1.1.Spring提供了大量的注解, 尤其是相同的注解用到各个类中,会相当的啰嗦: 1.2.元注解: 可以注解到别的注解上的注解: 组合注解: 被注解注解的注解称为 组合注解: 组合注解 具备 元注解 的功能,Spring的很多注解都可以作为元注解: 1.3.案例 package com.an.config; import co

  • Spring条件注解@Conditional示例详解

    前言 @Conditional是Spring4新提供的注解,它的作用是根据某个条件创建特定的Bean,通过实现Condition接口,并重写matches接口来构造判断条件.总的来说,就是根据特定条件来控制Bean的创建行为,这样我们可以利用这个特性进行一些自动的配置. 本文将分为三大部分,@Conditional源码的介绍.Condition的使用示例和@Conditional的扩展注解的介绍. 一.@Conditional的源码 @Target({ElementType.TYPE, Elem

  • 详解SpringBoot开发使用@ImportResource注解影响拦截器

    问题描述 今天在给SpringBoot项目配置拦截器的时候发现怎么都进不到拦截器的方法里面,在搜索引擎上看了无数篇关于配置拦截器的文章都没有找到解决方案. 就在我准备放弃的时候,在 CSDN 上发现了一篇文章,说的是SpringBoot 用了@ImportResource 配置的拦截器就不起作用了.于是我就赶紧到Application启动类看了一眼,果然项目中使用了@ImportResource 注解用于配置系统的参数. 代码如下: 启动类配置 package com.xx.xxx; impor

  • Spring的组合注解和元注解原理与用法详解

    本文实例讲述了Spring的组合注解和元注解原理与用法.分享给大家供大家参考,具体如下: 一 点睛 从Spring 2开始,为了相应JDK 1.5推出的注解功能,Spring开始加入注解来替代xml配置.Spring的注解主要用来配置和注入Bean,以及AOP相关配置.随着注解的大量使用,尤其相同的多个注解用到各个类或方法中,会相当繁琐.出现了所谓的样本代码,这是Spring设计要消除的代码. 元注解:可以注解到别的注解上去的注解. 组合注解:被注解的注解,组合注解具备其上的元注解的功能. Sp

  • SpringAOP中的注解配置详解

    这篇文章主要介绍了SpringAOP中的注解配置详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下 使用注解实现SpringAOP的功能: 例子: //表示这是被注入Spring容器中的 @Component //表示这是个切面类 @Aspect public class AnnotationHandler { /* * 在一个方法上面加上注解来定义切入点 * 这个切入点的名字就是这个方法的名字 * 这个方法本身不需要有什么作用 * 这个方法的

  • Spring注解@Resource和@Autowired区别对比详解

    前言 @Resource和@Autowired都是做bean的注入时使用,其实@Resource并不是Spring的注解,它的包是javax.annotation.Resource,需要导入,但是Spring支持该注解的注入. 1.共同点 两者都可以写在字段和setter方法上.两者如果都写在字段上,那么就不需要再写setter方法. 2.不同点 (1)@Autowired @Autowired为Spring提供的注解,需要导入包org.springframework.beans.factory

  • Spring Boot之AOP配自定义注解的最佳实践过程

    前言 AOP(Aspect Oriented Programming),即面向切面编程,是Spring框架的大杀器之一. 首先,我声明下,我不是来系统介绍什么是AOP,更不是照本宣科讲解什么是连接点.切面.通知和切入点这些让人头皮发麻的概念. 今天就来说说AOP的一些应用场景以及如何通过和其他特性的结合提升自己的灵活性.下面话不多说了,来一起看看详细的介绍吧 AOP应用举例 AOP的一大好处就是解耦.通过切面,我们可以将那些反复出现的代码抽取出来,放在一个地方统一处理. 同时,抽出来的代码很多是

  • Spring Boot 通过AOP和自定义注解实现权限控制的方法

    本文介绍了Spring Boot 通过AOP和自定义注解实现权限控制,分享给大家,具体如下: 源码:https://github.com/yulc-coding/java-note/tree/master/aop 思路 自定义权限注解 在需要验证的接口上加上注解,并设置具体权限值 数据库权限表中加入对应接口需要的权限 用户登录时,获取当前用户的所有权限列表放入Redis缓存中 定义AOP,将切入点设置为自定义的权限 AOP中获取接口注解的权限值,和Redis中的数据校验用户是否存在该权限,如果R

  • 详解使用Spring Boot的AOP处理自定义注解

    上一篇文章Java 注解介绍讲解了下Java注解的基本使用方式,并且通过自定义注解实现了一个简单的测试工具:本篇文章将介绍如何使用Spring Boot的AOP来简化处理自定义注解,并将通过实现一个简单的方法执行时间统计工具为样例来讲解这些内容. AOP概念 面向侧面的程序设计(aspect-oriented programming,AOP,又译作面向方面的程序设计.观点导向编程.剖面导向程序设计)是计算机科学中的一个术语,指一种程序设计范型.该范型以一种称为侧面(aspect,又译作方面)的语

  • 详解使用Spring AOP和自定义注解进行参数检查

    引言 使用SpringMVC作为Controller层进行Web开发时,经常会需要对Controller中的方法进行参数检查.本来SpringMVC自带@Valid和@Validated两个注解可用来检查参数,但只能检查参数是bean的情况,对于参数是String或者Long类型的就不适用了,而且有时候这两个注解又突然失效了(没有仔细去调查过原因),对此,可以利用Spring的AOP和自定义注解,自己写一个参数校验的功能. 代码示例 注意:本节代码只是一个演示,给出一个可行的思路,并非完整的解决

  • Spring AOP 实现自定义注解的示例

    自工作后,除了一些小项目配置事务使用过 AOP,真正自己写 AOP 机会很少,另一方面在工作后还没有写过自定义注解,一直很好奇注解是怎么实现他想要的功能的,刚好做项目的时候,经常有人日志打得不够全,经常出现问题了,查日志的才发现忘记打了,所以趁此机会,搜了一些资料,用 AOP + 自定义注解,实现请求拦截,自定义打日志,玩一下这两个东西,以下是自己完的一个小例子,也供需要的同学参考. 1. 注解如下: package cn.bridgeli.demo.annotation;   import j

  • Spring boot通过AOP防止API重复请求代码实例

    这篇文章主要介绍了Spring boot通过AOP防止API重复请求代码实例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下 实现思路 基于Spring Boot 2.x 自定义注解,用来标记是哪些API是需要监控是否重复请求 通过Spring AOP来切入到Controller层,进行监控 检验重复请求的Key:Token + ServletPath + SHA1RequestParas Token:用户登录时,生成的Token Servlet

  • Spring Boot 2 实战:自定义启动运行逻辑实例详解

    本文实例讲述了Spring Boot 2 实战:自定义启动运行逻辑.分享给大家供大家参考,具体如下: 1. 前言 不知道你有没有接到这种需求,项目启动后立马执行一些逻辑.比如缓存预热,或者上线后的广播之类等等.可能现在没有但是将来会有的.想想你可能的操作, 写个接口上线我调一次行吗?NO!NO!NO!这种初级菜鸟才干的事.今天告诉你个骚操作使得你的代码更加优雅,逼格更高. 2. CommandLineRunner 接口 package org.springframework.boot; impo

  • Spring Boot 结合 aop 实现读写分离

    前言 入职新公司到现在也有一个月了,完成了手头的工作,前几天终于有时间研究下公司旧项目的代码.在研究代码的过程中,发现项目里用到了Spring Aop来实现数据库的读写分离,本着自己爱学习(我自己都不信-)的性格,决定写个实例工程来实现spring aop读写分离的效果. 环境部署 数据库:MySql 库数量:2个,一主一从 关于mysql的主从环境部署,可以参考: https://www.jb51.net/article/184698.htm 开始项目 首先,毫无疑问,先开始搭建一个Sprin

  • Spring Boot请求处理之常用参数注解使用教程

    目录 请求处理-SpringBoot常用参数注解使用 1.@PathVariable注解 2.@RequestHeader注解 3.@RequestParam注解 4.@CookieValue注解 5.@RequestAttribute注解 6.@RequestBody注解 7.@MatrixVariable与UrlPathHelper 7.1.基本简介 7.2.MatrixVariable注解 7.3.使用细节 7.3.1.WebMvcAutoConfiguration自动装配 7.3.2.U

  • Spring Boot 项目搭建教程及注解

    Spring Boot Spring Boot是由Pivotal团队提供的全新框架,其设计目的是用来简化新Spring应用的初始搭建以及开发过程.该框架使用了特定的方式来进行配置,从而使开发人员不再需要定义样板化的配置.通过这种方式,Spring Boot致力于在蓬勃发展的快速应用开发领域成为领导者 特点: 1. 创建独立的Spring应用程序 2. 嵌入的Tomcat,无需部署WAR文件 3. 简化Maven配置 4. 自动配置Spring 5. 提供生产就绪型功能,如指标,健康检查和外部配置

随机推荐