目錄
- 一個(gè)故事(事故)
- 分環(huán)境
- 分環(huán)境實(shí)現(xiàn)
- 指定環(huán)境打包的缺點(diǎn)
- 只打一個(gè)包
- 版本檢查
- git-commit-id-plugin
- 版本檢查地址
- 總結(jié)
- 相關(guān)資源
DevOps是Development和Operations的組合詞种蝶，作為一名軟件工程師或者系統(tǒng)架構(gòu)師堂淡，對(duì)于系統(tǒng)的開發(fā)和部署需要有充分的了解和把控钧萍。
下面我們通過一個(gè)故事，把軟件發(fā)布中的分環(huán)境配置和版本檢查的解決方案為你娓娓道來......
本文涉及到的所有代碼可以在這里 ?? maven-devops 獲取。
一個(gè)故事(事故)
試想這樣一個(gè)場(chǎng)景埃疫，你做了一個(gè)功能：
每天凌晨4點(diǎn)去某個(gè)系統(tǒng)拉取一份數(shù)據(jù)郵件放坏，然后第二天上午6點(diǎn)以郵件的形式發(fā)給你的老板。
首先你在自己的電腦上開發(fā)和測(cè)試亿傅，確認(rèn)開發(fā)完成以后媒峡，把代碼打包放到測(cè)試服務(wù)器上跑了一下。
你找到可愛的測(cè)試小妹妹葵擎，經(jīng)過嚴(yán)格的測(cè)試谅阿，確認(rèn)通過了所有測(cè)試用例。最后你不忘恭維一下測(cè)試小妹妹最近燙的頭發(fā)真漂亮，并含蓄地表示有空想請(qǐng)她看最近上映的漫威電影签餐。( 而實(shí)際上測(cè)試小妹妹的頭發(fā)沒有燙過寓涨，她也沒聽懂你的暗示，她更不喜歡看漫威的電影氯檐，最最關(guān)鍵的是戒良，你根本沒有時(shí)間請(qǐng)別人看電影——這個(gè)問題問一下你家里洗衣機(jī)里靜靜趟了兩星期的襪子就知道了。)
你把自己的代碼合并到主分支冠摄，然后通知發(fā)布人員把代碼發(fā)布到生產(chǎn)環(huán)境糯崎。當(dāng)你收到運(yùn)維人員發(fā)布成功的提醒的時(shí)候，抬頭看看表已經(jīng)是午夜兩點(diǎn)了河泳。你喝干凈杯子里的咖啡拇颅，深深懶腰，搭車回家了乔询。
第二天上午樟插，你在一陣急促的電話鈴聲中被吵醒，電話那頭的聲音頓時(shí)讓你困意全無：老板沒有收到任何郵件竿刁，郵件里的資料要在2h以后的一個(gè)重要會(huì)議中使用黄锤！
......
數(shù)據(jù)終于是想方設(shè)法搞到了，但疲憊食拜、恐懼鸵熟、羞恥和自責(zé)已經(jīng)淹沒了你的頭腦，你要搞事情了：查到原因负甸，徹底解決這個(gè)問題流强！
笨人和聰明人的差異就在于，笨人只會(huì)不停地栽跟頭呻待，而聰明人跌倒以后爬起來打月，不忘把坑填上，還會(huì)在旁邊立個(gè)碑蚕捉，以警后人 —— 能做到這一點(diǎn)的幾乎就是偉人了奏篙。
分環(huán)境
前面提到了你自己開發(fā)、給測(cè)試小妹妹測(cè)試以及給運(yùn)維人員發(fā)布迫淹，一共三個(gè)環(huán)境秘通，而實(shí)際上一個(gè)軟件系統(tǒng)的環(huán)境往往不止這些。
常用的環(huán)境有：dev敛熬、sit肺稀、uat、sandbox应民、pro话原。
dev就是開發(fā)環(huán)境(Development Environment)炸茧，每個(gè)開發(fā)人員自己搭建的環(huán)境，當(dāng)然一般也會(huì)在公司內(nèi)部服務(wù)器搭建一些諸如數(shù)據(jù)庫(kù)稿静、分布式服務(wù)等公用的開發(fā)環(huán)境服務(wù)梭冠。
sit就是系統(tǒng)集成測(cè)試環(huán)境(System Integration Testing Environment)，主要目的是把系統(tǒng)的各個(gè)模塊作為一個(gè)組進(jìn)行測(cè)試改备。
uat就是用戶驗(yàn)收測(cè)試環(huán)境(User Acceptance Testing Environment)控漠，一般是對(duì)系統(tǒng)比較熟悉的人，對(duì)開發(fā)成果進(jìn)行驗(yàn)收的環(huán)境悬钳。
sandbox就是沙箱環(huán)境(Sandbox Environment)盐捷，這個(gè)環(huán)境為的是最真實(shí)地模擬生產(chǎn)環(huán)境。
pro就是生產(chǎn)環(huán)境(Production Environment)默勾，這個(gè)環(huán)境是我們最終交付的產(chǎn)品所運(yùn)行的環(huán)境碉渡。
為什么要有這么多環(huán)境呢？答案是形勢(shì)所迫母剥。隨著軟件開發(fā)的分工日益精細(xì)化和軟件系統(tǒng)的日益復(fù)雜化滞诺，不同環(huán)境所承擔(dān)的職責(zé)不同，但最終目的是一樣的：提高效率环疼、保證質(zhì)量习霹、節(jié)約成本、保證收益炫隶。
關(guān)于分環(huán)境的思想這里就不多講了淋叶，下面要講的一個(gè)問題是分環(huán)境是如何實(shí)現(xiàn)的？
分環(huán)境的實(shí)現(xiàn)方式有很多Spring Profile伪阶、Spring Boot等等都有不同的實(shí)現(xiàn)煞檩。
下面講一個(gè)使用 maven profiles 實(shí)現(xiàn)分環(huán)境配置的方式。
分環(huán)境實(shí)現(xiàn)
比如我在不同的環(huán)境需要提供不同的配置文件栅贴，怎么實(shí)現(xiàn)呢斟湃？
首先在pom.xml增加如下幾個(gè)環(huán)境的配置，并指定配置路徑：
<profiles>
<!-- 分環(huán)境profile> -->
<profile>
<id>dev</id>
<!-- 如果dev帶上activeByDefault筹误，會(huì)默認(rèn)將dev下的配置復(fù)制到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>
然后在打包項(xiàng)目的時(shí)候通過-P參數(shù)指定環(huán)境就行了桐早。例如打包uat環(huán)境：
$ mvn install -Puat
指定環(huán)境打包的缺點(diǎn)
首先就是慢，也可說浪費(fèi)咖啡厨剪。很多大型項(xiàng)目每次從編譯到拉文件都要半個(gè)多小時(shí)。
那怎么節(jié)省發(fā)布的時(shí)間友存，讓我們?cè)琰c(diǎn)下班呢祷膳？答案就是所有環(huán)境一個(gè)包。
5個(gè)環(huán)境就能節(jié)省2個(gè)小時(shí)屡立，太值了直晨！
只打一個(gè)包
怎么所有環(huán)境一個(gè)包呢？
首先在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ā)布的包復(fù)制到指定環(huán)境機(jī)器的磁盤上以后敛摘，通過mv命令把需要發(fā)布的環(huán)境的配置移動(dòng)出來门烂。例如發(fā)布sandbox環(huán)境：
mv config/sandbox/* config/
當(dāng)然這個(gè)操作不是必須的，比如你在啟動(dòng)容器的時(shí)候指定了當(dāng)前的環(huán)境兄淫，然后通過${spring.profile.active}來指定當(dāng)前讀取哪個(gè)目錄下的配置也可以屯远。
版本檢查
現(xiàn)在解決了打包慢的問題，但是怎么保證運(yùn)維人員發(fā)布的代碼版本跟我們功能所在的版本一致呢捕虽？
當(dāng)然可以口頭確認(rèn)慨丐，結(jié)果就發(fā)生了上面的“慘案”。
那么我們能不能自己檢查呢泄私？那就要借助工具了房揭。
git-commit-id-plugin
git-commit-id-plugin是一個(gè)插件，會(huì)根據(jù)當(dāng)前分支的版本號(hào)生成一個(gè)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擴(kuò)展到整個(gè)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提供實(shí)現(xiàn); -->
<gitDescribe>
<!--是否生成描述屬性 -->
<skip>false</skip>
<!--提交操作未發(fā)現(xiàn)tag時(shí),僅打印提交操作ID -->
<always>false</always>
<!--提交操作ID顯式字符長(zhǎng)度,最大值為:40;默認(rèn)值:7; 0代表特殊意義;-->
<abbrev>7</abbrev>
<!--構(gòu)建觸發(fā)時(shí),代碼有修改時(shí)(即"dirty state"),添加指定后綴;默認(rèn)值:""; -->
<dirty>-dirty</dirty>
<forceLongFormat>false</forceLongFormat>
</gitDescribe>
</configuration>
</plugin>
接著打包項(xiàng)目崩溪，你就可以看到自己編譯的文件下面多了一個(gè)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
有了這個(gè)文件，我們就可以清晰地知道生產(chǎn)環(huán)境的代碼是什么版本了斩松。
需要特別注意的是伶唯，使用這個(gè)插件要保證你編譯的項(xiàng)目是有.git目錄的，因?yàn)檫@個(gè)插件要獲取git的提交信息惧盹，如果不使用git進(jìn)行版本管理的項(xiàng)目乳幸，編譯會(huì)報(bào)錯(cuò)。
版本檢查地址
下面提供一個(gè)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插件啟動(dòng)項(xiàng)目粹断，并訪問SwaggerUI地址 http://localhost:8241/swagger/index.html ，最后通過http://localhost:8241/git/commit/info請(qǐng)求到了我們的git提交信息嫡霞。
一般我們?yōu)榱税姹净貪L的方便瓶埋，發(fā)布的時(shí)候會(huì)通過git commit id進(jìn)行打包，可以通過機(jī)器對(duì)比兩者是否一致诊沪，達(dá)到自動(dòng)檢查的目的养筒，而不是每次需要人工檢查。
總結(jié)
本文講解了使用Maven進(jìn)行分環(huán)境配置和進(jìn)行發(fā)布版本檢查的一種實(shí)現(xiàn)模式端姚，在持續(xù)集成/持續(xù)部署(CI/CD)的實(shí)踐中非常有借鑒意義晕粪。
