基於【SpringBoot】的微服務【Jenkins】自動化部署

　　最近，也是抽空整理了一些在工作中積累的經驗，通過博客記錄下來分享給大家，希望能對大家有所幫助；

一、關於自動化部署

　　關於自動化部署的優點，我就不在這里贅述了；只要想想手工打包、上傳、部署、重啟的種種，就會有很多場景歷歷在目，相信經歷過的朋友都能體會其中的酸甜苦辣；

而一旦到了大型項目，比如所微服務化之后的項目，不僅僅功能模塊多，而且都不再是單機部署；並且一搞大型活動就是動不動幾十個節點的大集群部署，想要靠手工再來完成這些操作，那就等着玩死自己吧；

那么，如果把這一切都交給Jenkins來管理，你要做的就是在頁面輕點鼠標，接下來就是刷刷手機、喝喝茶。。。哈哈哈哈

二、環境介紹

　　--centos 7

　　--Jenkins v.2.121.3

　    --JDK 1.8

　　--SpringBoot+Maven+Git

三、項目中要完成的操作

　　這里，我們借助了maven-assembly-plugin來完成打包，操作如下；

　　1、第一步，在項目的pom.xml文件中加入如下的配置：

<build>
        <finalName>bm-demo-admin</finalName>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <configuration>
                    <archive>
                        <manifest>
                            <!--指定main入口-->
                            <mainClass>cn.com.bluemoon.admin.web.WebAdminApplication</mainClass>
                            <addClasspath>true</addClasspath>
                            <classpathPrefix>lib/</classpathPrefix>
                        </manifest>
                    </archive>
                    <excludes>
                        <include>*.xml</include>
                        <include>*.yml</include>
                        <include>*.json</include>
                    </excludes>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-assembly-plugin</artifactId>
                <configuration>
                    <!-- not append assembly id in release file name -->
                    <appendAssemblyId>false</appendAssemblyId>
                    <descriptors>
                        <!--打包的詳細描述，需要配置額外文件-->
                        <descriptor>src/assembly/assembly-descriptor.xml</descriptor>
                    </descriptors>
                </configuration>
                <executions>
                    <execution>
                        <id>make-assembly</id>
                        <phase>package</phase>
                        <goals>
                            <goal>single</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

　　2、在項目的src目錄下，新建assembly目錄，新建assembly-descriptor.xml文件，內容如下：

<?xml version="1.0" encoding="UTF-8"?>
<assembly>
    <id>bin</id>
    <!-- 最終打包成一個用於發布的zip文件 -->
    <formats>
        <format>tar.gz</format>
    </formats>
    <fileSets>
        <!-- 打包jar文件 -->
        <fileSet>
            <directory>${project.build.directory}</directory>
            <outputDirectory></outputDirectory>
            <includes>
                <include>*.jar</include>
            </includes>
            <fileMode>0755</fileMode>
            <lineEnding>unix</lineEnding>
        </fileSet>
        <!-- 把項目相關的啟動腳本，打包進zip文件的bin目錄 -->
        <fileSet>
            <directory>${project.basedir}/src/main/scripts</directory>
            <outputDirectory>/</outputDirectory>
            <includes>
                <include>*</include>
            </includes>
            <fileMode>0755</fileMode>
            <lineEnding>unix</lineEnding>
        </fileSet>

        <!-- 把項目的配置文件，打包進zip文件的config目錄 -->
        <fileSet>
            <directory>${project.build.directory}/classes</directory>
            <outputDirectory>conf</outputDirectory>
            <includes>
                <include>*.xml</include>
                <include>*.yml</include>
                <include>*.json</include>
            </includes>
        </fileSet>
    </fileSets>
    <!-- 把項目的依賴的jar打包到lib目錄下 -->
    <dependencySets>
        <dependencySet>
            <outputDirectory>lib</outputDirectory>
            <scope>runtime</scope>
            <excludes>
                <exclude>${groupId}:${artifactId}</exclude>
            </excludes>
        </dependencySet>
    </dependencySets>
</assembly>

　　3、在src/main目錄下新建scripts文件下，加入restart.sh、start.sh、stop.sh腳本，內容分別如下：

　　restart.sh

#!/bin/sh
./stop.sh
./start.sh

　　start.sh

