SpringBoot java程序打包

目标

打包后形成一个xxxx.tar.gz的压缩包。解压后，文件夹的名字为程序的名字+版本号。文件夹内有一个可执行jar，springboot配置文件。部署在Linux服务器上可以使用springboot提供的启动命令进行启动：xxx.jar start|stop|run等等。

过程

在pom.xml文件中的build这一节中，引入springboot的打包插件和assembly插件。如下：

<build>
        <finalName>${artifactId}</finalName>

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

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-assembly-plugin</artifactId>
                <version>2.4</version>
                <executions>
                    <execution>
                        <id>make-zip</id>
                        <phase>package</phase>
                        <goals>
                            <goal>single</goal>
                        </goals>
                        <configuration>
                            <descriptors>
                                <descriptor>src/main/script/assembly.xml</descriptor>
                            </descriptors>
                        </configuration>
                    </execution>
                </executions>
            </plugin>

        </plugins>

    </build>

spring-boot-maven-plugin插件是为了打包成springboot的可执行jar。
maven-assembly-plugin插件是为了后续的压缩包文件的规整。

在项目中新建 src/main/script/assembly.xml 文件。内容如下：

<?xml version="1.0" encoding="utf-8"?>
<assembly
    xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd">
    <id>${project.version}</id>
    <formats>
        <format>tar.gz</format>
    </formats>
    <baseDirectory>${project.artifactId}-${project.version}</baseDirectory>
    <includeBaseDirectory>false</includeBaseDirectory>

    <fileSets>
        <fileSet>
            <directory>src/main/resources</directory>
            <outputDirectory>/</outputDirectory>
            <includes>
                <include>application.properties</include>
                <!-- <include>log4j.xml</include> -->
            </includes>
            <fileMode>0644</fileMode>
        </fileSet>
        <fileSet>
            <directory>src/main/script</directory>
            <outputDirectory>/</outputDirectory>
            <includes>
                <include>auth.conf</include>
            </includes>
            <fileMode>0644</fileMode>
        </fileSet>
        <fileSet>
            <directory>${project.build.directory}</directory>
            <outputDirectory>/</outputDirectory>
            <includes>
                <include>auth.jar</include>
            </includes>
            <fileMode>0755</fileMode>
        </fileSet>

    </fileSets>
</assembly>

这里注意几个点

• pom文件里
  
  • finalName 是打包后jar的名字，这里我希望是不带版本号的名字，因此配置的是 ${artifactId}

• assembly文件中

  • id 是压缩包中程序名后缀，例如：程序名是auth，压缩包按照上述配置，就是auth-版本号.tar.gz；
  • baseDirectiory 中配置的是最终打包后文件夹的名字，这里我期望文件夹上带版本号，便于运维直接看到程序的版本号。

• 剩下的就是配置文件的拷贝，这些提前在工程中做好。

效果如下：

• 打包后的是左边压缩包，解压后是右边的文件夹

• 打开文件夹，如下：可执行jar，applicattion.properties是程序配置文件，auth.conf 是 jar配置文件（配置java启动参数等）
  这里配置文件都是springboot的基本知识，如果不太明白的，建议看springboot官方文档。

• 运行一次之后，的效果，生成了用于存放pid的文件夹。

好了，搞定。