Springboot 04 starter

如果创建新的 Springboot 项目,目录结构类似于下图。

目录规范来自构建工具 maven/gradle,而不是 Spring 框架。

图片来自《Springboot 实战第 4 版》

@SpringBootApplication 注解的类是应用程序启动类,实现两个功能:自动配置,启动引导。

@SpringBootApplication 注解由以下三个注解组成。

@EnableAutoConfiguration:启动自动配置。

@ComponentScan:启动组件扫描。

@SpringBootConfiguration:表示是配置类。

main 方法启动程序。

java 复制代码
@SpringBootApplication
public class MyApplication {
    public static void main(String[] args) {
       SpringApplication.run(MyApplication.class, args);
    }
}

起步依赖

Springboot starter 定义好组件和配置文件。用户引用依赖即可使用功能,无需管理依赖,无需担心版本,无需配置参数。比如 spring-boot-starter-web 依赖可以让用户快速搭建 web 服务。

xml 复制代码
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

spring-boot-starter-web 依赖包含 spring-boot-starter,spring-boot-starter 依赖 spring-boot-autoconfigure。正是 spring-boot-autoconfigure 实现自动配置。

spring-boot-autoconfigure

META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件中定义 Springboot 提供的自动配置类。文件每一行是一个自动配置类,类名后缀均是 AutoConfiguration。Springboot 程序启动时会尝试自动加载所有配置类 bean。

org.springframework.boot.autoconfigure.web.servlet.DispatcherServletAutoConfiguration自动配置类向 IOC 容器注册名为 dispatcherServlet 的 bean。

java 复制代码
package org.springframework.boot.autoconfigure.web.servlet;
@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE) // 最高优先级
@AutoConfiguration(after = ServletWebServerFactoryAutoConfiguration.class) // 在 ServletWebServerFactoryAutoConfiguration 之后执行,确保环境就绪
@ConditionalOnWebApplication(type = Type.SERVLET) // 仅在应用是 servlet web 应用生效
@ConditionalOnClass(DispatcherServlet.class) // 要求 JVM 能够加载 DispatcherServlet 类,向容器注册 bean
public class DispatcherServletAutoConfiguration {
	@Configuration(proxyBeanMethods = false) // 配置类
	@Conditional(DefaultDispatcherServletCondition.class) // 确保不存在其他 dispatcherServlet 实例,避免重复注册
	@ConditionalOnClass(ServletRegistration.class) // 要求 JVM 能够加载 ServletRegistration 类,向容器注册 bean
	@EnableConfigurationProperties(WebMvcProperties.class) // 启动配置属性绑定,将配置文件中 spring.mvc 前缀的属性注入到 webMvcProperties 对象
	protected static class DispatcherServletConfiguration {
		@Bean(name = DEFAULT_DISPATCHER_SERVLET_BEAN_NAME)
		public DispatcherServlet dispatcherServlet(WebMvcProperties webMvcProperties) {
			DispatcherServlet dispatcherServlet = new DispatcherServlet();
			dispatcherServlet.setDispatchOptionsRequest(webMvcProperties.isDispatchOptionsRequest());
			dispatcherServlet.setDispatchTraceRequest(webMvcProperties.isDispatchTraceRequest());
			configureThrowExceptionIfNoHandlerFound(webMvcProperties, dispatcherServlet);
			dispatcherServlet.setPublishEvents(webMvcProperties.isPublishRequestHandledEvents());
			dispatcherServlet.setEnableLoggingRequestDetails(webMvcProperties.isLogRequestDetails());
			return dispatcherServlet;
		}
}

三方包 starter

mybatis-plus-boot-starter分享三方包 starter。starter 引入Springboot 的 spring-boot-autoconfigure 和 自己定义的 mybatis-plus-spring-boot-autoconfigure。

xml 复制代码
    <dependency>
      <groupId>com.baomidou</groupId>
      <artifactId>mybatis-plus-spring-boot-autoconfigure</artifactId>
      <version>3.5.4.1</version>
      <scope>compile</scope>
    </dependency>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-autoconfigure</artifactId>
      <scope>compile</scope>
    </dependency>

在 mybatis-plus-spring-boot-autoconfigure 包的META-INF\spring\org.springframework.boot.autoconfigure.AutoConfiguration.imports定义自动配置类。

复制代码
com.baomidou.mybatisplus.autoconfigure.MybatisPlusInnerInterceptorAutoConfiguration
com.baomidou.mybatisplus.autoconfigure.IdentifierGeneratorAutoConfiguration
com.baomidou.mybatisplus.autoconfigure.MybatisPlusLanguageDriverAutoConfiguration
com.baomidou.mybatisplus.autoconfigure.MybatisPlusAutoConfiguration

源码仓库。自动配置类向 IOC 容器注册名为 sqlSessionFactory 的 bean。

java 复制代码
@SuppressWarnings("ConstantConditions")
@org.springframework.context.annotation.Configuration // 配置类
@ConditionalOnClass({SqlSessionFactory.class, MybatisSqlSessionFactoryBean.class}) // 要求 JVM 能够加载 SqlSessionFactory MybatisSqlSessionFactoryBean 类
@ConditionalOnBean(DataSource.class) // 要求 IOC 容器包含 DataSource 类型的 bean
@EnableConfigurationProperties(MybatisPlusProperties.class) // 启动配置属性绑定,将配置文件中 mybatis-plus 前缀的属性注入到 MybatisPlusProperties 对象
@AutoConfigureAfter(DataSourceAutoConfiguration.class) // 在 DataSourceAutoConfiguration 之后执行,确保环境就绪
public class MybatisPlusAutoConfiguration {

