deploy.sh

#!/bin/bash

# Ubuntu需要将dash取消才能运行shell脚本，sudo dpkg-reconfigure dash

# doc:
# EN:Server deployment script, this script encapsulates common deployment operations, not necessarily used
# CN:服务器部署脚本，这个脚本封装了常用部署操作，不是一定要使用的

# EN:The deploy.sh script includes, start the server, gracefully stop the server, update the program file, restart the server, corresponding to four commands
# CN:deploy.sh脚本包括了，启动服务器，优雅停止服务器，更新程序文件，重新启动服务器，对应四个命令：start|stop|update|stopUpdateStart。

##############################################################################################################################################################################################################################################################################
# usage 1:
# sh deploy.sh start /usr/local/tank/single-boot/single-boot-1.0.jar

# EN:start starts the server, the absolute path is very important,[/usr/local/tank/single-boot/single-boot-1.0.jar] is the absolute path of the jar package，

# CN:start启动服务器，绝对路径很重要，[/usr/local/tank/single-boot/single-boot-1.0.jar]是jar包的绝对路径

####################################################################################################################################################################################
# usage 2:
# sh deploy.sh stop single

# EN:stop closes the server, use command jps | grep single，grab the java process that needs to be closed, so you don't need to enter the full name of single-boot
# If you have two launchers named [single-boot1.jar], [single-boot2], both will be turned off

# CN:stop关闭服务器，会使用jps | grep single，抓取需要关闭的java进程，所以不需要输入single-boot的全名（不是绝对路径）
# 如果你有两个名称为[single-boot1.jar]，[single-boot2]的启动程序，则会把这两个都关闭

####################################################################################################################################################################################
# usage 3:
# sh deploy.sh update /usr/local/tank/single-boot/single-boot-1.0.jar

# EN:update updates the jar package. By default, the jar package under the root path [single-boot-1.0.jar] will be
# used to update the jar package of [/usr/local/tank/single-boot/single-boot-1.0.jar]
# In this way, the jar must be placed in the root directory (the topmost directory, not the root directory, don't make a mistake),
# it is very important, because the jar of the root path is used by default to update the jar at the location you specify

# CN:update更新jar包，默认会使用根路径[/single-boot-1.0.jar]下的jar包去更新[/usr/local/tank/single-boot/single-boot-1.0.jar]的jar包
# 此种方式jar必须放在 / 根目录(最上层的目录，不是root目录，不要弄错了)，非常重要，因为默认使用根路径的jar取更新你指定位置的jar

####################################################################################################################################################################################
# usage 4:
# sh deploy.sh stopUpdateStart /usr/local/tank/single-boot/single-boot-1.0.jar

# EN:stop Update Start, execute the commands stop, update, start, three-in-one commands in order,
# because there is an update, so you must put your jar in the root directory

# CN:stopUpdateStart，按顺序执行命令stop，update，start，三合一的命令，因为有个update，所以必须把你的jar放在根目录（非常重要）
# stop的是[single-boot-1.0.jar]，会分割字符串[/usr/local/tank/single-boot/single-boot-1.0.jar]获取到最后的分号后的名称
# update的是[/usr/local/tank/single-boot/single-boot-1.0.jar]，所以必须把jar放在 / 根目录(最上层的目录，不是root目录，不要弄错了)，非常重要
# start同[usage 1]

####################################################################################################################################################################################
# @author godotg

## java config
JAVA_HOME="/usr/local/java"
JAVA_JVM_OPTIONS="-Dspring.profiles.active=pro -XX:InitialHeapSize=1g -XX:MaxHeapSize=1g -XX:AutoBoxCacheMax=20000 -XX:+UseStringDeduplication -XX:+HeapDumpOnOutOfMemoryError -Djdk.attach.allowAttachSelf=true -Duser.timezone=Asia/Shanghai -Dfile.encoding=UTF-8"
## log config
WAIT_LOG=true
LOG_FILE="spring.log"


