跨境电商网站开发文档,网站建设费可摊几年,seo教程seo教程,wordpress主题开发文档目录 1. starter介绍2. starter原理2-1. 起步依赖2-2. 自动配置基于Java代码的Bean配置自动配置的条件依赖Bean参数获取Bean的发现Bean的加载自动配置总结 3. 自定义starter案例3-1. 开发starter3-2. 使用starter 1. starter介绍
我们知道Spring Boot大大简化了项目初始搭建以… 目录 1. starter介绍2. starter原理2-1. 起步依赖2-2. 自动配置基于Java代码的Bean配置自动配置的条件依赖Bean参数获取Bean的发现Bean的加载自动配置总结 3. 自定义starter案例3-1. 开发starter3-2. 使用starter 1. starter介绍
我们知道Spring Boot大大简化了项目初始搭建以及开发过程而这些都是通过Spring Boot提供的starter来完成的。
spring boot 在配置上相比spring要简单许多, 其核心在于spring-boot-starter, 在使用spring boot来搭建一个项目时, 只需要引入官方提供的starter, 就可以直接使用, 免去了各种配置。starter简单来讲就是引入了一些相关依赖和一些初始化的配置。
Spring官方提供了很多starter第三方也可以定义starter。为了加以区分starter从名称上进行了如下规范
Spring官方提供的starter名称为spring-boot-starter-xxx 例如spring-boot-starter-web第三方提供的starter名称为xxx-spring-boot-starter 例如mybatis-spring-boot-starter
2. starter原理
Spring Boot之所以能够帮我们简化项目的搭建和开发过程主要是基于它提供的起步依赖和自动配置。
2-1. 起步依赖
起步依赖其实就是将具备某种功能的坐标打包到一起可以简化依赖导入的过程。例如我们导入spring-boot-starter-web这个starter则和web开发相关的jar包都一起导入到项目中了。如下图所示 2-2. 自动配置
自动配置就是无须手动配置xml自动配置并管理bean可以简化开发过程。那么Spring Boot是如何完成自动配置的呢
自动配置涉及到如下几个关键步骤 基于Java代码的Bean配置 自动配置条件依赖 Bean参数获取 Bean的发现 Bean的加载
我们可以通过一个实际的例子mybatis-spring-boot-starter来说明自动配置的实现过程。
基于Java代码的Bean配置
当我们在项目中导入了mybatis-spring-boot-starter这个jar后可以看到它包括了很多相关的jar包如下图 其中在mybatis-spring-boot-autoconfigure这个jar包中有如下一个MybatisAutoConfiguration自动配置类 打开这个类截取的关键代码如下 Configuration 注解的类可以看作是能生产让Spring IOC容器管理的Bean实例的工厂。 Bean 注解的方法返回的对象可以被注册到Spring容器中。 Configuration和 Bean这两个注解一起使用就可以创建一个基于Java代码的配置类可以用来替代传统的xml配置文件。
自动配置的条件依赖
从MybatisAutoConfiguration这个类中使用的注解可以看出要完成自动配置是有依赖条件的。 所以要完成Mybatis的自动配置需要在类路径中存在SqlSessionFactory.class、SqlSessionFactoryBean.class这两个类同时需要存在DataSource这个bean且这个bean完成自动注册。
这些注解是spring boot特有的常见的条件依赖注解有
注解功能说明ConditionalOnBean仅在当前上下文中存在某个bean时才会实例化这个BeanConditionalOnClass某个class位于类路径上才会实例化这个BeanConditionalOnExpression当表达式为true的时候才会实例化这个BeanConditionalOnMissingBean仅在当前上下文中不存在某个bean时才会实例化这个BeanConditionalOnMissingClass某个class在类路径上不存在的时候才会实例化这个BeanConditionalOnNotWebApplication不是web应用时才会实例化这个BeanAutoConfigureAfter在某个bean完成自动配置后实例化这个beanAutoConfigureBefore在某个bean完成自动配置前实例化这个bean
Bean参数获取
要完成mybatis的自动配置需要我们在配置文件中提供数据源相关的配置参数例如数据库驱动、连接url、数据库用户名、密码等。那么spring boot是如何读取yml或者properites配置文件的的属性来创建数据源对象的
在我们导入mybatis-spring-boot-starter这个jar包后会传递过来一个spring-boot-autoconfigure包在这个包中有一个自动配置类DataSourceAutoConfiguration如下所示 我们可以看到这个类上加入了EnableConfigurationProperties这个注解继续跟踪源码DataSourceProperties这个类如下 可以看到这个类上加入了ConfigurationProperties注解这个注解的作用就是把yml或者properties配置文件中的配置参数信息封装到ConfigurationProperties注解标注的bean(即DataSourceProperties)的相应属性上。
EnableConfigurationProperties注解的作用是使ConfigurationProperties注解生效。
Bean的发现
spring boot默认扫描启动类所在的包下的主类与子类的所有组件但并没有包括依赖包中的类那么依赖包中的bean是如何被发现和加载的
我们需要从Spring Boot项目的启动类开始跟踪在启动类上我们一般会加入SpringBootApplication注解此注解的源码如下 重点介绍如下三个注解 SpringBootConfiguration作用就相当于Configuration注解被注解的类将成为一个bean配置类 ComponentScan作用就是自动扫描并加载符合条件的组件最终将这些bean加载到spring容器中 EnableAutoConfiguration 这个注解很重要借助Import的支持收集和注册依赖包中相关的bean定义
继续跟踪EnableAutoConfiguration注解源码 AutoConfigurationImportSelector类源码如下 AutoConfigurationImportSelector类的getCandidateConfigurations方法中的调用了SpringFactoriesLoader类的loadFactoryNames方法继续跟踪源码 SpringFactoriesLoader的loadSpringFactories静态方法可以从所有的jar包中读取META-INF/spring.factories文件而自动配置的类就在这个文件中进行配置 这个文件里面的内容如下
这样Spring Boot就可以加载到MybatisAutoConfiguration这个配置类了。
Bean的加载
在Spring Boot应用中要让一个普通类交给Spring容器管理通常有以下方法
1、使用 Configuration与Bean 注解
2、使用Controller Service Repository Component 注解标注该类并且启用ComponentScan自动扫描
3、使用Import 方法
其中Spring Boot实现自动配置使用的是Import注解这种方式AutoConfigurationImportSelector类的selectImports方法返回一组从META-INF/spring.factories文件中读取的bean的全类名这样Spring Boot就可以加载到这些Bean并完成实例的创建工作。
自动配置总结
我们可以将自动配置的关键几步以及相应的注解总结如下
1、Configuration与Bean基于Java代码的bean配置
2、Conditional设置自动配置条件依赖
3、EnableConfigurationProperties与ConfigurationProperties读取配置文件转换为bean
4、EnableAutoConfiguration与Import实现bean发现与加载
3. 自定义starter案例
3-1. 开发starter
第一步创建starter工程digest-spring-boot-starter并配置pom.xml文件
?xml version1.0 encodingUTF-8?
project xmlnshttp://maven.apache.org/POM/4.0.0xmlns:xsihttp://www.w3.org/2001/XMLSchema-instancexsi:schemaLocationhttp://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsdmodelVersion4.0.0/modelVersiongroupIdcom.iteng/groupIdartifactIddigest-spring-boot-starter/artifactIdversion1.0-SNAPSHOT/versionpropertiesmaven.compiler.source8/maven.compiler.sourcemaven.compiler.target8/maven.compiler.targetproject.build.sourceEncodingUTF-8/project.build.sourceEncoding/propertiesdependencies!-- 提供自动装配所依赖的注解 --dependencygroupIdorg.springframework.boot/groupIdartifactIdspring-boot-autoconfigure/artifactIdversion2.7.6/versionoptionaltrue/optional !-- 不进行依赖传递 --/dependency!--apache 加密--dependencygroupIdcommons-codec/groupIdartifactIdcommons-codec/artifactIdversion1.15/version/dependency/dependencies/project第二步创建配置属性类DigestProperty
package com.iteng.digest.config;import org.springframework.boot.context.properties.ConfigurationProperties;/**读取配置文件转换为bean* */
ConfigurationProperties(prefix digest)
public class DigestProperty {private String type;public String getType() {return type;}public void setType(String type) {this.type type;}
}第三步创建业务类Digest 以及实现类Md5Digest、ShaDigest
service
public interface Digest {String digest(String raw);
}impl
public class Md5Digest implements Digest {Overridepublic String digest(String raw) {System.out.println(Md5加密生成摘要);return DigestUtils.md5Hex(raw);}
}public class ShaDigest implements Digest {Overridepublic String digest(String raw) {System.out.println(Sha加密生成摘要);return DigestUtils.sha256Hex(raw);}
}第四步创建自动配置类DigestAutoConfiguration
Configuration
// 使ConfigurationProperties注解生效
EnableConfigurationProperties(DigestProperty.class)
// 只有类路径下有DigestUtils.class时DigestConfiguration配置类才配置
ConditionalOnClass(DigestUtils.class)
public class DigestAutoConfiguration {private DigestProperty digestProperty;//通过构造方法注入配置属性对象DigestProperty, 也可以使用Autowired注解注入public DigestAutoConfiguration(DigestProperty digestProperty) {this.digestProperty digestProperty;}BeanConditionalOnMissingBean // 没有Digest这个Beab时才装配Digest Bean// 只有当yml中的digest.type md5时才装配Digest Bean。// matchIfMissing true表示yml没有写digest.type时也装配Digest BeanConditionalOnProperty(prefix digest, name type, havingValue md5, matchIfMissing true)public Digest md5Digest() {return new Md5Digest();}BeanConditionalOnMissingBeanConditionalOnProperty(prefix digest, name type, havingValue sha)public Digest shaDigest() {return new ShaDigest();}
}第五步(Spring Boot 2.7 及以上在resources目录下创建META-INF文件夹在META-INF文件夹里面创建一个spring文件夹。在spring文件夹中创建org.springframework.boot.autoconfigure.AutoConfiguration.imports的文件。文件内容写自动配置类的全限名
com.iteng.digest.config.DigestAutoConfiguration(Spring Boot 2.7 以下在resources目录下创建META-INF文件夹在文件夹中创建spring.factories文件
org.springframework.boot.autoconfigure.EnableAutoConfiguration\
com.iteng.digest.config.DigestAutoConfiguration至此starter已经开发完成了可以将当前starter安装到本地maven仓库供其他应用来使用。
3-2. 使用starter
