共计 14034 个字符,预计需要花费 36 分钟才能阅读完成。
Spring 源码解析十二:SpringBoot 的加载机制
1. spring-boot
蕴含的模块
在解析 SpringBoot 的加载机制之前,先来看看官网 spring-boot
蕴含有哪些模块,各有什么用。
spring-boot 官网仓库
spring-boot
:SpringBoot 的外围包,包含对spring-framework
的封装与扩大、application.yaml
加载机制、注解启动机制等spring-boot-autoconfigure
:application.yaml
的配置项定义spring-boot-actuator
:对 Spring 的健康检查、审计、统计和监控spring-boot-actuator-autoconfigure
:对 Spring 健康检查、审计、统计和监控的application.yaml
配置项反对spring-boot-cli
:命令行执行反对spring-boot-devtools
:开发时监听 class 文件变动主动刷新应用程序spring-boot-starters/*
:SpringBoot starter,上面的我的项目全副是依赖定义,没有代码spring-boot-tools/*
:SpringBoot 配套工具
2. 利用入口
一个打包好的利用有如下的根本目录构造
- /
- BOOT-INF
- classes # 寄存利用的 class 文件与 Resources 资源文件
- lib # 依赖的 jar
- META-INF
- MANIFEST.MF # 利用的启动配置
- org/springframework/boot/loader/ # spring-boot-loader 代码
咱们个别能够应用 java -jar app.jar
来启动利用,MANIFEST.MF
就是来配置利用的启动
# MANIFEST.MF
Manifest-Version: 1.0
Start-Class: com.example.demo.App
Spring-Boot-Classes: BOOT-INF/classes/
Spring-Boot-Lib: BOOT-INF/lib/
Spring-Boot-Version: 2.1.4.RELEASE
Main-Class: org.springframework.boot.loader.JarLauncher
对 Java 来说,这外面的配置,只有 Main-Class
是无效的,就是指定入口类
3. JarLauncher
JarLauncher
的次要性能是通过 jar 来启动利用
public class JarLauncher extends ExecutableArchiveLauncher {
// 入口启动办法
public static void main(String[] args) throws Exception {new JarLauncher().launch(args);
}
}
当初来认真合成这个类,先来看看继承关系
- Launcher
- ExecutableArchiveLauncher
- JarLauncher
3.1. Launcher
Launcher
的次要性能是实现了根本的启动机制
public abstract class Launcher {
// 启动利用
protected void launch(String[] args) throws Exception {
// 获取类加载器
ClassLoader classLoader = createClassLoader(getClassPathArchivesIterator());
// 获取启动类
String launchClass = getMainClass();
// 启动
launch(args, launchClass, classLoader);
}
// 启动
protected void launch(String[] args, String launchClass, ClassLoader classLoader) throws Exception {Thread.currentThread().setContextClassLoader(classLoader);
// 创立 runner,run
createMainMethodRunner(launchClass, args, classLoader).run();}
// 创立 runner
protected MainMethodRunner createMainMethodRunner(String mainClass, String[] args, ClassLoader classLoader) {return new MainMethodRunner(mainClass, args);
}
// 获取启动类,由子类实现
protected abstract String getMainClass() throws Exception;}
来看看 MainMethodRunner
是怎么运行的
public class MainMethodRunner {
private final String mainClassName;
private final String[] args;
public MainMethodRunner(String mainClass, String[] args) {
this.mainClassName = mainClass;
this.args = (args != null) ? args.clone() : null;}
public void run() throws Exception {Class<?> mainClass = Class.forName(this.mainClassName, false, Thread.currentThread().getContextClassLoader());
// 获取 mainClass 的 main 办法
Method mainMethod = mainClass.getDeclaredMethod("main", String[].class);
mainMethod.setAccessible(true);
// 调用 main 办法
mainMethod.invoke(null, new Object[] {this.args});
}
}
3.2. ExecutableArchiveLauncher
ExecutableArchiveLauncher
的次要性能是执行归档文件(jar, war)
public abstract class ExecutableArchiveLauncher extends Launcher {
// 启动类
private static final String START_CLASS_ATTRIBUTE = "Start-Class";
// 获取启动类
@Override
protected String getMainClass() throws Exception {// 获取归档文件 (jar, war) 中的 `MANIFEST.MF` 文件
Manifest manifest = this.archive.getManifest();
String mainClass = null;
if (manifest != null) {
// 获取 Start-Class 指定的类作为启动类
mainClass = manifest.getMainAttributes().getValue(START_CLASS_ATTRIBUTE);
}
if (mainClass == null) {
// 启动类不能为空
throw new IllegalStateException("No'Start-Class'manifest entry specified in" + this);
}
return mainClass;
}
}
3.3. JarLauncher
JarLauncher
的次要性能是执行 jar 文件,并指定 classpath
public class JarLauncher extends ExecutableArchiveLauncher {
// 是否能够加载这上面的文件
static final EntryFilter NESTED_ARCHIVE_ENTRY_FILTER = (entry) -> {if (entry.isDirectory()) {return entry.getName().equals("BOOT-INF/classes/");
}
return entry.getName().startsWith("BOOT-INF/lib/");
};
// "BOOT-INF/classes/" 与 "BOOT-INF/lib/*.jar" 当做 classpath 加载
@Override
protected boolean isNestedArchive(Archive.Entry entry) {return NESTED_ARCHIVE_ENTRY_FILTER.matches(entry);
}
}
4. 启动利用
咱们来看一个最根本的启动
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class App {public static void main(String[] args) {SpringApplication.run(App.class, args);
}
}
SpringApplication
的 run
办法因为启动一个 SpringBoot 利用
public class SpringApplication {public static ConfigurableApplicationContext run(Class<?>[] primarySources, String[] args) {
// 指定启动主源,运行参数
return new SpringApplication(primarySources).run(args);
}
}
5. SpringApplication.run
public class SpringApplication {public SpringApplication(Class<?>... primarySources) {this(null, primarySources);
}
public SpringApplication(ResourceLoader resourceLoader, Class<?>... primarySources) {
// 资源加载器
this.resourceLoader = resourceLoader;
// 启动主源
this.primarySources = new LinkedHashSet<>(Arrays.asList(primarySources));
// 获取 spring.factories 文件中定义的,实现 Bootstrapper 接口的组件
this.bootstrappers = new ArrayList<>(getSpringFactoriesInstances(Bootstrapper.class));
// 获取 spring.factories 文件中定义的,实现 ApplicationContextInitializer 接口的组件
setInitializers((Collection) getSpringFactoriesInstances(ApplicationContextInitializer.class));
// 获取 spring.factories 文件中定义的,实现 ApplicationListener 接口的组件
setListeners((Collection) getSpringFactoriesInstances(ApplicationListener.class));
// 获取入口类文件,如 com.example.demo.App.class
this.mainApplicationClass = deduceMainApplicationClass();}
// 运行我的项目
public ConfigurableApplicationContext run(String... args) {
// 创立启动上下文
DefaultBootstrapContext bootstrapContext = createBootstrapContext();
// 利用上下文
ConfigurableApplicationContext context = null;
// ... 代码省略
// 获取 spring.factories 文件中定义的,实现 SpringApplicationRunListener 接口的组件
SpringApplicationRunListeners listeners = getRunListeners(args);
// 启动监听器
listeners.starting(bootstrapContext, this.mainApplicationClass);
try {
// 利用参数
ApplicationArguments applicationArguments = new DefaultApplicationArguments(args);
// 筹备环境对象
ConfigurableEnvironment environment = prepareEnvironment(listeners, bootstrapContext, applicationArguments);
// 初始化 spring.beaninfo.ignore 配置
configureIgnoreBeanInfo(environment);
// 创立利用上下文,默认应用 AnnotationConfigServletWebServerApplicationContext
context = createApplicationContext();
// 筹备利用上下文
prepareContext(bootstrapContext, context, environment, listeners, applicationArguments, printedBanner);
// 调用 context 的 refresh 办法,刷新上下文数据
refreshContext(context);
// ... 代码省略
// 调用利用开始的监听函数
listeners.started(context);
// 运行利用
callRunners(context, applicationArguments);
}
catch (Throwable ex) {// ... 代码省略}
try {
// 调用利用运行的监听函数
listeners.running(context);
}
catch (Throwable ex) {// ... 代码省略}
return context;
}
// 创立启动上下文
private DefaultBootstrapContext createBootstrapContext() {
// 默认应用 DefaultBootstrapContext,调用 bootstrappers 中每个组件的 intitialize 办法初始化
DefaultBootstrapContext bootstrapContext = new DefaultBootstrapContext();
this.bootstrappers.forEach((initializer) -> initializer.intitialize(bootstrapContext));
return bootstrapContext;
}
}
public class SpringApplication {
// 筹备环境对象
private ConfigurableEnvironment prepareEnvironment(SpringApplicationRunListeners listeners,
DefaultBootstrapContext bootstrapContext, ApplicationArguments applicationArguments) {
// 创立一个 spring-web 的规范环境
ConfigurableEnvironment environment = getOrCreateEnvironment();
// 配置环境
configureEnvironment(environment, applicationArguments.getSourceArgs());
// ... 代码省略
// 配置 additionalProfiles
configureAdditionalProfiles(environment);
// 绑定环境与利用
bindToSpringApplication(environment);
// ... 代码省略
return environment;
}
// 配置环境
protected void configureEnvironment(ConfigurableEnvironment environment, String[] args) {
// 增加数据转换与格式化服务
if (this.addConversionService) {ConversionService conversionService = ApplicationConversionService.getSharedInstance();
environment.setConversionService((ConfigurableConversionService) conversionService);
}
// 配置命令行的属性起源 propertySources
configurePropertySources(environment, args);
}
}
public class SpringApplication {
// 筹备利用上下文
private void prepareContext(DefaultBootstrapContext bootstrapContext, ConfigurableApplicationContext context,
ConfigurableEnvironment environment, SpringApplicationRunListeners listeners,
ApplicationArguments applicationArguments, Banner printedBanner) {
// 设置环境
context.setEnvironment(environment);
// 增加 bean 名字生成器、资源加载器、数据转换服务
postProcessApplicationContext(context);
// 调用 initializers 中组件的 initialize 办法
applyInitializers(context);
// ... 代码省略
// 获取 bean 工厂
ConfigurableListableBeanFactory beanFactory = context.getBeanFactory();
// 注册 springApplicationArguments 单例
beanFactory.registerSingleton("springApplicationArguments", applicationArguments);
// ... 代码省略
// 获取所有的源
Set<Object> sources = getAllSources();
// 加载这些源下的资源
load(context, sources.toArray(new Object[0]));
// ... 代码省略
}
// 加载这些源下的资源
protected void load(ApplicationContext context, Object[] sources) {
// 创立 BeanDefinitionLoader
BeanDefinitionLoader loader = createBeanDefinitionLoader(getBeanDefinitionRegistry(context), sources);
// ... 代码省略
// 加载资源
loader.load();}
}
public class SpringApplication {
// 运行利用
private void callRunners(ApplicationContext context, ApplicationArguments args) {List<Object> runners = new ArrayList<>();
// 利用运行器 ApplicationRunner
runners.addAll(context.getBeansOfType(ApplicationRunner.class).values());
// 命令行运行器 CommandLineRunner
runners.addAll(context.getBeansOfType(CommandLineRunner.class).values());
for (Object runner : new LinkedHashSet<>(runners)) {if (runner instanceof ApplicationRunner) {
// 调用 ApplicationRunner.run 办法
callRunner((ApplicationRunner) runner, args);
}
if (runner instanceof CommandLineRunner) {
// 调用 CommandLineRunner.run 办法
callRunner((CommandLineRunner) runner, args);
}
}
}
}
这一大节中,有几点须要接下来缓缓解析
AnnotationConfigServletWebServerApplicationContext
如何治理利用与数据BeanDefinitionLoader.load
如何加载资源
6. AnnotationConfigServletWebServerApplicationContext
AnnotationConfigServletWebServerApplicationContext
是 SpringBoot 默认应用利用上下文
先看看继承关系
- GenericWebApplicationContext
- ServletWebServerApplicationContext
- AnnotationConfigServletWebServerApplicationContext
GenericWebApplicationContext
在 Spring 源码解析二:上下文组件(WebApplicationContext) 中曾经讲过了,先来看看 ServletWebServerApplicationContext
6.1. ServletWebServerApplicationContext
ServletWebServerApplicationContext
的次要性能是能够启动本身为一个应用服务
public class ServletWebServerApplicationContext extends GenericWebApplicationContext
implements ConfigurableWebServerApplicationContext {
// 刷新利用
@Override
protected void onRefresh() {super.onRefresh();
// 刷新的时候,从新创立一个应用服务
createWebServer();}
// 创立一个应用服务
private void createWebServer() {
WebServer webServer = this.webServer;
ServletContext servletContext = getServletContext();
// 应用服务与上下文都为空
if (webServer == null && servletContext == null) {
// 获取 ServletWebServerFactory 的 bean,内置实现有 tomcat、jetty、undertow、netty
ServletWebServerFactory factory = getWebServerFactory();
// 当应用服务初始化实现后,调用本身的 selfInitialize
this.webServer = factory.getWebServer(getSelfInitializer());
// ... 代码省略
}
// 如果有上下文对象,调用本身的 selfInitialize 来初始化
else if (servletContext != null) {
try {getSelfInitializer().onStartup(servletContext);
}
catch (ServletException ex) {// ... 代码省略}
}
// ... 代码省略
}
}
public class ServletWebServerApplicationContext extends GenericWebApplicationContext
implements ConfigurableWebServerApplicationContext {
// 初始化利用
private void selfInitialize(ServletContext servletContext) throws ServletException {
// ... 代码省略
// 获取所有 ServletContextInitializer 的 bean,调用这些组件的 onStartup 办法
for (ServletContextInitializer beans : getServletContextInitializerBeans()) {beans.onStartup(servletContext);
}
}
}
6.2. AnnotationConfigServletWebServerApplicationContext
AnnotationConfigServletWebServerApplicationContext
的次要性能是主动扫描注解定义的 bean
public class AnnotationConfigServletWebServerApplicationContext extends ServletWebServerApplicationContext
implements AnnotationConfigRegistry {
// 注解 bean 定义读取器
private final AnnotatedBeanDefinitionReader reader;
// 类门路 bean 定义扫描器
private final ClassPathBeanDefinitionScanner scanner;
// 已注册的注解类组件
private final Set<Class<?>> annotatedClasses = new LinkedHashSet<>();
// 待扫描的包
private String[] basePackages;
public AnnotationConfigServletWebServerApplicationContext() {
// 初始化读取器与扫描器
this.reader = new AnnotatedBeanDefinitionReader(this);
this.scanner = new ClassPathBeanDefinitionScanner(this);
}
public AnnotationConfigServletWebServerApplicationContext(DefaultListableBeanFactory beanFactory) {super(beanFactory);
// 初始化读取器与扫描器
this.reader = new AnnotatedBeanDefinitionReader(this);
this.scanner = new ClassPathBeanDefinitionScanner(this);
}
public AnnotationConfigServletWebServerApplicationContext(Class<?>... annotatedClasses) {this();
// 注册 bean,并刷新利用上下文数据
register(annotatedClasses);
refresh();}
public AnnotationConfigServletWebServerApplicationContext(String... basePackages) {this();
// 扫描包,并刷新利用上下文数据
scan(basePackages);
refresh();}
}
public class AnnotationConfigServletWebServerApplicationContext extends ServletWebServerApplicationContext
implements AnnotationConfigRegistry {
// 注册 bean
@Override
public final void register(Class<?>... annotatedClasses) {this.annotatedClasses.addAll(Arrays.asList(annotatedClasses));
}
// 扫描包
@Override
public final void scan(String... basePackages) {this.basePackages = basePackages;}
// 利用上下文刷新完之后,主动加载 bean 与扫描包
@Override
protected void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) {super.postProcessBeanFactory(beanFactory);
if (this.basePackages != null && this.basePackages.length > 0) {this.scanner.scan(this.basePackages);
}
if (!this.annotatedClasses.isEmpty()) {this.reader.register(ClassUtils.toClassArray(this.annotatedClasses));
}
}
}
7. BeanDefinitionLoader.load
在下面的代码中,资源加载是类 BeanDefinitionLoader
实现的
class BeanDefinitionLoader {
// 加载资源
void load() {
// 遍历加载
for (Object source : this.sources) {load(source);
}
}
// 加载单个资源
private void load(Object source) {
// 加载类下的资源
if (source instanceof Class<?>) {loadClass((Class<?>) source);
return;
}
// 加载 Resource 的资源
if (source instanceof Resource) {loadResource((Resource) source);
return;
}
// 加载包下的资源
if (source instanceof Package) {loadPackage((Package) source);
return;
}
// 加载字符代表的资源
if (source instanceof CharSequence) {loadCharSequence((CharSequence) source);
return;
}
// 其余不能加载
throw new IllegalArgumentException("Invalid source type" + source.getClass());
}
}
class BeanDefinitionLoader {
// 加载类下的资源
private void loadClass(Class<?> source) {
// 加载类下的注解
this.annotatedReader.register(source);
}
// 加载 Resource 的资源
private void loadResource(Resource source) {
// 加载 Resource 的 xml
this.xmlReader.loadBeanDefinitions(source);
}
// 加载包下的资源
private void loadPackage(Package source) {
// 扫描包下的注解
this.scanner.scan(source.getName());
}
// 加载字符代表的资源
private void loadCharSequence(CharSequence source) {// 替换占位符 ${}
String resolvedSource = this.scanner.getEnvironment().resolvePlaceholders(source.toString());
// 当做类加载,如果胜利,返回
try {load(ClassUtils.forName(resolvedSource, null));
return;
}
catch (IllegalArgumentException | ClassNotFoundException ex) {}
// 当做 Resource 加载,如果胜利,返回
if (loadAsResources(resolvedSource)) {return;}
// 当做包加载,如果胜利,返回
Package packageResource = findPackage(resolvedSource);
if (packageResource != null) {load(packageResource);
return;
}
// 其余不能加载
throw new IllegalArgumentException("Invalid source'" + resolvedSource + "'");
}
}
后续
更多博客,查看 https://github.com/senntyou/blogs
作者:深予之 (@senntyou)
版权申明:自在转载 - 非商用 - 非衍生 - 放弃署名(创意共享 3.0 许可证)