在Linux下使用shell脚本管理Java的应用程序

前言

在日常开发和运维工作中，管理基于Java的应用程序是一项基础且频繁的任务。本文将通过一个示例脚本，展示如何利用Shell脚本简化这一流程，实现Java应用的一键式启动、停止与重启操作。本脚本不仅提升了工作效率，还确保了操作的标准化与可靠性。

一、目录结构

这是一个典型的Java项目部署结构，其中user_defined目录用于存放管理应用的各种脚本，其下细分有多个子目录以组织不同的资源。

.
├─user_defined     # 使用者自定义目录名      
│  ├─bin           # 脚本存放目录
│  ├─conf          # 配置文件目录
│  ├─lib           # 应用依赖的jar包存放目录
│  ├─log           # 应用日志输出目录
│  ├─pid           # 存放进程ID文件的目录
│  └─sql           # SQL脚本或数据相关文件

二、脚本实现

1. 脚本内容

#!/bin/bash

# 检查脚本是否被传递了有效的命令
if [ -z "$1" ]; then
  echo "Usage: $0 {start|stop|restart}"
  exit 1
fi

# jar包名称，不带.jar后缀
JAR_NAME='example'
# 获取当前脚本所在的目录
SCRIPT_BIN="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
# jar包主目录
JARPACKAGE_HOME="$SCRIPT_BIN/.."

# 设置jar包的路径
JAR_PATH="$JARPACKAGE_HOME/lib/$JAR_NAME.jar"

# 检查当前目录下是否存此jar文件
if [ ! -f "$JAR_PATH" ]; then
  echo "Error: $JAR_NAME.jar not found."
  exit 1
fi

# 定义运行的Java命令
JAVA_CMD="java -jar $JAR_PATH"

# 创建pid目录，如果不存在
PID_DIR="$JARPACKAGE_HOME/pid"
mkdir -p "$PID_DIR"

# 启动jar包
start() {
  echo "Starting jar package..."
  # nohup $JAVA_CMD > /dev/null 2>&1 &
  # 使用nohup在后台运行jar包，并将日志输出到文件
  nohup $JAVA_CMD > $JARPACKAGE_HOME/log/${JAR_NAME}.log 2>&1 &
  echo $! > "$PID_DIR/$JAR_NAME.pid"
  echo "Jar package is started. pid is saved in $PID_DIR/$JAR_NAME.pid"
}

# 停止jar包
stop() {
  echo "Stopping jar package..."
  PID=$(cat "$PID_DIR/$JAR_NAME.pid")
  if [ -n "$PID" ]; then
    kill $PID
    echo "Jar package has been stopped"
    yes | rm "$PID_DIR/$JAR_NAME.pid"
  else
    echo "Error: Jar package is not running."
  fi
}

# 重启jar package
restart() {
  echo "Restarting jar package..."
  stop
  sleep 3
  start
}

# 根据传入的参数调用相应的方法
case "$1" in
  start)
    start
    ;;
  stop)
    stop
    ;;
  restart)
    restart
    ;;
  *)
    echo "Error: Invalid command. Use {start|stop|restart}."
    exit 1
    ;;
esac

exit 0

2. 使用说明

2.1 配置脚本

修改脚本以适配你的应用：打开提供的Shell脚本模板，找到JAR_NAME变量，将其值更改为你的Java应用程序jar包名称（不包含.jar后缀）。如果Java应用运行时需要额外参数，可以在JAVA_CMD变量中追加这些参数。

2.2 脚本部署

保存脚本：将修改后的脚本保存为.sh文件，推荐命名为与你的应用相关的易于识别的名字，如myapp-manager.sh。
构建目录结构：依据之前提到的目录结构图，在你的工作目录下创建相应的目录。确保bin目录下存放着你的Shell脚本，而lib目录内则需放入对应的jar包。

2.3 操作你的Java应用

启动应用：通过终端切换到脚本所在的bin目录，然后运行以下命令启动应用：
```
./myapp-manager.sh start
```
这将会后台启动你的Java应用，并将输出信息保存到log目录下.log结尾的日志文件中，同时在pid目录下生成一个包含应用进程ID的文件。
停止应用：当需要关闭应用时，执行：
```
./myapp-manager.sh stop
```
此命令会读取PID文件，发送终止信号给应用进程，并清理PID文件。
重启应用：如果需要重启应用以应用最新更改，仅需输入：
```
./myapp-manager.sh restart
```
这个操作会自动完成停止和再次启动的全过程，中间包含短暂的等待时间以确保平稳过渡。

总结

通过上述Shell脚本，我们不仅实现了Java应用的便捷管理，还保证了操作的自动化与标准化，大大减轻了运维负担。无论是日常开发调试还是生产环境的部署维护，这样的脚本都是提升效率的利器。