最近项目有需要的关系,就抽出点时间研究了一下 Linux 下使用脚本启动Java应用的方式。很简单,大家作为参考。
这个脚本是在网上找到一个挺好的通用 shell 脚本。只需要修改一些配置变量,就可以用来做起动脚本了。并且除了能起动、还支持关闭、重启、查看是否正在运行的功能。
start 函数中,nohup 部分其实也可以提出来放入一个配置变量中。
项目介绍
项目说明
这是一个Web项目,在其中提供了一个包含main方法的Java类作为启动类。项目的功能就是每隔两秒钟打印日志到 /tmp/Alog.log 文件中。
项目源码
/**
* 启动类
*/
public class Test {
public static void main(String[] args) throws InterruptedException {
while (true) {
// 每两秒打印一次日志
Thread.sleep(2000);
new Thread(new Runnable() {
@Override
public void run() {
// 打印日志
new ClassA().printLog();
}
}).start();
}
}
}
import org.apache.log4j.Logger;
/**
* 打印日志的类
*/
public class ClassA {
private static Logger logger = Logger.getLogger(ClassA.class);
public void printLog() {
// 记录debug级别的信息
logger.debug("这是 debug 消息。");
}
}
log4j.properties 文件
### 输出信息到控制抬 ###
log4j.appender.stdout = org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target = System.out
log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern = [%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%n%m%n
### 输出DEBUG 级别以上的日志到=E://logs/Alog.log ###
log4j.logger.com.lpf.ClassA= DEBUG, A, stdout
log4j.appender.A=org.apache.log4j.FileAppender
log4j.appender.A.File=/tmp/Alog.log
log4j.appender.A.layout=org.apache.log4j.PatternLayout
log4j.appender.A.layout.ConversionPattern=%d %p [%c] - %m%n
代码很简单,就不做过多的解释了。
打包方式
选中项目—>右键—>Export—>WAR file
部署项目
将打包好的项目上传到 Linux 服务器上,使用如下命令解压:
[root@peipei3514 src]# unzip -oq Linux_Java_Shell.war -d /usr/local/Linux_Java_Shell
命令解释:
- -o 不必先询问用户,unzip执行后覆盖原有文件;
- -q 执行时不显示任何信息;
- -d <目录> 指定文件解压缩后所要存储的目录。
启动脚本
#!/bin/sh
#该脚本为Linux下启动java程序的通用脚本。既可以作为开机自启动service脚本被调用,
#也可以作为启动java程序的独立脚本来使用。
#
#警告!!!:该脚本stop部分使用系统kill命令来强制终止指定的java程序进程。
#在杀死进程前,未作任何条件检查。在某些情况下,如程序正在进行文件或数据库写操作,
#可能会造成数据丢失或数据不完整。如果必须要考虑到这类情况,则需要改写此脚本,
#增加在执行kill命令前的一系列检查。
#
#
###################################
#环境变量及程序执行参数
#需要根据实际环境以及Java程序名称来修改这些参数
###################################
#JDK所在路径
JAVA_HOME="/usr/local/jdk1.8.0_161/"
#执行程序启动所使用的系统用户,考虑到安全,推荐不使用root帐号
RUNNING_USER=root
#Java程序所在的目录(classes的上一级目录)
APP_HOME=/usr/local/Linux_Java_Shell/WEB-INF/
#需要启动的Java主程序(main方法类)
APP_MAINCLASS=com.lpf.Test
#拼凑完整的classpath参数,包括指定lib目录下所有的jar
CLASSPATH=$APP_HOME/classes
for i in "$APP_HOME"/lib/*.jar; do
CLASSPATH="$CLASSPATH":"$i"
done
#java虚拟机启动参数
JAVA_OPTS="-ms512m -mx512m -Xmn256m -Djava.awt.headless=true -XX:MaxPermSize=128m"
###################################
#(函数)判断程序是否已启动
#
#说明:
#使用JDK自带的JPS命令及grep命令组合,准确查找pid
#jps 加 l 参数,表示显示java的完整包路径
#使用awk,分割出pid ($1部分),及Java程序名称($2部分)
###################################
#初始化psid变量(全局)
psid=0
checkpid() {
javaps=`$JAVA_HOME/bin/jps -l | grep $APP_MAINCLASS`
if [ -n "$javaps" ]; then
psid=`echo $javaps | awk '{print $1}'`
else
psid=0
fi
}
###################################
#(函数)启动程序
#
#说明:
#1. 首先调用checkpid函数,刷新$psid全局变量
#2. 如果程序已经启动($psid不等于0),则提示程序已启动
#3. 如果程序没有被启动,则执行启动命令行
#4. 启动命令执行后,再次调用checkpid函数
#5. 如果步骤4的结果能够确认程序的pid,则打印[OK],否则打印[Failed]
#注意:echo -n 表示打印字符后,不换行
#注意: "nohup 某命令 >/dev/null 2>&1 &" 的用法
###################################
start() {
checkpid
if [ $psid -ne 0 ]; then
echo "================================"
echo "warn: $APP_MAINCLASS already started! (pid=$psid)"
echo "================================"
else
echo -n "Starting $APP_MAINCLASS ..."
JAVA_CMD="nohup $JAVA_HOME/bin/java $JAVA_OPTS -classpath $CLASSPATH $APP_MAINCLASS >/dev/null 2>&1 &"
su - $RUNNING_USER -c "$JAVA_CMD"
checkpid
if [ $psid -ne 0 ]; then
echo "(pid=$psid) [OK]"
else
echo "[Failed]"
fi
fi
}
###################################
#(函数)停止程序
#
#说明:
#1. 首先调用checkpid函数,刷新$psid全局变量
#2. 如果程序已经启动($psid不等于0),则开始执行停止,否则,提示程序未运行
#3. 使用kill -9 pid命令进行强制杀死进程
#4. 执行kill命令行紧接其后,马上查看上一句命令的返回值: $?
#5. 如果步骤4的结果$?等于0,则打印[OK],否则打印[Failed]
#6. 为了防止java程序被启动多次,这里增加反复检查进程,反复杀死的处理(递归调用stop)。
#注意:echo -n 表示打印字符后,不换行
#注意: 在shell编程中,"$?" 表示上一句命令或者一个函数的返回值
###################################
stop() {
checkpid
if [ $psid -ne 0 ]; then
echo -n "Stopping $APP_MAINCLASS ...(pid=$psid) "
su - $RUNNING_USER -c "kill -9 $psid"
if [ $? -eq 0 ]; then
echo "[OK]"
else
echo "[Failed]"
fi
checkpid
if [ $psid -ne 0 ]; then
stop
fi
else
echo "================================"
echo "warn: $APP_MAINCLASS is not running"
echo "================================"
fi
}
###################################
#(函数)检查程序运行状态
#
#说明:
#1. 首先调用checkpid函数,刷新$psid全局变量
#2. 如果程序已经启动($psid不等于0),则提示正在运行并表示出pid
#3. 否则,提示程序未运行
###################################
status() {
checkpid
if [ $psid -ne 0 ]; then
echo "$APP_MAINCLASS is running! (pid=$psid)"
else
echo "$APP_MAINCLASS is not running"
fi
}
###################################
#(函数)打印系统环境参数
###################################
info() {
echo "System Information:"
echo "****************************"
echo `head -n 1 /etc/issue`
echo `uname -a`
echo
echo "JAVA_HOME=$JAVA_HOME"
echo `$JAVA_HOME/bin/java -version`
echo
echo "APP_HOME=$APP_HOME"
echo "APP_MAINCLASS=$APP_MAINCLASS"
echo "****************************"
}
###################################
#读取脚本的第一个参数($1),进行判断
#参数取值范围:{start|stop|restart|status|info}
#如参数不在指定范围之内,则打印帮助信息
###################################
case "$1" in
'start')
start
;;
'stop')
stop
;;
'restart')
stop
start
;;
'status')
status
;;
'info')
info
;;
esac
echo "Usage: $0 {start|stop|restart|status|info}"
exit 1
赋予脚本可执行权限:
- chmod 555 scriptname 允许任何人都具有可读权和执行权限;
- chmod +rx scriptname 允许任何人都具有可读权和执行权限;
- chmod u+rx scriptname 只给脚本的所有者可读和执行权限。
查看环境信息:
[root@peipei3514 Linux_Java_Shell]# ./Linux_Java_Shell.sh info
System Information:
****************************
\S
Linux peipei3514 3.10.0-693.21.1.el7.x86_64 #1 SMP Wed Mar 7 19:03:37 UTC 2018 x86_64 x86_64 x86_64 GNU/Linux
JAVA_HOME=/usr/local/jdk1.8.0_161/
java version "1.8.0_161"
Java(TM) SE Runtime Environment (build 1.8.0_161-b12)
Java HotSpot(TM) 64-Bit Server VM (build 25.161-b12, mixed mode)
APP_HOME=/usr/local/Linux_Java_Shell/WEB-INF/
APP_MAINCLASS=com.lpf.Test
****************************
Usage: ./Linux_Java_Shell.sh {start|stop|restart|status|info}
启动应用:
[root@peipei3514 Linux_Java_Shell]# ./Linux_Java_Shell.sh start
Starting com.lpf.Test ...(pid=1408) [OK]
Usage: ./Linux_Java_Shell.sh {start|stop|restart|status|info}
停止应用:
[root@peipei3514 Linux_Java_Shell]# ./Linux_Java_Shell.sh stop
Stopping com.lpf.Test ...(pid=1408) [OK]
Usage: ./Linux_Java_Shell.sh {start|stop|restart|status|info}
启动应用后,可以看到日志的输出:
[root@peipei3514 Linux_Java_Shell]# tail -f /tmp/Alog.log
2018-05-06 18:58:53,128 DEBUG [com.lpf.ClassA] - 这是 debug 消息。
2018-05-06 18:58:54,723 DEBUG [com.lpf.ClassA] - 这是 debug 消息。
2018-05-06 18:58:56,805 DEBUG [com.lpf.ClassA] - 这是 debug 消息。
2018-05-06 18:58:58,803 DEBUG [com.lpf.ClassA] - 这是 debug 消息。
2018-05-06 18:59:00,795 DEBUG [com.lpf.ClassA] - 这是 debug 消息。
2018-05-06 18:59:02,783 DEBUG [com.lpf.ClassA] - 这是 debug 消息。
2018-05-06 18:59:04,806 DEBUG [com.lpf.ClassA] - 这是 debug 消息。
2018-05-06 18:59:06,809 DEBUG [com.lpf.ClassA] - 这是 debug 消息。
2018-05-06 18:59:08,812 DEBUG [com.lpf.ClassA] - 这是 debug 消息。
2018-05-06 18:59:10,794 DEBUG [com.lpf.ClassA] - 这是 debug 消息。
2018-05-06 18:59:12,796 DEBUG [com.lpf.ClassA] - 这是 debug 消息。
2018-05-06 18:59:14,792 DEBUG [com.lpf.ClassA] - 这是 debug 消息。
2018-05-06 18:59:16,795 DEBUG [com.lpf.ClassA] - 这是 debug 消息。
脚本中的问题
/bin/sh^M: 坏的解释器: 没有那个文件或目录
执行脚本的时候可能会报这样的错误:
-bash: ./Linux_Java_Shell.sh: /bin/sh^M: 坏的解释器: 没有那个文件或目录
这是因为 .sh文件是从windows拷贝过来的,所以多了\r,执行:
sed -i 's/\r$//' Linux_Java_Shell.sh
会把 Linux_Java_Shell.sh 中的\r 替换成空白,再次执行则成功!
在windows下编辑的时候,换行结尾是 \n\r , 而在linux下是 \n,所以才会有多出来的 \r
java.awt.headless 模式
参考文章:java.awt.headless 模式