Spring Boot项目部署与监控

在完成项目开发工作后，需要把项目部署到测试环境中，由测试人员进行功能测试，同时开发人员需要监控当前服务的运行情况，包括CPU、内存、磁盘和网络的占用情况，查看项目运行时产生的日志文件，便于定位错误。

在完成测试工作后，还需要把项目部署到生产环境中，同时也需要对服务器的运行情况和产生的日志文件进行监控和查看，以便定位服务器突发问题，确定服务器的运行是否平稳。

　SpringBoot打包部署

Spring Boot项目开发完成后，必须将项目打包部署到测试开发环境。

Java项目常见的打包方式是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.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;

/**

* @author ke.zhang

* @version 1.0

* @description: hello world

* @date 2021/7/14 13:46 */

@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 packageDMaven.test.skip=true，该命令会打包项目且跳过测试，运行后显示的结果如图10.1所示，表示jar已经构建成功。构建成功的jar在target目录下，名称为
springboot-demo-deploy-0.0.1-SNAPSHOT.jar。在当前目录下运行java-jar
springboot-demo-deploy-0.0.1-SNAPSHOT.jar命令，启动这个jar包，启动后显示的结果如图10.2所示，表示当前jar包已经成功启动。打开浏览器，访问http://localhost:8080/hi?name=cc和
http://localhost:8080/queryUser?name=cc，能看到正确的返回结果。

实战：将项目打包成war

下面演示如何将10.1.2小节中的程序打包成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 packageDMaven.test.skip=true命令，项目会自动打包为war，打包成功后的文件保存在target目录下，如图10.3所示。

请读者自行下载Tomcat 9.0.45到本地（请注意使用这个版本的Tomcat），解压下载文件后清空webapps下的ROOT目录，把springboot-demodeploy.war复制到ROOT目录下，再执行bin目录下的startup.bat就能启动该项目。打开浏览器，访问http://localhost:8080/hi?name=cc和
http://localhost:8080/queryUser?name=cc，可以看到，接口返回了正确的结果。

实战：使用Docker部署jar工程

Docker是一个开源的应用容器引擎，它基于Go语言开发。Docker可以让开发者打包应用并将依赖包存放到一个轻量级且可移植的容器中，然后将其发布到任意平台上运行。容器完全使用沙箱机制，相互之间不会有任何接口（类似于iPhone的App），且容器性能开销极低。

基于Docker的很多优点，很多公司的应用已经从war部署方式变成了Docker部署。下面介绍如何使用Docker部署jar包。

（1）在本地安装Docker，直接选择安装最新版本即可，安装完成后启动Docker，使用命令行输入Docker -v，会显示Docker的版本，即表示安装成功，如图10.4所示。

（2）按照10.1.2小节的步骤把项目打成jar包，在项目的根目录下新建Dockerfile文件，代码如下：

#FROM：表示基础镜像，即运行环境，使用open jdk8

FROM openjdk:8-jdk-alpine

# 镜像作者信息

MAINTAINER ke.zhang

#VOLUME在宿主机的/var/lib/docker目录下创建一个临时文件并把它链接到容器中的/tmp

目录

VOLUME /tmp

# ADD：添加文件并且重命名

ADD target/springboot-demo-deploy-0.0.1-SNAPSHOT.jar /app.jar

#EXPOSE：建立image暴露的端口

EXPOSE 8080

#ENTRYPOINT：容器启动时运行的命令，相当于在命令行中输入java -jar xxxx.jar

ENTRYPOINT ["java","-jar","/app.jar"]

（3）打开命令行工具，构建自己的镜像文件，代码如下：

docker build -t springboot-demo:v1 .

构建镜像时打印的日志如图10.5所示，表示当前构建了一个版本号是v1、名称是springboot-demo的镜像。使用docker images命令查看构建好的镜像，可以看到已经成功地构建了镜像，如图10.6所示。

（4）运行镜像的命令：

docker run -d -p 8080:8080 --name my-springboot springboot-demo:v1上述命令是通过映射本机端口8080来镜像端口8080，容器的名称是myspringboot，基于springboot-demo的v1镜像创建容器并且运行。

（5）使用docker ps -a命令查看正在运行的容器，如图10.7所示。项目启动后可以查看运行的日志，使用的命令是“docker logs -f --tail=100容器的id”，本容器的id是4270d0f1547e。

至此完成了用Docker构建镜像并且在镜像中运行项目的步骤。

提示：如果项目很复杂，可以使用docker-compose来构建自己的服务，当然大公司可以直接考虑使用Kubernetes构建。

实战：使用spring-boot-devtools进行热部署

在开发过程中经常会出现这样的场景，有时想修改代码后马上自动加载修改后的代码，以便看到修改后的效果，这时候就需要集成使用springboot-devtools进行辅助开发。

spring-boot-devtools通过提供自动重启和LiveReload功能，使开发者能够更快、更轻松地完成Spring Boot应用程序的开发工作。但是项目部署在生产环境中运行时，建议不要再使用spring-boot-devtools，一般只在开发环境中使用spring-boot-devtools。使用IDEA进行开发时，需要配置IDEA自动编译来启用该功能。

spring-boot-devtools提供自动重启的功能。每当类路径中的文件发生更改时，spring-boot-devtools会自动重新启动正在运行的应用程序，并进行更新。当开发人员在本地开发时，不再需要手动重启程序。如果要禁用服务器重启，则可以配置如下属性：

spring.devtools.restart.enabled = false

如果在项目启动时需要排除一些文件，则需设置禁用自动重启，可以使用spring. devtools.restart.exclude，例如：

spring.devtools.restart.exclude=static/**,public/**还原当前项目打包方式为jar的启动方式，在pom.xml中引入springboot-devtools依赖：

<dependencies>

<dependency>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-devtools</artifactId>

<optional>true</optional>

</dependency>

</dependencies>

启动当前项目，访问
http://localhost:8080/queryUser?name=cc，显示结果如图10.8所示。

修改HelloController类中的方法：

@RestController

public class HelloController {

@GetMapping("/queryUser")

public String queryUser(@RequestParam("name")String name){

return "/new hi "+name;

}

}

此时可以看到IDEA正在自动更新代码。重新部署项目，再次访问
http://localhost:8080/queryUser?name=cc即可看到返回的结果，如图10.9所示。可以看到，已经完成了热部署。

根据笔者的开发经验，笔者认为热部署功能的实用性不是很大，实际的开发工作中使用spring-boot-devtools可能会面临内存占用过大的问题，开启自动编译重启后IDEA会变得卡顿，而且为了提高开发效率，重启本地开发一般是验证之前修改的几处修改点，而不是修改一点就重启和查看效果。