Jboot使用appassembler-maven-plugin插件生成啟動腳本

appassembler-maven-plugin介紹：

使用appassembler-maven-plugin插件可自動生成跨平台的啟動腳本，可省去手工寫腳本的麻煩，而且還可以生成jsw的后台運行程序。

插件官網：http://www.mojohaus.org/appassembler/appassembler-maven-plugin/

官網詳細介紹了該插件的用法。

實戰：

最近項目用到了Jboot框架，如何在Jboot框架中應用appassembler-maven-plugin插件生成啟動腳本，是本文要寫的。

1 生成可執行啟動腳本

1.1 直接在pom.xml文件中加入插件配置

<build>
    <plugins>

        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <!-- Apache Maven編譯器插件 -->
            <artifactId>maven-compiler-plugin</artifactId>
            <configuration>
                <source>1.8</source>
                <target>1.8</target>
                <encoding>UTF-8</encoding>
                <!-- 必須添加compilerArgument配置，才能使用JFinal的Controller方法帶參數的功能 -->
                <compilerArgument>-parameters</compilerArgument>
            </configuration>
        </plugin>

        <plugin>
            <groupId>org.codehaus.mojo</groupId>
            <artifactId>appassembler-maven-plugin</artifactId>
            <version>1.10</version>
            <configuration>
                <!-- 文件生成的根目錄 -->
                <assembleDirectory>${project.build.directory}/app</assembleDirectory>
                <!-- 打包的jar，以及maven依賴的jar放到這個目錄里面 -->
                <repositoryName>lib</repositoryName>
                <!-- 可執行腳本的目錄 -->
                <binFolder>bin</binFolder>
                <!-- 配置文件的目標目錄 -->
                <configurationDirectory>webRoot</configurationDirectory>
                <!-- 拷貝配置文件到上面的目錄中 -->
                <copyConfigurationDirectory>true</copyConfigurationDirectory>
                <!-- 從哪里拷貝配置文件 (默認src/main/config) -->
                <configurationSourceDirectory>src/main/resources</configurationSourceDirectory>
                <!-- lib目錄中jar的存放規則，默認是${groupId}/${artifactId}的目錄格式，flat表示直接把jar放到lib目錄 -->
                <repositoryLayout>flat</repositoryLayout>
                <encoding>UTF-8</encoding>
                <logsDirectory>logs</logsDirectory>
                <tempDirectory>tmp</tempDirectory>

                <programs>
                    <!-- 程序打包：mvn package appassembler:assemble -->
                    <program>
                        <!-- 生成的腳本文件的名稱，比如start.sh,你也可以根據你的需要命名成其他名字 -->
                        <id>jboot</id>
                        <mainClass>io.jboot.Jboot</mainClass>
                        <!-- 生成linux, windows兩種平台的執行腳本 -->
                        <platforms>
                            <platform>windows</platform>
                            <platform>unix</platform>
                        </platforms>
                    </program>
                </programs>

            </configuration>
        </plugin>

    </plugins>
</build>

 1.2 在終端中執行：mvn package appassembler:assemble

程序打包完成

在項目的target-->app-->bin文件下可找到新生成腳本文件，無文件后綴的是linux可執行的腳本文件，jboot.bat為windows下可執行腳本文件。

1.3 可執行腳本測試

1.3.1 linux下測試

將 target 整個文件拷貝到 linux 文件目錄下

通過終端進入app/bin目錄下，並賦予 jboot 文件可執行權限，然后執行 ./jboot 命令，可以看到項目啟動成功。

在瀏覽器中訪問：http://192.168.154.216:8080/ 可以看到項目訪問正常。

2 生成后台服務程序

2.1 在生成可執行啟動腳本pom.xml文件的<configuration>下繼續添加如下內容

<daemons>
    <!-- 后台程序打包：mvn clean package appassembler:generate-daemons -->
    <daemon>
        <id>jboot</id>
        <mainClass>io.jboot.Jboot</mainClass>
        <platforms>
            <platform>jsw</platform>
        </platforms>
        <generatorConfigurations>
            <generatorConfiguration>
                <generator>jsw</generator>
                <includes>
                    <include>linux-x86-32</include>
                    <include>linux-x86-64</include>
                    <include>macosx-universal-32</include>
                    <include>macosx-universal-64</include>
                    <include>windows-x86-32</include>
                    <include>windows-x86-64</include>
                </includes>
                <configuration>
                    <property>
                        <name>configuration.directory.in.classpath.first</name>
                        <value>webRoot</value>
                    </property>
                    <property>
                        <name>wrapper.ping.timeout</name>
                        <value>120</value>
                    </property>
                    <property>
                        <name>set.default.REPO_DIR</name>
                        <value>lib</value>
                    </property>
                    <property>
                        <name>wrapper.logfile</name>
                        <value>logs/wrapper.log</value>
                    </property>
                </configuration>
            </generatorConfiguration>
        </generatorConfigurations>
    </daemon>
</daemons>

2.2 在終端中執行：mvn clean package appassembler:generate-daemons 稍后即打包完成。

在項目的target-->generated-resources-->appassembler-->jsw-->jboot-->bin文件下可找到新生成的腳本文件，無后綴jboot文件的是linux可執行的腳本文件，jboot.bat為windows下可執行腳本文件。

2.3 后台服務程序腳本測試

2.3.1 windows下測試

以管理員身份進入DOS操作界面，進入腳本文件所在目錄，執行jboot.bat命令，展示出腳本用法列表

Usage: jboot.bat { console : start : pause : resume : stop : restart : install : remove : status }

執行 jboot.bat start 啟動項目

在瀏覽器中輸入：http://localhost:8080/ 可以看到項目啟動成功，也可以操作 jboot.bat status 查看運行狀態、jboot.bat stop 停止項目運行

2.3.2 linux下測試

同樣將 target 整個文件拷貝到 linux 文件目錄下，然后在終端進入腳本文件所在位置

賦予jboot、wrapper-linux-x86-64可執行權限，執行 ./jboot 命令可以顯示腳本用法列表

接着執行 ./jboot start 啟動項目，執行 ./jboot status 查看運行狀態

在瀏覽器中輸入：http://192.168.154.216:8080/ 可以看到項目訪問成功，同樣可以使用 ./jboot stop 終止項目運行

注：

1、在終端執行生成后台服務程序的命令后，會將前面生成可執行啟動腳本命令生成的app文件刪掉，如果還想要可執行啟動腳本，在終端再執行一遍 mvn package appassembler:assemble 即可，然后將新的target文件拷貝到對應目錄下，可執行啟動腳本和后台服務程序腳本都會存在。

2、如果pom文件中增加了新的依賴，或者減少了依賴，則需要重新使用命令打包，否則新加入的jar包無法引入到項目的lib下，命令會把每個jar包都加入到lib下。

至此，Jboot使用appassembler-maven-plugin插件生成啟動腳本的相關操作結束。

參考：

① 使用appassembler-maven-plugin插件生成啟動腳本

② 使用appassembler插件生成啟動腳本

③ 用Maven自動生成帶有sh和bat啟動腳本的java應用

④ Jboot-項目構建