「Jenkins+Git+Maven+Shell+Tomcat持续集成」经典教程

ゝ一世哀愁。 2022-03-22 10:12 171阅读 0赞

[Jenkins][] 是一个开源软件项目，旨在提供一个开放易用的软件平台，使软件的持续集成变得可能。现在软件开发追求的是效率以及质量，Jenkins使得自动化成为可能！

## 亮点 ##

*  采用shell自定义脚本,控制集成部署环境更加方便灵活
 *  精简war包中的lib包,常驻tomcat里，减少war包传输时间
 *  Jenkins 用户权限管理
 *  构建失败发邮件通知相关人员解决
 *  自动按天备份war包,Jenkins配置备份以及版本控制化

## 环境 ##

Ubuntu 14.10 (GNU/Linux 3.16.0-33-generic x86\_64)

## 准备工作 ##

*  Git版本控制服务器
 *  Tomcat发布服务器
 *  Jenkins服务器(提前安装好Maven,Git,Jdk)

**实验时可以在同一台机器配置，但是生产不建议，一台机器电源断掉了，所有服务器都挂了**。

## 步骤 ##

### 安装Jenkins ###

下载Jenkins War包，[Jenkins官网][Jenkins] 。

[![89858625.jpg][]][89858625.jpg]

启动Jenkins ，将War包放入Tomcat容器里，启动Tomcat。  
[![43641603.jpg][]][43641603.jpg]

提示：  
此时Jenkins在初始化配置目录，其默认配置目录路径为当前用户下的.jenkins目录，用户也可以自定义目录，Jenkins默认是把配置文件中的数据读到内存中，如果你替换了之前的配置文件，此时需要点击「Jenkins的读取设置」或者「重启Tomcat」,如果此时Jenkins页面无响应，则应该查看Tomcat的Catalina.out,多半是由于内存溢出造成(解决方法增大Tomcat调用Java虚拟机时内存大小,本文不做重点)，运行Jenkins的服务器配置最好内存1G以上，因为后续会加入一些Jenkins插件，有一些会比较占用内存，导致Jenkins启动不了。

[![43013545.jpg][]][43013545.jpg]

[![36415220.jpg][]][36415220.jpg]

[![39798351.jpg][]][39798351.jpg]

[![300][]][300]

### 安装Jenkins插件 ###

*  `Email Extension Plugin` (邮件通知)
 *  `GIT plugin` (可能已经默认安装了)
 *  `Publish Over SSH` (远程Shell)  
    安装方法：  
    首页->系统管理->管理插件->可选插件->过滤(搜索插件名)->勾选->点击最下面直接安装即可(需要等待一段时间,详情可以看catalina.out日志变化)

[![22240263.jpg][]][22240263.jpg]

[![60164531.jpg][]][60164531.jpg]

### 配置Jenkins ###

配置基本信息

每个选项后都有个问号解释当前含义，**(此步新手可以略过，默认不填即可)**  
配置方法：首页->系统管理->系统设置

[![87775273.jpg][]][87775273.jpg]

配置邮件

管理员邮件地址就是邮件的发件人地址(必须和后面邮件配置发件人邮箱一致，否则发不成功邮件)

[![92777026.jpg][]][92777026.jpg]

配置Jdk

`JAVA_HOME`为Jdk路径 其中Jdk也可以从这里下载安装解压

[![12633393.jpg][]][12633393.jpg]

[![54600660.jpg][]][54600660.jpg]

配置 Maven

配置 Maven Configuration

路径为maven的setting.xml路径(Maven安装略)

[![79896914.jpg][]][79896914.jpg]

配置Maven项目

[![51431985.jpg][]][51431985.jpg]

配置Maven安装目录

[![50417925.jpg][]][50417925.jpg]

配置 Git

其中`Path to Git executable`为你git执行的路径 一般默认是/usr/bin/git ,如有差异，可以`whereis git`

[![34954420.jpg][]][34954420.jpg]

[![26683072.jpg][]][26683072.jpg]

配置邮件

邮件模板配置

配置好邮件的模板(可自定义html编写) User Name为用户名 Password为密码 SMTP不同邮箱不同,请自行google(另外gmail邮件如无代理翻墙，请勿用，推荐163比较好配置)

