Spring Boot 可执行jar包制作系统服务

我就是我 2021-11-04 14:46 391阅读 0赞

# Spring Boot 可执行jar包制作系统服务 #

在Spring Boot的Maven插件中，还提供了构建完整可执行程序的功能，什么意思呢？

就是说，我们可以不用`java -jar`，而是直接运行jar来执行程序。这样我们就可以方便的将其创建成系统服务在后台运行了。

主要步骤如下：

## 1.配置pom文件 ##

在pom.xml中添加Spring Boot的插件，并注意设置executable配置

<build> 
      <plugins> 
        <plugin> 
          <groupId>org.springframework.boot</groupId>  
          <artifactId>spring-boot-maven-plugin</artifactId>  
          <configuration> 
            <executable>true</executable> 
          </configuration> 
        </plugin> 
      </plugins> 
    </build>

## 2. 生成可执行jar ##

在完成上述配置后，使用`mvn install`进行打包，构建一个可执行的jar包

## 3.创建软连接 ##

创建软连接到`/etc/init.d/`目录下

sudo ln -s /var/yourapp/yourapp.jar /etc/init.d/yourapp

## 4.服务化启动项目 ##

在完成软连接创建之后，我们就可以通过如下命令对yourapp.jar应用来控制启动、停止、重启操作了

service yourapp start

service yourapp stop

service yourapp restart

service yourapp start

## 说明 ##

### zip格式里的magic number ###

生成的jar/war实际上是一个zip格式的文件，这个zip格式文件为什么可以在shell下面直接执行？

研究了下zip文件的格式。

zip文件是由entry组成的，而每一个entry开头都有一个4个字节的`magic number`：

Local file header signature = 0x04034b50 (read as a little-endian number)
    
    即 PK\003\004

参考：[https://en.wikipedia.org/wiki/Zip\_(file\_format)][https_en.wikipedia.org_wiki_Zip_file_format]

zip处理软件是读取到magic number才开始处理。所以在linux/unix下面，可以把一个bash文件直接写在一个zip文件的开头，这样子会被认为是一个bash script。 而zip处理软件在读取这个文件时，仍然可以正确地处理。

比如spring boot生成的`executable jar/war`，的开头是：

#!/bin/bash
    #
    #    .   ____          _            __ _ _
    #   /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
    #  ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
    #   \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
    #    '  |____| .__|_| |_|_| |_\__, | / / / /
    #   =========|_|==============|___/=/_/_/_/
    #   :: Spring Boot Startup Script ::
    #

在script内容结尾，可以看到zip entry的magic number:

exit 0
    PK^C^D

### spring boot的launch.script ###

实际上`spring boot maven plugin`是把下面这个script打包到fat jar的最前面部分。

[https://github.com/spring-projects/spring-boot/blob/v1.5.18.RELEASE/spring-boot-tools/spring-boot-loader-tools/src/main/resources/org/springframework/boot/loader/tools/launch.script][https_github.com_spring-projects_spring-boot_blob_v1.5.18.RELEASE_spring-boot-tools_spring-boot-loader-tools_src_main_resources_org_springframework_boot_loader_tools_launch.script]

这个`launch.script` 支持很多变量设置。

还可以自动识别是处于auto还是service不同mode中。

所谓的`auto mode`就是指直接运行`jar/war`：

./demo.jar

而`service mode`则是由操作系统在启动service的情况：

service demo start/stop/restart/status

所以fat jar可以直接在普通的命令行里执行，`./xxx.jar` 或者link到`/etc/init.d/`下，变为一个service。

## 总结 ##

1.  `jar/war`实际就是zip格式。
2.  `spring-boot-maven-plugin`把启动脚本打到`executable jar/war`的最前面。
3.  脚本的最后一行是`exit 0`，脚本只执行自己的内容，不会执行到jar/war里的内容。
4.  zip文件由多个entry组成，entry的开头有`magic number`，所以zip处理软件可以跳过前面的脚本，准确找到`zip entry`

[https_en.wikipedia.org_wiki_Zip_file_format]: https://en.wikipedia.org/wiki/Zip_%28file_format%29
[https_github.com_spring-projects_spring-boot_blob_v1.5.18.RELEASE_spring-boot-tools_spring-boot-loader-tools_src_main_resources_org_springframework_boot_loader_tools_launch.script]: https://github.com/spring-projects/spring-boot/blob/v1.5.18.RELEASE/spring-boot-tools/spring-boot-loader-tools/src/main/resources/org/springframework/boot/loader/tools/launch.script