diff --git a/README-BACK.md b/README-BACK.md new file mode 100644 index 0000000..6da4bda --- /dev/null +++ b/README-BACK.md @@ -0,0 +1,442 @@ +
+ 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` + - `BeanWrapper` + - `PropertyEditor` + - `Converter` + + - `ConverterFactory` + - `GenericConverter` + - `ConditionalConverter` + - `ConversionService` + - `Parser` + - `Printer` + - `AnnotationFormatterFactory` + +- 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工厂接口。 + +#### Spring AOP + ++ AOP 术语:Aspect、Join point、Advice、Pointcut 等 + ++ Spring AOP 实现原理 + ++ 动态代理:JDK 与 CGLIB + ++ @AspectJ 支持与使用 + ++ 切点表达式解析 + +#### Spring 事件机制 + ++ 事件的发布与监听 + ++ 自定义事件 + +#### Spring 事务管理 + ++ Spring 事务管理介绍 + ++ 编程式与声明式事务 + ++ @Transactional 注解解析 + ++ 事务传播行为 + ++ 事务隔离级别 + ++ 事务管理器实现原理 + +#### Spring MVC + +- `@Controller`:定义类为 Spring MVC 控制器,处理请求并返回视图。 + +- `@RequestMapping`:映射请求 URL 到处理方法。 + +- `@RequestMapping`:简化 HTTP 方法映射注解,处理 GET、POST、PUT 和 DELETE 请求。 + +- `@RequestParam`:绑定请求参数到方法参数。 + +- `@PathVariable`:提取 URI 中的模板变量。 + +- `@RequestBody`:绑定请求体内容到方法参数,通常用于处理 POST 请求中的 JSON 数据。 + +- `@ResponseBody`:将方法返回值直接写入 HTTP 响应体。 + +- `@ModelAttribute`:将方法返回值或参数添加到模型,使其在视图中可访问。 + +- `@SessionAttribute`:指定模型属性存储在会话中,以在多个请求之间共享。 + +- `@InitBinder`:定制数据绑定过程,例如将字符串转换为日期。 + +- `@Validated`:类级别注解,标记验证组。 + +- `@ResponseBodyAdvice`:全局定制控制器方法返回值的处理。 + +- `@RestController`:定义类为 RESTful 控制器,直接将每个方法的返回值写入响应体。 + +- `@RequestMappingHandlerMapping`:配置自定义的请求映射处理器。 + +- `@SessionAttributes`:控制器类上标记,指定哪些模型属性存储在会话中,用于在多个请求中共享。 + +- `@ModelAttribute`:在方法级别和参数级别使用,将模型属性绑定到方法参数,实现数据传递。 + +- `@SessionAttribute`:将模型属性存储在会话中,实现在多个请求中的数据共享。 + +- `@InitBinder`:在类和方法级别使用,定制数据绑定过程,例如字符串转日期。 + +- `@Validated`:类级别注解,标记验证组,与验证框架一起使用。 + +- `@ResponseBodyAdvice`:全局处理控制器方法返回值,用于定制响应体逻辑。 + +- `@RestController`:类似于 @Controller,专注于 RESTful 服务,直接将方法返回值写入响应体。 + +- `@RequestMappingHandlerMappin`g:配置自定义请求映射处理器,用于个性化 URL 映射逻辑。 + +#### Spring Boot + ++ `@SpringBootApplication`:启动类标识,包含了组合注解 。 + ++ `@EnableAutoConfiguration`:启用 Spring Boot 的自动配置。 + ++ `@ConfigurationProperties`:将配置文件中的属性值注入到配置类的属性中。 + ++ `@EnableCaching`:启用缓存支持。 + ++ `@Async`:异步方法注解。 + ++ `@EventListener`:监听事件。 + +#### Spring Cloud + +- `@EnableDiscoveryClient`:启用服务发现客户端,用于将服务注册到服务注册中心(例如 Eureka)。 + +- `@EnableEurekaServer`:启用 Eureka 服务端,用于搭建服务注册中心。 + +- `@LoadBalanced`:启用负载均衡,通常用于 RestTemplate 和 WebClient,使其具备负载均衡的能力。 + +- `@FeignClient`:声明一个声明式的 HTTP 客户端,简化了服务调用的过程。 + +- `@EnableCircuitBreaker`:启用断路器,用于防止分布式系统中的雪崩效应。 + +- `@HystrixCommand`:定义一个熔断器命令。 + +- `@EnableZuulProxy`:启用 Zuul API 网关代理。 + +- `@ZuulRoute`:用于配置 Zuul 路由。 + +- `@EnableConfigServer`:启用配置中心服务端。 + +- `@RefreshScope`:用于刷新配置,通常与 Spring Cloud Config 配合使用。 + +- `@EnableZipkinServer`:启用 Zipkin 服务器,用于分布式链路追踪。 + +- `@EnableBinding`:绑定消息通道,与 Spring Cloud Stream 配合使用。 + +- `@GlobalTransactional`:全局事务注解,与 Seata 等分布式事务框架配合使用。 + +- `@SentinelResource`:Sentinel 限流和熔断注解。 + +- `@DubboTransported`:用于 Dubbo 服务的注解。 + +- `@NacosInjected`:用于注入 Nacos 相关的实例。 + + +#### Spring 编程风格与设计模式 + ++ 设计模式在 Spring 源码中的应用 + ++ Spring 源码阅读技巧 + +## 💬与我联系 + +✉️ [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 +
+ +## 👥加入我们 + +欢迎加入我们的群聊!一起探讨、分享和学习吧! 🌐 + +
+logo +
+ diff --git a/README.md b/README.md index 395d984..dd8d32e 100644 --- a/README.md +++ b/README.md @@ -116,6 +116,20 @@ - [`ConfigurableEnvironment`](spring-env/spring-env-configurableEnvironment/README.md):动态配置应用环境,激活、默认配置,提升应用灵活性。 +- 验证、数据绑定与类型转换 + + - [`Validator`](spring-dataops/spring-dataops-validator/README.md):提供自定义数据验证逻辑,确保模型对象满足业务规则。 + - `BeanWrapper`:用于操作JavaBean的属性,实现动态属性设置和获取。 + - `PropertyEditor`:自定义JavaBean属性的转换逻辑,处理属性类型转换。 + - `Converter`:用于不同类型间的转换,定义简单的源至目标类型转换规则。 + - `ConverterFactory`:创建针对特定源类型的转换器,用于类型转换。 + - `GenericConverter`:更复杂的转换器,支持多种源和目标类型转换。 + - `ConditionalConverter`:根据条件选择是否执行转换的转换器。 + - `ConversionService`:提供统一的类型转换服务接口,管理转换器。 + - `Parser`:用于将文本解析为对象,专注于解析逻辑。 + - `Printer`:用于将对象格式化为文本,专注于格式化输出。 + - `AnnotationFormatterFactory`:针对带注解字段的格式化器工厂,链接注解与格式化逻辑。 + - Bean定义导入与组合 - `ImportBeanDefinitionRegistrar`:运行时动态注册 Bean,实现灵活配置,扩展配置类功能。 @@ -260,139 +274,6 @@ - [`Provider`](spring-jsr/spring-jsr330-provider/README.md):Java标准库提供的通用Bean工厂接口。 -#### Spring AOP - -+ AOP 术语:Aspect、Join point、Advice、Pointcut 等 - -+ Spring AOP 实现原理 - -+ 动态代理:JDK 与 CGLIB - -+ @AspectJ 支持与使用 - -+ 切点表达式解析 - -#### Spring 事件机制 - -+ 事件的发布与监听 - -+ 自定义事件 - -#### Spring 事务管理 - -+ Spring 事务管理介绍 - -+ 编程式与声明式事务 - -+ @Transactional 注解解析 - -+ 事务传播行为 - -+ 事务隔离级别 - -+ 事务管理器实现原理 - -#### Spring MVC - -- `@Controller`:定义类为 Spring MVC 控制器,处理请求并返回视图。 - -- `@RequestMapping`:映射请求 URL 到处理方法。 - -- `@RequestMapping`:简化 HTTP 方法映射注解,处理 GET、POST、PUT 和 DELETE 请求。 - -- `@RequestParam`:绑定请求参数到方法参数。 - -- `@PathVariable`:提取 URI 中的模板变量。 - -- `@RequestBody`:绑定请求体内容到方法参数,通常用于处理 POST 请求中的 JSON 数据。 - -- `@ResponseBody`:将方法返回值直接写入 HTTP 响应体。 - -- `@ModelAttribute`:将方法返回值或参数添加到模型,使其在视图中可访问。 - -- `@SessionAttribute`:指定模型属性存储在会话中,以在多个请求之间共享。 - -- `@InitBinder`:定制数据绑定过程,例如将字符串转换为日期。 - -- `@Validated`:类级别注解,标记验证组。 - -- `@ResponseBodyAdvice`:全局定制控制器方法返回值的处理。 - -- `@RestController`:定义类为 RESTful 控制器,直接将每个方法的返回值写入响应体。 - -- `@RequestMappingHandlerMapping`:配置自定义的请求映射处理器。 - -- `@SessionAttributes`:控制器类上标记,指定哪些模型属性存储在会话中,用于在多个请求中共享。 - -- `@ModelAttribute`:在方法级别和参数级别使用,将模型属性绑定到方法参数,实现数据传递。 - -- `@SessionAttribute`:将模型属性存储在会话中,实现在多个请求中的数据共享。 - -- `@InitBinder`:在类和方法级别使用,定制数据绑定过程,例如字符串转日期。 - -- `@Validated`:类级别注解,标记验证组,与验证框架一起使用。 - -- `@ResponseBodyAdvice`:全局处理控制器方法返回值,用于定制响应体逻辑。 - -- `@RestController`:类似于 @Controller,专注于 RESTful 服务,直接将方法返回值写入响应体。 - -- `@RequestMappingHandlerMappin`g:配置自定义请求映射处理器,用于个性化 URL 映射逻辑。 - -#### Spring Boot - -+ `@SpringBootApplication`:启动类标识,包含了组合注解 。 - -+ `@EnableAutoConfiguration`:启用 Spring Boot 的自动配置。 - -+ `@ConfigurationProperties`:将配置文件中的属性值注入到配置类的属性中。 - -+ `@EnableCaching`:启用缓存支持。 - -+ `@Async`:异步方法注解。 - -+ `@EventListener`:监听事件。 - -#### Spring Cloud - -- `@EnableDiscoveryClient`:启用服务发现客户端,用于将服务注册到服务注册中心(例如 Eureka)。 - -- `@EnableEurekaServer`:启用 Eureka 服务端,用于搭建服务注册中心。 - -- `@LoadBalanced`:启用负载均衡,通常用于 RestTemplate 和 WebClient,使其具备负载均衡的能力。 - -- `@FeignClient`:声明一个声明式的 HTTP 客户端,简化了服务调用的过程。 - -- `@EnableCircuitBreaker`:启用断路器,用于防止分布式系统中的雪崩效应。 - -- `@HystrixCommand`:定义一个熔断器命令。 - -- `@EnableZuulProxy`:启用 Zuul API 网关代理。 - -- `@ZuulRoute`:用于配置 Zuul 路由。 - -- `@EnableConfigServer`:启用配置中心服务端。 - -- `@RefreshScope`:用于刷新配置,通常与 Spring Cloud Config 配合使用。 - -- `@EnableZipkinServer`:启用 Zipkin 服务器,用于分布式链路追踪。 - -- `@EnableBinding`:绑定消息通道,与 Spring Cloud Stream 配合使用。 - -- `@GlobalTransactional`:全局事务注解,与 Seata 等分布式事务框架配合使用。 - -- `@SentinelResource`:Sentinel 限流和熔断注解。 - -- `@DubboTransported`:用于 Dubbo 服务的注解。 - -- `@NacosInjected`:用于注入 Nacos 相关的实例。 - - -#### Spring 编程风格与设计模式 - -+ 设计模式在 Spring 源码中的应用 - -+ Spring 源码阅读技巧 - ## 💬与我联系 ✉️ [Email](xuchengshengsuper@163.com) | 💬 [Issue](https://github.com/xuchengsheng/spring-reading/issues) | 🌐 [CSDN](https://blog.csdn.net/duzhuang2399?type=blog) Me about everything! diff --git a/pom.xml b/pom.xml index f73d792..cbeaf74 100644 --- a/pom.xml +++ b/pom.xml @@ -31,6 +31,7 @@ spring-context spring-factory spring-env + spring-dataops diff --git a/spring-dataops/pom.xml b/spring-dataops/pom.xml new file mode 100644 index 0000000..baed57f --- /dev/null +++ b/spring-dataops/pom.xml @@ -0,0 +1,18 @@ + + + + spring-reading + com.xcs.spring + 0.0.1-SNAPSHOT + + + 4.0.0 + spring-dataops + pom + + spring-dataops-validator + + + \ No newline at end of file diff --git a/spring-dataops/spring-dataops-validator/README.md b/spring-dataops/spring-dataops-validator/README.md new file mode 100644 index 0000000..8ed5662 --- /dev/null +++ b/spring-dataops/spring-dataops-validator/README.md @@ -0,0 +1,230 @@ +## Validator + +- [Validator](#validator) + - [一、基本信息](#一基本信息) + - [二、知识储备](#二知识储备) + - [三、基本描述](#三基本描述) + - [四、主要功能](#四主要功能) + - [五、接口源码](#五接口源码) + - [六、主要实现](#六主要实现) + - [七、最佳实践](#七最佳实践) + - [八、与其他组件的关系](#八与其他组件的关系) + - [九、常见问题](#九常见问题) + + +### 一、基本信息 + +✒️ **作者** - Lex 📝 **博客** - [掘金](https://juejin.cn/user/4251135018533068/posts) 📚 **源码地址** - [github](https://github.com/xuchengsheng/spring-reading) + +### 二、知识储备 + +1. **Spring MVC** + + + 了解 Spring MVC 是很重要的。这包括控制器(Controllers)、请求映射(RequestMapping)、视图解析(View Resolution)等。理解如何处理 HTTP 请求和响应,以及 Spring MVC 中的数据绑定和表单处理。 + +2. **Bean Validation(JSR 303/JSR 380)** + + + 虽然 `Validator` 接口是 Spring 的一部分,了解 JSR 303/JSR 380(Bean Validation API)也是有益的,因为 Spring 支持这些标准。了解常用的 Bean Validation 注解,如 `@NotNull`, `@Size`, `@Min`, `@Max` 等。 + +3. **错误处理** + + + 理解 Spring 中的错误处理机制,特别是与数据验证相关的,如 `Errors` 和 `BindingResult` 接口。 + +### 三、基本描述 + +`Validator` 接口是 Spring 框架中用于实现对象数据验证的关键部分,它提供了一种标准化的方法来验证 Java 对象,特别是在处理用户输入和表单数据时。 + +### 四、主要功能 + +1. **自定义数据验证** + + + 允许我们根据业务需求实现自定义的验证逻辑,用于检查对象属性是否符合特定的约束和条件。 + +2. **支持多种对象类型** + + + 通过 `supports(Class clazz)` 方法,验证器可以指定它能够验证哪些类型的对象,使得同一个验证器可以用于不同类型的数据模型。 + +3. **错误记录** + + + 在 `validate(Object target, Errors errors)` 方法中,验证器检查目标对象的属性,如果发现不符合要求的情况,可以将错误信息添加到 `Errors` 对象中,这些信息可用于错误展示和后续处理。 + +4. **与 Spring MVC 集成** + + + 在 Spring MVC 中,`Validator` 可以集成到控制器流程中,自动验证模型对象,常与 `@Valid` 注解一同使用,用于处理表单提交和请求参数的验证。 + +### 五、接口源码 + +`Validator` 接口,是一个用于自定义对象验证的关键组件。这个接口包含两个主要方法:`supports(Class clazz)` 用于判断验证器是否支持特定类型的对象,通常通过检查对象是否为特定类或其子类来实现;`validate(Object target, Errors errors)` 用于执行实际的验证逻辑,其中 `target` 是待验证的对象,而 `errors` 用于记录验证中发现的错误。 + +```java +/** + * 用于应用程序特定对象的验证器。 + * + *

此接口与任何基础设施或上下文完全脱离关系;也就是说,它不仅限于验证Web层、数据访问层或任何其他层的对象。因此,它适用于应用程序的任何层次,并支持将验证逻辑作为其本身的一等公民进行封装。 + * + *

下面是一个简单但完整的 {@code Validator} 实现示例,它验证了 {@code UserLogin} 实例的各种 {@link String} 属性不为空(即它们不是 {@code null} 并且不完全由空白字符组成),以及任何存在的密码至少是 {@code 'MINIMUM_PASSWORD_LENGTH'} 个字符长。 + * + *

 public class UserLoginValidator implements Validator {
+ *
+ *    private static final int MINIMUM_PASSWORD_LENGTH = 6;
+ *
+ *    public boolean supports(Class clazz) {
+ *       return UserLogin.class.isAssignableFrom(clazz);
+ *    }
+ *
+ *    public void validate(Object target, Errors errors) {
+ *       ValidationUtils.rejectIfEmptyOrWhitespace(errors, "userName", "field.required");
+ *       ValidationUtils.rejectIfEmptyOrWhitespace(errors, "password", "field.required");
+ *       UserLogin login = (UserLogin) target;
+ *       if (login.getPassword() != null
+ *             && login.getPassword().trim().length() < MINIMUM_PASSWORD_LENGTH) {
+ *          errors.rejectValue("password", "field.min.length",
+ *                new Object[]{Integer.valueOf(MINIMUM_PASSWORD_LENGTH)},
+ *                "The password must be at least [" + MINIMUM_PASSWORD_LENGTH + "] characters in length.");
+ *       }
+ *    }
+ * }
+ * + *

有关 {@code Validator} 接口及其在企业应用中的角色的更全面讨论,请参阅 Spring 参考手册。 + * + * @author Rod Johnson + * @see SmartValidator + * @see Errors + * @see ValidationUtils + */ +public interface Validator { + + /** + * 判断这个 Validator 是否能够验证提供的 clazz 类型的实例。 + *

这个方法通常这样实现: + *

return Foo.class.isAssignableFrom(clazz);
+ * (其中 Foo 是实际要被验证的对象实例的类或超类。) + * @param clazz 这个 Validator 被询问是否能验证的 Class 类型 + * @return 如果这个 Validator 能验证提供的 clazz 类型的实例,返回 {@code true} + */ + boolean supports(Class clazz); + + /** + * 对提供的目标对象进行验证,该目标对象必须是 supports(Class) 方法通常会(或可能会)返回 true 的 Class 类型。 + *

提供的 Errors 实例可以用来报告任何验证错误。 + * @param target 需要被验证的对象 + * @param errors 验证过程中的上下文状态 + * @see ValidationUtils + */ + void validate(Object target, Errors errors); + +} +``` + +### 六、主要实现 + +1. **LocalValidatorFactoryBean** + + - 这是一个桥接类,用于在 Spring 应用中集成 JSR-303/JSR-380 Bean Validation API。它实现了 `Validator` 接口,允许使用标准的 Bean Validation 注解对对象进行验证。 + +2. **SpringValidatorAdapter** + + - 这个类适配 JSR-303/JSR-380 标准验证器到 Spring 的 `Validator` 接口。它使得可以在 Spring 中使用标准的 Bean Validation API。 + +### 七、最佳实践 + +使用 Spring 的 `Validator` 接口来验证 `Person` 对象的属性。程序创建了一个 `Person` 实例并设置了潜在的无效值,接着实例化了一个自定义的 `PersonValidator` 来进行验证。通过 `BeanPropertyBindingResult` 对象来存储和追踪验证过程中的错误,最后检查并打印出所有验证错误。 + +```java +public class ValidatorDemo { + + public static void main(String[] args) { + // 创建一个 Person 对象实例 + Person person = new Person(); + person.setName(null); + person.setAge(130); + + // 创建一个 BeanPropertyBindingResult 对象,用于存储验证过程中的错误 + BeanPropertyBindingResult result = new BeanPropertyBindingResult(person, "person"); + + // 创建一个 PersonValidator 实例,这是自定义的验证器 + PersonValidator validator = new PersonValidator(); + + // 检查 PersonValidator 是否支持 Person 类的验证 + if (validator.supports(person.getClass())) { + // 执行验证逻辑 + validator.validate(person, result); + } + + // 检查是否存在验证错误,并打印出所有的字段错误 + if (result.hasErrors()) { + for (FieldError error : result.getFieldErrors()) { + System.out.println(error.getField() + ":" + error.getDefaultMessage()); + } + } + } +} +``` + + `PersonValidator` 类用于检查 `Person` 对象的 `name` 是否为空以及 `age` 是否在有效范围内。如果发现不符合规则的字段,将相应的错误信息记录到 `Errors` 对象中。 + +```java +public class PersonValidator implements Validator { + + @Override + public boolean supports(Class clazz) { + return Person.class.equals(clazz); + } + + @Override + public void validate(Object obj, Errors e) { + // 检查名称是否为空 + ValidationUtils.rejectIfEmpty(e, "name", "name.empty", "姓名不能为空"); + + // 将对象转换为 Person 类型 + Person p = (Person) obj; + + // 检查年龄是否为负数 + if (p.getAge() < 0) { + e.rejectValue("age", "negative.value", "年龄不能为负数"); + } + // 检查年龄是否超过 120 岁 + else if (p.getAge() > 120) { + e.rejectValue("age", "too.darn.old", "目前年龄最大的是120岁"); + } + } +} +``` + +定义了一个简单的 Java 类 `Person`。 + +```java +public class Person { + + private String name; + + private int age; + + // get and set +} +``` + +### 八、与其他组件的关系 + ++ **Spring MVC框架** + + + `Validator` 接口的功能主要集中在处理和验证Web层的用户输入和模型数据。它与控制器紧密结合,用于在处理客户端请求(如表单提交)前验证模型数据。在数据绑定过程中,`Validator` 可用于检查绑定到模型对象的请求参数是否满足特定的验证规则。此外,Spring MVC 通过 `LocalValidatorFactoryBean` 支持与 JSR 303/JSR 380 Bean Validation 的集成,这允许我们在保持现有代码不变的情况下利用标准的 Bean Validation 注解。 + +### 九、常见问题 + +1. **正确实现 `supports` 方法** + + - 确保 `supports(Class clazz)` 方法正确实现是常见的问题之一。这个方法需要正确判断验证器是否支持特定类型的对象,否则可能导致验证逻辑不被执行。 + +2. **逻辑的分离与国际化** + + - 我们在保持验证逻辑与业务逻辑分离的同时,需要确保验证逻辑完整且与业务规则相符。另外管理和显示验证错误信息,特别是在需要支持多语言环境下进行错误信息国际化的情况。 + +3. **集成与 JSR 303/JSR 380 Bean Validation** + + + 在使用 `Validator` 与 JSR 303/JSR 380 Bean Validation 标准共同工作时,了解二者之间的区别和如何有效集成是一个常见问题。 + +5. **嵌套属性和复杂对象的验证** + + + 当验证对象具有嵌套属性或结构复杂时,实现有效且高效的验证逻辑可能会更加困难。 + diff --git a/spring-dataops/spring-dataops-validator/pom.xml b/spring-dataops/spring-dataops-validator/pom.xml new file mode 100644 index 0000000..5b266c1 --- /dev/null +++ b/spring-dataops/spring-dataops-validator/pom.xml @@ -0,0 +1,14 @@ + + + + spring-dataops + com.xcs.spring + 0.0.1-SNAPSHOT + + + 4.0.0 + spring-dataops-validator + + \ No newline at end of file diff --git a/spring-dataops/spring-dataops-validator/src/main/java/com/xcs/spring/Person.java b/spring-dataops/spring-dataops-validator/src/main/java/com/xcs/spring/Person.java new file mode 100644 index 0000000..f727bf0 --- /dev/null +++ b/spring-dataops/spring-dataops-validator/src/main/java/com/xcs/spring/Person.java @@ -0,0 +1,28 @@ +package com.xcs.spring; + +/** + * @author xcs + * @date 2023年12月04日 14时13分 + **/ +public class Person { + + private String name; + + private int age; + + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public int getAge() { + return age; + } + + public void setAge(int age) { + this.age = age; + } +} diff --git a/spring-dataops/spring-dataops-validator/src/main/java/com/xcs/spring/PersonValidator.java b/spring-dataops/spring-dataops-validator/src/main/java/com/xcs/spring/PersonValidator.java new file mode 100644 index 0000000..28b67ca --- /dev/null +++ b/spring-dataops/spring-dataops-validator/src/main/java/com/xcs/spring/PersonValidator.java @@ -0,0 +1,35 @@ +package com.xcs.spring; + +import org.springframework.validation.Errors; +import org.springframework.validation.ValidationUtils; +import org.springframework.validation.Validator; + +/** + * @author xcs + * @date 2023年12月04日 14时13分 + **/ +public class PersonValidator implements Validator { + + @Override + public boolean supports(Class clazz) { + return Person.class.equals(clazz); + } + + @Override + public void validate(Object obj, Errors e) { + // 检查名称是否为空 + ValidationUtils.rejectIfEmpty(e, "name", "name.empty", "姓名不能为空"); + + // 将对象转换为 Person 类型 + Person p = (Person) obj; + + // 检查年龄是否为负数 + if (p.getAge() < 0) { + e.rejectValue("age", "negative.value", "年龄不能为负数"); + } + // 检查年龄是否超过 120 岁 + else if (p.getAge() > 120) { + e.rejectValue("age", "too.darn.old", "目前年龄最大的是120岁"); + } + } +} diff --git a/spring-dataops/spring-dataops-validator/src/main/java/com/xcs/spring/ValidatorDemo.java b/spring-dataops/spring-dataops-validator/src/main/java/com/xcs/spring/ValidatorDemo.java new file mode 100644 index 0000000..bc62984 --- /dev/null +++ b/spring-dataops/spring-dataops-validator/src/main/java/com/xcs/spring/ValidatorDemo.java @@ -0,0 +1,37 @@ +package com.xcs.spring; + +import org.springframework.validation.BeanPropertyBindingResult; +import org.springframework.validation.FieldError; + +/** + * @author xcs + * @date 2023年12月04日 14时06分 + **/ +public class ValidatorDemo { + + public static void main(String[] args) { + // 创建一个 Person 对象实例 + Person person = new Person(); + person.setName(null); + person.setAge(130); + + // 创建一个 BeanPropertyBindingResult 对象,用于存储验证过程中的错误 + BeanPropertyBindingResult result = new BeanPropertyBindingResult(person, "person"); + + // 创建一个 PersonValidator 实例,这是自定义的验证器 + PersonValidator validator = new PersonValidator(); + + // 检查 PersonValidator 是否支持 Person 类的验证 + if (validator.supports(person.getClass())) { + // 执行验证逻辑 + validator.validate(person, result); + } + + // 检查是否存在验证错误,并打印出所有的字段错误 + if (result.hasErrors()) { + for (FieldError error : result.getFieldErrors()) { + System.out.println(error.getField() + ":" + error.getDefaultMessage()); + } + } + } +}