spring boot EnableConfigurationProperties ConfigurationProperties 怎么配合使用的

2024-04-24 20:58
文章标签 java 使用 怎么 spring boot 配合 configurationproperties enableconfigurationproperties

本文主要是介绍spring boot EnableConfigurationProperties ConfigurationProperties 怎么配合使用的，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

  1. 先看我的demo实现
第一步： 配置ConfigurationProperties属性
@ConfigurationProperties(prefix = "redis.proxy")
@Getter
@Setter
public class RedisProperties {/** 服务器列表*/private List<String> configServerList;/** 可选配置，Redis运行模式，默认值singleton模式，枚举值Singleton,Sentinel,Sharded，从1.1.8-snapshot开始支持*/private RedisCacheMode mode;/** 可选配置（仅当模式为Sentinel时需要配置），表示master的名称*/private String masterName;private String password;
}
第二步： 配置bean
@Configuration
@EnableConfigurationProperties({RedisProperties.class})
public class RedisConfig {这里注意要将RedisProperties 作为入参传进来，并将属性set进行@Bean(initMethod = "init")@ConditionalOnMissingBeanpublic RedisCacheManager redisCacheManager(RedisProperties redisProperties){RedisCacheManager redisCacheManager = new RedisCacheManager();redisCacheManager.setConfigServerList(redisProperties.getConfigServerList());redisCacheManager.setMasterName(redisProperties.getMasterName());redisCacheManager.setMode(redisProperties.getMode());redisCacheManager.setPassword(redisProperties.getPassword());return redisCacheManager;}
  1. 源码分析
    先看@EnableConfigurationProperties源码
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
这里导入了EnableConfigurationPropertiesImportSelector
@Import(EnableConfigurationPropertiesImportSelector.class)  
public @interface EnableConfigurationProperties {/*** Convenient way to quickly register {@link ConfigurationProperties} annotated beans* with Spring. Standard Spring Beans will also be scanned regardless of this value.* @return {@link ConfigurationProperties} annotated beans to register*/Class<?>[] value() default {};}

再看EnableConfigurationPropertiesImportSelector ，关于EnableConfigurationPropertiesImportSelector 是怎么被调用到的，请查看我的博客 https://blog.csdn.net/tszxlzc/article/details/88113819 （可以跳到博客最下面查看时序图了解全流程）

class EnableConfigurationPropertiesImportSelector implements ImportSelector {//下面的selectImports方法返回的类private static final String[] IMPORTS = {ConfigurationPropertiesBeanRegistrar.class.getName(),ConfigurationPropertiesBindingPostProcessorRegistrar.class.getName() };// selectImports方法会在org.springframework.context.annotation.ConfigurationClassParser#processImports方法里被调用@Overridepublic String[] selectImports(AnnotationMetadata metadata) {return IMPORTS;}

下图是通过debug查看org.springframework.context.annotation.ConfigurationClassParser#processImports方法调用EnableConfigurationPropertiesImportSelector 选择器的返回结果，正好是org.springframework.boot.context.properties.EnableConfigurationPropertiesImportSelector#IMPORTS数组中的类
在这里插入图片描述
说说这两个类吧
ConfigurationPropertiesBeanRegistrar 和ConfigurationPropertiesBindingPostProcessorRegistrar这两个类 是处理
@ EnableConfigurationProperties和 @ConfigurationProperties注解的
ConfigurationPropertiesBeanRegistrar类核心源码如下
registerBeanDefinitions方法会在
org.springframework.context.annotation.ConfigurationClassBeanDefinitionReader#loadBeanDefinitionsFromRegistrars方法中调用，而loadBeanDefinitionsFromRegistrars方法又会在org.springframework.context.annotation.ConfigurationClassBeanDefinitionReader#loadBeanDefinitionsForConfigurationClass方法中调用，loadBeanDefinitionsForConfigurationClass方法又会在org.springframework.context.annotation.ConfigurationClassBeanDefinitionReader#loadBeanDefinitions方法中被调用，loadBeanDefinitions方法又会在org.springframework.context.annotation.ConfigurationClassPostProcessor#processConfigBeanDefinitions方法中调用，processConfigBeanDefinitions方法又会在org.springframework.context.annotation.ConfigurationClassPostProcessor#postProcessBeanDefinitionRegistry方法中调用，
最后就倒退到了ConfigurationClassPostProcessor 这个bean后处理器（配置的入口）
ConfigurationClassPostProcessor 是怎么调到loadBeanDefinitions方法的看时序图，是在配置解析之后
在这里插入图片描述

public static class ConfigurationPropertiesBeanRegistrarimplements ImportBeanDefinitionRegistrar {//注册bean定义（ConfigurationProperties注解的bean）@Overridepublic void registerBeanDefinitions(AnnotationMetadata metadata,BeanDefinitionRegistry registry) {getTypes(metadata).forEach((type) -> register(registry,(ConfigurableListableBeanFactory) registry, type));}// 获取EnableConfigurationProperties注解的属性值，即ConfigurationProperties注解配置的属性文件private List<Class<?>> getTypes(AnnotationMetadata metadata) {MultiValueMap<String, Object> attributes = metadata.getAllAnnotationAttributes(EnableConfigurationProperties.class.getName(), false);return collectClasses((attributes != null) ? attributes.get("value"): Collections.emptyList());}private List<Class<?>> collectClasses(List<?> values) {return values.stream().flatMap((value) -> Arrays.stream((Object[]) value)).map((o) -> (Class<?>) o).filter((type) -> void.class != type).collect(Collectors.toList());}//  将ConfigurationProperties注解的属性文件注册到容器中private void register(BeanDefinitionRegistry registry,ConfigurableListableBeanFactory beanFactory, Class<?> type) {String name = getName(type);if (!containsBeanDefinition(beanFactory, name)) {registerBeanDefinition(registry, name, type);}}private String getName(Class<?> type) {ConfigurationProperties annotation = AnnotationUtils.findAnnotation(type,ConfigurationProperties.class);String prefix = (annotation != null) ? annotation.prefix() : "";return (StringUtils.hasText(prefix) ? prefix + "-" + type.getName(): type.getName());}private boolean containsBeanDefinition(ConfigurableListableBeanFactory beanFactory, String name) {if (beanFactory.containsBeanDefinition(name)) {return true;}BeanFactory parent = beanFactory.getParentBeanFactory();if (parent instanceof ConfigurableListableBeanFactory) {return containsBeanDefinition((ConfigurableListableBeanFactory) parent,name);}return false;}private void registerBeanDefinition(BeanDefinitionRegistry registry, String name,Class<?> type) {assertHasAnnotation(type);GenericBeanDefinition definition = new GenericBeanDefinition();definition.setBeanClass(type);registry.registerBeanDefinition(name, definition);}private void assertHasAnnotation(Class<?> type) {Assert.notNull(AnnotationUtils.findAnnotation(type, ConfigurationProperties.class),() -> "No " + ConfigurationProperties.class.getSimpleName()+ " annotation found on  '" + type.getName() + "'.");}}

总结： 通过以上解析注册后，被ConfigurationProperties注册的属性bean最终被注册到spring容器中，属性bean就可以在被EnableConfigurationProperties注册的bean或者被@bean配置的bean实例化时被依赖注入（set注入或构造方法注入），其实最终发现EnableConfigurationProperties ConfigurationProperties都是配置了一个bean被使用，spring可真是面向bean编程啊

这篇关于spring boot EnableConfigurationProperties ConfigurationProperties 怎么配合使用的的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/932830。

相关文章

JVM 的类初始化机制

JVM 的类初始化机制

前言 当你在 Java 程序中new对象时，有没有考虑过 JVM 是如何把静态的字节码（byte code）转化为运行时对象的呢，这个问题看似简单，但清楚的同学相信也不会太多，这篇文章首先介绍 JVM 类初始化的机制，然后给出几个易出错的实例来分析，帮助大家更好理解这个知识点。 JVM 将字节码转化为运行时对象分为三个阶段，分别是：loading 、Linking、initialization
阅读更多...
Spring Security 基于表达式的权限控制

Spring Security 基于表达式的权限控制

前言 spring security 3.0已经可以使用spring el表达式来控制授权，允许在表达式中使用复杂的布尔逻辑来控制访问的权限。 常见的表达式 Spring Security可用表达式对象的基类是SecurityExpressionRoot。 表达式描述hasRole([role])用户拥有制定的角色时返回true （Spring security默认会带有ROLE_前缀）,去
阅读更多...
浅析Spring Security认证过程

浅析Spring Security认证过程

类图 为了方便理解Spring Security认证流程，特意画了如下的类图，包含相关的核心认证类 概述 核心验证器 AuthenticationManager 该对象提供了认证方法的入口，接收一个Authentiaton对象作为参数; public interface AuthenticationManager {Authentication authenticate(Authenti
阅读更多...
Spring Security--Architecture Overview

Spring Security--Architecture Overview

1 核心组件 这一节主要介绍一些在Spring Security中常见且核心的Java类，它们之间的依赖，构建起了整个框架。想要理解整个架构，最起码得对这些类眼熟。 1.1 SecurityContextHolder SecurityContextHolder用于存储安全上下文（security context）的信息。当前操作的用户是谁，该用户是否已经被认证，他拥有哪些角色权限…这些都被保
阅读更多...
Spring Security基于数据库验证流程详解

Spring Security基于数据库验证流程详解

Spring Security 校验流程图 相关解释说明（认真看哦） AbstractAuthenticationProcessingFilter 抽象类 /*** 调用 #requiresAuthentication(HttpServletRequest, HttpServletResponse) 决定是否需要进行验证操作。* 如果需要验证，则会调用 #attemptAuthentica
阅读更多...
Spring Security 从入门到进阶系列教程

Spring Security 从入门到进阶系列教程

Spring Security 入门系列 《保护 Web 应用的安全》 《Spring-Security-入门（一）：登录与退出》 《Spring-Security-入门（二）：基于数据库验证》 《Spring-Security-入门（三）：密码加密》 《Spring-Security-入门（四）：自定义-Filter》 《Spring-Security-入门（五）：在 Sprin
阅读更多...
Java架构师知识体认识

Java架构师知识体认识

源码分析 常用设计模式 Proxy代理模式Factory工厂模式Singleton单例模式Delegate委派模式Strategy策略模式Prototype原型模式Template模板模式 Spring5 beans 接口实例化代理Bean操作 Context Ioc容器设计原理及高级特性Aop设计原理Factorybean与Beanfactory Transaction 声明式事物
阅读更多...
AI绘图怎么变现？想做点副业的小白必看！

AI绘图怎么变现？想做点副业的小白必看！

在科技飞速发展的今天，AI绘图作为一种新兴技术，不仅改变了艺术创作的方式，也为创作者提供了多种变现途径。本文将详细探讨几种常见的AI绘图变现方式，帮助创作者更好地利用这一技术实现经济收益。 更多实操教程和AI绘画工具，可以扫描下方，免费获取 定制服务：个性化的创意商机 个性化定制 AI绘图技术能够根据用户需求生成个性化的头像、壁纸、插画等作品。例如，姓氏头像在电商平台上非常受欢迎，
阅读更多...
W外链微信推广短连接怎么做？

W外链微信推广短连接怎么做？

制作微信推广链接的难点分析 一、内容创作难度 制作微信推广链接时，首先需要创作有吸引力的内容。这不仅要求内容本身有趣、有价值，还要能够激起人们的分享欲望。对于许多企业和个人来说，尤其是那些缺乏创意和写作能力的人来说，这是制作微信推广链接的一大难点。 二、精准定位难度 微信用户群体庞大，不同用户的需求和兴趣各异。因此，制作推广链接时需要精准定位目标受众，以便更有效地吸引他们点击并分享链接
阅读更多...
中文分词jieba库的使用与实景应用（一）

中文分词jieba库的使用与实景应用（一）

知识星球：https://articles.zsxq.com/id_fxvgc803qmr2.html 目录 一.定义： 精确模式（默认模式）： 全模式： 搜索引擎模式： paddle 模式（基于深度学习的分词模式）： 二 自定义词典 三.文本解析   调整词出现的频率 四. 关键词提取 A. 基于TF-IDF算法的关键词提取 B. 基于TextRank算法的关键词提取
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2