From 6344c26355523a76f30b328b0e35b39446ccbb7a Mon Sep 17 00:00:00 2001 From: linlei Date: Tue, 2 Apr 2024 15:23:53 +0800 Subject: [PATCH] =?UTF-8?q?Pointcut=E6=BA=90=E7=A0=81=E5=88=86=E6=9E=90?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README-BACK.md | 354 ----------------- README.md | 1 + spring-aop/pom.xml | 5 + spring-aop/spring-aop-advisor/README.md | 32 ++ spring-aop/spring-aop-advisor/pom.xml | 14 + spring-aop/spring-aop-pointcut/README.md | 358 ++++++++++++++++++ spring-aop/spring-aop-pointcut/pom.xml | 14 + .../java/com/xcs/spring/MyAnnotation.java | 14 + .../src/main/java/com/xcs/spring/MyBean.java | 16 + .../java/com/xcs/spring/MyCustomAdvice.java | 12 + .../java/com/xcs/spring/MyCustomPointcut.java | 39 ++ .../java/com/xcs/spring/PointcutDemo.java | 89 +++++ 12 files changed, 594 insertions(+), 354 deletions(-) delete mode 100644 README-BACK.md create mode 100644 spring-aop/spring-aop-advisor/README.md create mode 100644 spring-aop/spring-aop-advisor/pom.xml create mode 100644 spring-aop/spring-aop-pointcut/README.md create mode 100644 spring-aop/spring-aop-pointcut/pom.xml create mode 100644 spring-aop/spring-aop-pointcut/src/main/java/com/xcs/spring/MyAnnotation.java create mode 100644 spring-aop/spring-aop-pointcut/src/main/java/com/xcs/spring/MyBean.java create mode 100644 spring-aop/spring-aop-pointcut/src/main/java/com/xcs/spring/MyCustomAdvice.java create mode 100644 spring-aop/spring-aop-pointcut/src/main/java/com/xcs/spring/MyCustomPointcut.java create mode 100644 spring-aop/spring-aop-pointcut/src/main/java/com/xcs/spring/PointcutDemo.java diff --git a/README-BACK.md b/README-BACK.md deleted file mode 100644 index 708e6d7..0000000 --- a/README-BACK.md +++ /dev/null @@ -1,354 +0,0 @@ -
- logo -
-
-

深入Spring，从源码开始！

-

探索Java最受欢迎的框架，理解它的内部机制，带大家从入门到精通。

-
-

- Stars Badge - Follow Badge - Fork Badge - Watchers Badge -

-

- Visitor Badge - Wechat Badge - CSDN Badge -

-

- ⚡ 技术 - | - 👋 简介 - | - 🍵 Why - | - 🙏 点个星 - | - 🌱 Spring源码 - | - 💬 联系我 - | - ⛵ 贡献 - | - 🔄 更新 - | - 💻 统计 -

