SpringBoot2.X 实战12-安装为systemd服务部署

一.前言

除了使用java -jar运行SpringBoot应用程序之外,还可以为Unix系统创建完全可执行的应用程序。一个完全可执行的jar可以像任何其他可执行二进制文件一样执行,也可以用 init.d 或 systemd 注册它。这使得在常见的生产环境中很容易安装和管理SpringBoot应用程序。

完全可执行的jar通过在文件的前面嵌入额外的脚本来工作。目前,一些工具不接受这种格式,所以您可能不能总是使用这种技术。例如,jar -xf可能无法提取已完全可执行的jar或war。建议只在打算直接执行jar或war时才完全执行它,而不是使用java -jar运行它或将它部署到servlet容器中。
要使用Maven创建一个“完全可执行的”jar,请使用以下插件配置


  org.springframework.boot
  spring-boot-maven-plugin
  
    true
  

然后您可以通过键入./my-application.jar来运行您的应用程序(其中my-application是您的工程的名称)。包含jar的目录用作应用程序的工作目录。

二.添加 Unix/Linux 服务支持

通过使用 init.d 或 systemd, Spring-Boot应用程序可以很容易地作为Unix/Linux服务启动。

1.作为 init.d 服务安装

如果您将Spring Boot的Maven插件配置为生成一个完全可执行的jar,而不使用自定义embeddedLaunchScript,则可以将应用程序用作init.d服务。为此,将jar符号链接到init.d支持标准的start、stop、restart和status命令。
该脚本支持以下功能:

  • 以拥有jar文件的用户的身份启动服务
  • 使用/var/run//.pid跟踪应用程序的PID
  • 将控制台日志写入/var/log/.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/.log的日志文件是否有错误。

2. 保护 init.d 服务

当以 root 执行时,就像使用 root 启动 init.d 服务一样,默认的可执行脚本以拥有jar文件的用户的身份运行应用程序。您不应该以 root 的身份运行Spring-Boot应用程序,因此您的应用程序的jar文件不应该由XXXX拥有。相反,创建一个特定的用户来运行您的应用程序,并使用chown使其成为jar文件的所有者,如下面的示例所示:

$ chown bootapp:bootapp your-app.jar

3.安装为systemd服务

systemd是System V init系统的继承者,现在被许多现代Linux发行版使用。
可以继续通过systemd 使用 init.d 脚本,还可以使用systemd 'service' 脚本启动Spring引导应用程序。

假设您在 /opt/exec/ 中安装了一个Spring Boot应用程序,
要将Spring引导应用程序安装为systemd服务,
创建一个名为 executable.service 的脚本。并将其放在/etc/systemd/system目录中。
下面的脚本提供了一个例子:

[Unit]
# 服务描述
Description=executable
# 指定了在systemd在执行完那些target之后再启动该服务
Documentation=https://www.baidu.com
After=syslog.target

[Service]
User=bootapp
ExecStartexecutable.jar run
ExecReload=/opt/exec/executable.jar restart
ExecStop=/opt/exec/executable.jar stop
SuccessExitStatus=143
Restart=always
PrivateTmp=true=/opt/exec/

[Install]
# 多用户
WantedBy=multi-user.target

注意,与作为 init.d 服务运行时不同,运行应用程序、PID文件和控制台日志文件的用户由systemd本身管理,因此必须使用“服务”脚本中的适当字段进行配置。有关详细信息,请参阅服务单元配置手册页。
要标记应用程序在系统启动时自动启动,请使用以下命令:

systemctl enable executable.service

除了JARFILE和APP_NAME之外,可以使用.conf文件配置上一节中列出的设置。
该文件应该放在jar文件旁边,并且具有相同的名称,但是后缀是.conf而不是.jar。
例如,一个名为/opt/exec/executable.jar 的jar 使用名为 /opt/exec/executable.jar 的配置文件。
如下例所示:
executable.conf

序号 名称 说明
1 MODE 操作的“模式”。默认值取决于构建jar的方式,但通常是自动的(这意味着它试图通过检查init.d目录中的符号链接来猜测它是否是init脚本)。您可以显式地将其设置为service,以便stop/start/status/restart命令可以工作,或者如果您想在前台运行脚本,可以运行该命令。
2 USE_START_STOP_DAEMON 当start-stop-daemon命令可用时,是否应该使用它来控制进程。默认值为true。
3 PID_FOLDER pid文件夹的根名称(默认/var/run)。
4 LOG_FOLDER 存放日志文件的文件夹的名称(默认情况下是/var/log)。
5 CONF_FOLDER 要从中读取.conf文件的文件夹的名称(默认情况下与jar-file相同)。
6 LOG_FILENAME LOG_FOLDER中的日志文件的名称(默认情况下.log)。
7 APP_NAME 如果jar从符号链接运行,脚本将猜测应用程序的名称。如果它不是一个符号链接,或者您想显式地设置应用程序名称,这将非常有用。
8 RUN_ARGS 传递给程序(Spring Boot应用程序)的参数。
9 JAVA_HOME 默认情况下,通过使用路径可以发现java可执行文件的位置,但是如果在$JAVA_HOME/bin/java中有一个可执行文件,则可以显式地设置它。
10 JAVA_OPTS 启动JVM时传递给JVM的选项。
11 JARFILE jar文件的显式位置,以防脚本用于启动一个实际上没有嵌入的jar。
12 DEBUG 如果不是空的,则在shell进程上设置-x标志,使其更容易看到脚本中的逻辑。
13 STOP_WAIT_TIME 在强制关闭应用程序之前等待的时间(默认为60秒),以秒为单位。

示例

APP_NAME=executable
JAVA_HOME=/opt/soft/jdk1.8
# pid文件夹的根名称(默认/var/run)。
PID_FOLDER=/opt/exec/
# LOG_FOLDER中的日志文件的名称(默认.log)
LOG_FOLDER=/opt/exec/
#后台运行
MODE=service
JAVA_OPTS="-server -Xmx100m -Xms100m -Xloggc:/opt/exec/pandora_gc.log -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=utf-8"
#RUN_ARGS="--server.port=3011 --spring.profiles.active=debug --spring.pid.file=/tmp/logs/blog.pid"

你可能感兴趣的:(SpringBoot2.X 实战12-安装为systemd服务部署)