[原创]SpringBoot的自动配置原理与自定义SpringBootStarter

本文涉及的产品
云数据库 Tair(兼容Redis),内存型 2GB
Redis 开源版,标准版 2GB
推荐场景:
搭建游戏排行榜
简介: [原创]SpringBoot的自动配置原理与自定义SpringBootStarter

以SpringBootAdmin的实现方式作为参考


# 实现的效果:



  • 添加相关的依赖,再在启动类上加上@EnableXXX就可以使用相关的功能了。


# 原理-SpringBootAdmin为例



  • 在启动类上标记注解@EnableAdminServer

@EnableAdminServer
@SpringBootApplication
public class AdminApplication {
    public static void main(String[] args) {
        SpringApplication.run(AdminApplication.class, args);
    }
}


  • 点进去发现只是导入了一个类AdminServerMarkerConfiguration.class

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import(AdminServerMarkerConfiguration.class)
public @interface EnableAdminServer {
}


  • 点进这个类AdminServerMarkerConfiguration发现只是向容器中添加了一个bean Marker

public class AdminServerMarkerConfiguration {
    @Bean
    public Marker adminServerMarker() {
        return new Marker();
    }
    public static class Marker {
    }
}



  • 所以这一部分的总结就是:添加@EnableAdminServer注解,向容器中添加一个类型为 Marker的bean


  • 接下来找到AdminServerAutoConfiguration这个类,一般默认SpringBoot的自动配置类都是以XXXAutoConfiguration命名,所以很容易找到,例如RedisAutoConfiguration...

@Configuration
@ConditionalOnBean(AdminServerMarkerConfiguration.Marker.class)
@EnableConfigurationProperties(AdminServerProperties.class)
@Import({AdminServerWebConfiguration.class})
public class AdminServerAutoConfiguration {
 @Bean
    @ConditionalOnMissingBean
    public InstanceRegistry instanceRegistry(InstanceRepository instanceRepository,
                                             InstanceIdGenerator instanceIdGenerator) {
        return new InstanceRegistry(instanceRepository, instanceIdGenerator);
    }
    @Bean
    @ConditionalOnMissingBean
    public InstanceIdGenerator instanceIdGenerator() {
        return new HashingInstanceUrlIdGenerator();
    }
......
}


  • 解读这个类的注解可发现以下几点:
  1. @Configuration  这是一个配置类,可以看到这个类里面通过@Bean定义了很多bean
  2. @ConditionalOnBean(AdminServerMarkerConfiguration.Marker.class) [重点],判断容器中有这个bean,这就是上一部分,在启动类上添加@EnableAdminServer的作用,当容器中有Marker这个bean时,这个Configuration才生效,才会向容器中添加这个类中定义的bean
  3. @EnableConfigurationProperties(AdminServerProperties.class) 启动配置类AdminServerProperties,将配置类与配置文件绑定
@ConfigurationProperties("spring.boot.admin")
      public class AdminServerProperties {
        ...
      }
  1. @Import({AdminServerWebConfiguration.class}) 导入另外一个配置类,向容器中添加其他bean


接下来的问题是:如何让Spring在启动的时候扫面到这个配置类呢,通过分析@EnableAutoConfiguration注解的实现可得知:将需要自动配置的类的全路径配置在META-INF/spring.factories,Spring会在启动的时候扫描类路径下所有的META-INF/spring.factories文件

  • 如SpringBootAdmin的配置:

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  de.codecentric.boot.admin.server.config.AdminServerAutoConfiguration,\
  de.codecentric.boot.admin.server.config.AdminServerNotifierAutoConfiguration,\
  de.codecentric.boot.admin.server.config.AdminServerHazelcastAutoConfiguration,\
  de.codecentric.boot.admin.se  rver.config.AdminServerCloudFoundryAutoConfiguration


image.png

# 另外一个例子:  项目中Redis的自动配置



  • SpringBoot项目中使用Redis更加简单,添加Redis依赖即可使用

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


SpringBoot是如何实现添加了redis依赖就可以使用Redis,RedisTemplate的呢?

