使用git+maven+shell实现持续集成

秒速五厘米 2022-06-02 06:55 203阅读 0赞

前言：这篇博客是一直心心念念想要写的，但是因为拖延症一直拖着拖着已经拖了半个月了，今晚就一定把他写完。

需求：之前在做项目的时候经常会有这么一个情况，交付的时候往往会出现需求变动，修复bug的情况，每次上线测试之后发现问题就需要执行“修复-编译打包-部署”等动作，一次两次操作还好，但是一年来每次都是完成这样的动作，就会很疲劳，特别是部署，每次都需要kill -9 tomcat，再启动。有的时候在家里开发，打出来的包已经四五十M，上传速度慢每次都要上传个半小时，每次的修复部署都是一个比较烦躁的过程。

认识《maven实战》：因为之前在开发的过程中使用maven的主要功能只是添加依赖，因为在工作中需要接触工程的依赖与聚合，所以下载了这本书阅读，如果100分为满分的话，那这本书可以给100分，是接触到的maven资料里面写的最好，最齐全的。在学习的过程中不仅知道了maven的相关知识点，也认识到一个东西，即使用maven来进行持续集成。

持续集成：持续集成是什么呢？阮一峰的[这篇文章][Link 1] 已经描写的很详细，对于我来说，持续集成的过程就是上述的整个“修复-部署”的过程，即持续集成的过程让我很烦躁，那maven是如何来解决持续集成的这个问题呢？在《maven实战》书中介绍的是使用Hudson来进行项目自动化持续集成，Hudson是什么呢？便是jenkins的前身。

认识jenkins：百科——Jenkins是一个开源软件项目，是基于Java开发的一种持续集成工具，用于监控持续重复的工作，旨在提供一个开放易用的软件平台，使软件的持续集成变成可能。简而言之，是一个让你可以自动持续集成，又提供监控….的java项目。在查看相关资料后立马就下载了玩，在一番接触过之后，发现持续集成需要通过Jenkins配置以下内容：

*  maven
 *  git地址
 *  shell语法（主要用来启动服务）

看了一下之后发现配置的方式好像比较麻烦，而且对于目前我做的这个项目来说只有一个服务器，所以只能在应用服务器上面部署Jenkins，再让Jenkins来帮我完成持续集成，总体来说，为了实现我的需求，那么可以画出以下的架构图  
![这里写图片描述][SouthEast]  
其中：

*  git的作用是用来拉取源码
 *  maven的作用是用来编译打包
 *  shell是把maven打出来的应用包部署到服务器

看完上述Jenkins的流程之后，我就在想这些东西我都会用，那我为什么还要用Jenkins那么重的一个工程来消耗我的服务器资源呢？所以干脆卸载Jenkins，自己用git+maven+shell来实现一个持续部署的流程。思路如下：  
其主要的思路就是：  
让shell帮我完成

*  拉取代码
 *  编译打包
 *  部署至服务器

其中部署至服务器只是简单的把软件包复制到tomcat的Apps中，关闭tomcat，再重启即可。

那实际是如何完成整个步骤的呢？

一、安装maven  
在你的服务器上安装maven，网上已经有很多maven的安装教程，这里便不再重复，其中，几个需要注意的点是：  
1.配置maven的环境变量，即把/bin目录配置到环境变量中。  
2.配置好你的maven仓库，如果你不想你的jar包乱放的话。  
3.配置maven淘宝镜像，体验飞一般的速度。

二、安装git  
在你的服务器上安装git，网上已经有很多git的安装教程，这里便不再重复，其中，几个需要注意的点是：  
1.配置git的环境变量。  
2.配置ssh，这里可以直接参考[官网教程][Link 2]，这里为什么需要配置ssh呢？这是因为当我们使用git pull命令时需要手动的填入密码，我们使用shell操作时要模拟输入密码的这个过程比较麻烦，所以我们使用ssh的通信方式可以省过这个输入密码的过程，当然了，让你创建仓库拉取代码的时候，你也需要使用ssh的获取方式

