spring-boot-start原理分析

本文详细解析了SpringBoot自定义Starter的过程,包括如何使用@EnableAutoConfiguration注解加载自动配置,通过@ConditionalOnXxx注解实现条件化Bean加载,以及如何在资源目录下注册配置文件。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

源码分析github地址原文链接

了解springboot的都知道启动类上经常又个@SpringBootApplication注解,这个注解点进去看下是包括一个自动配置很关键的注解,那就是@EnableAutoConfiguration注解。我们看下源码

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(EnableAutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
	String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";
	Class<?>[] exclude() default {};
	String[] excludeName() default {};
}

可以从源码看出关键功能是@import注解导入自动配置功能类AutoConfigurationImportSelector类,主要方法getCandidateConfigurations()使用了SpringFactoriesLoader.loadFactoryNames()方法加载META-INF/spring.factories的文件(spring.factories声明具体自动配置)。

protected List<String> getCandidateConfigurations(AnnotationMetadata metadata,
			AnnotationAttributes attributes) {
		List<String> configurations = SpringFactoriesLoader.loadFactoryNames(
				getSpringFactoriesLoaderFactoryClass(), getBeanClassLoader());
		Assert.notEmpty(configurations,
				"No auto configuration classes found in META-INF/spring.factories. If you "
						+ "are using a custom packaging, make sure that file is correct.");
		return configurations;
	}

starter常用的条件注解

@ConditionalOnBean 当容器里有指定的Bean的条件下。
@ConditionalOnClass 当类路径下有指定的类的条件下。
@ConditionalOnProperty 指定的属性是否有指定的值。

自定义starter

模拟公司获取密码的组件写一个demo-starter

依赖
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.yyl</groupId>
    <artifactId>password-spring-starter</artifactId>
    <version>1.0-SNAPSHOT</version>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.8.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>
</project>

服务类

package com.yyl.service;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.util.StringUtils;

/**
 * author:yangyuanliang Date:2019-10-15 Time:13:32
 **/
public class PasswordService {
    private String key;
    @Autowired
    //模拟的第三方系统service
    private ThirdPartyService thirdPartyService;
    public String getSystemPassword(String objectKey,String originalPassord){
        if(StringUtils.isEmpty(objectKey)){
            return  originalPassord;
        }
        //从第三方系统获取密码
        String password= thirdPartyService.getPassword(objectKey);
        //返回密码
        return password!=null?password:originalPassord;
    }
}
public class ThirdPartyService {
    public String getPassword(String objectKey){
        //返回一个32位随机数
        return UUID.randomUUID().toString();
    }
}

属性配置类

package com.yyl.properties;

import org.springframework.boot.context.properties.ConfigurationProperties;

/**
 * author:yangyuanliang Date:2019-10-15 Time:13:34
 **/
@ConfigurationProperties(prefix = "spring.starter.password")
public class BaseServiceProperties {
    private String serviceName;
    private String serviceVersion;

    public String getServiceName() {
        return serviceName;
    }

    public void setServiceName(String serviceName) {
        this.serviceName = serviceName;
    }

    public String getServiceVersion() {
        return serviceVersion;
    }

    public void setServiceVersion(String serviceVersion) {
        this.serviceVersion = serviceVersion;
    }
}

配置使用类

public class BaseStarterService {

    public void addServiceName(BaseServiceProperties baseServiceProperties){
        System.out.println("serviceName:"+baseServiceProperties.getServiceName()+"----"+"serviceVersion"+baseServiceProperties.getServiceVersion());
    }
}

自动配置类

@Configuration
//自动加载配置文件属性值
@EnableConfigurationProperties(BaseServiceProperties.class)
@Import(BeanConfiguration.class)
//判断当前环境是否为windows
@Conditional(MacCondition.class)
//判断属性spring.project.ThirdPartySystemService.isPassword是否等于true
@ConditionalOnProperty(prefix = "spring.project.ThirdPartySystemService",value = "enablePassword", havingValue = "true",matchIfMissing = true)
public class AutoConfigurationPassoword {
    @Autowired
    private BaseServiceProperties baseServiceProperties;
    @Autowired
    private BaseStarterService baseWindowsService;

    //加载第三方系统service
    @Bean("thirdPartySystemService")
    public ThirdPartyService thirdPartySystemService(){
        baseWindowsService.addServiceName(baseServiceProperties);
        return new ThirdPartyService();
    }
    @Bean
    //判断IOC容器中是否存在ThirdPartySystemService类,存在则创建PasswordService bean
    @ConditionalOnClass(ThirdPartyService.class)
    public PasswordService passwordService(){
        baseWindowsService.addServiceName(baseServiceProperties);
        return new PasswordService();
    }
}

条件类

package com.yyl.condition;

import com.yyl.service.BaseStarterService;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.beans.factory.support.RootBeanDefinition;
import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.env.Environment;
import org.springframework.core.type.AnnotatedTypeMetadata;

/**
 * author:yangyuanliang Date:2019-10-15 Time:13:37
 **/