原理:
  • 永远第一步:找到Redis的自动配置类RedisAutoConfiguration

@Configuration
@ConditionalOnClass(RedisOperations.class)
@EnableConfigurationProperties(RedisProperties.class)
@Import({ LettuceConnectionConfiguration.class, JedisConnectionConfiguration.class })
public class RedisAutoConfiguration {
    @Bean
    @ConditionalOnMissingBean(name = "redisTemplate")
    public RedisTemplate<Object, Object> redisTemplate(
            RedisConnectionFactory redisConnectionFactory) throws UnknownHostException {
        RedisTemplate<Object, Object> template = new RedisTemplate<>();
        template.setConnectionFactory(redisConnectionFactory);
        return template;
    }
    @Bean
    @ConditionalOnMissingBean
    public StringRedisTemplate stringRedisTemplate(
            RedisConnectionFactory redisConnectionFactory) throws UnknownHostException {
        StringRedisTemplate template = new StringRedisTemplate();
        template.setConnectionFactory(redisConnectionFactory);
        return template;
    }
}


  • @Configuration
  • @ConditionalOnClass(RedisOperations.class)    当类路径下有RedisOperations这个类时,那么很明显,这个类肯定是在添加redis依赖的时候导进来的,现在看一下这个类的路径。


image.png

  • 确实是通过redis的起步依赖导进来的,这就是为什么添加了redis的起步依赖,redis就可以直接使用了
  • @EnableConfigurationProperties(RedisProperties.class)  激活配置类RedisProperties

@ConfigurationProperties(prefix = "spring.redis")
public class RedisProperties {
/**
     * Database index used by the connection factory.
     */
    private int database = 0;
    /**
     * Connection URL. Overrides host, port, and password. User is ignored. Example:
     * redis://user:password@example.com:6379
     */
    private String url;
    /**
     * Redis server host.
     */
    private String host = "localhost";
    /**
     * Login password of the redis server.
     */
    private String password;
    /**
     * Redis server port.
     */
    private int port = 6379;
        ......
  }
  • @Import({ LettuceConnectionConfiguration.class, JedisConnectionConfiguration.class }) 导入LettuceConnectionConfigurationJedisConnectionConfiguration,这两个都是redis的客户端。
    那么启用哪一个呢
  • LettuceConnectionConfiguration

@Configuration
@ConditionalOnClass(RedisClient.class)
class LettuceConnectionConfiguration extends RedisConnectionConfiguration {}
  • JedisConnectionConfiguration

@Configuration
@ConditionalOnClass({ GenericObjectPool.class, JedisConnection.class, Jedis.class })
class JedisConnectionConfiguration extends RedisConnectionConfiguration {}
  • 可以看到当类路径下有响应的客户端时,就启用相应的自动配置类


image.png


而SpringBoot默认使用的是lettuce

image.png