**未翻墙**

[![53719531.jpg][]][53719531.jpg]

**翻墙后**

[![80636233.jpg][]][80636233.jpg]

**模板效果图**

[![8355114.jpg][]][8355114.jpg]

Default Subject 代码：

<table> 
 <tbody> 
  <tr> 
   <td> <pre><code>1
</code></pre> </td> 
   <td> <pre><code>构建通知:$PROJECT_NAME - Build # $BUILD_NUMBER - $BUILD_STATUS!
</code></pre> </td> 
  </tr> 
 </tbody> 
</table>

模板Default Content分享：

<table> 
 <tbody> 
  <tr> 
   <td> <pre><code>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
</code></pre> </td> 
   <td> <pre><code>(本邮件是程序自动下发的，请勿回复，&lt;span style="color:red"&gt;请相关人员fix it,重新提交到git 构建&lt;/span&gt;)&lt;br/&gt;&lt;hr/&gt;

项目名称：$PROJECT_NAME&lt;br/&gt;&lt;hr/&gt;

构建编号：$BUILD_NUMBER&lt;br/&gt;&lt;hr/&gt;
    
GIT版本号：${GIT_REVISION}&lt;br/&gt;&lt;hr/&gt;
    
构建状态：$BUILD_STATUS&lt;br/&gt;&lt;hr/&gt;
    
触发原因：${CAUSE}&lt;br/&gt;&lt;hr/&gt;
    
构建日志地址：&lt;a href="${BUILD_URL}console"&gt;${BUILD_URL}console&lt;/a&gt;&lt;br/&gt;&lt;hr/&gt;
    
构建地址：&lt;a href="$BUILD_URL"&gt;$BUILD_URL&lt;/a&gt;&lt;br/&gt;&lt;hr/&gt;
    
变更集:${JELLY_SCRIPT,template="html"}&lt;br/&gt;&lt;hr/&gt;
</code></pre> </td> 
  </tr> 
 </tbody> 
</table>

配置邮件触发器  
当失败的时候，会触发邮件通知，这个功能比较实用。

[![61013067.jpg][]][61013067.jpg]

配置 Publish over SSH

远程执行shell脚本 采用公钥私钥连接 其中Key里贴的是私钥 远程被管理的主机里贴的是公钥,这2台主机就是相互信任，这样scp等操作就**不需要输入用户名和密码**。

公钥私钥生成方法：

1.管理主机linux 上 `ssh-keygen -t rsa -C "mousycoder@foxmail.com` 一路回车 会在/root/.ssh下生成id\_rsa(私钥) id\_rsa.pub(公钥)。

2.copy 公钥的内容到远程需要通信(被管理)的主机 `/root/.ssh/authorized_keys` 如无此目录文件则手动创建。

[![20534587.jpg][]][20534587.jpg]

[![62960902.jpg][]][62960902.jpg]

[![11156151.jpg][]][11156151.jpg]

[![67647542.jpg][]][67647542.jpg]

配置完之后可以Test Configuration

[![52200380.jpg][]][52200380.jpg]

配置 Job

步骤:首页->新建->构建一个maven项目(输入item名称)->进入该项目->配置

[![21171329.jpg][]][21171329.jpg]

[![75488006.jpg][]][75488006.jpg]

JOB基本信息  
[![42554114.jpg][]][42554114.jpg]

项目源码管理  
Repository UR 项目地址 Credentials授权可以是SSH也可以是用户名密码(SSH方法同上)

[![88293973.jpg][]][88293973.jpg]

[![53868727.jpg][]][53868727.jpg]

选择需要构建的分支，我们项目采用git工作流 默认master和develop 平时开发构建develop分支，正式上线构建master并且打标签(前公司git提交标准化相当复杂，分支相当多,这里大家可以根据实际情况来)。

[![98039735.jpg][]][98039735.jpg]

构建触发器

这里我们选择poll轮询每隔1分钟去检测git仓库代码库版本,如果有更改则立刻构建，这里大家可以根据自己团队实际情况去制定，当然还有另外一个插件gitlab-hook可以主动去通知jenkins构建,不过插件所占内存比较大，需要增大tomcat虚拟机内存配置，不然会内存溢出。

