Schnelle SpringBoot-Integration (Linux / UNIX)

SpringBoot 4.1.x-Integration

In diesem Abschnitt werden die Schritte beschrieben, um schnell mit SpringBoot 4.1.0 loszulegen. Andere Versionen sollten auf ähnliche Weise funktionieren.

Diese Konfiguration basiert auf dem Starten einer SpringBoot-Anwendung als eigenständigen Server.

SpringBoot-Anwendung erstellen

SpringBoot wird nicht als eigenständiger Server heruntergeladen. Dieses Dokument setzt voraus, dass Sie in der Lage sind, Ihr ausführbares SpringBoot-Fat-JAR zu erstellen.

Für dieses Beispiel verwenden wir das gs-spring-boot-Projekt, eine einfache Hello-World-Anwendung. Klonen Sie eine lokale Kopie des Repositorys. Wechseln Sie in das Verzeichnis complete des Projekts und führen Sie mvn package aus. Dadurch wird die Datei target/spring-boot-complete-0.0.1-SNAPSHOT.jar erstellt.

Erstellen Sie ein gleichrangiges Verzeichnis spring-boot-complete, in dem wir die Anwendung aufbauen. Kopieren Sie das oben genannte ausführbare JAR in dieses Verzeichnis als spring-boot-complete/lib/spring-boot-complete-0.0.1-SNAPSHOT.jar

Wrapper herunterladen

Die folgenden Schritte sind für die Version 3.7.4 des Java Service Wrappers ausgelegt. Die Verwendung früherer Versionen ist möglich, erfordert jedoch wahrscheinlich einige Änderungen.

Entscheiden Sie, welche Edition Sie verwenden möchten (Professional, Standard oder Community), und wählen Sie die Zielplattform, Bittiefe und Architektur. Dann laden Sie das Installationsprogramm oder Archiv herunter und installieren bzw. entpacken Sie es. Wir gehen davon aus, dass Sie die Professional 64-Bit-Edition unter Linux x86 verwenden.

Wrapper-Integration

Um die Platzierung der erforderlichen Wrapper-Dateien zu erleichtern, erstellen Sie das folgende Shell-Skript in Ihrem Verzeichnis spring-boot-complete als updateWrapper.sh. Passen Sie den Speicherort an, an dem Sie den Wrapper oben installiert oder entpackt haben. Vergessen Sie nicht, es ausführbar zu machen.

#!/bin/sh
WRAPPER_HOME=../wrapper-linux-x86-64-3.7.4-pro
SBAPP_HOME=.
WRAPPER_SCRIPT=service.sh

mkdir -p ${SBAPP_HOME}/bin
mkdir -p ${SBAPP_HOME}/lib
if [ -d ${WRAPPER_HOME}/lang ]
then
    mkdir -p ${SBAPP_HOME}/lang
    cp -n ${WRAPPER_HOME}/lang/wrapper_*.mo ${SBAPP_HOME}/lang/.
    cp -n ${WRAPPER_HOME}/lang/wrapperjni_*.mo ${SBAPP_HOME}/lang/.
fi
mkdir -p ${SBAPP_HOME}/conf
if [ -f ${WRAPPER_HOME}/src/conf/wrapper-license-time.conf ]
then
    cp -n ${WRAPPER_HOME}/src/conf/wrapper-license-time.conf ${SBAPP_HOME}/conf/wrapper-license.conf
fi
mkdir -p ${SBAPP_HOME}/logs

cp ${WRAPPER_HOME}/bin/wrapper ${SBAPP_HOME}/bin/wrapper
cp ${WRAPPER_HOME}/lib/wrapper.jar ${SBAPP_HOME}/lib/.
cp ${WRAPPER_HOME}/lib/libwrapper.* ${SBAPP_HOME}/lib/.
cp ${WRAPPER_HOME}/src/bin/App.sh.in ${SBAPP_HOME}/bin/${WRAPPER_SCRIPT}

sed -i '' \
  -e 's|@app\.name@|sbapp|g' \
  -e 's|@app\.long\.name@|SBApp|g' \
  ${SBAPP_HOME}/bin/${WRAPPER_SCRIPT}
chmod +x ${SBAPP_HOME}/bin/${WRAPPER_SCRIPT}

Führen Sie das Skript aus:

./updateWrapper.sh

Die Konfiguration verwendet die Integrationsmethode 4.

NOTE