三、测试maven与git  
首先测试git看看能否拉取代码，这里可以参考[这篇文章][Link 3] 记录了一些常用的git命令，非常实用。

git remote rm origin
    git remote add origin git@gitee.com:jjtHappy/hospital.git
    git push origin

拉取之后尝试编译打包：

mvn clean package -Dmaven.test.skip=true -Premote

当执行成功之后，你将会在你的代码库中看到生成target的文件夹，进入之后会看到你打包出来的项目  
![这里写图片描述][SouthEast 1]  
看到这里，已经证明你离成功不远了。

四、把tomcat配置成服务  
这里可以参考我写的另外一篇文章[这里][Link 4]，为什么要把tomcat配置成服务呢？

*  可以做成开机启动
 *  停止tomcat的时候可以使用服务去停，不用用kill -9，不用用./shutdown.sh，你可能会说你想用./shutdown.sh，但是你要考虑使用./shutdown.sh的时候能不能杀干净进程。
 *  启动时可以用服务启动

因为第二、第三点的原因，我们需要把tomcat配置成服务器，这样我们就可以简单的使用

service tomcat start service tomcat stop

的命令来操作tomcat了。

五、shell  
接下来就是重头戏了，shell是整个持续集成的核心，是帮我们操作的机器人，他主要完成以下逻辑：  
![这里写图片描述][SouthEast 2]

接下来还是通过shell代码来认识整个逻辑：

deploy.sh