public class MacCondition implements Condition {
    private final static String WINDOWS="Windows";
    @Override
    public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
        //获取当前环境变量
        Environment environment=conditionContext.getEnvironment();
        //获取bean注册器
        BeanDefinitionRegistry registry = conditionContext.getRegistry();
        //能获取到ioc使用的beanfactory
        ConfigurableListableBeanFactory beanFactory = conditionContext.getBeanFactory();
        //获取环境变量中操作系统
        String property = environment.getProperty("os.name");
        //判断操作系统是否为windows
        if(!property.contains(WINDOWS)){
            //判断是否存在baseWindowsSevice类,不存在则进行bean注册
            boolean isWindowsSevice = registry.containsBeanDefinition("baseStarterService");
            if(!isWindowsSevice){
                //指定Bean定义信息;(Bean的类型,Bean的一系列信息)
                RootBeanDefinition beanDefinition = new RootBeanDefinition(BaseStarterService.class);
                //注册一个Bean,指定bean名
                registry.registerBeanDefinition("baseStarterService", beanDefinition);
                BaseStarterService windowsSevice = (BaseStarterService)beanFactory.getBean("baseStarterService");
            }
            return true;
        }
        return false;
    }
}

注册配置

在resource下新建META-INF文件夹新建spring.factories文件

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.yyl.autoconf.AutoConfigurationPassoword

完成并测试

 <dependencies>
        <dependency>
				 <groupId>com.yyl</groupId>
			    <artifactId>password-spring-starter</artifactId>
			    <version>1.0-SNAPSHOT</version>
     </dependency>
    </dependencies>

application.properties属性

spring.starter.password.serviceName=aaa
spring.starter.password.serviceVersion=1
spring.project.ThirdPartyService.enablePassword=true

总结

  • SpringBoot启动时会自动搜索包含spring.factories文件的JAR包;
  • 根据spring.factories文件加载自动配置类AutoConfiguration;
  • 通过AutoConfiguration类,加载满足条件(@ConditionalOnXxx)的bean到Spring IOC容器中;
  • 使用者可以直接使用自动加载到IOC的bean。