- ---- - -## ⚡技术 - -
- - - - - - -
- -## 👋简介 -大家好呀，我是Lex👨‍💻。我是一名拥有8年经验的Java 后端开发人员👨‍💼，也是一个对 Spring 框架充满热情❤️的程序员。为了帮助那些希望深入了解 Spring 框架的程序员们🧑‍💻，我创建了这个 “Spring 源码阅读系列”📖。通过这个系列，我希望能够与你们共同探索 Spring 的内部工作机制⚙️。如果您有同样的兴趣或问题🤔，请联系我📩！ - -## 🍵**为何做Spring源码分析** -在我作为框架研发的开发者👨‍🔬的工作中，我经常遇到需要深入理解和调整框架行为的情况🔧。这些工作不只是简单地使用框架的API，更多地是需要对框架的内部工作方式有详细的了解🔍。虽然Github上有关于Spring的简化版本📦，这些对于入门学习确实有很大的帮助✅，但当涉及到真实的项目应用时，与真正的Spring框架还是有很大的差异❌。因此，我开始深入研究Spring的源码，希望能够更透彻地理解其内部的工作机制，以便更好地应用到我的实际工作中🧰。分享我的源码分析📝，也是为了给那些希望真正理解Spring，而不仅仅是使用它的开发者提供一些参考和帮助🙌。 - -## 🙏顺手点个星 -亲爱的朋友们👥，我真的花了很多心思💭去研究和整理这个“Spring 源码阅读系列”📘。如果你觉得这东西还不错👍，或者给你带来了一点点帮助🤗，麻烦点一下星星吧🌟。这真的对我意义重大🎖，每一颗星✨都能让我觉得所有的努力都是值得的💪。我知道这是小事一桩，但你的那一下点击🖱，对我来说就是最好的鼓励🎉。无论如何，都要感谢你抽时间🕰阅读我的内容，真的很感激🙏！ - -## 🌱Spring 源码阅读系列 - -#### Spring IOC - -- 资源加载与访问 - - - [`Resource`](spring-resources/spring-resource/README.md)：抽象接口，表示文件、类路径等，用于访问不同来源的资源。 - - - [`ResourceLoader`](spring-resources/spring-resource-resourceLoader/README.md)：资源获取核心接口，实现统一加载不同位置资源的策略。 - - - [`ResourcePatternResolver`](spring-resources/spring-resource-resourcePatternResolver/README.md)：资源模式解析接口，用于灵活加载应用中的多种资源。 - - - [`DocumentLoader`](spring-resources/spring-resource-documentLoader/README.md)：XML文档加载解析核心接口，支持后台自动配置Spring应用。 - -- 元数据与过滤 - - - [`MetadataReader`](spring-metadata/spring-metadata-metadataReader/README.md)：类元数据获取核心，支持组件扫描、条件化注解、AOP等高级功能。 - - - [`AnnotationMetadata`](spring-metadata/spring-metadata-annotationMetadata/README.md)：动态获取和操作运行时类注解信息。 - - - [`TypeFilter`](spring-metadata/spring-metadata-typeFilter/README.md)：组件扫描时自定义类筛选，支持复杂条件和精确过滤。 - - - [`Condition`](spring-metadata/spring-metadata-condition/README.md)：条件判断，决定Bean创建和配置的灵活机制。 - -- Bean定义与注册 - - - [`BeanDefinition`](spring-beans/spring-bean-beanDefinition/README.md)：详细描述Bean，支持依赖注入、AOP、作用域控制等核心功能。 - - - [`BeanDefinitionHolder`](spring-beans/spring-bean-beanDefinitionHolder/README.md)：管理和操作BeanDefinition的关键类。 - - - [`BeanDefinitionRegistry`](spring-beans/spring-bean-beanDefinitionRegistry/README.md)：Bean定义注册管理关键接口，处理Bean元数据。 - -- Bean定义读取与扫描 - - - [`XmlBeanDefinitionReader`](spring-beans/spring-bean-xmlBeanDefinitionReader/README.md)：加载解析XML配置，构建IOC容器，注册Bean定义。 - - - [`PropertiesBeanDefinitionReader`](spring-beans/spring-bean-propertiesBeanDefinitionReader/README.md)：属性文件加载，解析为Bean定义。 - - - [`GroovyBeanDefinitionReader`](spring-beans/spring-bean-groovyBeanDefinitionReader/README.md)：Groovy脚本解析为Bean定义。 - - - [`AnnotatedBeanDefinitionReader`](spring-beans/spring-bean-annotatedBeanDefinitionReader/README.md)：注解配置，自动扫描注册Spring组件，简化Bean定义配置。 - - - [`ClassPathBeanDefinitionScanner`](spring-beans/spring-bean-classPathBeanDefinitionScanner/README.md)：类路径扫描注册Spring Bean，支持自动装配。 - -- 属性解析和环境配置 - - - [`PropertySource`](spring-env/spring-env-propertySource/README.md)：管理各种配置源的抽象类，支持灵活地加载和访问应用配置。 - - - [`PropertySources`](spring-env/spring-env-propertySources/README.md)：用于统一管理和访问多个 PropertySource 实例，简化配置数据的处理。 - - - [`PropertyResolver`](spring-env/spring-env-propertyResolver/README.md)：通用属性解析，获取配置值，处理属性缺失，简便灵活。 - - - [`ConfigurablePropertyResolver`](spring-env/spring-env-configurablePropertyResolver/README.md)：属性解析配置，占位符设置，适应不同配置需求。 - - - [`Environment`](spring-env/spring-env-environment/README.md)：应用环境表示，提供属性访问，支持配置文件，实现动态配置。 - - - [`ConfigurableEnvironment`](spring-env/spring-env-configurableEnvironment/README.md)：动态配置应用环境，激活、默认配置，提升应用灵活性。 - -- 验证、数据绑定与类型转换 - - - [`Validator`](spring-dataops/spring-dataops-validator/README.md)：提供自定义数据验证逻辑，确保模型对象满足业务规则。 - - - [`PropertyEditor`](spring-dataops/spring-dataops-propertyEditor/README.md)：自定义JavaBean属性的转换逻辑，处理属性类型转换。 - - - [`Converter`](spring-dataops/spring-dataops-converter/README.md)：用于不同类型间的转换，定义简单的源至目标类型转换规则。 - - - [`ConverterFactory`](spring-dataops/spring-dataops-converterFactory/README.md)：创建针对特定源类型的转换器，用于类型转换。 - - - [`GenericConverter`](spring-dataops/spring-dataops-genericConverter/README.md)：更复杂的转换器，支持多种源和目标类型转换。 - - - [`ConditionalConverter`](spring-dataops/spring-dataops-conditionalConverter/README.md)：根据条件选择是否执行转换的转换器。 - - - [`ConversionService`](spring-dataops/spring-dataops-conversionService/README.md)：提供统一的类型转换服务接口，管理转换器。 - - - [`Printer`](spring-dataops/spring-dataops-printer/README.md)：用于将对象格式化为文本，专注于格式化输出。 - - - [`Parser`](spring-dataops/spring-dataops-parser/README.md)：用于将文本解析为对象，专注于解析逻辑。 - - - `BeanWrapper`：用于操作JavaBean的属性，实现动态属性设置和获取。 - - - `AnnotationFormatterFactory`：针对带注解字段的格式化器工厂，链接注解与格式化逻辑。 - -- Spring 表达式语言（SpEL） - - - [`ExpressionParser`](spring-spel/spring-spel-expressionParser/README.md): 解析字符串形式的 SpEL 表达式，创建并返回 Expression 实例。 - - - `EvaluationContext`: 定义用于 SpEL 表达式求值的环境，包括变量、根对象等。 - - - `PropertyAccessor`: 处理属性的读写操作，支持表达式中的属性访问。 - - - `MethodResolver`: 在表达式中解析并调用方法，支持自定义方法解析。 - - - `TypeLocator`: 用于在表达式中定位和引用特定的类型，例如类名。 - - - `TypeConverter`: 实现不同类型间的转换，用于表达式中的值转换。 - - - `BeanResolver`: 用于在表达式中解析并访问 Spring 容器中的 beans。 - - - `ConstructorResolver`: 解析并执行表达式中的构造函数调用。 - - - `OperatorOverloader`: 用于自定义表达式中的操作符行为，如加减乘除。 - - - `ParserContext`: 提供解析 SpEL 表达式时的上下文信息。 - - - `SpelNode`: 构成 SpEL 表达式内部结构的节点，表示表达式的各个部分。 - - - `LiteralExpression`: 表示简单的文字值表达式，如数字、字符串。 - - - `CompoundExpression`: 组合多个子表达式，形成复合的 SpEL 表达式。 - -- Bean定义导入与组合 - - - `ImportBeanDefinitionRegistrar`：运行时动态注册 Bean，实现灵活配置，扩展配置类功能。 - - - `ImportSelector`：运行时动态导入配置类，实现条件选择和灵活配置。 - - - `DeferredImportSelector`：运行时动态导入配置，支持条件选择和按组别延迟加载。 - -- Bean工厂 - - - [`BeanFactory`](spring-factory/spring-factory-beanFactory/README.md)：Spring的核心接口，提供对Bean的配置、创建、管理的基本功能。 - - - [`ListableBeanFactory`](spring-factory/spring-factory-listableBeanFactory/README.md)：支持按类型获取Bean的集合。 - - - [`HierarchicalBeanFactory`](spring-factory/spring-factory-hierarchicalBeanFactory/README.md)：支持父子容器关系，实现Bean定义的层次结构。 - - - [`ConfigurableBeanFactory`](spring-factory/spring-factory-configurableBeanFactory/README.md)：提供对BeanFactory配置的扩展，如属性编辑器、作用域等。 - - + [`AutowireCapableBeanFactory`](spring-factory/spring-factory-autowireCapableBeanFactory/README.md)：Bean创建、初始化、注入、销毁的核心功能接口。 - - + [`ConfigurableListableBeanFactory`](spring-factory/spring-factory-configurableListableBeanFactory/README.md)：支持配置和列表操作的可配置Bean工厂接口。 - -- 基于Java的配置 - - - `ConfigurationClassPostProcessor`：处理@Configuration注解，关键容器启动后置处理器。 - - - `ConfigurationClassParser`：解析@Configuration，提取Config信息，支持@Bean和条件化配置。 - -- 容器上下文 - - - [`ClassPathXmlApplicationContext`](spring-context/spring-context-classPathXmlApplicationContext/README.md)：类路径（classpath）加载 XML 配置文件的上下文。 - - - [`AnnotationConfigApplicationContext`](spring-context/spring-context-annotationConfigApplicationContext/README.md)：注解配置类中加载配置信息的上下文。 - - - `GenericApplicationContext`：支持多种配置方式，XML、注解、手动注册的上下文。 - -- Bean生命周期 - - - [`Bean的定义注册过程`](spring-core/spring-core-registerBeanDefinition)：加载与解析配置文件，注册解析Bean定义，类名、作用域、属性等。 - - - [`Bean的初始化过程`](spring-core/spring-core-getBean/README.md)：实例化、属性注入、Aware回调、后置处理器、初始化方法调用、Bean就绪。 - - - [`Bean的依赖解析过程`](spring-core/spring-core-resolveDependency/README.md)：声明依赖，查找依赖，注入依赖，处理循环依赖，延迟依赖解析。 - - - [`Bean的销毁过程`](spring-core/spring-core-destroyBean/README.md)：销毁方法调用，接口回调，后处理清理，通知触发，GC回收资源。 - -- Bean初始化与扩展点 - - - [`InitializingBean`](spring-interface/spring-interface-initializingBean/README.md)：提供Bean初始化时执行自定义逻辑的接口。 - - - [`DisposableBean`](spring-interface/spring-interface-disposableBean/README.md)：定义Bean销毁前执行清理操作的接口。 - - - [`BeanDefinitionRegistryPostProcessor`](spring-interface/spring-interface-beanDefinitionRegistryPostProcessor/README.md)：在容器启动时，对BeanDefinition进行动态修改或添加。 - - - [`BeanFactoryPostProcessor`](spring-interface/spring-interface-beanFactoryPostProcessor/README.md)：在Bean实例化前，对BeanFactory进行全局修改或配置。 - - - [`BeanPostProcessor`](spring-interface/spring-interface-beanPostProcessor/README.md)：在Bean初始化前后，进行自定义处理，可影响所有Bean。 - - - [`InstantiationAwareBeanPostProcessor`](spring-interface/spring-interface-instantiationAwareBeanPostProcessor/README.md)：提供更深层次的实例化和属性注入控制。 - - - [`DestructionAwareBeanPostProcessor`](spring-interface/spring-interface-destructionAwareBeanPostProcessor/README.md)： 允许在Bean销毁前进行额外的清理操作。 - - - [`MergedBeanDefinitionPostProcessor`](spring-interface/spring-interface-mergedBeanDefinitionPostProcessor/README.md)：在合并Bean定义时，对BeanDefinition进行进一步处理。 - - - [`SmartInstantiationAwareBeanPostProcessor`](spring-interface/spring-interface-smartInstantiationAwareBeanPostProcessor/README.md)：提供更智能的实例化控制。 - - - [`SmartInitializingSingleton`](spring-interface/spring-interface-smartInitializingSingleton/README.md)：在所有单例Bean初始化完成后，执行自定义逻辑。 - -- Aware接口系列 - - - [`BeanNameAware`](spring-aware/spring-aware-beanNameAware/README.md)：让Bean获取自身在容器中的名字。 - - - [`BeanClassLoaderAware`](spring-aware/spring-aware-beanClassLoaderAware/README.md)：允许Bean获取其类加载器。 - - - [`BeanFactoryAware`](spring-aware/spring-aware-beanFactoryAware/README.md)：提供Bean获取所属的BeanFactory。 - - - [`EnvironmentAware`](spring-aware/spring-aware-environmentAware/README.md)：允许Bean获取应用程序环境配置。 - - - [`EmbeddedValueResolverAware`](spring-aware/spring-aware-embeddedValueResolverAware/README.md)：允许Bean解析嵌入式值占位符。 - - - [`ResourceLoaderAware`](spring-aware/spring-aware-beanClassLoaderAware/README.md)：允许Bean获取资源加载器。 - - - [`ApplicationEventPublisherAware`](spring-aware/spring-aware-applicationEventPublisherAware/README.md)：允许Bean发布应用程序事件。 - - - [`MessageSourceAware`](spring-aware/spring-aware-messageSourceAware/README.md)：允许Bean获取消息源。 - - - [`ApplicationStartupAware`](spring-aware/spring-aware-applicationStartupAware/README.md)：允许Bean获取应用程序启动信息。 - - - [`ApplicationContextAware`](spring-aware/spring-aware-applicationContextAware/README.md)：允许Bean获取应用程序上下文。 - - - [`ImportAware`](spring-aware/spring-aware-importAware/README.md)：允许被导入的配置类获取导入它的类的信息。 - -- 核心注解 - - - [`@Configuration`](spring-annotation/spring-annotation-configuration/README.md)：声明类为配置类，定义Bean和Bean之间的依赖关系。 - - - [`@ComponentScan`](spring-annotation/spring-annotation-componentScan/README.md)：启用组件扫描，自动发现并注册标记为组件的类。 - - - [`@Bean`](spring-annotation/spring-annotation-bean/README.md)：在配置类中声明方法，返回Bean实例。 - - - [`@Import`](spring-annotation/spring-annotation-import/README.md)：引入其他配置类，将其Bean定义合并到当前容器。 - - - [`@PropertySource`](spring-annotation/spring-annotation-propertySource/README.md)：指定属性文件，加载外部配置到环境中。 - - - [`@DependsOn`](spring-annotation/spring-annotation-dependsOn/README.md)：指定Bean的依赖顺序，确保特定Bean在其他Bean之前初始化。 - - - [`@Conditional`](spring-annotation/spring-annotation-conditional/README.md)：根据条件决定是否创建Bean。 - - - [`@Lazy`](spring-annotation/spring-annotation-lazy/README.md)：指定Bean的延迟初始化，只有在首次使用时才创建。 - - - [`@Value`](spring-annotation/spring-annotation-value/README.md)：注入简单值或表达式到Bean的字段或方法参数。 - - - [`@Autowired`](spring-annotation/spring-annotation-autowired/README.md)：自动装配Bean依赖。 - - - `@Primary`：指定在多个候选Bean中优先选择的首选Bean。 - - - `@Description`：为Bean提供描述性信息。 - - - `@Role`：为Bean提供角色提示，用于区分相似类型的Bean。 - - - `@Indexed`： 标记Bean用于索引。 - - - `@Order`：指定Bean的加载顺序。 - -- JSR规范 - - - [`@Inject`](spring-jsr/spring-jsr330-inject/README.md)：JSR-330标准的依赖注入注解。 - - - [`@Named`](spring-jsr/spring-jsr330-named/README.md)：JSR-330标准的命名注解。 - - - [`@Resource`](spring-jsr/spring-jsr250-resource/README.md)：Java EE标准的资源注入注解。 - - - [`@Qualifier`](spring-jsr/spring-jsr330-qualifier/README.md)：用于限定注入的Bean。 - - - [`@Scope`](spring-jsr/spring-jsr330-scope/README.md)：指定Bean的作用域。 - - - [`@Singleton`](spring-jsr/spring-jsr330-singleton/README.md)：指定Bean为单例。 - - - [`@PostConstruct`](spring-jsr/spring-jsr250-postConstruct/README.md)：指定初始化方法。 - - - [`@PreDestroy`](spring-jsr/spring-jsr250-preDestroy/README.md)：指定销毁方法。 - - - [`Provider`](spring-jsr/spring-jsr330-provider/README.md)：Java标准库提供的通用Bean工厂接口。 - -## 💬与我联系 - -✉️ [Email](xuchengshengsuper@163.com) | 💬 [Issue](https://github.com/xuchengsheng/spring-reading/issues) | 🌐 [CSDN](https://blog.csdn.net/duzhuang2399?type=blog) Me about everything! - -## ⛵欢迎贡献！ - -如果你发现任何错误🔍或者有改进建议🛠️，欢迎提交 issue 或者 pull request。你的反馈📢对于我非常宝贵💎！ - -## 🔄持续更新中 - -为了给大家提供最新🌱、最有价值的内容💼，我会坚持每天更新这个仓库⏳。每一天，你都可以期待看到一些新的内容或者对已有内容的改进✨。如果你有任何建议或反馈📣，欢迎随时联系我📞。我非常珍视每一个反馈💌，因为这是我持续改进的动力🚀。 - -## 💻我的 GitHub 统计 - -[![Star History Chart](https://api.star-history.com/svg?repos=xuchengsheng/spring-reading&type=Date)](https://star-history.com/#xuchengsheng/spring-reading&Date) - -## 🍱请我吃盒饭？ - -作者晚上还要写博客✍️,平时还需要工作💼,如果帮到了你可以请作者吃个盒饭🥡 -
-logo -logo -
- -## 👥加入我们 - -📢 想要一起加入我们的精彩微信群吗？跟着以下简单步骤： - -1️⃣ **扫描我的二维码**：使用微信的扫一扫功能，扫描下方的二维码，将我添加为你的好友。 - -
-logo -
- -2️⃣ **等待好友请求被接受**：一旦你的好友请求被接受，你将收到一份群组邀请。 - -3️⃣ **点击邀请链接**：打开邀请链接，立即加入我们的精彩群组！ - -4️⃣ **尽情参与和分享**：在群组中，你将有机会与其他成员分享观点、经验和信息。我们热切期待你的参与！ - diff --git a/README.md b/README.md index fe5c149..a7a06e6 100644 --- a/README.md +++ b/README.md @@ -196,6 +196,7 @@ - [Provider](spring-jsr/spring-jsr330-provider/README.md)：Java标准库提供的通用Bean工厂接口。 + Spring AOP + - [Pointcut](spring-jsr/spring-jsr330-inject/README.md)：定义切入点，匹配被拦截的方法。 + Spring AOT diff --git a/spring-aop/pom.xml b/spring-aop/pom.xml index 8e5ad5a..d7c31d1 100644 --- a/spring-aop/pom.xml +++ b/spring-aop/pom.xml @@ -7,6 +7,11 @@ com.xcs.spring 0.0.1-SNAPSHOT + pom + + spring-aop-advisor + spring-aop-pointcut + 4.0.0 spring-aop diff --git a/spring-aop/spring-aop-advisor/README.md b/spring-aop/spring-aop-advisor/README.md new file mode 100644 index 0000000..5509a0b --- /dev/null +++ b/spring-aop/spring-aop-advisor/README.md @@ -0,0 +1,32 @@ +## Advisor + +- [Advisor](#Advisor) + - [一、基本信息](#一基本信息) + - [二、知识储备](#二知识储备) + - [三、基本描述](#三基本描述) + - [四、主要功能](#四主要功能) + - [五、接口源码](#五接口源码) + - [六、主要实现](#六主要实现) + - [七、最佳实践](#七最佳实践) + - [八、与其他组件的关系](#八与其他组件的关系) + - [九、常见问题](#九常见问题) + +### 一、基本信息 + +✒️ **作者** - Lex 📝 **博客** - [掘金](https://juejin.cn/user/4251135018533068/posts) 📚 **源码地址** - [github](https://github.com/xuchengsheng/spring-reading) + +### 二、知识储备 + +### 三、基本描述 + +### 四、主要功能 + +### 五、接口源码 + +### 六、主要实现 + +### 七、最佳实践 + +### 八、与其他组件的关系 + +### 九、常见问题 \ No newline at end of file diff --git a/spring-aop/spring-aop-advisor/pom.xml b/spring-aop/spring-aop-advisor/pom.xml new file mode 100644 index 0000000..4e6f3ca --- /dev/null +++ b/spring-aop/spring-aop-advisor/pom.xml @@ -0,0 +1,14 @@ + + + + com.xcs.spring + spring-aop + 0.0.1-SNAPSHOT + + + 4.0.0 + spring-aop-advisor + + \ No newline at end of file diff --git a/spring-aop/spring-aop-pointcut/README.md b/spring-aop/spring-aop-pointcut/README.md new file mode 100644 index 0000000..ab6a86c --- /dev/null +++ b/spring-aop/spring-aop-pointcut/README.md @@ -0,0 +1,358 @@ +## Pointcut + +- [Pointcut](#pointcut) + - [一、基本信息](#一基本信息) + - [二、知识储备](#二知识储备) + - [三、基本描述](#三基本描述) + - [四、主要功能](#四主要功能) + - [五、接口源码](#五接口源码) + - [六、主要实现](#六主要实现) + - [七、最佳实践](#七最佳实践) + - [自定义Pointcut](#自定义pointcut) + - [AspectJExpressionPointcut](#aspectjexpressionpointcut) + - [AnnotationMatchingPointcut](#annotationmatchingpointcut) + - [NameMatchMethodPointcut](#namematchmethodpointcut) + - [八、与其他组件的关系](#八与其他组件的关系) + - [九、常见问题](#九常见问题) + +### 一、基本信息 + +✒️ **作者** - Lex 📝 **博客** - [掘金](https://juejin.cn/user/4251135018533068/posts) 📚 **源码地址** - [github](https://github.com/xuchengsheng/spring-reading) + +### 二、知识储备 + +1. **AOP 概念** + + + 了解面向切面编程（AOP）的基本概念和原理，包括切面、连接点、通知、切点等概念。理解 AOP 的作用和用途，以及它与传统的面向对象编程的区别。 + +2. **Spring AOP** + + + 熟悉 Spring 框架中的 AOP 实现方式，了解 Spring AOP 如何在运行时将切面织入到目标对象的方法中，以及它的工作原理。 + +3. **代理模式** + + + 了解代理模式的基本原理和实现方式，包括静态代理和动态代理。在 Spring AOP 中，代理对象负责拦截目标对象的方法调用，并在必要时应用切面逻辑。 + +### 三、基本描述 + +`Pointcut` 接口主要用于定义切入点，即确定哪些方法应该被切面所影响。Pointcut 接口提供了匹配规则，以确定在哪些类的哪些方法上应用切面，以及在何种情况下应该应用切面。 + +### 四、主要功能 + +1. **定义切入点** + + + Pointcut 接口用于定义切入点，即确定哪些方法应该被切面所影响。它允许开发人员指定在哪些类的哪些方法上应用切面。 + +2. **匹配规则** + + + 提供了匹配规则，以确定在哪些方法上应用切面。这些规则可以基于方法的名称、参数、返回类型、类名称等多种条件来定义，从而实现对切入点的精确定位。 + +3. **获取类过滤器** + + + `getClassFilter()` 方法用于获取一个 `ClassFilter` 对象，该对象用于确定哪些类应该被匹配。我们可以根据自己的需求自定义类过滤逻辑。 + +4. **获取方法匹配器** + + + `getMethodMatcher()` 方法用于获取一个 `MethodMatcher` 对象，该对象用于确定哪些方法应该被匹配。我们可以根据自己的需求自定义方法匹配逻辑。 + +### 五、接口源码 + +`Pointcut`接口定义了 Spring AOP 中的切入点的核心抽象，由 `ClassFilter` 和 `MethodMatcher` 组成，分别用于确定哪些类和方法应该被匹配。通过这个接口，可以创建不同的切入点，并灵活地组合它们来定义复杂的切面。接口中还定义了一个常量 `TRUE`，代表始终匹配的切入点。 + +```java +/** + * 核心的 Spring 切入点抽象。 + * + *

