Installing Spring Boot Applications

除了使用 java -jar 直接运行 Spring Boot 应用程序外，还可以将它们作为 systemd、init.d 或 Windows 服务运行。

Installation as a systemd Service

systemd 是 System V 初始化系统的继任者，现在它被许多现代 Linux 发行版使用。Spring Boot 应用程序可以使用 systemd ``service’ 脚本启动。

假设你在 /var/myapp 中有一个打包成 uber jar 的 Spring Boot 应用程序，要以 systemd 服务的形式安装它，请创建一个名为 myapp.service 的脚本，并将其放在 /etc/systemd/system 目录中。以下脚本提供了一个示例：

[Unit]
Description=myapp
After=syslog.target network.target

[Service]
User=myapp
Group=myapp

Environment="JAVA_HOME=/path/to/java/home"

ExecStart=${JAVA_HOME}/bin/java -jar /var/myapp/myapp.jar
ExecStop=/bin/kill -15 $MAINPID
SuccessExitStatus=143

[Install]
WantedBy=multi-user.target

别忘了更改应用程序的 Description、User、Group、Environment 和 ExecStart 字段。

ExecStart 字段不声明脚本操作命令，这意味着 run 命令将被默认使用。

运行该应用程序的用户、PID 文件和控制台日志文件由 systemd 本身管理，因此必须使用 ``service’ 脚本中的适当字段对其进行配置。有关更多详细信息，请参阅 service unit configuration man page 。

若要标记该应用程序在系统启动时自动启动，请使用以下命令：

$ systemctl enable myapp.service

运行 man systemctl 以了解更多详细信息。

Installation as an init.d Service (System V)

若要以 init.d 服务的形式使用应用程序，请配置其构建以生成 fully executable jar 。

完全可执行 jar 文件通过在文件开头嵌入一个额外脚本工作的。目前，一些工具不接受此格式，因此你可能无法始终使用此技术。例如，jar -xf 可能静默失败提取一个已被制作成完全可执行的 jar 或 war。建议仅在你打算直接执行 jar 或 war 时，而不是在使用 java -jar 运行它或将其部署到 servlet 容器时，才使其完全可执行。

一个 zip64 格式的 jar 文件不能被制成完全可执行。试图这样做将导致当直接执行或使用 java -jar 执行时，将 jar 文件报告为已损坏。包含一个或多个 zip64 格式的嵌套 jar 文件的标准格式 jar 文件可以被完全执行。

若要使用 Maven 创建 ``完全可执行’ jar，请使用以下插件配置：

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

以下示例显示等效的 Gradle 配置：

tasks.named('bootJar') {
	launchScript()
}

然后可以将其符号链接到 init.d 以支持标准 start、stop、restart 和 status 命令。

添加到一个完全可执行的 jar 文件中的默认启动脚本支持大多数 Linux 发行版，并在 CentOS 和 Ubuntu 上进行了测试。其他平台（如 OS X 和 FreeBSD）需要使用一个自定义脚本。默认脚本支持以下功能：

  • 以 jar 文件所有者的身份启动服务

  • 使用 /var/run/&lt;appname&gt;/&lt;appname&gt;.pid 跟踪应用程序的 PID。

  • 将控制台日志写入 /var/log/&lt;appname&gt;.log。

假设您在 /var/myapp 安装了 Spring Boot 应用程序，要将 Spring Boot 应用程序安装为 init.d 服务，请按照如下所示创建一个符号链接：

$ sudo ln -s /var/myapp/myapp.jar /etc/init.d/myapp

安装完成后，您可以用惯常的方式启动并停止服务。例如，在基于 Debian 的系统上，您可以使用以下命令启动：

$ service myapp start

如果您的应用程序无法启动，请查看写入到 /var/log/<appname>.log 中的日志文件以获取错误。

您还可使用标准操作系统工具将应用程序标记为自动启动。例如，在 Debian 中，您可以使用以下命令：

$ update-rc.d myapp defaults <priority>

Securing an init.d Service

