本文会演示如何在CRP上编译并部署一个Java Web应用。
我的应用
技术栈
我的应用是一个简单的在线购书的网站。因为是示例,所以代码就只有简单的一个登陆界面和登陆以后的书目列表界面。代码库在https://code.aliyun.com/blade_1986/bookstore。 使用的技术栈如下:
- Gradle作为构建工具
- Spring作为IOC容器及MVC框架
- JUnit作为测试框架
- Spring Test作为集成测试框架
- Selenium作为功能测试工具
有兴趣的同学可以先把这个代码下载下来按照README.md现在本地跑起来。
部署环境
我有两台ECS的机器,都有公网IP,并且开放了22端口。我选择其中的一台做我的预发环境,另一台做我的正式环境,它们是:
- 预发环境:120.xx.xx.103
- 正式环境:120.xx.xx.137
在CRP上编译该项目的预备工作
使用gradle wrapper及CRP下载源
该项目使用的是gradle的官方推荐用法:gradle wrapper。使用这种方式,第一次运行./gradlew命令时,会下载相应版本的gradle发行版本下来,然后执行接下来的命令。直接从gradle官方下载gradle发行版本会比较慢,所以我按照这篇文章的引导修改了下载源,运行起./gradlew
来速度杠杠的。
使用maven.aliyun.com
直接使用maven
的库速度会有些慢,所以可以将依赖库的地址配置到我们的maven.aliyun.com
来加速编译。该库代理了maven
的官方库。但如果某个你访问的库在maven.aliyun.com
中不存在的话,则第一次编译可能会超时失败,但第二次就可以成功了。修改方式是在build.gradle
中添加如下配置:
repositories {
maven{ url 'http://maven.aliyun.com/nexus/content/groups/public'}
}
开始进行配置
在CRP中创建了项目之后,可以选择新建工作流,默认会提示从模板创建,我选择了“JAVA工程标准模板”,输入项目名称“bookstore”,然后点击确认,就会看到这样的页面:
关联代码库并配置触发器
看到上面大大的“点我配置触发器”,于是就点了一下,然后尝试去选择代码仓库和侦听分支,发现什么都没有。那是因为没有将该代码库与该项目进行关联。需要点击侧边栏的“代码管理”,然后在关联代码库的输入框内输入“bookstore”,然后CRP就可以自动提输出该代码库的全名,然后点击添加就可以把该代码库关联到这个项目了。然后再回到工作流配置界面,点击触发器按钮,去配置代码库及侦听分支。如果你想尝试这个步骤,需要先把上述的代码库fork一份出来到你的code.aliyun.com
的账户下,因为非代码库成员的CRP账户无法关联该代码库。
完成代码库配置后我们来看看这个模板都包含了什么。
持续集成的配置
第一个阶段叫做代码检出-单元测试
,其中自动加入了两个任务,我们只需要关注"编译/测试"这个任务即可。这个任务的目标是对代码进行验证,并打一个war包出来,以供后续的部署之用。该任务的默认配置如下图所示:
可以看到默认命令使用的是maven
。而我使用的是gradle
,所以需要做相应变化。我会使用下面的命令来运行单元测试和集成测试:
./gradlew test integrationTest
./gradlew war
运行完之后生成的war包会在build/libs/bookstore.war
。所以修改完的配置如下所示:
到此为止我们就配置好了测试,点击右上角的生效后,再点击右上角的触发,工作流就开始运行了。点击控制台输出可以看到任务运行的日志。
发布的配置
预发环境
接下来我想要把代码部署到预发环境了,但是模板只给了我一个“正式部署”。没关系,这只是个名字而已,点击这个活动把名字改了就好:
上面是默认配置,下面解释一下每个配置的含义:
- 目标机器就应该是我预发机器的IP:120.xx.xx.103
- 部署路径:CRP会把我生成的bookstore.war这个文件再压缩成为一个package.tgz文件。当部署任务运行时,CRP会把这个package.tgz拷贝到我指定的“部署路径”中。我直接将其指定到了
/root
下。 - 部署命令:这个就是当拷贝完成之后用来部署的脚本。那我的脚本要做什么呢?很简单,停止tomcat,把war包拷贝到tomcat的webapps目录下,然后再启动tomcat,that's it!
所以最后我的配置是这样的:
CRP会默认在登录用户的home目录下执行这些命令。由于我用root
账户登录,而该用户的home
目录就是/root
,所以可以直接开始执行解压的命令。如果你拷贝的位置不是登录用户的home
目录,则需要先cd
过去。
哦对了,CRP如何才能访问你的机器?需要点击配置框右下角的“机器授权”来完成这件事情。
正式环境
配置好了预发环境,接下来要配置正式环境了。聪明的你可能已经想到了,配置方面除了“目标机器”的IP不同之外,其它的所有配置都跟预发环境是一模一样的(不要忘记再次配置机器授权!)。
一些细节的配置
我希望自动化测试和打包这件事情在每次提交代码之后自动发生,但是我希望经过手工批准才能进行两个配置任务。所以三个活动中,第一个活动是自动触发的,后面两个都需要手动批准。这个配置是通过活动信息的“自动触发”和“自动完成”两个选项生效的:
单元测试活动两个都勾选了;两个部署活动只勾选了自动完成。
当然我还希望单元测试出错时候能够通过邮件提示我,所以我还选中上图中的“异常通知”来。而部署的操作肯定是在页面上进行的,所以如果出错立马就能看到,所以这个就不需要配置邮件通知了。
运行完第一个活动后:
点击三角符号才会触发预发环境的部署。运行结束后你会看到:
再次点击那个按钮之后就可以触发生产环境的配置。运行结束后你会看到:
配置精简
作为一个视重复为万恶之源的程序员,我发现了“预发部署”的配置和“产品部署”的配置在“部署命令”这个输入框中的内容是一模一样的!所以我需要像个办法来精简一下。做法很简单,那就是把这些命令放到deploy.sh
这个部署脚本中,然后把bookstore.war
和deploy.sh
这两个文件达成一个压缩包,名为bookstore.zip
。然后CRP会把bookstore.zip
再打成package.tgz
。所以我们的CRP中的配置脚本就可以简化为:
- 解压package.tgz
- 解压bookstore.zip
- 运行deploy.sh来进行部署
为了做到这一点,首先第一个活动的配置需要改为:
然后两个部署的配置均可改为:
tar -xvf package.tgz
rm -rf bookstore
unzip bookstore.zip -d bookstore
cd bookstore
sh deploy.sh
当然现在看起来还是有些不可避免的冗余,CRP后续会再对此再作一些优化。
更多
在上述的例子中,你已经学会了如何把对你的应用做持续集成,并把它部署到预发和产品环境。但这并不是全部。你可能还会关心下面的几个话题。
多机部署
这个例子在一个环境中只部署了一台机器,显然这无法满足无感知发布的需求。后续我会写一篇结合阿里云SLB进行无感知发布的文章。
数据库
简单起见,本示例没有连接数据库。如果需要在测试中使用数据库的话,需要自行安装数据库,具体的安装方法请参看这里。
功能测试
如你所见,示例项目中其实有使用selenium编写的功能测试,但并没有配置到CRP的工作流中。我会在后续的文章中详细描述这部分内容。