#!/bin/sh
export JAVA_HOME=$JAVA_HOME
export PATH=$JAVA_HOME/bin:$PATH
export CLASSPATH=.:$JAVA_HOME/lib/dt.jar:$JAVA_HOME/lib/tools.jar
PIDFILE=service.pid
ROOT_DIR="$(cd $(dirname $0) && pwd)"
CLASSPATH=./*:$ROOT_DIR/lib/*:$ROOT_DIR/conf/
JAVA_OPTS="-Xms256m -Xmx512m -XX:+UseParallelGC"
MAIN_CLASS=cn.com.bluemoon.admin.web.WebAdminApplication
if [ ! -d "logs" ]; then
   mkdir logs
fi
if [ -f "$PIDFILE" ]; then
    echo "Service is already start ..."
else
    echo "Service  start ..."
    nohup java $JAVA_OPTS -cp $CLASSPATH $MAIN_CLASS 1> logs/bm-demo-admin.out 2>&1  &
    printf '%d' $! > $PIDFILE
    echo "Service  start SUCCESS "
fi

　　stop.sh

#!/bin/sh
PIDFILE=service.pid
if [ -f "$PIDFILE" ]; then
     kill -9 `cat $PIDFILE`
     rm -rf $PIDFILE
     echo "Service is stop SUCCESS!"
else
    echo "Service is already stop ..."
fi

四、新建Jenkins任務

　　這里就不在介紹如何安裝Jenkins，以及Jenkins的環境配置，包括git，mave，node.js等，網上有很多的博客講這一塊，可以自己找一下；

　　1、選擇新建任務=>構建一個maven項目，輸入任務的名稱

　　2、添加描述，選擇添加構建參數等等

 

 　　3、勾選丟棄舊的構建，保持構建天數 7天，保持最大構建個數 3個，這里可以自己選擇，主要是用於回滾

　　4、勾選參數化構建過程，添加字符參數

　　這里有必要解釋一下添加的參數

　　brunch  git的分支，作為部署時的可修改參數

　　target_host 部署的目標機器，可以是ip，也可以在hosts里面添加代理（后面補充）

　　war_path 項目打包完成之后的包所在路徑

　　deploy_path 部署在目標服務器上面的路徑

　　app_name 部署的應用的名稱

　　tar_name　打包完成之后的壓縮包的名字（這里不是達成jar，而是壓縮包）

　　5、在源碼管理=》勾選git 添加倉庫地址和用戶權限

　　6、構建觸發器和構建環境可以根據自己的需要選擇，我這里沒有選擇

 

 　　7、Build中添加參數

　　8、添加shell命令

cd /data/ansible/jenkins-ansible-supervisor-deploy
ansible-playbook -i hosts om-platform.yml --verbose --extra-vars "target_host=$target_host 
deploy_path=$deploy_path deploy_war_path=$WORKSPACE/$war_path tar_name=$tar_name app_name=$app_name"

如上是執行的shell命令，這里解釋兩個文件，一個是om-platform.yml，內容貼出來看一下：

---
# This playbook deploys a simple standalone Tomcat 7 server. 

- hosts: "{{ target_host }}"
  user: appadm
  
  roles:
    - om-platform-deploy

一個是hosts 也就是host文件，在上面target_host中配置了別名的話，就需要在此處的hosts文件中定義：

比如你要部署的節點服務是兩個節點的，那你就可以針對240.62/63添加一個叫bm_mana_11_11_test的別名，那么部署的時候在target_host參數中添加別名代替就可以一次部署完畢了；

 最后保存，任務就新建完了，當然，如果有其他的需要你可以自己行選擇；

　　9、在目標服務器上的部署目錄/home/appadm 下添加init.sh文件，內容如下：

# init.sh 初始化項目
#!/bin/sh

serverName=$1

if [ ! $serverName ]; then
  echo "請輸入正確的啟動服務包名。。"
else
  #echo "$serverName 正准備啟動，請稍候。。。"
 cd "/home/appadm/$serverName"
 echo "/home/appadm$serverName"
  #./start.sh
   #nohup java -jar  $serverName &
  #echo "the ${serverName} 啟動完成。。。"
fi

 

一般，我們在部署時，就會操作這個界面來修改參數部署

四、補充說明

　　這里要補充說明的是，jenkins的機器和目標服務器之間是需要做SSH KEY的，關於怎么完成這一步其實也很簡單，就是生成信任的key，具體操作就由度娘來介紹吧；

 

　　那么，到這里關於怎么完成項目的自動化部署，基本上就介紹完了，開始構建，並構建成功之后，就會在自動去git拉去代碼，並且打包完成並發送到對應的服務器目錄，完成重啟操作；

如果有什么疑問，歡迎大家提問和討論；如有不對之處，懇請批評指正；如果覺得對您有所幫忙，那么也請您賞個贊；