安装 Spring Boot 应用程序

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

作为 systemd 服务安装

systemd 是 System V init 系统的继任者，现在被许多现代 Linux 发行版使用。 Spring Boot 应用程序可以通过使用 systemd 的 ‘service’ 脚本来启动。

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

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

[Service]
User=myapp
Group=myapp

Type=exec
ExecStart=/path/to/java/home/bin/java -jar /var/myapp/myapp.jar
WorkingDirectory=/var/myapp
SuccessExitStatus=143

[Install]
WantedBy=multi-user.target

重要提示：请记住为您的应用程序更改 Description、User、Group、ExecStart 和 WorkingDirectory 字段。

注意：ExecStart 字段没有声明脚本操作命令，这意味着默认使用 run 命令。

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

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

$ systemctl enable myapp.service

运行 man systemctl 获取更多详细信息。

作为 init.d 服务安装（System V）

要将您的应用程序用作 init.d 服务，请配置其构建以生成 完全可执行的 jar。

警告：完全可执行的 jar 通过在文件开头嵌入额外的脚本来工作。 目前，某些工具不接受这种格式，因此您可能无法始终使用此技术。 例如，jar -xf 可能会在尝试提取已完全可执行的 jar 或 war 时静默失败。 建议仅在打算直接执行 jar 或 war 时，而不是使用 java -jar 运行或部署到 servlet 容器时，才将其设为完全可执行。

警告：zip64 格式的 jar 文件不能设为完全可执行。 尝试这样做将导致 jar 文件在直接执行或使用 java -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/<appname>/<appname>.pid 跟踪应用程序的 PID

  • 将控制台日志写入 /var/log/<appname>.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>

保护 init.d 服务

注意：以下是一组关于如何保护作为 init.d 服务运行的 Spring Boot 应用程序的指南。 这并非旨在详尽列出为强化应用程序及其运行环境而应做的所有事情。

当以 root 身份执行时（如使用 root 启动 init.d 服务的情况），默认的可执行脚本以 RUN_AS_USER 环境变量中指定的用户身份运行应用程序。 当未设置环境变量时，将使用拥有 jar 文件的用户。 您永远不应该以 root 身份运行 Spring Boot 应用程序，因此 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 来控制应用程序的服务，并且您 使用 .conf 文件 来自定义其启动，则 .conf 文件由 root 用户读取和评估。 它应该相应地受到保护。 使用 chmod 使文件只能由所有者读取，并使用 chown 使 root 成为所有者，如下例所示：

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

自定义启动脚本

Maven 或 Gradle 插件写入的默认嵌入式启动脚本可以通过多种方式进行自定义。 对于大多数人来说，使用默认脚本和一些自定义通常就足够了。 如果您发现无法自定义所需的内容，请使用 embeddedLaunchScript 选项完全编写自己的文件。

在写入时自定义启动脚本

在将启动脚本写入 jar 文件时自定义其元素通常是有意义的。 例如，init.d 脚本可以提供 “description”。 由于您预先知道描述（并且它不需要更改），您可以在生成 jar 时提供它。

要自定义写入的元素，请使用 Spring Boot Maven 插件的 embeddedLaunchScriptProperties 选项或 Spring Boot Gradle 插件的 launchScript 的 properties 属性。

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

名称 描述 Gradle 默认值 Maven 默认值

mode

脚本模式。

auto

auto

initInfoProvides

“INIT INFO” 的 Provides 部分

${task.baseName}

${project.artifactId}

initInfoRequiredStart

“INIT INFO” 的 Required-Start 部分。

$remote_fs $syslog $network

$remote_fs $syslog $network

initInfoRequiredStop

“INIT INFO” 的 Required-Stop 部分。

$remote_fs $syslog $network

$remote_fs $syslog $network

initInfoDefaultStart

“INIT INFO” 的 Default-Start 部分。

2 3 4 5

2 3 4 5

initInfoDefaultStop

“INIT INFO” 的 Default-Stop 部分。

0 1 6

0 1 6

initInfoShortDescription

“INIT INFO” 的 Short-Description 部分。

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

${project.name}

initInfoDescription

“INIT INFO” 的 Description 部分。

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

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

initInfoChkconfig

“INIT INFO” 的 chkconfig 部分

2345 99 01

2345 99 01

confFolder

CONF_FOLDER 的默认值

包含 jar 的文件夹

包含 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

在运行时自定义脚本

对于需要在 jar 写入 之后 自定义的脚本项，您可以使用环境变量或 配置文件。

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

变量 描述

MODE

操作的 “mode”。 默认值取决于 jar 的构建方式，但通常为 auto（意味着它通过检查它是否是 init.d 目录中的符号链接来尝试猜测它是否是 init 脚本）。 您可以显式地将其设置为 service，以便 stop|start|status|restart 命令工作，或者设置为 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 中日志文件的名称（默认为 <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 标志，允许您查看脚本中的逻辑。

STOP_WAIT_TIME

停止应用程序时等待的时间（以秒为单位），然后强制关闭（默认为 60）。

注意：PID_FOLDER、LOG_FOLDER 和 LOG_FILENAME 变量仅对 init.d 服务有效。 对于 systemd，等效的自定义是通过使用 ‘service’ 脚本进行的。 有关更多详细信息，请参阅 service unit configuration man page。

使用 Conf 文件

除了 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 环境变量来自定义配置文件的位置。

要了解如何适当地保护此文件，请参阅 保护 init.d 服务的指南。

Microsoft Windows 服务

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

一个（ 单独维护的示例）详细描述了如何为您的 Spring Boot 应用程序创建 Windows 服务。