一个切入点由一个 {@link ClassFilter} 和一个 {@link MethodMatcher} 组成。 + * 这两个基本术语以及一个切入点本身可以组合起来构建组合（例如通过 {@link org.springframework.aop.support.ComposablePointcut}）。 + * + * @author Rod Johnson + * @see ClassFilter + * @see MethodMatcher + * @see org.springframework.aop.support.Pointcuts + * @see org.springframework.aop.support.ClassFilters + * @see org.springframework.aop.support.MethodMatchers + */ +public interface Pointcut { + + /** + * 返回此切入点的 ClassFilter。 + * @return ClassFilter（永不为 {@code null}） + */ + ClassFilter getClassFilter(); + + /** + * 返回此切入点的 MethodMatcher。 + * @return MethodMatcher（永不为 {@code null}） + */ + MethodMatcher getMethodMatcher(); + + + /** + * 始终匹配的规范切入点实例。 + */ + Pointcut TRUE = TruePointcut.INSTANCE; + +} +``` + +### 六、主要实现 + +1. **NameMatchMethodPointcut** + + + 根据方法名称匹配的切入点。可以配置指定的方法名称或通配符，以匹配目标类中的方法。 + +2. **JdkRegexpMethodPointcut** + + + 使用正则表达式匹配方法的切入点。可以使用正则表达式指定方法的匹配规则。 + +3. **AspectJExpressionPointcut** + + + 使用 AspectJ 切入点表达式匹配方法的切入点。可以使用 AspectJ 的语法来定义更灵活的切入点匹配规则。 + +4. **ComposablePointcut** + + + 可组合的切入点，允许将多个切入点组合起来使用，支持与、或、非等逻辑操作。 + +5. **StaticMethodMatcherPointcut** + + + 静态方法匹配器切入点，用于直接指定方法匹配规则，不支持动态匹配。 + +6. **TruePointcut** + + + 始终匹配的切入点，代表不进行任何匹配，即匹配所有的类和方法。 + +### 七、最佳实践 + +#### 自定义Pointcut + +使用 Spring AOP 创建代理对象，并应用自定义的切入点和通知来拦截目标方法的调用。首先，通过 `ProxyFactory` 创建了一个代理工厂，然后使用 `addAdvisor` 方法添加了一个切面，其中包含了自定义的切入点和通知。接着，通过代理工厂的 `getProxy` 方法获取代理对象。最后，使用代理对象调用方法。 + +```java +public class PointcutDemo { + public static void main(String[] args) { + customPointcut(); + } + + /** + * 自定义 Pointcut 最佳实践 + */ + private static void customPointcut() { + // 创建代理工厂 + ProxyFactory proxyFactory = new ProxyFactory(new MyBean()); + // 添加切面：使用自定义的切入点和通知构建默认切面 + proxyFactory.addAdvisor(new DefaultPointcutAdvisor(new MyCustomPointcut(), new MyCustomAdvice())); + // 获取代理对象 + MyBean myBean = (MyBean) proxyFactory.getProxy(); + + // 使用代理对象调用方法 + myBean.getName(); // 将被通知拦截 + myBean.getAge(); // 将被通知拦截 + myBean.setName(); // 不会被通知拦截 + } +} +``` + +自定义了一个自定义的切入点 `MyCustomPointcut`，该切入点匹配所有类，并且匹配所有方法名以 "get" 开头的方法。这意味着通过该切入点定义的切面将会拦截所有类的所有以 "get" 开头的方法调用。 + +```java +class MyCustomPointcut implements Pointcut { + + @Override + public ClassFilter getClassFilter() { + // 匹配所有类 + return clazz -> true; + } + + @Override + public MethodMatcher getMethodMatcher() { + return new MethodMatcher() { + @Override + public boolean matches(Method method, Class targetClass) { + // 匹配所有以 "get" 开头的方法 + return method.getName().startsWith("get"); + } + + @Override + public boolean isRuntime() { + // 是否需要在运行时动态匹配 + return false; + } + + @Override + public boolean matches(Method method, Class targetClass, Object... args) { + // 运行时匹配，这里不需要，所以简单返回 false + return false; + } + }; + } +} +``` + +自定义的通知 `MyCustomAdvice`，它实现了 `MethodBeforeAdvice` 接口，因此是一个前置通知，用于在目标方法执行之前执行额外的逻辑。在 `before` 方法中，它输出一条日志信息 "Before advice is executed"，表示在目标方法执行前执行了该通知逻辑。 + +```java +class MyCustomAdvice implements MethodBeforeAdvice { + @Override + public void before(Method method, Object[] args, Object target) throws Throwable { + System.out.println("Before advice is executed"); + } +} +``` + +定义了一个简单的 Java 类 `MyBean`，其中包含了三个方法`getName()`、`setName()` 和 `getAge()`。 + +```java +public class MyBean { + public void getName() { + System.out.println("getName() method"); + } + + public void setName() { + System.out.println("setName() method"); + } + + public void getAge() { + System.out.println("getAge() method"); + } +} +``` + +#### AspectJExpressionPointcut + +使用 `AspectJExpressionPointcut` 实现一个简单的切入点定义。在 `aspectJExpressionPointcut` 方法中，我们创建了一个 `AspectJExpressionPointcut` 对象，并设置了 AspectJ 表达式，该表达式匹配了所有类中的 `getName()` 方法。然后，我们将切入点与通知关联，并将其作为切面添加到代理工厂中。最后，我们使用代理对象调用了几个方法，根据切入点的定义，只有匹配到的方法会被通知拦截。 + +```java +public class PointcutDemo { + public static void main(String[] args) { + aspectJExpressionPointcut(); + } + + /** + * AspectJExpressionPointcut最佳实践 + */ + private static void aspectJExpressionPointcut() { + // 创建 AspectJ 表达式切入点 + AspectJExpressionPointcut pointcut = new AspectJExpressionPointcut(); + pointcut.setExpression("execution(* *.getName())"); + + // 创建代理工厂 + ProxyFactory proxyFactory = new ProxyFactory(new MyBean()); + // 添加切面：使用自定义的切入点和通知构建默认切面 + proxyFactory.addAdvisor(new DefaultPointcutAdvisor(pointcut, new MyCustomAdvice())); + // 获取代理对象 + MyBean myBean = (MyBean) proxyFactory.getProxy(); + + // 使用代理对象调用方法 + myBean.getName(); // 将被通知拦截 + myBean.getAge(); // 不会被通知拦截 + myBean.setName(); // 不会被通知拦截 + } +} +``` + +#### AnnotationMatchingPointcut + +使用 `AnnotationMatchingPointcut` 实现一个简单的切入点定义。在 `annotationMatchingPointcut` 方法中，我们创建了一个 `AnnotationMatchingPointcut` 对象，并指定了要匹配的注解类型 `MyAnnotation`，以及是否检查继承的方法。然后，我们将切入点与通知关联，并将其作为切面添加到代理工厂中。最后，我们使用代理对象调用了几个方法，根据切入点的定义，所有使用了 `MyAnnotation` 注解的方法都会被通知拦截。 + +```java +public class PointcutDemo { + public static void main(String[] args) { + annotationMatchingPointcut(); + } + + /** + * AnnotationMatchingPointcut 最佳实践 + */ + private static void annotationMatchingPointcut() { + // 创建代理工厂 + ProxyFactory proxyFactory = new ProxyFactory(new MyBean()); + // 添加切面：使用AnnotationMatchingPointcut切入点和通知构建默认切面 + proxyFactory.addAdvisor(new DefaultPointcutAdvisor(new AnnotationMatchingPointcut(MyAnnotation.class, false), new MyCustomAdvice())); + // 获取代理对象 + MyBean myBean = (MyBean) proxyFactory.getProxy(); + + // 使用代理对象调用方法 + myBean.getName(); // 将被通知拦截 + myBean.getAge(); // 将被通知拦截 + myBean.setName(); // 将被通知拦截 + } +} +``` + +#### NameMatchMethodPointcut + +使用 `NameMatchMethodPointcut` 实现一个简单的切入点定义。在 `nameMatchMethodPointcut` 方法中，我们创建了一个 `NameMatchMethodPointcut` 对象，并添加了要匹配的方法名 `getAge`。然后，我们将切入点与通知关联，并将其作为切面添加到代理工厂中。最后，我们使用代理对象调用了几个方法，根据切入点的定义，只有匹配到的方法会被通知拦截。 + +```java +public class PointcutDemo { + public static void main(String[] args) { + nameMatchMethodPointcut(); + } + + /** + * AspectJExpressionPointcut最佳实践 + */ + private static void nameMatchMethodPointcut() { + // 创建方法名匹配切入点 + NameMatchMethodPointcut pointcut = new NameMatchMethodPointcut(); + pointcut.addMethodName("getAge"); + + // 创建代理工厂 + ProxyFactory proxyFactory = new ProxyFactory(new MyBean()); + // 添加切面：使用自定义的切入点和通知构建默认切面 + proxyFactory.addAdvisor(new DefaultPointcutAdvisor(pointcut, new MyCustomAdvice())); + // 获取代理对象 + MyBean myBean = (MyBean) proxyFactory.getProxy(); + + // 使用代理对象调用方法 + myBean.getName(); // 不会被通知拦截 + myBean.getAge(); // 将被通知拦截 + myBean.setName(); // 不会被通知拦截 + } +} +``` + +### 八、与其他组件的关系 + +1. **Advisor** + + + Advisor 包含了切入点和通知，而切入点就是由 Pointcut 定义的。Advisor 使用 Pointcut 来确定在何处应该应用通知。 + +2. **切面（Aspect）** + + + 切面是一种横切关注点的模块化实现，其中包含了切入点和通知。切面通常将 Pointcut 与 Advice（通知）结合在一起，定义了在何处和如何应用通知。 + +3. **Pointcut实现类** + + + `Pointcut` 接口是定义切入点的核心接口。Spring AOP 提供了多种实现了 `Pointcut` 接口的类，如 `NameMatchMethodPointcut`、`AspectJExpressionPointcut` 等，用于实现不同类型的切入点匹配规则。 + +### 九、常见问题 + +1. **切入点表达式定义错误** + + + 使用 AspectJ 表达式时，可能会由于表达式定义错误导致切入点匹配失败。例如，表达式写错了、漏掉了必要的切入点信息等。 + +2. **匹配不到目标方法** + + + 定义的切入点可能无法匹配到目标方法，导致通知无法正确地应用。这可能是由于切入点的匹配规则不正确，或者目标方法的特征与切入点不匹配等原因造成的。 + +3. **切入点过于宽泛** + + + 切入点定义过于宽泛，导致匹配到了不必要的方法，使得通知影响范围过大。这可能会导致性能问题或意外的行为。 + +4. **切入点过于狭窄** + + + 切入点定义过于狭窄，导致无法匹配到预期的目标方法，使得通知无法正确应用。这可能会导致切面无法达到预期的效果。 + +5. **运行时动态匹配问题** + + + 如果使用了运行时动态匹配的切入点，可能会由于动态条件的设置不正确或者动态条件的结果不符合预期等原因导致匹配失败。 + +6. **与其他切面冲突** + + + 如果多个切面定义了相互冲突的切入点，可能会导致切面的顺序问题或者切面之间的冲突，使得通知的执行顺序出现问题或者切面功能失效。 + +7. **性能问题** + + + 如果切入点定义过于宽泛或者运行时动态匹配过于频繁，可能会导致性能问题，影响应用程序的性能表现。 \ No newline at end of file diff --git a/spring-aop/spring-aop-pointcut/pom.xml b/spring-aop/spring-aop-pointcut/pom.xml new file mode 100644 index 0000000..f9d85bd --- /dev/null +++ b/spring-aop/spring-aop-pointcut/pom.xml @@ -0,0 +1,14 @@ + + + + com.xcs.spring + spring-aop + 0.0.1-SNAPSHOT + + + 4.0.0 + spring-aop-pointcut + + \ No newline at end of file diff --git a/spring-aop/spring-aop-pointcut/src/main/java/com/xcs/spring/MyAnnotation.java b/spring-aop/spring-aop-pointcut/src/main/java/com/xcs/spring/MyAnnotation.java new file mode 100644 index 0000000..9b1d294 --- /dev/null +++ b/spring-aop/spring-aop-pointcut/src/main/java/com/xcs/spring/MyAnnotation.java @@ -0,0 +1,14 @@ +package com.xcs.spring; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * 定义自定义注解 + */ +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.TYPE) +public @interface MyAnnotation { +} diff --git a/spring-aop/spring-aop-pointcut/src/main/java/com/xcs/spring/MyBean.java b/spring-aop/spring-aop-pointcut/src/main/java/com/xcs/spring/MyBean.java new file mode 100644 index 0000000..13f04e3 --- /dev/null +++ b/spring-aop/spring-aop-pointcut/src/main/java/com/xcs/spring/MyBean.java @@ -0,0 +1,16 @@ +package com.xcs.spring; + +@MyAnnotation +public class MyBean { + public void getName() { + System.out.println("getName() method"); + } + + public void setName() { + System.out.println("setName() method"); + } + + public void getAge() { + System.out.println("getAge() method"); + } +} diff --git a/spring-aop/spring-aop-pointcut/src/main/java/com/xcs/spring/MyCustomAdvice.java b/spring-aop/spring-aop-pointcut/src/main/java/com/xcs/spring/MyCustomAdvice.java new file mode 100644 index 0000000..c83c970 --- /dev/null +++ b/spring-aop/spring-aop-pointcut/src/main/java/com/xcs/spring/MyCustomAdvice.java @@ -0,0 +1,12 @@ +package com.xcs.spring; + +import org.springframework.aop.MethodBeforeAdvice; + +import java.lang.reflect.Method; + +class MyCustomAdvice implements MethodBeforeAdvice { + @Override + public void before(Method method, Object[] args, Object target) throws Throwable { + System.out.println("Before advice is executed"); + } +} diff --git a/spring-aop/spring-aop-pointcut/src/main/java/com/xcs/spring/MyCustomPointcut.java b/spring-aop/spring-aop-pointcut/src/main/java/com/xcs/spring/MyCustomPointcut.java new file mode 100644 index 0000000..558afc5 --- /dev/null +++ b/spring-aop/spring-aop-pointcut/src/main/java/com/xcs/spring/MyCustomPointcut.java @@ -0,0 +1,39 @@ +package com.xcs.spring; + +import org.springframework.aop.ClassFilter; +import org.springframework.aop.MethodMatcher; +import org.springframework.aop.Pointcut; + +import java.lang.reflect.Method; + +class MyCustomPointcut implements Pointcut { + + @Override + public ClassFilter getClassFilter() { + // 匹配所有类 + return clazz -> true; + } + + @Override + public MethodMatcher getMethodMatcher() { + return new MethodMatcher() { + @Override + public boolean matches(Method method, Class targetClass) { + // 匹配所有以 "get" 开头的方法 + return method.getName().startsWith("get"); + } + + @Override + public boolean isRuntime() { + // 是否需要在运行时动态匹配 + return false; + } + + @Override + public boolean matches(Method method, Class targetClass, Object... args) { + // 运行时匹配，这里不需要，所以简单返回 false + return false; + } + }; + } +} diff --git a/spring-aop/spring-aop-pointcut/src/main/java/com/xcs/spring/PointcutDemo.java b/spring-aop/spring-aop-pointcut/src/main/java/com/xcs/spring/PointcutDemo.java new file mode 100644 index 0000000..ab27273 --- /dev/null +++ b/spring-aop/spring-aop-pointcut/src/main/java/com/xcs/spring/PointcutDemo.java @@ -0,0 +1,89 @@ +package com.xcs.spring; + +import org.springframework.aop.aspectj.AspectJExpressionPointcut; +import org.springframework.aop.framework.ProxyFactory; +import org.springframework.aop.support.DefaultPointcutAdvisor; +import org.springframework.aop.support.NameMatchMethodPointcut; +import org.springframework.aop.support.annotation.AnnotationMatchingPointcut; + +public class PointcutDemo { + public static void main(String[] args) { + customPointcut(); + } + + /** + * 自定义 Pointcut 最佳实践 + */ + private static void customPointcut() { + // 创建代理工厂 + ProxyFactory proxyFactory = new ProxyFactory(new MyBean()); + // 添加切面：使用自定义的切入点和通知构建默认切面 + proxyFactory.addAdvisor(new DefaultPointcutAdvisor(new MyCustomPointcut(), new MyCustomAdvice())); + // 获取代理对象 + MyBean myBean = (MyBean) proxyFactory.getProxy(); + + // 使用代理对象调用方法 + myBean.getName(); // 将被通知拦截 + myBean.getAge(); // 将被通知拦截 + myBean.setName(); // 不会被通知拦截 + } + + /** + * AspectJExpressionPointcut最佳实践 + */ + private static void aspectJExpressionPointcut() { + // 创建 AspectJ 表达式切入点 + AspectJExpressionPointcut pointcut = new AspectJExpressionPointcut(); + pointcut.setExpression("execution(* *.getName())"); + + // 创建代理工厂 + ProxyFactory proxyFactory = new ProxyFactory(new MyBean()); + // 添加切面：使用自定义的切入点和通知构建默认切面 + proxyFactory.addAdvisor(new DefaultPointcutAdvisor(pointcut, new MyCustomAdvice())); + // 获取代理对象 + MyBean myBean = (MyBean) proxyFactory.getProxy(); + + // 使用代理对象调用方法 + myBean.getName(); // 将被通知拦截 + myBean.getAge(); // 不会被通知拦截 + myBean.setName(); // 不会被通知拦截 + } + + /** + * AnnotationMatchingPointcut 最佳实践 + */ + private static void annotationMatchingPointcut() { + // 创建代理工厂 + ProxyFactory proxyFactory = new ProxyFactory(new MyBean()); + // 添加切面：使用AnnotationMatchingPointcut切入点和通知构建默认切面 + proxyFactory.addAdvisor(new DefaultPointcutAdvisor(new AnnotationMatchingPointcut(MyAnnotation.class, false), new MyCustomAdvice())); + // 获取代理对象 + MyBean myBean = (MyBean) proxyFactory.getProxy(); + + // 使用代理对象调用方法 + myBean.getName(); // 将被通知拦截 + myBean.getAge(); // 将被通知拦截 + myBean.setName(); // 将被通知拦截 + } + + /** + * AspectJExpressionPointcut最佳实践 + */ + private static void nameMatchMethodPointcut() { + // 创建方法名匹配切入点 + NameMatchMethodPointcut pointcut = new NameMatchMethodPointcut(); + pointcut.addMethodName("getAge"); + + // 创建代理工厂 + ProxyFactory proxyFactory = new ProxyFactory(new MyBean()); + // 添加切面：使用自定义的切入点和通知构建默认切面 + proxyFactory.addAdvisor(new DefaultPointcutAdvisor(pointcut, new MyCustomAdvice())); + // 获取代理对象 + MyBean myBean = (MyBean) proxyFactory.getProxy(); + + // 使用代理对象调用方法 + myBean.getName(); // 不会被通知拦截 + myBean.getAge(); // 将被通知拦截 + myBean.setName(); // 不会被通知拦截 + } +}