SpringBoot项目在为开发者带来方便的同时，也带来了一个新的问题就是Jar包如何启动？在一般情况下我们都是采用了最为经典的java -jar 命令来进行启动。然后通过ps命令找到对应的应用线程通过kill命令来进行停止，如果想要对应用添加参数、添加其他的启动命令的时候就想对复杂了，为了解决这些问题，我们可以使用Shell脚本来进行Spring Boot应用的启停操作。

下面笔者就来分享一个运维大牛的SpringBoot启动脚本，通过Shell脚本可以轻松快速的实现Jar包的启动。

基础版本

#!/bin/bash

# Spring Boot JAR 文件路径
JAR_FILE="/data/app/bin/spring-boot-app.jar"

# 启动 Spring Boot 应用
start() {
    echo "Starting Spring Boot application..."
    nohup java -jar $JAR_FILE > /dev/null 2>&1 &
    echo "Spring Boot application started."
}

# 停止 Spring Boot 应用
stop() {
    echo "Stopping Spring Boot application..."
    PID=$(ps -ef | grep $JAR_FILE | grep -v grep | awk '{print $2}')
    if [ -n "$PID" ]; then
        kill -9 $PID
        echo "Spring Boot application stopped."
    else
        echo "Spring Boot application is not running."
    fi
}

# 重启 Spring Boot 应用
restart() {
    stop
    start
}

# 主函数，接收命令行参数
case "$1" in
    start)
        start
        ;;
    stop)
        stop
        ;;
    restart)
        restart
        ;;
    *)
        echo "Usage: $0 {start|stop|restart}"
        exit 1
        ;;
esac
exit 0

在这个脚本中，实现了对于Spring Boot应用启动、停止、以及重启操作。将上述脚本保存成一个.sh后缀的文件，例如start-spring-boot.sh。然后给该脚本赋予可执行的权限。如下所示。

chmod +x start-spring-boot.sh

接下来我们就可以通过如下的方式来调用脚本实现对于Spring Boot应用的启停操作了。

./start-spring-boot.sh start    # 启动应用
./start-spring-boot.sh stop     # 停止应用
./start-spring-boot.sh restart  # 重启应用

这里需要注意的是，需要将脚本中的JAR_FILE变量替换成你实际需要部署的jar包的路径，否则就无法使用该脚本了。当然对于变量的替换，可以放到自动发布里面。这又涉及到CICD的操作了。这里就不做过多的说明了。

当然有读者会问到，如果在启动过程中出现了报错，没有启动日志操作，根本无法定位到哪里错了，那么下面我们就对脚本进行修改，增加启动日志输出的操作。

添加启动日志功能

如果希望在启动SpringBoot应用的时候，将标准的输出日志记录到日志文件中，我们可以通过如下的方式来进行操作。

#!/bin/bash

# Spring Boot JAR 文件路径
JAR_FILE="/path/to/your/spring-boot-app.jar"

# 标准输出日志文件路径
OUT_LOG_FILE="/path/to/your/application.out.log"

# 启动 Spring Boot 应用
start() {
    echo "Starting Spring Boot application..."
    nohup java -jar $JAR_FILE >> $OUT_LOG_FILE 2>&1 &
    echo "Spring Boot application started. Standard output logged to: $OUT_LOG_FILE"
}

# 停止 Spring Boot 应用
stop() {
    echo "Stopping Spring Boot application..."
    PID=$(ps -ef | grep $JAR_FILE | grep -v grep | awk '{print $2}')
    if [ -n "$PID" ]; then
        kill -9 $PID
        echo "Spring Boot application stopped."
    else
        echo "Spring Boot application is not running."
    fi
}

# 重启 Spring Boot 应用
restart() {
    stop
    start
}

# 主函数，接收命令行参数
case "$1" in
    start)
        start
        ;;
    stop)
        stop
        ;;
    restart)
        restart
        ;;
    *)
        echo "Usage: $0 {start|stop|restart}"
        exit 1
        ;;
esac

exit 0

在上述脚本中，增加了一个OUT_LOG_FILE的变量，用来将标准输出记录到一个application.out.log日志文件中。这样如果在项目启动的时候出现了报错的情况，我们就可以从application.out.log日志文件中知道是什么报错了。

添加远程调试功能？

在一般情况下，当项目上线之后，很少会出现问题，但是在一些性能调优的场景下，我们需要开启项目的远程调试功能。而我们也可以将这个开启远程调试的功能添加到Shell脚本中，这样也方便我们对应用开启远程调试功能来进行性能调优或者是问题查找定位。

启动脚本时可以选择是否启用远程调试，并且在正常情况下仍然正常启动应用，可以修改脚本以支持通过命令参数来控制是否启用远程调试。如下所示。

#!/bin/bash

# Spring Boot JAR 文件路径
JAR_FILE="/path/to/your/spring-boot-app.jar"

# 标准输出日志文件路径
OUT_LOG_FILE="/path/to/your/application.out.log"

# 远程调试端口
DEBUG_PORT=5005

# 启动 Spring Boot 应用
start() {
    echo "Starting Spring Boot application..."
    nohup java -jar $JAR_FILE >> $OUT_LOG_FILE 2>&1 &
    echo "Spring Boot application started. Standard output logged to: $OUT_LOG_FILE"
}

# 带调试模式启动 Spring Boot 应用
start_debug() {
    echo "Starting Spring Boot application with remote debugging..."
    nohup java -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:$DEBUG_PORT -jar $JAR_FILE >> $OUT_LOG_FILE 2>&1 &
    echo "Spring Boot application started with remote debugging enabled. Standard output logged to: $OUT_LOG_FILE"
    echo "Remote debugging port: $DEBUG_PORT"
}

# 停止 Spring Boot 应用
stop() {
    echo "Stopping Spring Boot application..."
    PID=$(ps -ef | grep $JAR_FILE | grep -v grep | awk '{print $2}')
    if [ -n "$PID" ]; then
        kill -9 $PID
        echo "Spring Boot application stopped."
    else
        echo "Spring Boot application is not running."
    fi
}

# 重启 Spring Boot 应用
restart() {
    stop
    if [ "$1" = "debug" ]; then
        start_debug
    else
        start
    fi
}

# 主函数，接收命令行参数
case "$1" in
    start)
        start
        ;;
    start_debug)
        start_debug
        ;;
    stop)
        stop
        ;;
    restart)
        restart $2
        ;;
    *)
        echo "Usage: $0 {start|start_debug|stop|restart [debug]}"
        exit 1
        ;;
esac
exit 0

在上述脚本中设置了5005用来开启远程调用，可以通过如下的方式来开启远程调用。

./start-spring-boot.sh start               # 启动应用
./start-spring-boot.sh start_debug         # 带远程调试模式启动应用
./start-spring-boot.sh stop                # 停止应用
./start-spring-boot.sh restart             # 重启应用（不开启远程调试）
./start-spring-boot.sh restart debug       # 重启应用并开启远程调试

总结

当然上述Shell脚本只是展示了一些简单的功能，感兴趣的读者可以基于上述脚本进行进一步的优化，例如可以在脚本中设置JVM启动参数、可以设置堆栈信息、可以设置是否开启JVM日志等操作。当然上述脚本也可以通过CICD平台直接发送到对应的应用器上并且可以实现根据不同的服务器配置将配置路径在打包的时候进行替换等操作。需要根据实际的项目需要来对上述的脚本进行进一步的优化。

Linux中如何通过Shell脚本来控制Spring Boot的Jar包启停服务?

基础版本

添加启动日志功能

添加远程调试功能？

总结

相关文章