Spring Boot WAR包运行原理分析

Spring Boot应用支持用jar方式独立运行(官方推荐)。当然了,也支持打包成war放到web容器中运行

下面,讲简单的演示一下打包成war包运行的步骤

1:新建maven项目

《Spring Boot WAR包运行原理分析》

<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.pp</groupId>
	<artifactId>spring-boot-mall</artifactId>
	<version>1.0.0</version>
	<!-- 注意这里要是war -->
	<packaging>war</packaging>

	<name>spring-boot-mall</name>
	<url>http://maven.apache.org</url>

	<properties>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<maven.compiler.source>1.8</maven.compiler.source>
		<maven.compiler.target>1.8</maven.compiler.target>
	</properties>

	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>1.4.3.RELEASE</version>
	</parent>

	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-tomcat</artifactId>
			<!-- 注意这里是  provided -->
			<scope>provided</scope>
		</dependency>
	</dependencies>

	<build>
		<plugins>
			<!-- 配置这个插件之后,就支持直接用命令的方式启动(maven clean jetty:run)应用而无需单独准备一个web容器 -->
			<plugin>
				<groupId>org.eclipse.jetty</groupId>
				<artifactId>jetty-maven-plugin</artifactId>
				<version>9.3.3.v20150827</version>
				<configuration>
					<stopKey>foo</stopKey>
					<stopPort>9999</stopPort>
					<httpConnector>
						<port>8080</port>
					</httpConnector>
					<webApp>
						<contextPath>/</contextPath>
					</webApp>
				</configuration>
			</plugin>
			<plugin>
				<artifactId>maven-war-plugin</artifactId>
				<configuration>
					<!-- 本例子由于项目里面没有web.xml,所以要配置这个 -->
					<failOnMissingWebXml>false</failOnMissingWebXml>
				</configuration>
			</plugin>
		</plugins>
	</build>
</project>

package com.pp.mall;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MyController {
	
	@GetMapping("/hello")
	public String hello() {
		return "Hello World!";
	}

}

package com.pp.mall;

import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.support.SpringBootServletInitializer;

@SpringBootApplication
public class SampleWarApplication extends SpringBootServletInitializer {

}

最后,执行maven clean package打包,把打好的war包仍到tomcat等web容器中后,启动容器。

当然了,也可以直接在项目的根目录执行 mvn clean jetty:run 运行项目

之后,就可以访问 /${contextPath}/hello

那么现在问题来了,这个web项目里面没有web.xml,也就是说,没有配置任何初始化、过滤器或者其他Servlet,为什么能启动spring容器呢?

首先要看看Servlet3.0中的一个新接口javax.servlet.ServletContainerInitializer
ServletContainerInitializer 是 Servlet 3.0 新增的一个接口,容器在启动时使用 JAR 服务 API(JAR Service API) 来发现 ServletContainerInitializer 的实现类,并且容器将 WEB-INF/lib 目录下 JAR 包中的类都交给该类的 onStartup() 方法处理,我们通常需要在该实现类上使用 @HandlesTypes 注解来指定希望被处理的类,过滤掉不希望给 onStartup() 处理的类。

也就是说,这里用到了Java的SPI机制。
SPI的全名为Service Provider Interface。这个是针对厂商或者插件的。在java.util.ServiceLoader的文档里有比较详细的介绍。简单的总结下java spi机制的思想。
我们系统里抽象的各个模块,往往有很多不同的实现方案,比如日志模块的方案,xml解析模块、jdbc模块的方案等。
面向的对象的设计里,我们一般推荐模块之间基于接口编程,模块之间不对实现类进行硬编码。一旦代码里涉及具体的实现类,就违反了可拔插的原则,如果需要替换一种实现,就需要修改代码。
为了实现在模块装配的时候能不在程序里动态指明,这就需要一种服务发现机制。 java spi就是提供这样的一个机制:为某个接口寻找服务实现的机制。
有点类似IOC的思想,就是将装配的控制权移到程序之外,在模块化设计中这个机制尤其重要。
java spi的具体约定为:当服务的提供者,提供了服务接口的一种实现之后,在jar包的META-INF/services/目录里同时创建一个以服务接口命名的文件。该文件里就是实现该服务接口的具体实现类。
而当外部程序装配这个模块的时候,就能通过该jar包META-INF/services/里的配置文件找到具体的实现类名,并装载实例化,完成模块的注入。 
基于这样一个约定就能很好的找到服务接口的实现类,而不需要再代码里制定。jdk提供服务实现查找的一个工具类:java.util.ServiceLoader

在spring-web-${version}.jar文件里面,可以看到

《Spring Boot WAR包运行原理分析》

META-INF/services/javax.servlet.ServletContainerInitializer

文件里面的内容是:
org.springframework.web.SpringServletContainerInitializer

意思就是web容器在启动的时候,会去加载所有的javax.servlet.ServletContainerInitializer接口的实现类,然后调用onStartup方法做初始化工作。

所以,在没有web.xml的情况下,也能进行spring容器的启动

    原文作者:Spring Boot
    原文地址: https://blog.csdn.net/mn960mn/article/details/54693985
    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