<think>首先,用户的问题是关于Spring Boot工程中引入mybatis-spring-boot-starter依赖失败的问题。我需要根据系统指令来构建回答。 系统指令的关键点: - 所有行内数学表达式使用$...$格式,但在这个上下文中,可能不涉及数学表达式,所以我可以忽略。 - 独立公式使用$$...$$,但同样,可能不需要。 - LaTeX语法正确:确保任何数学公式正确。 - 使用中文回答。 - 生成相关问题:在回答后添加相关问题。 - 回答中引用的段落末尾添加引用标识,如[^1]。 - 回答结构清晰,帮助用户逐步解决问题,保证真实可靠。 - 参考提供的站内引用:引用[1]和引用[2]。 提供的引用: - 引用[1]: 关于Spring Boot 2.3.0后不再包含Validation,引入spring-boot-starter-validation导致依赖冲突。 - 引用[2]: 关于mybatis-spring-boot-starter和mybatis-plus-boot-starter的区别,建议不要同时使用。 用户的问题:在Spring Boot工程中遇到无法找到或引入mybatis-spring-boot-starter依赖的问题,需要解决依赖引入失败的方案。 用户说:"我想在Spring Boot工程中遇到无法找到或引入mybatis-spring-boot-starter依赖的问题,需要解决依赖引入失败的方案",所以我需要提供解决方案。 我的回答结构: 1. **理解问题**:解释依赖引入失败的可能原因。 2. **逐步解决方案**:提供清晰的步骤来解决这个问题。 3. **引用相关部分**:根据引用[1]和[2],整合相关信息。 4. **生成相关问题**:在结尾添加相关问题。 可能的原因: - 依赖版本不兼容。 - Maven或Gradle配置错误。 - 依赖冲突,如引用[1]提到的Validation问题。 - 混淆了mybatis-spring-boot-starter和mybatis-plus-boot-starter,如引用[2]。 解决方案步骤: 1. **检查依赖声明**:确保在pom.xml(如果使用Maven)或build.gradle(如果使用Gradle)中正确声明了依赖。 - 例如,对于Maven: ```xml <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>最新版本</version> </dependency> ``` 2. **检查Spring Boot版本**:确保Spring Boot版本与mybatis-spring-boot-starter版本兼容。引用[1]提到Spring Boot 2.3.0后不再包含Validation,所以类似地,mybatis依赖可能有兼容性问题。 3. **解决依赖冲突**:使用Maven或Gradle工具检查依赖树,排除冲突的依赖。 - 例如,运行`mvn dependency:tree`查看冲突。 4. **避免同时使用mybatis-plus-boot-starter**:如引用[2]所说,mybatis-plus-boot-starter包含了mybatis的功能,所以不要同时引入两者。 5. **更新依赖**:确保使用最新稳定版本。 6. **清理和重新构建**:运行`mvn clean install`或Gradle的等效命令。 7. **IDE问题**:如果是IDE(如IntelliJ IDEA)中显示爆红,尝试重新导入项目或更新索引。 整合引用: - 在提到依赖冲突时,引用引用[1]。 - 在讨论mybatis-plus时,引用引用[2]。 生成相关问题: - 类似于示例,添加3个相关问题。 最终回答结构: 1. 介绍问题。 2. 提供步骤。 3. 结尾添加相关问题。 使用中文回答。</think>### Spring Boot 工程中引入 mybatis-spring-boot-starter 依赖失败的解决方案 在 Spring Boot 工程中,引入 `mybatis-spring-boot-starter` 依赖失败是常见问题,通常由依赖版本不兼容、配置错误或依赖冲突引起。以下我将逐步提供解决方案,确保您能顺利集成依赖。解决方案基于 Maven 构建工具(如使用 Gradle,原理类似),并参考了相关站内引用信息。请按顺序操作,以高效解决问题。 #### 步骤 1: 检查并修正依赖声明 首先,确保在 `pom.xml` 文件中正确声明了 `mybatis-spring-boot-starter` 依赖。常见的错误包括拼写错误、版本缺失或版本不兼容。Spring Boot 版本与 MyBatis 版本必须匹配。参考最佳实践: - **正确声明示例**(Maven): ```xml <dependencies> <!-- Spring Boot Starter Web 依赖(确保已存在) --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <version>3.1.0</version> <!-- 替换为您的 Spring Boot 版本 --> </dependency> <!-- MyBatis Spring Boot Starter 依赖 --> <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>3.0.3</version> <!-- 推荐使用最新兼容版本 --> </dependency> </dependencies> ``` - **关键点**: - 确认 `groupId` 和 `artifactId` 正确:`org.mybatis.spring.boot:mybatis-spring-boot-starter`。 - 版本兼容性:Spring Boot 3.x 建议使用 MyBatis Starter 3.x 版本;Spring Boot 2.x 使用 2.x 版本。访问 [MyBatis 官方仓库](https://mvnrepository.com/artifact/org.mybatis.spring.boot/mybatis-spring-boot-starter) 查询最新版本。 - 如果您的工程同时引入了 `mybatis-plus-boot-starter`,请移除它。因为 `mybatis-plus-boot-starter` 已包含 MyBatis 核心功能,同时引入会导致冲突和依赖解析失败[^2]。 #### 步骤 2: 解决依赖冲突 依赖冲突是失败的主要原因,例如其他依赖(如 Validation)与 MyBatis 冲突。使用 Maven 依赖树分析工具: - **运行命令**: ```bash mvn dependency:tree ``` 这会输出依赖树,查找冲突(例如多个版本的 Spring 或 MyBatis)。 - **常见冲突场景与解决方案**: - **Validation 冲突**:Spring Boot 2.3.0 后不再内建 Validation 支持,引入 `spring-boot-starter-validation` 可能导致其他依赖(如 Lombok 或 MyBatis)注解爆红[^1]。解决: - 排除冲突依赖:在 `pom.xml` 中添加 `exclusions`。 ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId> <version>3.1.0</version> <exclusions> <exclusion> <groupId>org.hibernate.validator</groupId> <artifactId>hibernate-validator</artifactId> </exclusion> </exclusions> </dependency> ``` - 或升级所有依赖到兼容版本。 - **MyBatis 与 MyBatis-Plus 冲突**:确保只引入一个。如引用[2]所述,`mybatis-plus-boot-starter` 已包含 `mybatis-spring-boot-starter` 的功能,同时使用会冗余加载,导致失败[^2]。移除 `mybatis-spring-boot-starter` 或 `mybatis-plus-boot-starter` 中的一个。 #### 步骤 3: 清理和重新构建工程 依赖解析失败可能是缓存问题。执行清理操作: - **Maven 命令**: ```bash mvn clean install -U ``` `-U` 参数强制更新依赖。 - **IDE 操作**(如 IntelliJ IDEA): - 右键点击项目 > Maven > Reimport。 - 或 File > Invalidate Caches / Restart。 #### 步骤 4: 验证和测试 - **验证依赖**:确保 Maven 本地仓库(`~/.m2/repository`)中存在 `mybatis-spring-boot-starter` JAR 文件。 - **简单测试**:创建一个 MyBatis Mapper 接口和 XML 文件,运行 Spring Boot 应用检查是否启动正常。 ```java @Mapper public interface UserMapper { @Select("SELECT * FROM users") List<User> findAll(); } ``` 如果应用启动失败,检查日志中的 `ClassNotFoundException` 或 `NoSuchBeanDefinitionException`,针对性地解决。 #### 预防措施 - **使用 BOM 管理版本**:在 `pom.xml` 中添加 Spring Boot 的 dependencyManagement 确保版本一致。 ```xml <dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-dependencies</artifactId> <version>3.1.0</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement> ``` - **定期更新依赖**:避免使用过时版本,参考 [Spring Initializr](https://start.spring.io/) 生成兼容配置。 如果以上步骤无效,请提供更多细节(如错误日志、`pom.xml` 内容),我会进一步分析
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值