SpringBoot项目jar和war打包部署方式详解

2022-11-13 16:11:50 部署 打包 详解

jar与war

Spring Boot项目开发完成后,需要以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.boot</groupId>
     <artifactId>spring-boot-starter-parent</artifactId>
     <version>2.3.10.RELEASE</version>
     <relativePath/> <!-- lookup parent from repository -->
 </parent>
 <groupId>com.example</groupId>
 <artifactId>springboot-demo-deploy</artifactId>
 <version>0.0.1-SNAPSHOT</version>
 <name>springboot-demo-deploy</name>
 <description>Demo project for Spring Boot</description>
 <!-- 设置打包方式为jar -->
 <packaging>jar</packaging>
 <properties>
     <java.version>11</java.version>
 </properties>
 <dependencies>
     <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-thymeleaf</artifactId>
     </dependency>
     <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-web</artifactId>
     </dependency>
     <dependency>
         <groupId>org.projectlombok</groupId>
         <artifactId>lombok</artifactId>
         <optional>true</optional>
     </dependency>
     <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-test</artifactId>
         <scope>test</scope>
     </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中的<packaging>jar</packaging><packaging>war</packaging>,表示项目的打包方式变成war。

(2)在pom.xml中添加Tomcat的依赖,代码如下:

 <!--当将war包配置到Tomcat时,自动排除内置的Tomcat,避免二者产生冲突-->
 <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-tomcat</artifactId>
     <!--Tomcat依赖只参与编译、测试和运行等周期。-->
     <scope>provided</scope>
 </dependency>

(3)修改build标签,在<build></build>标签内指定war文件的名称。这里设置war包的名称为springboot-demo-deploy,代码如下:

 <build>
     <finalName>springboot-demo-deploy</finalName>
     <plugins>
         <plugin>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-maven-plugin</artifactId>
             <configuration>
                 <excludes>
                     <exclude>
                         <groupId>org.projectlombok</groupId>
                         <artifactId>lombok</artifactId>
                     </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包部署成功。

以上就是SpringBoot项目jar和war打包部署方式详解的详细内容,更多关于SpringBoot jar war打包部署的资料请关注其它相关文章!

相关文章