目錄
- 一個故事(事故)
- 分環(huán)境
- 分環(huán)境實現(xiàn)
- 指定環(huán)境打包的缺點
- 只打一個包
- 版本檢查
- git-commit-id-plugin
- 版本檢查地址
- 總結(jié)
- 相關(guān)資源
DevOps是Development和Operations的組合詞，作為一名軟件工程師或者系統(tǒng)架構(gòu)師，對于系統(tǒng)的開發(fā)和部署需要有充分的了解和把控。
下面我們通過一個故事，把軟件發(fā)布中的分環(huán)境配置和版本檢查的解決方案為你娓娓道來......
本文涉及到的所有代碼可以在這里 ?? maven-devops 獲取。
一個故事(事故)
試想這樣一個場景，你做了一個功能：
每天凌晨4點去某個系統(tǒng)拉取一份數(shù)據(jù)郵件，然后第二天上午6點以郵件的形式發(fā)給你的老板。
首先你在自己的電腦上開發(fā)和測試，確認開發(fā)完成以后，把代碼打包放到測試服務(wù)器上跑了一下。
你找到可愛的測試小妹妹，經(jīng)過嚴格的測試，確認通過了所有測試用例。最后你不忘恭維一下測試小妹妹最近燙的頭發(fā)真漂亮，并含蓄地表示有空想請她看最近上映的漫威電影。( 而實際上測試小妹妹的頭發(fā)沒有燙過，她也沒聽懂你的暗示，她更不喜歡看漫威的電影，最最關(guān)鍵的是，你根本沒有時間請別人看電影——這個問題問一下你家里洗衣機里靜靜趟了兩星期的襪子就知道了。)
你把自己的代碼合并到主分支，然后通知發(fā)布人員把代碼發(fā)布到生產(chǎn)環(huán)境。當你收到運維人員發(fā)布成功的提醒的時候，抬頭看看表已經(jīng)是午夜兩點了。你喝干凈杯子里的咖啡，深深懶腰，搭車回家了。
第二天上午，你在一陣急促的電話鈴聲中被吵醒，電話那頭的聲音頓時讓你困意全無：老板沒有收到任何郵件，郵件里的資料要在2h以后的一個重要會議中使用！
......
數(shù)據(jù)終于是想方設(shè)法搞到了，但疲憊、恐懼、羞恥和自責已經(jīng)淹沒了你的頭腦，你要搞事情了：查到原因，徹底解決這個問題！
笨人和聰明人的差異就在于，笨人只會不停地栽跟頭，而聰明人跌倒以后爬起來，不忘把坑填上，還會在旁邊立個碑，以警后人 —— 能做到這一點的幾乎就是偉人了。
分環(huán)境
前面提到了你自己開發(fā)、給測試小妹妹測試以及給運維人員發(fā)布，一共三個環(huán)境，而實際上一個軟件系統(tǒng)的環(huán)境往往不止這些。
常用的環(huán)境有：dev、sit、uat、sandbox、pro。
dev就是開發(fā)環(huán)境(Development Environment)，每個開發(fā)人員自己搭建的環(huán)境，當然一般也會在公司內(nèi)部服務(wù)器搭建一些諸如數(shù)據(jù)庫、分布式服務(wù)等公用的開發(fā)環(huán)境服務(wù)。
sit就是系統(tǒng)集成測試環(huán)境(System Integration Testing Environment)，主要目的是把系統(tǒng)的各個模塊作為一個組進行測試。
uat就是用戶驗收測試環(huán)境(User Acceptance Testing Environment)，一般是對系統(tǒng)比較熟悉的人，對開發(fā)成果進行驗收的環(huán)境。
sandbox就是沙箱環(huán)境(Sandbox Environment)，這個環(huán)境為的是最真實地模擬生產(chǎn)環(huán)境。
pro就是生產(chǎn)環(huán)境(Production Environment)，這個環(huán)境是我們最終交付的產(chǎn)品所運行的環(huán)境。
為什么要有這么多環(huán)境呢？答案是形勢所迫。隨著軟件開發(fā)的分工日益精細化和軟件系統(tǒng)的日益復雜化，不同環(huán)境所承擔的職責不同，但最終目的是一樣的：提高效率、保證質(zhì)量、節(jié)約成本、保證收益。
關(guān)于分環(huán)境的思想這里就不多講了，下面要講的一個問題是分環(huán)境是如何實現(xiàn)的？
分環(huán)境的實現(xiàn)方式有很多Spring Profile、Spring Boot等等都有不同的實現(xiàn)。
下面講一個使用 maven profiles 實現(xiàn)分環(huán)境配置的方式。
分環(huán)境實現(xiàn)
比如我在不同的環(huán)境需要提供不同的配置文件，怎么實現(xiàn)呢？
首先在pom.xml增加如下幾個環(huán)境的配置，并指定配置路徑：
<profiles>
<!-- 分環(huán)境profile> -->
<profile>
<id>dev</id>
<!-- 如果dev帶上activeByDefault，會默認將dev下的配置復制到config目錄下-->
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<properties>
<env>dev</env>
<package.target>dev</package.target>
<spring.profiles.active.value>dev</spring.profiles.active.value>
<yui.skip>true</yui.skip>
<config.path>src/main/resources/config/dev</config.path>
</properties>
</profile>
<!--sit-->
<profile>
<id>sit</id>
<properties>
<env>sit</env>
<package.target>sit</package.target>
<spring.profiles.active.value>sit</spring.profiles.active.value>
<yui.skip>false</yui.skip>
<config.path>src/main/resources/config/sit</config.path>
</properties>
</profile>
<!-- uat -->
<profile>
<id>uat</id>
<properties>
<env>uat</env>
<package.target>uat</package.target>
<spring.profiles.active.value>uat</spring.profiles.active.value>
<yui.skip>false</yui.skip>
<config.path>src/main/resources/config/uat</config.path>
</properties>
</profile>
<!--sandbox-->
<profile>
<id>sandbox</id>
<properties>
<env>sandbox</env>
<package.target>sandbox</package.target>
<spring.profiles.active.value>sandbox</spring.profiles.active.value>
<yui.skip>false</yui.skip>
<config.path>src/main/resources/config/sandbox</config.path>
</properties>
</profile>
<!--prod-->
<profile>
<id>prod</id>
<properties>
<env>prod</env>
<package.target>prod</package.target>
<spring.profiles.active.value>prod</spring.profiles.active.value>
<yui.skip>false</yui.skip>
<config.path>src/main/resources/config/prod</config.path>
</properties>
</profile>
</profiles>
然后在打包項目的時候通過-P參數(shù)指定環(huán)境就行了。例如打包uat環(huán)境：
$ mvn install -Puat
指定環(huán)境打包的缺點
首先就是慢，也可說浪費咖啡。很多大型項目每次從編譯到拉文件都要半個多小時。
那怎么節(jié)省發(fā)布的時間，讓我們早點下班呢？答案就是所有環(huán)境一個包。
5個環(huán)境就能節(jié)省2個小時，太值了！
只打一個包
怎么所有環(huán)境一個包呢？
首先在pom.xml配置maven-resources-plugin插件，并指定copy-resources的路徑，把所有環(huán)境的配置都打到包里。
<!-- maven-resources-plugin -->
<plugin>
<artifactId>maven-resources-plugin</artifactId>
<version>2.6</version>
<executions>
<execution>
<id>copy-resources</id>
<phase>validate</phase>
<goals>
<goal>copy-resources</goal>
</goals>
<configuration>
<outputDirectory>${basedir}/target/classes/config</outputDirectory>
<resources>
<resource>
<directory>${config.path}/</directory>
<filtering>true</filtering>
</resource>
</resources>
</configuration>
</execution>
</executions>
</plugin>
然后正常使用mvn install打包。
最后把要發(fā)布的包復制到指定環(huán)境機器的磁盤上以后，通過mv命令把需要發(fā)布的環(huán)境的配置移動出來。例如發(fā)布sandbox環(huán)境：
mv config/sandbox/* config/
當然這個操作不是必須的，比如你在啟動容器的時候指定了當前的環(huán)境，然后通過${spring.profile.active}來指定當前讀取哪個目錄下的配置也可以。
版本檢查
現(xiàn)在解決了打包慢的問題，但是怎么保證運維人員發(fā)布的代碼版本跟我們功能所在的版本一致呢？
當然可以口頭確認，結(jié)果就發(fā)生了上面的“慘案”。
那么我們能不能自己檢查呢？那就要借助工具了。
git-commit-id-plugin
git-commit-id-plugin是一個插件，會根據(jù)當前分支的版本號生成一個git.properties文件。
首先在pom.xml引入插件配置：
<!-- https://github.com/git-commit-id/maven-git-commit-id-plugin -->
<plugin>
<groupId>pl.project13.maven</groupId>
<artifactId>git-commit-id-plugin</artifactId>
<version>${git-commit-id-plugin.version}</version>
<executions>
<execution>
<id>get-the-git-infos</id>
<goals>
<goal>revision</goal>
</goals>
</execution>
</executions>
<configuration>
<!-- 使properties擴展到整個maven bulid 周期, Ref: https://github.com/ktoso/maven-git-commit-id-plugin/issues/280 -->
<injectAllReactorProjects>true</injectAllReactorProjects>
<dateFormat>yyyy.MM.dd HH:mm:ss</dateFormat>
<verbose>true</verbose>
<!-- 是否生 git.properties 屬性文件 -->
<generateGitPropertiesFile>true</generateGitPropertiesFile>
<!--git描述配置,可選;由JGit提供實現(xiàn); -->
<gitDescribe>
<!--是否生成描述屬性 -->
<skip>false</skip>
<!--提交操作未發(fā)現(xiàn)tag時,僅打印提交操作ID -->
<always>false</always>
<!--提交操作ID顯式字符長度,最大值為:40;默認值:7; 0代表特殊意義;-->
<abbrev>7</abbrev>
<!--構(gòu)建觸發(fā)時,代碼有修改時(即"dirty state"),添加指定后綴;默認值:""; -->
<dirty>-dirty</dirty>
<forceLongFormat>false</forceLongFormat>
</gitDescribe>
</configuration>
</plugin>
接著打包項目，你就可以看到自己編譯的文件下面多了一個git.properties文件：
#Generated by Git-Commit-Id-Plugin
#Sat Apr 20 13:08:01 CST 2019
git.branch=master
git.build.host=DESKTOP-12GT5DQ
git.build.time=2019.04.20 13\:08\:01
git.build.user.email=ijiangtao@foxmail.com
git.build.user.name=ijiangtao
git.build.version=1.1.01.01-SNAPSHOT
git.closest.tag.commit.count=
git.closest.tag.name=
git.commit.id=67b60eeffa9deca877c2b9a28d52a40d3ea55444
git.commit.id.abbrev=67b60ee
git.commit.id.describe=67b60ee
git.commit.id.describe-short=67b60ee
git.commit.message.full=\u53D1\u9001\u91CD\u8981\u6570\u636E\u7ED9\u8001\u677F~~~~
git.commit.message.short=\u53D1\u9001\u91CD\u8981\u6570\u636E\u7ED9\u8001\u677F~~~~
git.commit.time=2019.04.20 12\:57\:50
git.commit.user.email=ijiangtao@foxmail.com
git.commit.user.name=ijiangtao
git.dirty=false
git.remote.origin.url=https\://github.com/javastudydemo/jsd-maven.git
git.tags=
git.total.commit.count=2
有了這個文件，我們就可以清晰地知道生產(chǎn)環(huán)境的代碼是什么版本了。
需要特別注意的是，使用這個插件要保證你編譯的項目是有.git目錄的，因為這個插件要獲取git的提交信息，如果不使用git進行版本管理的項目，編譯會報錯。
版本檢查地址
下面提供一個Controller來展示git的提交信息。
package net.ijiangtao.tech.maven.web.controller;
import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.serializer.SerializerFeature;
import com.wordnik.swagger.annotations.Api;
import com.wordnik.swagger.annotations.ApiOperation;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import java.util.*;
import static org.apache.commons.lang3.ObjectUtils.defaultIfNull;
/**
* @author ijiangtao
*/
@Controller
@Api(value = "", description = "git info from git-commit-id-plugin")
public class GitCommitController {
/**
* @return
*/
@RequestMapping("/git/commit/info")
@ResponseBody
@ApiOperation(value = "get commit info", httpMethod = "GET")
public String showGitCommitInfo() {
//git.properties
ResourceBundle resourceBundle = ResourceBundle.getBundle("git", defaultIfNull(null, Locale.getDefault()));
Map<String, String> map = new TreeMap<>();
Enumeration<String> keysEnumeration = resourceBundle.getKeys();
while (keysEnumeration.hasMoreElements()) {
String key = keysEnumeration.nextElement();
map.put(key, resourceBundle.getString(key));
}
return JSON.toJSONString(map, SerializerFeature.PrettyFormat);
}
/**
* @return
*/
@ApiOperation(value = "get commit id", httpMethod = "GET")
@RequestMapping("/git/commit/id")
@ResponseBody
public String showGitCommitId() {
//git.properties
ResourceBundle resourceBundle = ResourceBundle.getBundle("git", defaultIfNull(null, Locale.getDefault()));
return resourceBundle.getString("git.commit.id");
}
}
通過Jetty插件啟動項目，并訪問SwaggerUI地址 http://localhost:8241/swagger/index.html ，最后通過http://localhost:8241/git/commit/info請求到了我們的git提交信息。
一般我們?yōu)榱税姹净貪L的方便，發(fā)布的時候會通過git commit id進行打包，可以通過機器對比兩者是否一致，達到自動檢查的目的，而不是每次需要人工檢查。
總結(jié)
本文講解了使用Maven進行分環(huán)境配置和進行發(fā)布版本檢查的一種實現(xiàn)模式，在持續(xù)集成/持續(xù)部署(CI/CD)的實踐中非常有借鑒意義。