Die Variable JAVA_HOME muss gesetzt sein, verwendet jedoch standardmäßig die Systemumgebung, falls sie dort definiert ist. Die SpringBoot-4.1.x-Serie erfordert, dass mindestens Java 17 angegeben wird.

Erstellen Sie die Wrapper-Konfigurationsdatei als conf/wrapper.conf mit folgendem Inhalt:

@encoding=UTF-8
# The configuration file must begin with a line declaring its encoding.

# Default mode for file inclusions
@include.default_mode=required

# Include file problems can be debugged by removing '#' at the beginning
#  of the following line:
#@include.debug

#********************************************************************
# Wrapper License Properties (Ignored by Community Edition)
#********************************************************************
# Professional and Standard Editions of the Wrapper require a valid
#  License Key to start.  Licenses can be purchased or a trial license
#  requested on the following pages:
# https://wrapper.tanukisoftware.com/purchase
# https://wrapper.tanukisoftware.com/trial

# The Wrapper will look for either of the following optional files for a
#  valid License Key.  License Key properties can optionally be included
#  directly in this configuration file.
@include.optional ../conf/wrapper-license.conf
@include.optional ../conf/wrapper-license-%WRAPPER_HOST_NAME%.conf

# The following property will output information about which License Key(s)
#  are being found, and can aid in resolving any licensing problems.
#wrapper.license.debug=TRUE

#********************************************************************
# Environment
#********************************************************************
set.default.JAVA_HOME=(SetMe)

#********************************************************************
# Wrapper Localization
#********************************************************************
# Specify the language and locale which the Wrapper should use.
#wrapper.lang=en_US # en_US or ja_JP

# Specify the location of the language resource files (*.mo).
wrapper.lang.folder=../lang

#********************************************************************
# Wrapper Java Properties
#********************************************************************
# Java Application
wrapper.java.command=%JAVA_HOME%/bin/java

# Tell the Wrapper to log the full generated Java command line.
#wrapper.java.command.loglevel=INFO

# Wrapper Jar file
wrapper.jarfile=../lib/wrapper.jar

# Log level for notices about missing Java Classpath entries.
wrapper.java.classpath.missing.loglevel=WARN

# Java Version control
wrapper.java.version.output=true
wrapper.java.version.min=17
#wrapper.java.version.max=