[![99560528.jpg][]][99560528.jpg]

构建命令

我们采用最简单的`clean install` 当然这里可以根据各自需求  
例如 部署后的产物上传到nexus等,详情参考 **Maven命令**

<table> 
 <tbody> 
  <tr> 
   <td> <pre><code>1
</code></pre> </td> 
   <td> <pre><code>clean install deploy:deploy-file -DgroupId=com.weitoo -DartifactId=common -Dversion=0.1-SNAPSHOT -Dpackaging=jar -Dfile=D:\workspace\server-aggregator\common\target\common-0.1-SNAPSHOT.jar -Durl=http://192.168.0.200:8081/nexus/content/repositories/thirdparty/ -DrepositoryId=thirdparty
</code></pre> </td> 
  </tr> 
 </tbody> 
</table>

[![4904405.jpg][]][4904405.jpg]

Add post-build step

构建成功后执行shell命令

[![55020803.jpg][]][55020803.jpg]

该shell的目的是取出war包lib中其他所有lib包 只留下common-0.1-SNAPSHOT.jar 大大减少war包大小(完整war包30M 传包到阿里云服务器需要2分多,精简后2M，10秒多,大大提高构建速度)。

[![40357217.jpg][]][40357217.jpg]

分享我的Shell

<table> 
 <tbody> 
  <tr> 
   <td> <pre><code>1
2
3
4
5
6
7
</code></pre> </td> 
   <td> <pre><code>mv ~/.jenkins/jobs/server/workspace/server/target/server/WEB-INF/lib/common-0.1-SNAPSHOT.jar ~/.jenkins/jobs/server/workspace/server/target/
