携手创作,共同成长!这是我参与「掘金日新计划 · 8 月更文挑战」的第30天,点击查看活动详情
Spring Boot项目开发完成后,需要以jar或war的方式将项目打包部署到测试开发环境。
jar与war
jar即Java Archive,是Java归档文件,该文件格式与平台无关,它允许将许多文件组合成一个压缩文件。Java程序都可以打成jar包,目前Docker广泛使用,Java项目都会打成可执行的jar包,最终构建为镜像文件来运行。
jar文件格式基于流行的ZIP文件格式。与ZIP文件不同的是,jar文件不仅用于压缩和发布,而且还用于部署和封装库、组件和插件程序,并可被编译器和JVM直接使用。在jar中包含特殊的文件(如manifests和部署描述符),用来指示工具如何处理特定的jar。
war(Web Application Archive)与jar的基本原理相似,它通常表示这是一个Java的Web应用程序包,是一个可以直接运行的Web压缩包,通常用于网站开发,制成war包后部署到容器中(Tomcat或者Jetty)。以Tomcat为例,将war包放置在Tomcat的webapps目录下,再启动Tomcat,war包会自动解压,然后通过浏览器访问,Tomcat会识别war包并自动部署。
注意:war包必须放在webapps下的ROOT目录下,否则访问时需要加上该目录的名称。
在早期的Servlet和JSP项目中,最终生成的war压缩包文件按照目录结构来组织,其根目录下包含js和jsp文件,或者包含这两种文件的目录,另外还有WEB-INF目录。
在WEB-INF目录下通常包含一个web.xml文件和一个classes目录,web.xml是这个应用的配置文件,而classes目录下则包含编译好的Servlet类和jsp,或包含Servlet所依赖的其他类,如JavaBean。
jar包部署运行
下面演示将程序打包成jar后运行。 (1)创建一个空项目springboot-demo-deploy,并添加项目依赖。添加依赖后的pom.xml如下:
<parent>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-parentartifactId>
<version>2.3.10.RELEASEversion>
<relativePath/>
parent>
<groupId>com.examplegroupId>
<artifactId>springboot-demo-deployartifactId>
<version>0.0.1-SNAPSHOTversion>
<name>springboot-demo-deployname>
<description>Demo project for Spring Bootdescription>
<packaging>jarpackaging>
<properties>
<java.version>11java.version>
properties>
<dependencies>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-thymeleafartifactId>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-webartifactId>
dependency>
<dependency>
<groupId>org.projectlombokgroupId>
<artifactId>lombokartifactId>
<optional>trueoptional>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-testartifactId>
<scope>testscope>
dependency>
dependencies>
复制代码
(2)修改application.properties,添加配置文件,代码如下:
#排除静态文件夹
spring.devtools.restart.exclude=static/**,public/**
#关闭Thymeleaf的缓存,开发过程中无须重启
spring.thymeleaf.cache = false
#设置thymeleaf页面的编码
spring.thymeleaf.encoding=UTF-8
spring.thymeleaf.mode=HTML5
#设置thymeleaf页面的后缀
spring.thymeleaf.suffix=.html
#设置thymeleaf页面的存储路径
spring.thymeleaf.prefix=classpath:/templates/
复制代码
(3)完成一个非常简单的HelloController()方法,代码如下:
package com.example.springbootdemodeploy.controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class HelloController {
@GetMapping("/queryUser")
public String queryUser(@RequestParam("name")String name){
return "/hi "+name;
}
}
复制代码
(4)新建访问入口UserController,代码如下:
package com.example.springbootdemodeploy.controller;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
@Controller
public class UserController {
@GetMapping("/hi")
public String queryUser(@RequestParam("name") String name, Model model) {
model.addAttribute("name", "hi " + name);
return "hi";
}
}
复制代码
(5)设置项目的启动类,代码如下:
package com.example.springbootdemodeploy;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class SpringbootDemoDeployApplication {
public static void main(String[] args) {
SpringApplication.run(SpringbootDemoDeployApplication.class, args);
}
}
复制代码
启动项目,分别访问两个链接,即http://localhost:8080/hi?name=cc和http://localhost:8080/queryUser?name=cc,得到正确的返回结果。
现在将整个项目生成一个jar包,并运行该jar包,再次访问上述两个链接。
在项目的根目录下运行Maven命令mvn package-DMaven.test.skip=true,该命令会打包项目且跳过测试,构建成功的jar在target目录下,名称为springboot-demo-deploy-0.0.1-SNAPSHOT.jar。在当前目录下运行java -jar springboot-demo-deploy-0.0.1-SNAPSHOT.jar命令,启动这个jar包,打开浏览器,访问http://localhost:8080/hi?name=cc和http://localhost:8080/queryUser?name=cc,能看到正确的返回结果。
war包部署运行
下面演示将上述程序打包成war后运行。
(1)修改pom.xml中的
为
,表示项目的打包方式变成war。
(2)在pom.xml中添加Tomcat的依赖,代码如下:
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-tomcatartifactId>
<scope>providedscope>
dependency>
复制代码
(3)修改build标签,在
标签内指定war文件的名称。这里设置war包的名称为springboot-demo-deploy,代码如下:
<build>
<finalName>springboot-demo-deployfinalName>
<plugins>
<plugin>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-maven-pluginartifactId>
<configuration>
<excludes>
<exclude>
<groupId>org.projectlombokgroupId>
<artifactId>lombokartifactId>
exclude>
excludes>
configuration>
plugin>
plugins>
build>
复制代码
(4)修改启动类,并继承SpringBootServletInitializer类,然后重写config方法,代码如下:
package com.example.springbootdemodeploy;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.boot.web.servlet.support.SpringBootServlet
Initializer;
@SpringBootApplication
public class SpringbootDemoDeployApplication extends SpringBootServlet
Initializer {
public static void main(String[] args) {
SpringApplication.run(SpringbootDemoDeployApplication.class, args);
}
@Override
protected SpringApplicationBuilder configure(SpringApplicationBuilderbuilder) {
return builder.sources(SpringbootDemoDeployApplication.class);
}
}
复制代码
(5)在项目的根目录下再次执行mvn clean package-DMaven.test.skip=true命令,项目会自动打包为war,打包成功后的文件保存在target目录下。把springboot-demo-deploy.war复制到Tomcat的ROOT目录下,再执行bin目录下的startup.bat就能启动该项目。打开浏览器,访问http://localhost:8080/hi?name=cc和http://localhost:8080/queryUser?name=cc,可以看到显示正常,war包部署成功。