# Java Classpath.  Add class path elements as needed starting from 1
wrapper.java.classpath.1=../lib/*.jar

# Java Modulepath. (Requires Java 9 or above)
#  Add module path elements as needed starting from 1
#wrapper.java.module_path.1=

# Java Module list. (Requires Java 9 or above)
#  Add module names as needed starting from 1
#wrapper.java.module.1=

# Java Library Path (location of wrapper.dll or libwrapper.so)
wrapper.java.library.path.1=../lib

# Java Bits.  On applicable platforms, tells the JVM to run in 32 or 64-bit mode.
wrapper.java.additional.auto_bits=TRUE

# Java Additional Parameters
wrapper.java.additional.1=

# Initial Java Heap Size (in MB)
#wrapper.java.initmemory=3

# Maximum Java Heap Size (in MB)
wrapper.java.maxmemory=256

# Application System Properties passed via the backend.
#  Core Java System Properties must be passed using wrapper.java.additional.<n>.
#wrapper.app.property.1=

# Java Main class.  This class must implement the WrapperListener interface
#  or guarantee that the WrapperManager class is initialized.
#  Helper classes are provided to do this for you.
#  See the following page for details:
#  https://wrapper.tanukisoftware.com/doc/english/integrate.html
wrapper.java.mainclass=org.tanukisoftware.wrapper.WrapperJarApp

# Application parameters.
#  Pass parameters via the backend instead of the command line.
#wrapper.app.parameter.backend=TRUE

#  Add parameters as needed starting from 1
wrapper.app.parameter.1=../lib/spring-boot-complete-0.0.1-SNAPSHOT.jar
    
# Point Spring Boot at external configuration
wrapper.app.parameter.2=--spring.config.location=file:../conf/

# Optional but recommended: also externalize logging config
wrapper.app.parameter.3=--logging.config=file:../conf/logback-spring.xml	

#********************************************************************
# Wrapper Logging Properties
#********************************************************************
# Enables Debug output from the Wrapper.
# wrapper.debug=TRUE

# Format of output for the console.  (See docs for formats)
wrapper.console.format=LPTM

# Log Level for console output.  (See docs for log levels)
wrapper.console.loglevel=INFO

# Log file to use for Wrapper output logging.
wrapper.logfile=../logs/wrapper.log

# Format of output for the log file.  (See docs for formats)
wrapper.logfile.format=LPTM

# Log Level for log file output.  (See docs for log levels)
wrapper.logfile.loglevel=INFO

# Roll mode of the log file.
#  SIZE_OR_WRAPPER causes the file to be rolled whenever its size exceeds the
#  value defined by wrapper.logfile.maxsize, or whenever the Wrapper is
#  launched.
wrapper.logfile.rollmode=SIZE_OR_WRAPPER

# Maximum size that the log file will be allowed to grow to before
#  the log is rolled. Size is specified in bytes.  The default value
#  of 0 disables log rolling.  May abbreviate with the 'k' (kb) or
#  'm' (mb) suffixes.  For example: 10m = 10 megabytes.
wrapper.logfile.maxsize=10m

# Maximum number of rolled log files which will be allowed before old
#  files are deleted.  The default value of 0 implies no limit.
wrapper.logfile.maxfiles=9

# Log Level for sys/event log output.  (See docs for log levels)
wrapper.syslog.loglevel=NONE

#********************************************************************
# Wrapper General Properties
#********************************************************************
# Allow for the use of non-contiguous numbered properties
wrapper.ignore_sequence_gaps=TRUE

# Do not start if the pid file already exists.
wrapper.pidfile.strict=TRUE

# Title to use when running as a console
wrapper.console.title=SpringBoot Server

#********************************************************************
# Wrapper JVM Checks
#********************************************************************
# Detect DeadLocked Threads in the JVM. (Requires Standard Edition)
wrapper.check.deadlock=TRUE
wrapper.check.deadlock.interval=60
wrapper.check.deadlock.action=RESTART
wrapper.check.deadlock.output=FULL

# Out Of Memory detection.
#  Ignore -verbose:class output to avoid false positives.
wrapper.filter.trigger.1000=[Loaded java.lang.OutOfMemoryError
wrapper.filter.action.1000=NONE
#  Ignore -Xlog:class+load=level output to avoid false positives.
wrapper.filter.trigger.1001=[class,load] java.lang.OutOfMemoryError
wrapper.filter.action.1001=NONE
# (Simple match)
wrapper.filter.trigger.1002=java.lang.OutOfMemoryError
# (Only match text in stack traces if -XX:+PrintClassHistogram is being used.)
#wrapper.filter.trigger.1002=Exception in thread "*" java.lang.OutOfMemoryError
#wrapper.filter.allow_wildcards.1002=TRUE
wrapper.filter.action.1002=RESTART
wrapper.filter.message.1002=The JVM has run out of memory.

#********************************************************************
# Wrapper Email Notifications. (Requires Professional Edition)
#********************************************************************
# Common Event Email settings.
#wrapper.event.default.email.debug=TRUE
#wrapper.event.default.email.smtp.host=<SMTP_Host>
#wrapper.event.default.email.smtp.port=25
#wrapper.event.default.email.subject=[%WRAPPER_HOSTNAME%:%WRAPPER_NAME%:%WRAPPER_EVENT_NAME%] Event Notification
#wrapper.event.default.email.sender=<Sender email>
#wrapper.event.default.email.recipient=<Recipient email>

# Configure the log attached to event emails.
#wrapper.event.default.email.maillog=ATTACHMENT
#wrapper.event.default.email.maillog.lines=50
#wrapper.event.default.email.maillog.format=LPTM
#wrapper.event.default.email.maillog.loglevel=INFO

# Enable specific event emails.
#wrapper.event.wrapper_start.email=TRUE
#wrapper.event.jvm_prelaunch.email=TRUE
#wrapper.event.jvm_start.email=TRUE
#wrapper.event.jvm_started.email=TRUE
#wrapper.event.jvm_deadlock.email=TRUE
#wrapper.event.jvm_stop.email=TRUE
#wrapper.event.jvm_stopped.email=TRUE
#wrapper.event.jvm_restart.email=TRUE
#wrapper.event.jvm_failed_invocation.email=TRUE
#wrapper.event.jvm_max_failed_invocations.email=TRUE
#wrapper.event.jvm_kill.email=TRUE
#wrapper.event.jvm_killed.email=TRUE
#wrapper.event.jvm_unexpected_exit.email=TRUE
#wrapper.event.wrapper_stop.email=TRUE

# Specify custom mail content
wrapper.event.jvm_restart.email.body=The JVM was restarted.\n\nPlease check on its status.\n

#********************************************************************
# Wrapper Secure File Properties
#********************************************************************
# To enforce the principle of least privilege for files containing
#  sensitive data, the Wrapper requires that all permissions granted
#  to these files be explicitly allowed in the configuration.
#  Please read the documentation for the full list of properties.

# Allow specific accounts or groups on Windows.
#wrapper.secure_file.check.windows.allowed_account.1=NT AUTHORITY\SYSTEM
#wrapper.secure_file.check.windows.allowed_account.2=BUILTIN\Administrators

# Allow specific groups on Unix systems.
#wrapper.secure_file.check.unix.allowed_group.1=<Group_Of_Users>

# Additional files to check for permissions (Requires Standard Edition)
#wrapper.secure_file.additional.1=<Secured_File>

#********************************************************************
# Wrapper Windows Service Properties
#********************************************************************
# WARNING - Do not modify any of these properties when an application
#  using this configuration file has been installed as a service.
#  Please uninstall the service before modifying this section.
#  The service can then be reinstalled.

# Name of the service
wrapper.name=springboot

# Display name of the service
wrapper.displayname=SpringBoot

# Description of the service
wrapper.description=SpringBoot Server

# Service dependencies.  Add dependencies as needed starting from 1
wrapper.ntservice.dependency.1=

# Mode in which the service is installed.
#  AUTO_START, DELAY_START (Requires Standard Edition) or DEMAND_START
wrapper.ntservice.starttype=AUTO_START

# Account to use when running the service.
#  The default blank value will use LocalSystem, which is highly privileged
#  account on Windows. Please read the documentation page for this property to
#  learn about other account types that can be used.
wrapper.ntservice.account=

# Allow the current user to perform certain actions without being prompted for
#  administrator credentials. (Requires Professional Edition)
#wrapper.ntservice.permissions.1.account=CURRENT_USER
#wrapper.ntservice.permissions.1.allow=START, STOP, PAUSE_RESUME

Obwohl sie für dieses einfache SpringBoot-JAR nicht erforderlich sind, enthält die obige Konfigurationsdatei Anwendungsparameter (wrapper.app.parameter.2 und wrapper.app.parameter.3), um den Speicherort externer Konfigurationsdateien und der Logging-Konfiguration anzugeben:

  • --spring.config.location gibt den Speicherort einer optionalen Datei application.properties an.

  • --logging.config gibt den Speicherort einer Datei logback-spring.xml an.

Erstellen Sie als Beispiel die folgende Datei conf/logback-spring.xml:

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <include resource="org/springframework/boot/logging/logback/defaults.xml"/>

    <property name="LOG_PATH" value="${LOG_PATH:-../logs}"/>
    <property name="LOG_FILE" value="${LOG_FILE:-sbapp}"/>

    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_PATH}/${LOG_FILE}.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>${LOG_PATH}/${LOG_FILE}.%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <maxFileSize>50MB</maxFileSize>
            <maxHistory>30</maxHistory>
            <totalSizeCap>2GB</totalSizeCap>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <root level="INFO">
        <appender-ref ref="FILE"/>
    </root>
</configuration>

NOTE

Wenn Sie die Standard oder Professional Edition verwenden, dann wurde eine standardmäßige 15-Minuten-Lizenz als etc/wrapper-license.conf kopiert. Sie müssen diese mit einer Trial-, Server- oder Development-Lizenz aktualisieren, um länger als diese Zeitspanne ausführen zu können.

Ausführen

Zum Ausführen in einer Konsole:

  • Ausführen: bin/service.sh console

Zum Ausführen als daemon (service):

  • Installieren Sie den Dienst mit: bin/service.sh install

  • Starten Sie anschließend den Dienst mit: bin/service.sh start

  • Stoppen Sie den Dienst mit: bin/service.sh stop

  • Deinstallieren Sie den Dienst mit: bin/service.sh remove

Für eine Liste der verfügbaren Befehle:

  • Ausführen: bin/service.sh

Feedback-Anfrage

Wenn Sie ein SpringBoot-Power-User sind und Vorschläge zur Verbesserung dieses Dokuments haben, lassen Sie es uns bitte unter support@tanukisoftware.com wissen.