以下是有关如何保护作为 init.d 服务运行的 Spring Boot 应用程序的指南。它不会罗列实现强化应用程序及其运行环境所需的所有事项。

当作为 root 执行时，比如在使用 root 启动 init.d 服务时，默认可执行脚本使用 RUN_AS_USER 环境变量中指定的用户运行应用程序。如果未设置环境变量，则该系统会改用拥有 jar 文件的用户。您绝不应将 Spring Boot 应用程序作为 root 运行，因此 RUN_AS_USER 不应为 root，并且您的应用程序的 jar 文件不应为 root 所有。相反，您可以创建一个特定用户来运行您的应用程序，并设置 RUN_AS_USER 环境变量或使用 chown 将其设为 jar 文件的所有者，如以下示例所示：

$ chown bootapp:bootapp your-app.jar

在这种情况下，默认可执行脚本将以 bootapp 用户身份运行应用程序。

为了减少应用程序用户帐户被入侵的可能性，您应该考虑阻止其使用登录 shell。例如，您可以将该帐户的 shell 设置为 /usr/sbin/nologin。

您还应采取措施来防止修改应用程序的 jar 文件。首先，配置其权限，使其不可写，并且只能由其所有者读取或执行，如以下示例所示：

$ chmod 500 your-app.jar

其次，您还应采取措施以在您的应用程序或运行它的帐户被入侵时限制损失。如果攻击者确实获得访问权限，他们可以使 jar 文件可写并更改其内容。一种防范方法是使用 chattr 使其不可变，如以下示例所示：

$ sudo chattr +i your-app.jar

这将阻止包括 root 在内的任何用户修改 jar 文件。

如果 root 用于控制应用程序的服务，并且您 use a .conf file 以自定义其启动，则 .conf 文件由 root 用户读取和评估。应对其进行相应的保护。使用 chmod，使得该文件只能由所有者读取，并使用 chown 使 root 成为所有者，如以下示例所示：

$ chmod 400 your-app.conf
$ sudo chown root:root your-app.conf

Customizing the Startup Script

Maven 或 Gradle 插件编写的默认嵌入式启动脚本可以通过多种方式自定义。一般而言，使用带有少量自定义的默认脚本通常已足够。如果您发现无法自定义您需要的内容，请使用 embeddedLaunchScript 选项完全编写您自己的文件。

Customizing the Start Script When It Is Written

通常对写入 jar 文件的 start 脚本的元素进行自定义是有意义的。例如，init.d 脚本可以提供 “description”。由于您预先就知道了描述（并且它不必更改），因此您不妨在生成 jar 文件时提供该描述。

要自定义书面元素，请使用 Spring Boot Maven 插件的 embeddedLaunchScriptProperties 选项或 properties property of the Spring Boot Gradle plugin’s launchScript。

使用默认脚本支持以下属性替换：

Name Description Gradle default Maven default

mode

The script mode.

auto

auto

initInfoProvides

“INIT INFO” 的 Provides 部分

${task.baseName}

${project.artifactId}

initInfoRequiredStart

Required-Start 部分的 “INIT INFO”.

$remote_fs $syslog $network

$remote_fs $syslog $network

initInfoRequiredStop

Required-Stop 部分的 “INIT INFO”.

$remote_fs $syslog $network

$remote_fs $syslog $network

initInfoDefaultStart

Default-Start 部分的 “INIT INFO”.

2 3 4 5

2 3 4 5

initInfoDefaultStop

Default-Stop 部分的 “INIT INFO”.

0 1 6

0 1 6

initInfoShortDescription

Short-Description 部分的 “INIT INFO”.

${project.description} 的单行版本（退回到 ${task.baseName}）

${project.name}

initInfoDescription

Description 部分的 “INIT INFO”.

${project.description}（退回到 ${task.baseName}）

${project.description}（退回到 ${project.name}）

initInfoChkconfig

chkconfig 部分的 “INIT INFO”

2345 99 01

2345 99 01

confFolder

CONF_FOLDER 的默认值

Folder containing the jar

