5. 構建工具
構建是指將源碼轉換成一個可使用的二進制程序的過程。這個過程可以包括但不限於這幾個環節:下載依賴、編譯、打包。構建過程的輸出——比如一個zip包,我們稱之爲製品(有些書籍也稱之爲產出物)。而管理製品的倉庫,稱爲製品庫。
5.1 構建工具的選擇
對構建工具的選擇,還取決於團隊對工具本身的接受程度。建議是,團隊中同一技術棧的所有項目都使用同一個構建工具。
5.2 tools指令介紹
tools指令能幫助我們自動下載並安裝所指定的構建工具,並將其加入PATH變量中。這樣,我們就可以在sh步驟裏直接使用了。但在agent none的情況下不會生效。
tools指令默認支持3種工具:JDK、Maven、Gradle。通過安裝插件,tools指令還可以支持更多的工具。接下來,我們介紹幾種常用的構建環境的搭建。
5.3 JDK環境搭建
5.3.1 自動安裝JDK
進入Manage Jenkins→Global Tool Configuration→JDK頁,單擊“Add JDK”:
注意
- 這裏需要oracle帳戶驗證。
- Jenkins不會馬上下載JDK,而是當pipeline使用到時纔會直接執行下載操作。
5.3.2 自定義JDK路徑
基於安全的考慮,公司的內網機器可能無法直接訪問因特網,所以使用自動下載會失敗。這時就需要在Jenkins agent上準備JDK,然後在Manage Jenkins→Global Tool Configuration→JDK頁中指定名稱和JAVA_HOME路徑:
5.4 Maven
5.4.1 使用Maven進行構建
Jenkins pipeline的tools指令默認就支持Maven。所以,使用Maven只需要兩步。1-進入Manage Jenkins→Global Tool Configuration→Maven頁,單擊“Add Maven”:
- 在Jenkinsfile中指定Maven版本,並使用mvn命令。
5.4.2 使用Managed files設置Maven
Maven默認使用的是其官方倉庫,國內下載速度很慢。所以,我們通常會使用國內的Maven鏡像倉庫。這時就需要修改 Maven 的配置文件 settings.xml。settings.xml 文件的默認路徑爲${M2_HOME}/conf/settings.xml。但是,我們是不可能登錄上Jenkins的機器,然後手動修改這個文件的。
Config File Provider插件能很好地解決這個問題。只需要在Jenkins的界面上填入settings.xml的內容,然後在pipeline中指定settings.xml就可以了。也就是說,對於不同的pipeline,可以使用不同的settings.xml。
具體實現方法如下:
- 安裝Config File Provider插件。
- 進入Manage Jenkins頁面,就可以看到多出一個“Managed files”菜單
- 單擊“Managed files”進入,在左側菜單欄中選擇“Add a new Config”,就會看到該插件支持很多種配置文件的格式及方式,
4選擇“Global Maven settings.xml”選項。因爲我們的設置是全局的。填寫“ID”字段,Jenkins pipeline會引用此變量名。假如使用的ID爲maven-global-settings。
5 在編輯頁將自定義的Maven settings.xml的內容粘貼到“Content”字段中,
- 在Jenkins pipeline中使用的方法如下:
configFileProvider([configFile(fileId: "maven-global-settings", variable: "MAVEN_GLOBAL_ENV")]) {
sh "mvn -s $MAVEN_GLOBAL_ENV clean install"
}
5.5 Go語言環境搭建
Jenkins支持Golang的構建,只需要以下幾步。
- 安裝Go插件。
- 進入Manage Jenkins→Global Tool Configuration→Go頁
- 在pipeline中加入tools部分。
pipeline {
agent none
environment {
GOPATH = "${env.WORKSPACE}/"
}
tools {
go 'go1.10'
}
stages {
stage('build') {
steps {
sh "go build"
}
}
}
}
此時,在環境變量中會增加一個GOROOT變量。
- 設置GOPATH。瞭解Go語言開發的讀者都會知道,編譯時需要設置GOPATH環境變量。直接在environment指令中添加就可以了。
5.6 Python環境搭建
Python環境很容易產生Python版本衝突、第三方庫衝突等問題。所以,Python開發通常會進行工程級別的環境隔離,也就是每個Python工程使用一個Python環境。
在Jenkins環境下,我們使用Pyenv Pipeline插件可以輕鬆地實現。
首先,準備Python基礎環境。
- 在Jenkins機器上安裝python、pip、virtualenv。
- pip:Python的包管理工具。
- virtualenv:Python中的虛擬環境管理工具。
- 安裝Pyenv Pipeline插件。
然後,在pipeline中使用Pyenv Pipeline插件提供的withPythonEnv方法。
withPythonEnv("/usr/bin/python") {
sh "python --version"
}
withPythonEnv方法會根據第一個參數——可執行python路徑——在當前工作空間下創建一個virtualenv環境。
withPythonEnv方法的第二個參數是一個閉包。閉包內的代碼就執行在新建的virtualenv環境下。
5.7 利用環境變量支持更多的構建工具
不是所有的構建工具都需要安裝相應的Jenkins插件纔可以使用。
平時,開發人員在搭建開發環境時做的就是:首先在機器上安裝好構建工具,然後將這個構建工具所在目錄加入PATH環境變量中。
如果想讓Jenkins支持更多的構建工具,也是同樣的做法:在Jenkins agent上安裝構建工具,並記錄下它的可執行命令的目錄,然後在需要使用此命令的Jenkins pipeline的PATH環境變量中加入該可執行命令的目錄。示例如下:
pipeline {
agent none
environment {
PATH = "/usr/local/customtool/bin:$PATH"
}
stages {
stage('build') {
steps {
sh "customtool build"
}
}
}
}
還可以有另一種寫法:
pipeline {
agent none
environment {
CUSTOM_TOOL_HOME = "/usr/local/customtool/bin"
}
stages {
stage('build') {
steps {
sh "${CUSTOM_TOOL_HOME}/customtool build"
}
}
}
}