#! /bin/bash
    logsPath=/home/apps/service/deploy/logs #日志地址
    srcPath=/home/apps/software/git-repository/hospital #源码地址
    deployPath=/home/apps/service/webapps/hospital #部署路径
    function log(){
       #日志函数
            logPath=$logsPath/deploy.`date +%Y-%m-%d`.log
            if [ ! -d $logsPath  ]; then
                    mkdir -p $logsPath
            fi
            if [ ! -d $logPath ];then
                    touch $logPath
            fi
            echo [`date +%Y-%m-%d\ %H:%M:%S`] $* >> $logPath;
    }
    
    #执行git拉取源码
    log 'pull src from github'
    cd $srcPath
    gitLog=`git pull origin 2>&1` 
    if [ $? -ne 0  ];
    then 
        log $gitLog
        exit $?
    fi
    echo "$gitLog" | while read line
    do 
        log $line
    done
    
    #执行maven进行编译
    log 'maven is building'
    mavenLog=`mvn clean package -Dmaven.test.skip=true -Premote  2>&1`
    if [ $? -ne 0  ];
    then 
            log $mavenLog
            exit $?
    fi
    echo "$mavenLog" | while read line
    do 
            log $line
    done
    
    #杀死tomcat
    log 'stop tomcat service'
    tomcatLog=`service tomcat stop 2>&1`
    
    #删除旧部署数据
    log 'delete old deploy data'
    rm $deployPath/* -rf
    log 'copy war to deploy path'
    
    #把代码包拷贝到部署路径
    cp $srcPath/target/hospital.war $deployPath/hospital.war
    cd $deployPath 
    unzip hospital.war > /dev/null
    
    #启动tomcat
    log 'start tomcat'
    service tomcat start
    
    #检测tomcat进程
    TomcatID=$(ps -ef |grep tomcat |grep -w 'tomcat'|grep -v 'grep'|awk '{print $2}')  
    log tomcatId is $TomcatID

执行脚本获取日志：

[2017-12-26 10:43:57] pull src from github
    [2017-12-26 10:43:59] 来自 gitee.com:jjtHappy/hospital
    [2017-12-26 10:43:59] a7f407d..3f9190d master -> origin/master
    [2017-12-26 10:43:59] 更新 a7f407d..3f9190d
    [2017-12-26 10:43:59] Fast-forward
    [2017-12-26 10:43:59] pom.xml | 2 +-
    [2017-12-26 10:43:59] 1 file changed, 1 insertion(+), 1 deletion(-)
    [2017-12-26 10:43:59] maven is building
    [2017-12-26 10:44:10] [INFO] Scanning for projects...
    [2017-12-26 10:44:10] [WARNING]
    [2017-12-26 10:44:10] [WARNING] Some problems were encountered while building the effective model for com.haizhi:hospital:war:0.0.1-SNAPSHOT
    [2017-12-26 10:44:10] [WARNING] 'dependencies.dependency.(groupId:artifactId:type:classifier)' must be unique: org.slf4j:slf4j-log4j12:jar -> duplicate declaration of version 1.6.1 @ line 299, column 15
    [2017-12-26 10:44:10] [WARNING] 'dependencies.dependency.scope' for org.springframework.data:spring-data-releasetrain:pom must be one of [provided, compile, runtime, test, system] but is 'import'. @ line 215, column 11
    [2017-12-26 10:44:10] [WARNING]
    [2017-12-26 10:44:10] [WARNING] It is highly recommended to fix these problems because they threaten the stability of your build.
    [2017-12-26 10:44:10] [WARNING]
    [2017-12-26 10:44:10] [WARNING] For this reason, future Maven versions might no longer support building such malformed projects.
    [2017-12-26 10:44:10] [WARNING]
    [2017-12-26 10:44:10] [INFO]
    [2017-12-26 10:44:10] [INFO] ------------------------------------------------------------------------
    [2017-12-26 10:44:10] [INFO] Building hospital 0.0.1-SNAPSHOT
    [2017-12-26 10:44:10] [INFO] ------------------------------------------------------------------------
    [2017-12-26 10:44:10] [INFO]
    [2017-12-26 10:44:10] [INFO] --- maven-clean-plugin:2.5:clean (default-clean) @ hospital ---
    [2017-12-26 10:44:10] [INFO] Deleting /home/apps/software/git-repository/hospital/target
    [2017-12-26 10:44:10] [INFO]
    [2017-12-26 10:44:10] [INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ hospital ---
    [2017-12-26 10:44:10] [INFO] Using 'UTF-8' encoding to copy filtered resources.
    [2017-12-26 10:44:10] [INFO] Copying 10 resources
    [2017-12-26 10:44:10] [INFO]
    [2017-12-26 10:44:10] [INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ hospital ---
    [2017-12-26 10:44:10] [INFO] Changes detected - recompiling the module!
    [2017-12-26 10:44:10] [INFO] Compiling 218 source files to /home/apps/software/git-repository/hospital/target/classes
    [2017-12-26 10:44:10] [WARNING] /home/apps/software/git-repository/hospital/src/main/java/com/haizhi/hospital/freemark/intf/impl/MedicalRecordDocServiceImpl.java: /home/apps/software/git-repository/hospital/src/main/java/com/haizhi/hospital/freemark/intf/impl/MedicalRecordDocServiceImpl.java使用或覆盖了已过时的 API。
    [2017-12-26 10:44:10] [WARNING] /home/apps/software/git-repository/hospital/src/main/java/com/haizhi/hospital/freemark/intf/impl/MedicalRecordDocServiceImpl.java: 有关详细信息, 请使用 -Xlint:deprecation 重新编译。
    [2017-12-26 10:44:10] [WARNING] /home/apps/software/git-repository/hospital/src/main/java/com/haizhi/hospital/dao/special/impl/StatisticRegisterDaoImpl.java: 某些输入文件使用了未经检查或不安全的操作。
    [2017-12-26 10:44:10] [WARNING] /home/apps/software/git-repository/hospital/src/main/java/com/haizhi/hospital/dao/special/impl/StatisticRegisterDaoImpl.java: 有关详细信息, 请使用 -Xlint:unchecked 重新编译。
    [2017-12-26 10:44:10] [INFO]
    [2017-12-26 10:44:10] [INFO] --- maven-resources-plugin:2.6:testResources (default-testResources) @ hospital ---
    [2017-12-26 10:44:10] [INFO] Not copying test resources
    [2017-12-26 10:44:10] [INFO]
    [2017-12-26 10:44:10] [INFO] --- maven-compiler-plugin:3.1:testCompile (default-testCompile) @ hospital ---
    [2017-12-26 10:44:10] [INFO] Not compiling test sources
    [2017-12-26 10:44:10] [INFO]
    [2017-12-26 10:44:10] [INFO] --- maven-surefire-plugin:2.12.4:test (default-test) @ hospital ---
    [2017-12-26 10:44:10] [INFO] Tests are skipped.
    [2017-12-26 10:44:10] [INFO]
    [2017-12-26 10:44:10] [INFO] --- maven-war-plugin:2.2:war (default-war) @ hospital ---
    [2017-12-26 10:44:10] [INFO] Packaging webapp
    [2017-12-26 10:44:10] [INFO] Assembling webapp [hospital] in [/home/apps/software/git-repository/hospital/target/hospital]
    [2017-12-26 10:44:10] [INFO] Processing war project
    [2017-12-26 10:44:10] [INFO] Copying webapp resources [/home/apps/software/git-repository/hospital/src/main/webapp]
    [2017-12-26 10:44:10] [INFO] Webapp assembled in [342 msecs]
    [2017-12-26 10:44:10] [INFO] Building war: /home/apps/software/git-repository/hospital/target/hospital.war
    [2017-12-26 10:44:10] [INFO] WEB-INF/web.xml already added, skipping
    [2017-12-26 10:44:10] [INFO] ------------------------------------------------------------------------
    [2017-12-26 10:44:10] [INFO] BUILD SUCCESS
    [2017-12-26 10:44:10] [INFO] ------------------------------------------------------------------------
    [2017-12-26 10:44:10] [INFO] Total time: 9.621 s
    [2017-12-26 10:44:10] [INFO] Finished at: 2017-12-26T10:44:10+08:00
    [2017-12-26 10:44:10] [INFO] Final Memory: 28M/263M
    [2017-12-26 10:44:10] [INFO] ------------------------------------------------------------------------
    [2017-12-26 10:44:10] stop tomcat service
    [2017-12-26 10:44:12] delete old deploy data
    [2017-12-26 10:44:12] copy war to deploy path
    [2017-12-26 10:44:13] start tomcat
    [2017-12-26 10:44:13] tomcatId is 37253 37254 37255

成功完成整个部署流程。

最后一个环节别忘了，部署脚本不是后台启动的，这里需要创建一个脚本，来后台启动它：

deploy-service.sh

#! /bin/bash
    /home/apps/service/deploy/deploy.sh &

以后当你修复的时候，你只需要在本地修改好代码，然后去到服务器执行./deploy-service.sh脚本，那么程序将会自动帮你完成编译-打包-部署的整个流程。

看到这里你会说，好麻烦，还需要自己去服务器启动脚本，嘿嘿，其实我也是想到这个点，也已经想出办法，但是懒得做，因为我觉得这样已经够智能了。

使用git hook的功能：  
1.提交代码时自动去调用服务器的某个接口  
2.利用这个接口去启动./deploy-service.sh脚本

这样就能做到你每次一提交就自动编译打包部署，一体化的持续集成过程，是不是很方便咧！赞我@

[Link 1]: http://www.ruanyifeng.com/blog/2015/09/continuous-integration.html
[SouthEast]: /images/20220602/f2f146674a6f4f69930cb77b67b3c6c0.png
[Link 2]: https://git-scm.com/book/zh/v1/%E6%9C%8D%E5%8A%A1%E5%99%A8%E4%B8%8A%E7%9A%84-Git-%E7%94%9F%E6%88%90-SSH-%E5%85%AC%E9%92%A5
[Link 3]: http://www.ruanyifeng.com/blog/2015/12/git-cheat-sheet.html
[SouthEast 1]: /images/20220602/aca4652f56e84a4089fab174e602c65b.png
[Link 4]: http://blog.csdn.net/hayre/article/details/78916844
[SouthEast 2]: /images/20220602/4c69ec3b5e02492394755811fedb122b.png