rm -rf ~/.jenkins/jobs/server/workspace/server/target/server/WEB-INF/lib/*
rm -rf ~/.jenkins/jobs/server/workspace/server/target/server.war 
mv ~/.jenkins/jobs/server/workspace/server/target/common-0.1-SNAPSHOT.jar ~/.jenkins/jobs/server/workspace/server/target/server/WEB-INF/lib/
cd ~/.jenkins/jobs/server/workspace/server/target/server/
zip -r ~/.jenkins/jobs/server/workspace/server/target/server.war * -r
scp /root/.jenkins/jobs/server/workspace/server/target/server.war root@123.56.xxx.xx:/opt/war/
</code></pre> </td> 
  </tr> 
 </tbody> 
</table>

构建成功远程执行shell脚本

`exec command` 是远程sh的路径

[![23697984.jpg][]][23697984.jpg]

[![15551812.jpg][]][15551812.jpg]

**分享我的publish.sh文件**

作用是备份每次上传的war包 重启Tomcat。

<table> 
 <tbody> 
  <tr> 
   <td> <pre><code>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
</code></pre> </td> 
   <td> <pre><code>export JAVA_HOME=/opt/software/jdk1.7.0_25
TOMCAT_HOME="/opt/software/apache-tomcat-7.0.59"
TOMCAT_PORT=80
PROJECT="server"
BAK_DIR=/opt/war/bak/$PROJECT/`date +%Y%m%d`

mkdir -p "${BAK_DIR}"
cp /opt/war/"${PROJECT}".war "${BAK_DIR}"/"${PROJECT}"_`date +%Y%m%d%H%M%S`.war

#shutdown tomcat
/opt/sh/kill-tomcat-force.sh

#publish project 
rm -rf "${TOMCAT_HOME}"/webapps/${PROJECT}
cp /opt/war/"${PROJECT}".war "${TOMCAT_HOME}"/webapps/${PROJECT}.war
q
#remove tmp
rm -rf /opt/war/${PROJECT}.war

#unzip war
unzip "${TOMCAT_HOME}"/webapps/${PROJECT}.war -d "${TOMCAT_HOME}"/webapps/${PROJECT}

rm -rf "${TOMCAT_HOME}"/webapps/${PROJECT}.war

##copy lib
cp /opt/lib/* "${TOMCAT_HOME}"/webapps/${PROJECT}/WEB-INF/lib/

## start tomcat

sleep 3

#start tomcat
/opt/software/apache-tomcat-7.0.59/bin/startup.sh
echo "tomcat is starting!"

```

**分享我的kill-tomcat-force.sh文件**
    
作用是强制关闭tomcat进程
</code></pre> </td> 
  </tr> 
 </tbody> 
</table>

set fileformat=unix

path=/opt/software/apache-tomcat-7.0.59/bin

ps -ef|grep $path|grep tomcat|awk ‘\{print $2\}’

echo “exec $path/shutdown.sh”  
$path/shutdown.sh

sleep 3s

\#kill -9 pid  
ps -ef|grep $path|grep tomcat|awk ‘\{print $2\}’|xargs kill -9

\#success msg  
echo “shutdown success”

ps -ef|grep $path|grep java|awk ‘\{print $2\}’

<code>**分享我的Tomcat精简方法**
  
- 在tomcat_home/lib下新建自定义jar包文件，导入项目所需其他jar包(以后有新增的话，单独再导一次)
- 修改tomcat_home/conf/catalina.properties 搜索**=shared.loader**加上路径
</code></pre> </td> 
  </tr> 
 </tbody> 
</table>

shared.loader=$\{catalina.base\}/lib/server,$\{catalina.base\}/lib/server/*.jar,$\{catalina.home\}/lib/server,$\{catalina.home\}/lib/server/*.jar

`` ` ``  
此时Tomcat运行前会加载server下的lib包，**如果是多个项目公用一个tomcat的时候，就需要这里放公共的lib包，避免tomcat加载多余的jar包,消耗内存。**

[![6464812.jpg][]][6464812.jpg]

[![71980625.jpg][]][71980625.jpg]

构建后邮件设置

邮件主题收件人配置  
[![41465080.jpg][]][41465080.jpg]

邮件触发器

**局部配置会覆盖掉全局配置**,我们之前在全局配置里配置了构建失败邮件触发器,这里是更加精细的配置，  
我们选择构建失败Failure-1st触发器，失败以后发邮件给开发者，(这里可以根据实际需要，配置，可以配置多个触发器)开发者的邮件在Recipient List里配置。

[![10494302.jpg][]][10494302.jpg]

### Jenkins用户权限管理 ###

步骤：首页-> 系统管理-> Configure Global Security  
基本配置:  
只有注册的用户才能操作,当然如果是大企业的话，可以采用项目矩阵授权策略,详情可以[Google][]。

[![52369629.jpg][]][52369629.jpg]

### Jenkins配置的备份和版本控制 ###

很多情况下稍不注意改变了Jenkins的配置，把平台弄坏了，又想去恢复，这个时候就得把Jenkins的配置文件进行配置或者版本化，只需要把**/root/.jenkins/**加入git版本库里即可,该目录下包含Jenkins所有信息,包括每次构建历史信息和历史jar包  
进行全备份然后覆盖掉该文件夹的时候，重新构建JOB会出现文件夹已经存在等exception，**只需要手动删掉这些目录即可，不会丢失数据。**(**这是Jenkins的一个bug,参考 [JENKINS-21330][]**)

[![68032109.jpg][]][68032109.jpg]

>  *  **本文作者：**mousycoder
>  *  **本文链接：**[http://mousycoder.com/2015/10/14/jenkins-git-maven-shell-tomcat-ci/][http_mousycoder.com_2015_10_14_jenkins-git-maven-shell-tomcat-ci]
>  *  **版权声明：**自由转载-非商用-非衍生-保持署名（[创意共享3.0许可证][3.0]），非商业转载请注明作者及出处，商业转载请联系作者本人。

[Jenkins]: http://jenkins-ci.org/
[89858625.jpg]: /images/20220322/e9f05e133bd94262b1c51a2b49853bd7.png
[43641603.jpg]: /images/20220322/07b7050f06924697b55a425886586b24.png
[43013545.jpg]: /images/20220322/cc8fa86335d144dead15f519aa2c295f.png
[36415220.jpg]: /images/20220322/374e0bb33239434da243303d184e5cf3.png
[39798351.jpg]: /images/20220322/8cfb13daf5ce4bf4b3ac74a590127544.png
[300]: /images/20220322/497de0d0724b4744892e7c1be6a6cf81.png
[22240263.jpg]: /images/20220322/f79b6759dcd944d5a8835940b0b21092.png
[60164531.jpg]: /images/20220322/245e806da3b84696a8a9f4e03b255edc.png
[87775273.jpg]: /images/20220322/c6adab1547584ee29245cb4e418f857e.png
[92777026.jpg]: /images/20220322/654b67e7ffee4b29b308275dcf7a7abe.png
[12633393.jpg]: /images/20220322/9c6c3c52f42742699a9f46fcc43a7dc2.png
[54600660.jpg]: /images/20220322/49ba8d277287400c8478d4ef76173ac0.png
[79896914.jpg]: /images/20220322/5365b5552b8748fbb1fae9414ce0d47b.png
[51431985.jpg]: /images/20220322/5998979c419f41bfb4316302a9e78288.png
[50417925.jpg]: /images/20220322/0489d91401074e8e9cb0a29ee1d840e0.png
[34954420.jpg]: /images/20220322/7c55fc89f8ec4cf899c1b808d127368d.png
[26683072.jpg]: /images/20220322/6b08fa3bb47647feb24edb4219da7542.png
[53719531.jpg]: /images/20220322/823811ec486e49e88e39034ca5f0a3bc.png
[80636233.jpg]: /images/20220322/2a6ef4026b18418199f54c3a7da106c3.png
[8355114.jpg]: /images/20220322/0dec3478f8b140eba3f0b93986612ed9.png
[61013067.jpg]: /images/20220322/0397a7e4faf34aabbd151eb865875072.png
[20534587.jpg]: /images/20220322/66676649411b48059f7bcc10829e7322.png
[62960902.jpg]: /images/20220322/3cce36ed689940ee8323e8552fea2687.png
[11156151.jpg]: /images/20220322/f06fdf43493e41ebb22c93025ba204f4.png
[67647542.jpg]: /images/20220322/b64d2ec537dc44118dfd115fd2edd630.png
[52200380.jpg]: /images/20220322/bdbc529561c44d78b0b779aa9fb3bf86.png
[21171329.jpg]: /images/20220322/fc0cb5832b274cea976b8b7f3c2759ab.png
[75488006.jpg]: /images/20220322/9ba1e28babf14bd1b695b1229f77edef.png
[42554114.jpg]: /images/20220322/a62f58d3a4804131b31f965454024881.png
[88293973.jpg]: /images/20220322/28754e3d5d494c6d9611c8d90f5e2983.png
[53868727.jpg]: /images/20220322/13faf89d1a0143a280925ebaa6542530.png
[98039735.jpg]: /images/20220322/505bb85a075a4d4ea271cc2b4f558784.png
[99560528.jpg]: /images/20220322/629b85d05236455d875f0c7941b61a8f.png
[4904405.jpg]: /images/20220322/1b7b381f384140e4a47de62778e2e450.png
[55020803.jpg]: /images/20220322/af05d20eb41c4f7eb95dca03e3d2af55.png
[40357217.jpg]: /images/20220322/a4b707e60f8a4dccb619787d5491ead8.png
[23697984.jpg]: /images/20220322/1005d014650c4b9684ba2bdd50a1528b.png
[15551812.jpg]: /images/20220322/b67413ea01554a6bbf237fb8b40bccdd.png
[6464812.jpg]: /images/20220322/467e914362c041fda178ebf6c9427ee2.png
[71980625.jpg]: /images/20220322/2b06ea8aba3b4d77879772b2d615519a.png
[41465080.jpg]: /images/20220322/deb860eee88d45d38c0774b25e16a32b.png
[10494302.jpg]: /images/20220322/9623dc9e8c494e3aac6260bdefc8b9f3.png
[Google]: http://www.google.com/
[52369629.jpg]: /images/20220322/9607e69682574af288830b6ffee193a8.png
[JENKINS-21330]: https://issues.jenkins-ci.org/browse/JENKINS-21330
[68032109.jpg]: /images/20220322/f63ab051a3644f529d6bfbcb12ef0246.png
[http_mousycoder.com_2015_10_14_jenkins-git-maven-shell-tomcat-ci]: http://mousycoder.com/2015/10/14/jenkins-git-maven-shell-tomcat-ci/
[3.0]: https://creativecommons.org/licenses/by-nc-nd/3.0/deed.zh