if [ $# -lt 1 ]; then
    echo "deploy.sh script use error, command parameter is illegal"
    echo "usage: sh deploy.sh start|stop|update|stopUpdateStart"
    exit 1
fi

command=${1}

# 为了避免一些部署的异常，每次执行脚本都更新一下环境变量
source /etc/profile

function waitAllProcessesExit() {
    while true; do
        local runningProcesses
        runningProcesses=$(${JAVA_HOME}/bin/jps -lvm | grep ${1})

        if [ -n "${runningProcesses}" ]; then
            echo "The following Java processes are being shut down ${1}："
            echo "${runningProcesses}"
            sleep 3
        else
            echo "Gracefully shut down ${1} processes"
            return
        fi
    done
}

function waitLogFile() {
    local logfile
    while true; do
        logfile=$(ls ./ | grep ${LOG_FILE})
        if [ -z "${logfile}" ]; then
            echo "Waiting for ${LOG_FILE} to be created..."
            sleep 1
        else
            return
        fi

        if [ -z "${logfile}" ]; then
            echo "Waiting for ${LOG_FILE} to be created..."
            sleep 2
        else
            return
        fi

        if [ -z "${logfile}" ]; then
            echo "Waiting for ${LOG_FILE} to be created..."
            sleep 3
        else
            return
        fi

        if [ -z "${logfile}" ]; then
            echo "If there is no response for a long time, solution 1: Please check the startup log, or whether there is a generated log file in the running directory"
            echo "如果长时间无响应，解决方法1：请检测启动log日志，或者运行目录是否有生成的日志文件"
            sleep 1
        else
            return
        fi

        if [ -z "${logfile}" ]; then
            echo "If there is no response for a long time, solution 2: Confirm whether the jvm parameter -Dspring.profiles.active=pro is correct and whether it is the operating environment configuration you expect"
            echo "如果长时间无响应，解决方法2：确认jvm参数-Dspring.profiles.active=pro是否正确，是否是你期望的运行环境配置"
            sleep 1
        else
            return
        fi

        if [ -z "${logfile}" ]; then
            echo "If there is no response for a long time, solution 3: directly use the command java -Dspring.profiles.active=pro -jar xxx.jar"
            echo "如果长时间无响应，解决方法3：直接使用命令 java -Dspring.profiles.active=pro -jar xxx.jar"
            sleep 1
        else
            return
        fi

        if [ -z "${logfile}" ]; then
            echo "If there is no response for a long time, solution 4: Run the main function in Idea, add the -Dspring.profiles.active=pro parameter, it can run in Idea and it must also run on the server"
            echo "如果长时间无响应，解决方法4：在Idea中运行main函数，加上-Dspring.profiles.active=pro参数，在Idea中能够运行也一定能在服务器运行"
            sleep 1
        else
            return
        fi
    done

    tail -f ${LOG_FILE}
}

# 停止所有进程,不包括login
function stop() {
    echo "######################################################################################################################### Ⅰ stop #########################################################################################################################"
    local pids
    pids=$(${JAVA_HOME}/bin/jps | grep ${1} | awk '{print $1}' | paste -d " " -s)

    if [ -z "${pids}" ]; then
        echo "Did not find any Java process containing the ${1} keyword"
        echo "没有找到任何包含${1}关键字的Java进程"
        return
    fi

    echo "*************************************  cpu  *************************************"
    uptime
    echo "uptime查看cpu的负载情况，load avarage分别是1分钟，5分钟，15分钟内系统的load值，一般load值不大于3，我们就认为它的负载是正常的，大于了3就要想办法降低系统的负载"

    echo "*************************************  memory  *************************************"
    free -m
    echo "free查看内存的使用情况，重点关注swap内存使用，swap大表示物理内存不够用，这时候容易导致OOM异常"

    echo "*************************************  disk  *************************************"
    df -h
    echo "df查看磁盘的使用情况，应该特别关注日志和数据库的挂载路径的使用情况"

    echo "*************************************  network  *************************************"
    sar -n DEV 1 2
    echo "sar查看网络的使用情况，可以通过网络设备的吞吐量，判断网络设备是否已经饱和。"

    echo "************************************* system log *************************************"
    dmesg | tail -n 5
    echo "df查看系统日志的最后20行，主要看有没有严重的系统问题"

    echo "*************************************  jmap  *************************************"
    for pid in ${pids}; do
        echo "${pid}->Information about the top 20 class instances of the process"
        ${JAVA_HOME}/bin/jmap -histo ${pid} | head -n 5
        echo -e "\n"
    done

    echo "************************************* stop process *************************************"
    echo "kill -15 $pids"
    kill -15 ${pids}

    waitAllProcessesExit ${1}
}

# 更新jar包
function update() {
    echo "######################################################################################################################### Ⅱ  update #########################################################################################################################"
    local jarPath=${1}

    if [ -z "${jarPath}" ]; then
        echo "The jar path to be updated cannot be empty"
        echo "usage: sh deploy.sh update jarPath"
        exit 1
    fi

    local jarFilePath=${jarPath%/*}
    local jarName=${jarPath##*/}

    # echo ${jarFilePath}
    # echo ${jarName}

    echo "Before source|target:"
    local fileInfo=$(ls -lh "/${jarName}")
    echo "${fileInfo}"

    if [ -f "${jarPath}" ]; then
        fileInfo=$(ls -lh ${jarPath})
        echo "${fileInfo}"
    fi

    rm -rf ${jarPath}
    mkdir -p ${jarFilePath}
    cp "/${jarName}" ${jarFilePath}

    echo "After target ------>"
    fileInfo=$(ls -lh ${jarPath})
    echo "${fileInfo}"
}

# 启动一个java进程，必须指定jar路径和jar名称
# -n为notEmpty，-z为empty
function start() {
    echo "######################################################################################################################### Ⅲ  start #########################################################################################################################"
    local jarPath=${1}

    if [ -z "${jarPath}" ]; then
        echo "Parameter error: The name of the jar package to start cannot be empty"
        echo "usage: sh deploy.sh start jarPath"
        exit 1
    fi

    local jarFilePath=${jarPath%/*}
    cd ${jarFilePath}

    local currentPath
    currentPath=$(pwd)
    echo "pwd current path : ${currentPath}"

    if [ ! -f "${jarPath}" ]; then
        echo "文件不存在：启动的jar包不存在，请检查jar的路径格式是否是绝对路径"
        echo "usage: sh deploy.sh start jarAbsPath"
        exit 1
    fi

    # -XX:+AlwaysPreTouch，并置零内存页面，可能令得启动时慢上一点，但后面访问时会更流畅，比如页面会连续分配
    # 输出到文件  >> output.log 2>&1 &
    echo "${JAVA_HOME}/bin/java ${JAVA_JVM_OPTIONS} -jar ${jarPath} >/dev/null 2>&1 &"
    nohup ${JAVA_HOME}/bin/java ${JAVA_JVM_OPTIONS} -jar ${jarPath} >/dev/null 2>&1 &

    # If there is no info log, keep waiting
    if $WAIT_LOG; then
        waitLogFile
    fi
}


function stopUpdateStart() {
    local jarPath=${1}

    if [ -z "${jarPath}" ]; then
        echo "The startup path cannot be empty"
        echo "usage: sh deploy.sh start jarPath"
        exit 1
    fi

    echo
    echo "Start executing tasks： stop -> update -> start"
    echo
    local jarFilePath=${jarPath%/*}
    local jarName=${jarPath##*/}

    # stop first
    stop ${jarName}

    # update second
    update ${jarPath}

    # last start
    start ${jarPath} ${3}
}

# Linux性能调优
function optimizeLinux() {
    echo "--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------"
    echo "--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------"
    echo "--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------"
}

# run optimizeLinux method immediately
optimizeLinux

case ${command} in
"stop")
    stop ${2}
    ;;
"update")
    update ${2}
    ;;
"start")
    start ${2}
    ;;
"stopUpdateStart")
    stopUpdateStart ${2}
    ;;
*)
    echo "command not recognized: ${1}"
    echo "usage: sh deploy.sh start|stop|udpate|stopUpdateStart"
    ;;
esac

exit 0