相关实践学习
基于Redis实现在线游戏积分排行榜
本场景将介绍如何基于Redis数据库实现在线游戏中的游戏玩家积分排行榜功能。
云数据库 Redis 版使用教程
云数据库Redis版是兼容Redis协议标准的、提供持久化的内存数据库服务,基于高可靠双机热备架构及可无缝扩展的集群架构,满足高读写性能场景及容量需弹性变配的业务需求。 产品详情:https://www.aliyun.com/product/kvstore &nbsp; &nbsp; ------------------------------------------------------------------------- 阿里云数据库体验:数据库上云实战 开发者云会免费提供一台带自建MySQL的源数据库&nbsp;ECS 实例和一台目标数据库&nbsp;RDS实例。跟着指引,您可以一步步实现将ECS自建数据库迁移到目标数据库RDS。 点击下方链接,领取免费ECS&amp;RDS资源,30分钟完成数据库上云实战!https://developer.aliyun.com/adc/scenario/51eefbd1894e42f6bb9acacadd3f9121?spm=a2c6h.13788135.J_3257954370.9.4ba85f24utseFl
目录
打赏
0
0
0
0
0
分享
相关文章
编写SpringBoot的自定义starter包
通过本文的介绍,我们详细讲解了如何创建一个Spring Boot自定义Starter包,包括自动配置类、配置属性类、`spring.factories`文件的创建和配置。通过自定义Starter,可以有效地复用公共配置和组件,提高开发效率。希望本文能帮助您更好地理解和应用Spring Boot自定义Starter,在实际项目中灵活使用这一强大的功能。
37 17
springboot自动配置原理
Spring Boot 自动配置原理:通过 `@EnableAutoConfiguration` 开启自动配置,扫描 `META-INF/spring.factories` 下的配置类,省去手动编写配置文件。使用 `@ConditionalXXX` 注解判断配置类是否生效,导入对应的 starter 后自动配置生效。通过 `@EnableConfigurationProperties` 加载配置属性,默认值与配置文件中的值结合使用。总结来说,Spring Boot 通过这些机制简化了开发配置流程,提升了开发效率。
63 17
springboot自动配置原理
SpringBoot自动配置及自定义Starter
Java程序员依赖Spring框架简化开发,但复杂的配置文件增加了负担。SpringBoot以“约定大于配置”理念简化了这一过程,通过引入各种Starter并加载默认配置,几乎做到开箱即用。
120 10
SpringBoot自动配置及自定义Starter
最新版 | 深入剖析SpringBoot3源码——分析自动装配原理(面试常考)
自动装配是现在面试中常考的一道面试题。本文基于最新的 SpringBoot 3.3.3 版本的源码来分析自动装配的原理,并在文未说明了SpringBoot2和SpringBoot3的自动装配源码中区别,以及面试回答的拿分核心话术。
最新版 | 深入剖析SpringBoot3源码——分析自动装配原理(面试常考)
SpringBoot配置跨模块扫描问题解决方案
在分布式项目中,使用Maven进行多模块开发时,某些模块(如xxx-common)没有启动类。如何将这些模块中的类注册为Spring管理的Bean对象?本文通过案例分析,介绍了两种解决方案:常规方案是通过`@SpringBootApplication(scanBasePackages)`指定扫描路径;推荐方案是保持各模块包结构一致(如com.xxx),利用SpringBoot默认扫描规则自动识别其他模块中的组件,简化配置。
SpringBoot配置跨模块扫描问题解决方案
Spring Boot 自动配置机制:从原理到自定义
Spring Boot 的自动配置机制通过 `spring.factories` 文件和 `@EnableAutoConfiguration` 注解,根据类路径中的依赖和条件注解自动配置所需的 Bean,大大简化了开发过程。本文深入探讨了自动配置的原理、条件化配置、自定义自动配置以及实际应用案例,帮助开发者更好地理解和利用这一强大特性。
155 14
|
3月前
|
SpringBoot入门(7)- 配置热部署devtools工具
SpringBoot入门(7)- 配置热部署devtools工具
156 1
SpringBoot入门(7)- 配置热部署devtools工具
springboot自动配置原理
启动类@SpringbootApplication注解下,有三个关键注解 (1)@springbootConfiguration:表示启动类是一个自动配置类 (2)@CompontScan:扫描启动类所在包外的组件到容器中 (3)@EnableConfigutarion:最关键的一个注解,他拥有两个子注解,其中@AutoConfigurationpackageu会将启动类所在包下的所有组件到容器中,@Import会导入一个自动配置文件选择器,他会去加载META_INF目录下的spring.factories文件,这个文件中存放很大自动配置类的全类名,这些类会根据元注解的装配条件生效,生效
springboot中路径默认配置与重定向/转发所存在的域对象
Spring Boot 提供了简便的路径默认配置和强大的重定向/转发机制,通过合理使用这些功能,可以实现灵活的请求处理和数据传递。理解并掌握不同域对象的生命周期和使用场景,是构建高效、健壮 Web 应用的关键。通过上述详细介绍和示例,相信读者能够更好地应用这些知识,优化自己的 Spring Boot 应用。
80 3
如何将Spring Boot应用程序运行到自定义端口
如何将Spring Boot应用程序运行到自定义端口
116 0
AI助理

你好,我是AI助理

可以解答问题、推荐解决方案等