java自定义切面增强方式(关于自定义注解aop)

2023-05-14 14:05:14 注解 自定义 切面

java自定义切面增强

写代码时会遇到一些有些重复机械的工作, 这个时候就可以运用切面技术来帮我们节约时间

介绍如何使用自定义注解增强方法, 实现自动完成重复的工作(还可以通过直接扫描包路径增强所有方法, 或者根据方法名, 入参等定向增强, 各种玩法)

本次示例中的代码目的是为了无效化我的缓存

1. 自定义一个注解

@Target(value = { ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
public @interface CacheNullify {
    boolean value = true;
}

2. 实现增强逻辑

@Slf4j
@Aspect
@Component
public class CacheNullifyHandler {

    @AfterReturning("@annotation(com.xxx.CacheNullify)")
    public void afterReturning() {
        log.info("走你");
        CacheServiceUtil.delUserInfoCache();
    }
}
  • @annotation: 后面跟的是你要增强的注解(所注释的方法), 可以直接写注解名, 但是为了防止重名尽可能写全路径吧
  • @AfterReturning: 方法执行完并成功返回则触发
  • @After: 方法完毕后触发(包括执行完毕, 或者抛出异常)

3. 使用

在需要增强的方法上加上@CacheNullify注解

切面、自定义注解的使用

先了解切面和自定义注解的基本概念和使用

AOP简介

AOP为Aspect Oriented Programming的缩写，意为：面向切面编程，通过预编译方式和运行期间动态代理实现程序功能的统一维护的一种技术。

AOP是OOP的延续，是软件开发中的一个热点，也是spring框架中的一个重要内容，是函数式编程的一种衍生范型。

利用AOP可以对业务逻辑的各个部分进行隔离，从而使得业务逻辑各部分之间的耦合度降低，提高程序的可重用性，同时提高了开发的效率。

AOP定义

  • Aspect（切面）

Aspect 声明类似于 Java 中的类声明，在 Aspect 中会包含着一些 Pointcut 以及相应的 Advice。

  • Joint point（连接点）

指那些被拦截的点，在spring中这些点指的是方法。

  • Pointcut（切入点）

表示一组 joint point，这些 joint point 或是通过逻辑关系组合起来，或是通过通配、正则表达式等方式集中起来，它定义了相应的 Advice 将要发生的地方。

  • Advice（增强/通知）

Advice 定义了在 Pointcut 里面定义的程序点具体要做的操作，它通过 before、after 和 around 来区别是在每个 joint point 之前、之后还是代替执行的代码。

  • Introduction（引介）

一种特殊的通知，可以在不修改源码的情况下动态添加一些方法。

  • Target（目标对象）

织入 Advice 的目标对象.。

  • Weaving（织入）

将 Aspect 和其他对象连接起来, 并创建 Adviced object 的过程

注解简介

注解是一种能被添加到java源代码中的元数据，方法、类、参数和包都可以用注解来修饰。

注解可以看作是一种特殊的标记，可以用在方法、类、参数和包上，程序在编译或者运行时可以检测到这些标记而进行一些特殊的处理。

元素和组成

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface MyAnnotation {
    String value() default"";
} 

分析上面的注解组成

  • public：修饰符

访问修饰符必须为public,不写默认为pubic；

  • @interface：关键字

关键字为@interface；

  • MyAnnotaion：注解名称

注解名称为自定义注解的名称，例如上面的MyAnnotaion就是注解名称

  • value：注解类型元素

注解类型元素是注解中内容，根据需要标志参数，例如上面的注解的value；

元注解

但仔细分析还包含@开头的四个注解@Target、@Retention、@Inherited、@Documented）这是四个是底层的元注解，注解其他注解的注解

@Target：用于描述注解的使用范围，该注解可以使用在什么地方

Target类型    描述

  • ElementType.TYPE    应用于类、接口（包括注解类型）、枚举
  • ElementType.FIELD    应用于属性（包括枚举中的常量）
  • ElementType.METHOD    应用于方法
  • ElementType.PARAMETER    应用于方法的形参
  • ElementType.CONSTRUCTOR    应用于构造函数
  • ElementType.LOCAL_VARIABLE    应用于局部变量
  • ElementType.ANNOTATION_TYPE    应用于注解类型
  • ElementType.PACKAGE    应用于包

备注：例如@Target(ElementType.METHOD)，标志的注解使用在方法上，但是我们在这个注解标志在类上，就会报错

@Retention：表明该注解的生命周期

生命周期类型    描述

  • RetentionPolicy.SOURCE    编译时被丢弃，不包含在类文件中
  • RetentionPolicy.CLASS    JVM加载时被丢弃，包含在类文件中，默认值
  • RetentionPolicy.RUNTIME    由JVM 加载，包含在类文件中，在运行时可以被获取到

@Inherited：是一个标记注解，@Inherited阐述了某个被标注的类型是被继承的。如果一个使用了        @Inherited修饰的annotation类型被用于一个class，则这个annotation将被用于该class的子类。

 @Documented：表明该注解标记的元素可以被Javadoc 或类似的工具文档化

总结

以上为个人经验，希望能给大家一个参考，也希望大家多多支持。

相关文章