Folder containing the jar

inlinedConfScript

引用应该内联到默认启动脚本中的文件脚本。这可用于在加载任何外部配置文件之前设置环境变量，例如 JAVA_OPTS

logFolder

LOG_FOLDER 的默认值。仅对 init.d 服务有效

logFilename

LOG_FILENAME 的默认值。仅对 init.d 服务有效

pidFolder

PID_FOLDER 的默认值。仅对 init.d 服务有效

pidFilename

PID_FOLDER 中 PID 文件名的默认值。仅对 init.d 服务有效

useStartStopDaemon

是否 start-stop-daemon 命令在可用时应该被用于控制进程

true

true

stopWaitTime

STOP_WAIT_TIME 在秒中的默认值。仅对 init.d 服务有效

60

60

Customizing a Script When It Runs

对于脚本中需要自定义的项 after jar 文件已写入，您可以使用环境变量或 config file.

默认脚本支持以下环境属性：

Variable Description

MODE

操作的"`mode`"。默认值取决于 jar 的构建方式，但通常为`auto`（表示通过检查它是否位于名为`init.d`的目录中的符号链接，来尝试猜测它是否为 init 脚本）。你可以明确地将它设置为`service`，这样 `stop

start

status

restart`命令可以工作，或者如果你想在 foreground 中运行脚本，你可以将它设置为`run`。

RUN_AS_USER

将用于运行应用程序的用户。未设置时，将使用拥有 jar 文件的用户。

USE_START_STOP_DAEMON

当 start-stop-daemon`命令可用的情况下，是否应使用它来控制该过程。默认为`true。

PID_FOLDER

pid 文件夹的根名称（默认为`/var/run`）。

LOG_FOLDER

放置日志文件的文件夹名称（默认为`/var/log`）。

CONF_FOLDER

从中读取 .conf 文件的文件夹名称（默认为 jar 文件所在的文件夹）。

LOG_FILENAME

LOG_FOLDER`中的日志文件名（默认为&lt;appname&gt;.log`）。

APP_NAME

应用程序的名称。如果 jar 文件从符号链接运行，脚本会猜测应用程序名称。如果不是符号链接，或者你想要明确设置应用程序名称，这可能很有用。

RUN_ARGS

传递给程序（Spring Boot 应用程序）的参数。

JAVA_HOME

默认情况下，java`可执行文件的位置是通过使用`PATH`来发现的，但如果在$JAVA_HOME/bin/java`处有可执行文件，你可以明确地设置它。

JAVA_OPTS

在启动 JVM 时传递给它的选项。

JARFILE

jar 文件的明确位置，以防脚本用来启动未实际嵌入的 jar 文件。

DEBUG

如果非空，在 shell 进程上设置 `-x`标志，允许你在脚本中查看该逻辑。

STOP_WAIT_TIME

PID_FOLDER、LOG_FOLDER`和`LOG_FILENAME`变量仅对`init.d`服务有效。对于`systemd，使用`service` 脚本进行等效自定义。有关详细信息，请参阅 service unit configuration man page。
Using a Conf File

除了`JARFILE`和`APP_NAME`之外，前面部分列出的设置都可以使用 .conf`文件进行配置。该文件应位于 jar 文件旁边，并且具有相同名称，但后缀为 `.conf，而不是 .jar。例如，名为`/var/myapp/myapp.jar`的 jar 使用名为`/var/myapp/myapp.conf`的配置文件，如下面的示例所示：

myapp.conf
JAVA_OPTS=-Xmx1024M
LOG_FOLDER=/custom/log/folder

如果你不喜欢配置文件位于 jar 文件旁边，你可以设置一个`CONF_FOLDER`环境变量来自定义配置文件的位置。

要了解如何适当保护此文件，请参阅the guidelines for securing an init.d service。

Microsoft Windows Services

Spring Boot 应用程序可以通过使用 winsw 作为 Windows 服务启动。

一个（ separately maintained sample）逐步描述了如何为你的 Spring Boot 应用程序创建一个 Windows 服务。