    @Bean
    @ConditionalOnMissingBean
    public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {
        MybatisSqlSessionFactoryBean factory = new MybatisSqlSessionFactoryBean();
        factory.setDataSource(dataSource);
        factory.setVfs(SpringBootVFS.class);
        if (StringUtils.hasText(this.properties.getConfigLocation())) {
            factory.setConfigLocation(this.resourceLoader.getResource(this.properties.getConfigLocation()));
        }
        GlobalConfiguration globalConfig;
        if (!ObjectUtils.isEmpty(this.properties.getGlobalConfig())) {
            globalConfig = this.properties.getGlobalConfig().convertGlobalConfiguration();
        } else {
            globalConfig = new GlobalConfiguration();
        }
        MybatisConfiguration configuration = this.properties.getConfiguration();
        if (configuration == null && !StringUtils.hasText(this.properties.getConfigLocation())) {
            configuration = new MybatisConfiguration();
        }
        if (configuration != null && !CollectionUtils.isEmpty(this.configurationCustomizers)) {
            for (ConfigurationCustomizer customizer : this.configurationCustomizers) {
                customizer.customize(configuration);
            }
        }
        factory.setConfiguration(configuration);
        if (this.properties.getConfigurationProperties() != null) {
            factory.setConfigurationProperties(this.properties.getConfigurationProperties());
        }
        if (!ObjectUtils.isEmpty(this.interceptors)) {
            factory.setPlugins(this.interceptors);
        }
        if (this.databaseIdProvider != null) {
            factory.setDatabaseIdProvider(this.databaseIdProvider);
        }
        if (StringUtils.hasLength(this.properties.getTypeAliasesPackage())) {
            factory.setTypeAliasesPackage(this.properties.getTypeAliasesPackage());
        }
        // TODO 自定义枚举包
        if (StringUtils.hasLength(this.properties.getTypeEnumsPackage())) {
            factory.setTypeEnumsPackage(this.properties.getTypeEnumsPackage());
        }
        if (StringUtils.hasLength(this.properties.getTypeHandlersPackage())) {
            factory.setTypeHandlersPackage(this.properties.getTypeHandlersPackage());
        }
        if (!ObjectUtils.isEmpty(this.properties.resolveMapperLocations())) {
            factory.setMapperLocations(this.properties.resolveMapperLocations());
        }
        //注入填充器
        if (this.applicationContext.getBeanNamesForType(MetaObjectHandler.class, false,
            false).length > 0) {
            MetaObjectHandler metaObjectHandler = this.applicationContext.getBean(MetaObjectHandler.class);
            globalConfig.setMetaObjectHandler(metaObjectHandler);
        }
        //注入主键生成器
        if (this.applicationContext.getBeanNamesForType(IKeyGenerator.class, false,
            false).length > 0) {
            IKeyGenerator keyGenerator = this.applicationContext.getBean(IKeyGenerator.class);
            globalConfig.setKeyGenerator(keyGenerator);
        }
        //注入sql注入器
        if (this.applicationContext.getBeanNamesForType(ISqlInjector.class, false,
            false).length > 0) {
            ISqlInjector iSqlInjector = this.applicationContext.getBean(ISqlInjector.class);
            globalConfig.setSqlInjector(iSqlInjector);
        }
        factory.setGlobalConfig(globalConfig);
        return factory.getObject();
    }
相关推荐
布列瑟农的星空6 分钟前
大话设计模式——关注点分离原则下的事件处理
前端·后端·架构
superlls28 分钟前
(计算机网络)JWT三部分及 Signature 作用
java·开发语言·计算机网络
多工坊36 分钟前
【DataGrip】连接达梦数据库后,能查询数据但是看不到表的几种情况分析,达梦数据库驱动包下载DmJdbcDriver18.jar
java·数据库·jar
秋难降1 小时前
优雅的代码是什么样的?🫣
java·python·代码规范
现在就干1 小时前
Spring事务基础:你在入门时踩过的所有坑
java·后端
浮游本尊2 小时前
Java学习第13天 - 数据库事务管理与MyBatis Plus
java
该用户已不存在2 小时前
Gradle vs. Maven,Java 构建工具该用哪个?
java·后端·maven
JohnYan2 小时前
Bun技术评估 - 23 Glob
javascript·后端·bun
浮游本尊2 小时前
Java学习第11天 - Spring Boot高级特性与实战项目
java
浮游本尊2 小时前
Java学习第12天 - Spring Security安全框架与JWT认证
java