56.1.3 自定義啟動腳本 · Spring Boot參考指南

###56.1.3 自定義啟動腳本 Maven或Gradle插件生成的默認內嵌啟動腳本可以通過很多方法自定義，對于大多數開發者，使用默認腳本和一些自定義通常就足夠了。如果發現不能自定義需要的東西，你可以使用`embeddedLaunchScript`選項生成自己的文件。 **在腳本生成時自定義** 自定義寫入jar文件的啟動腳本元素是有意義的，例如，為`init.d`腳本提供`description`，既然知道這會展示到前端，你可能會在生成jar時提供它。為了自定義寫入的元素，你需要為Spring Boot Maven或Gradle插件指定`embeddedLaunchScriptProperties`選項。以下是默認腳本支持的可代替屬性： |名稱|描述| |:----|:----| |`mode`|腳本模式，默認為`auto`| |`initInfoProvides`|'INIT INFO'部分的`Provides`，對于Gradle默認為`spring-boot-application`，對于Maven默認為`${project.artifactId}`| |`initInfoShortDescription`|‘INIT INFO’部分的`Short-Description`，對于Gradle默認為`Spring Boot Application`，對于Maven默認為`${project.name}`| |`initInfoDescription`|“INIT INFO”部分的`Description`，對于Gradle默認為`Spring Boot Application`，對于Maven默認為`${project.description}`（失敗會回退到`${project.name}`）| |`initInfoChkconfig`|“INIT INFO”部分的`chkconfig`，默認為`2345 99 01`| |`confFolder`|`CONF_FOLDER`的默認值，默認為包含jar的文件夾| |`logFolder`|`LOG_FOLDER`的默認值，只對`init.d`服務有效| |`pidFolder`|`PID_FOLDER`的默認值，只對`init.d`服務有效| |`useStartStopDaemon`|如果`start-stop-daemon`命令可用，它會控制該實例，默認為`true`| **在腳本運行時自定義** 對于需要在jar文件生成后自定義的項目，你可以使用環境變量或配置文件。默認腳本支持以下環境變量： |變量|描述| |:----|:----| |`MODE`|操作的模式，默認值依賴于jar構建方式，通常為`auto`（意味著它會嘗試通過檢查它是否為`init.d`目錄的軟連接來推斷這是不是一個init腳本）。你可以顯式將它設置為`service`，這樣`stop|start|status|restart`命令就可以工作了，或如果你只是想在前臺運行該腳本那只需`run`| |`USE_START_STOP_DAEMON`|如果`start-stop-daemon`命令可用，它將被用來控制該實例，默認為`true`| |`PID_FOLDER`|pid文件夾的根目錄（默認為`/var/run`）| |`LOG_FOLDER`|存放日志文件的文件夾（默認為`/var/log`）| |`CONF_FOLDER`|讀取`.conf`文件的文件夾| |`LOG_FILENAME`|存放于`LOG_FOLDER`的日志文件名（默認為`<appname>.log`）| |`APP_NAME`|應用名，如果jar運行自一個軟連接，腳本會猜測它的應用名。如果不是軟連接，或你想顯式設置應用名，這就很有用了| |`RUN_ARGS`|傳遞給程序的參數（Spring Boot應用）| |`JAVA_HOME`|默認使用`PATH`指定`java`的位置，但如果在`$JAVA_HOME/bin/java`有可執行文件，你可以通過該屬性顯式設置| |`JAVA_OPTS`|JVM啟動時傳遞的配置項| |`JARFILE`|在腳本啟動沒內嵌其內的jar文件時顯式設置jar位置| |`DEBUG`|如果shell實例的`-x`標識有設值，則你能輕松看到腳本的處理邏輯| **注** `PID_FOLDER`，`LOG_FOLDER`和`LOG_FILENAME`變量只對`init.d`服務有效。對于`systemd`等價的自定義方式是使用‘service’腳本。如果`JARFILE`和`APP_NAME`出現異常，上面的設置可以使用一個`.conf`文件進行配置。該文件預期是放到跟jar文件臨近的地方，并且名字相同，但后綴為`.conf`而不是`.jar`。例如，一個命名為`/var/myapp/myapp.jar`的jar將使用名為`/var/myapp/myapp.conf`的配置文件： **myapp.conf** ```properties JAVA_OPTS=-Xmx1024M LOG_FOLDER=/custom/log/folder ``` **注** 如果不喜歡配置文件放到jar附近，你可以使用`CONF_FOLDER`環境變量指定文件的位置。想要學習如何正確的保護文件可以參考[the guidelines for securing an init.d service.](the guidelines for securing an init.d service)。