團隊開發專案時,經常要頻繁地推拉、打包專案,如果能讓機器自動去做這些重復的作業,將節省大量時間,
Jenkins是基于Java開發的一種持續集成工具,用于監控持續重復的作業,旨在提供一個開放易用的軟體平臺,使軟體專案可以進行持續集成,學會使用Jenkins是中高級開發人員必備技能,
自動化構建經驗分享
- 一、自動化構建準備作業
- 1、需要哪些工具?
- 2、自動化構建原理
- 二、Jenkins安裝與配置
- 1、Jenkins安裝
- 2、進入Jenkins初始化頁面
- 3、Jenkins各項配置
- 三、Jenkins的使用
- 1、創建構建流程任務
- 2、傳遞構建引數,命令Unity打包
- 3、Unity接收引數,自動打包
- 4、Jenkins其他功能
- 四、云效+Jenkins 實作持續集成
- 1、云效代碼庫創建、遷移與配置
- 2、獲取Secret Token,創建Webhooks
- 3、創建流水線,添加執行命令
- 4、云效專案如何部署密鑰
- 5、云效如何配置個人SSH密鑰
- 五、其他問題解決辦法
- 1、訪問localhost:8080,提示無法訪問此網站
- 2、構建專案報錯
- 3、Jenkins插件安裝失敗處理方法
- 4、Jenkins防止跨站點請求偽造(CSRF)
- 5、Unity制作批量打包工具
- 6、查看本地或域用戶
- 7、獲取本機IP地址
一、自動化構建準備作業
1、需要哪些工具?
1、代碼托管平臺(如Github、碼云、云效等)
用于對專案原始碼進行管理,(本文以云效進行舉例 https://account.aliyun.com/)
2、一臺用于安裝Jenkins的服務器,如自己的電腦或者阿里云服務器等(需要安裝并配置java環境)
3、Jenkins及其插件
用于接受觸發事件,對專案進行打包、構建等操作,
(如匯出.apk、.exe、.isa、.jar)
下載地址:https://www.jenkins.io/download/
4、Tomcat(本文未使用tomcat,不過建議安裝,會比較方便)
Tomcat是一個免費的開放源代碼的Web 應用服務器,可利用它回應HTML頁面的訪問請求,
下載地址:https://tomcat.apache.org/index.html
如果安裝了tomcat,則無需安裝Jenkins,將下載好的jenkins.war放進tomcat/webapps目錄下,配置JAVA_HOME及JRE_HOME環境變數即可;
2、自動化構建原理
代碼托管平臺受到特殊指令,主動觸發Jenkins,Jenkins收到指令做資源拉取、控制本地工具構建等操作,
比如我們提交代碼到Github的時候,Github會幫我們發送一個關于Push的Post請求到我們的Jenkins服務器,然后Jenkins持續集成插件webhooks會接收到請求的引數,觸發構建流程自動做專案打包等作業,
二、Jenkins安裝與配置
注意:Jenkins和Tomcat安裝之前需要確定電腦已經安裝并配置了java環境,沒安裝的可以參考此篇博客,分享有JDK\SDK等的下載地址,
Win10環境部署Tomcat,不想裝或者已經裝過Tomcat的自行跳過,
部署方式參考這篇博客:https://blog.csdn.net/weixin_43720619/article/details/94769680
1、Jenkins安裝
(1)安裝了tomcat
如果安裝了tomcat,則無需安裝Jenkins,將下載好的jenkins.war放進tomcat/webapps目錄下,配置JAVA_HOME及JRE_HOME環境變數即可;
(2)沒安裝tomcat看這里
Jenkins下載地址https://jenkins.io/download/,僅下載war包;

安裝部分可以看我下面的介紹,也可以參考Jenkins官方檔案: 傳送門
下載好之后,cmd打開命令提示符視窗,進入jenkins.war存放的檔案夾,運行命令 java -jar jenkins.war,

2、進入Jenkins初始化頁面
注意:如果在使用Jenkins程序中遇到 “無法訪問此網站” 等問題,參考此博客末尾的特殊問題解決辦法,
瀏覽器瀏覽http://localhost:8080(或您在安裝時為 Jenkins 配置的任何埠),等待Unlock Jenkins頁面出現,第一次啟動時間可能有點長,耐心等待,根據頁面提示路徑拿到管理員密碼,單擊繼續,

解鎖后可能出現如下圖所示界面:

表示無法下載Jenkins插件,可能是因為防火墻導致,沒關系,可以進入Jenkins內部下載指定插件,
接著進入用戶創建頁面,設定登陸用戶和密碼,設定成功后即進入Jenkins主界面:

3、Jenkins各項配置
Jenkins各項配置基本都在如下界面:

1.插件下載
除了默認插件以外,進行Unity構建還需要一些特定的插件,
打開插件設定(ManagerPlugins),以Unity3D開發為例,搜索欄輸入unity,可以在可選插件中找到Unity打包構建的相關插件,勾選后點擊左下角下載匯入,

如下圖匯入成功

用Jenkins做持續集成時,一般會使用webhooks觸發構建,比如我們每一次提交代碼到云效、碼云或Github的時候,這些平臺會幫我們發送一個關于Push的Post請求到我們的Jenkins服務器,然后Jenkins持續集成插件webhooks會接收到請求的引數,觸發構建流程自動做專案打包等作業,
搜索webhooks,匯入

2.系統配置
(1)增加系統管理員郵件地址:

(2)添加編碼全域屬性,保存退出,(除了JDK必須配置,其他屬性根據開發需要自行配置)

3.全域工具配置
打開Global ToolConfiguration,配置JDK和Unity3D的路徑,
不勾選自動安裝(Install automatically)


如果用到Maven同樣配置一下,

4.全域安全配置
授權策略根據需求自行選擇,指定某項授權可以用安全矩陣,

關于跨站點請求偽造(CSRF),如果安裝的jenkins是2.204.6之前的版本,可以直接勾選關閉,2.204.6之后的版本洗掉了禁用 CSRF 保護的功能,如下圖,需要特殊處理,暫時不管后面會說,

三、Jenkins的使用
1、創建構建流程任務
點擊“新建Item”,命名任務名稱,選擇自由風格,確定,

創建完成進入如下界面,點擊配置,

設定專案備注、構建規則、顯示名稱等,此處因為使用本地專案測驗構建的,所以點擊右側高級設定,填入自定義的作業空間的地址,它的目錄就是當前流程所涉及到操作的unity工程,如下圖:

Disable Old Builds:
一個流程會被創建(Build)很多次,當到達一定的時間或者一定的構建次數時候,舊的創建是否被丟棄,一般這個是需要使用到的,
Git Hub 專案:這個流程是否使用到github上的專案,這里不勾選
This build requires lockable resources:如果有多個并發創建同時對一個資源有需求并且當前創建正在使用這個需求,則當前創建會將這個資源占為己有,等用完之后才釋放給其他創建使用,
This project is parameterized:當前流程所操作的專案是否需要引數,可能會使用到
Throttle builds: 限制在規定時間內只能執行定義好次數的構建
關閉構建:不再使用當前構建
在必要時并發構建:是否運行當前構建能夠和其他構建同時執行,這可能會引起一些問題,一般關閉
Build after other projects are built:指定某個流程, 當這個流程跑完之后,當前流程就會接著執行,
Build periodically:是否會后臺周期性的執行流程,可以指定周期時長,在問號點開的地方可以查看寫法,這個選項比較常用,因為unity的打包或者熱更通常需要等待,而開發者這時通常不能做什么,所以通常設定在晚上的11點或者其他時間進行自動執行流程,
Poll SCM:流程的執行通常會有具體內容,這個內容是由開發者在流程中寫好代碼執行的,這個選項勾選之后,沒一定時間會檢查代碼是否有更新,如果有更新則會重新執行流程,
如果需要下拉資源進行構建,配置URL

2、傳遞構建引數,命令Unity打包
構建步驟,在流程中涉及到的操作,這里只涉及到unity編輯器操作,也可以執行python、windows批處理命令,

命令列(注意空格)
-batchmode -executeMethod PerformBuild.CommandLineBuild AppName-TestAPK -quit
解釋下這條命令的含義:
批處理執行Unity專案中PerformBuild腳本的CommandLineBuild方法,其中引數AppName值為TestAPK,構建完畢后退出(-quit),
3、Unity接收引數,自動打包
注意:在構建程序中不能用unity開啟此工程,否則會報錯,
Jenkins構建步驟完畢,在Unity專案中創建一個Editor腳本,用來接收引數,執行構建,
原始碼如下:
using UnityEngine;
using UnityEditor;
using System.Collections;
using System.Collections.Generic;
using System;
using System.IO;
public class PerformBuild
{
static string[] GetBuildScenes()
{
List<string> names = new List<string>();
foreach (EditorBuildSettingsScene e in EditorBuildSettings.scenes)
{
if (e == null)
continue;
if (e.enabled)
names.Add(e.path);
}
return names.ToArray();
}
/// <summary>
/// 此方法是從jienkins上接受 資料的 方法
/// </summary>
static void CommandLineBuild()
{
try
{
//獲取需要打包的場景
string[] scenes = GetBuildScenes();
for (int i = 0; i < scenes.Length; ++i)
{
Debug.Log(string.Format("Scene[{0}]: \"{1}\"", i, scenes[i]));
}
//ProjectPackageEditor.BuildByJenkins(GetJenkinsParameter("Platform"), GetJenkinsParameter("AppID"), GetJenkinsParameter("Version"), GetJenkinsParameter("IPAddress"));
string target_dir = "E:/APK_測驗服";//這里的路徑是打包的路徑, 定義
string target_name = GetJenkinsParameter("AppName") + ".apk";//通過GetJenkinsParameter()方法獲取引數
if (Directory.Exists(target_dir))
{
if (File.Exists(target_name))
{
File.Delete(target_name);
}
}
else
{
Directory.CreateDirectory(target_dir);
}
//構建Android專案
BuildPipeline.BuildPlayer(scenes, target_dir + "/" + target_name, BuildTarget.Android, BuildOptions.None);
}
catch (Exception err)
{
Console.WriteLine("方法F中捕捉到:" + err.Message);
throw;//重新拋出當前正在由catch塊處理的例外err
}
finally
{
Debug.Log("----------> I am copying! <--------------");
}
}
/// <summary>
///解釋jekins 傳輸的引數
/// </summary>
/// <param name="name"></param>
/// <returns></returns>
static string GetJenkinsParameter(string name)
{
foreach (string arg in Environment.GetCommandLineArgs())
{
if (arg.StartsWith(name))
{
return arg.Split("-"[0])[1];
}
}
return null;
}
}
回到Jenkins,打開之前創建的任務,點擊BuildNow執行構建,可以在下方看到構建情況,構建完成即可在生成檔案中看到打出的apk,


感謝這兩位博主的分享,大家也可以參考一下:
http://www.u3d8.com/?p=1996
https://www.xuanyusong.com/archives/3349
4、Jenkins其他功能
1.查看Jenkins的系統屬性和環境變數等配置資訊
System Information


2.如何使用命令列操作Jenkins?
首頁-系統管理-Jenkins CLI,點擊下載jenkins-cli.jar保存至本地,
輸入命令列 java -jar jenkins-cli.jar -s http://IP:8080/ help,即可彈出所有命令的用法說明,

四、云效+Jenkins 實作持續集成
嘗試了在服務器上用Jenkins構建專案,下面接著嘗試用云效來遠程觸發Jenkins構建專案,
1、云效代碼庫創建、遷移與配置
關于代碼庫遷移可參考云效官方檔案:傳送門
點擊代碼管理進入代碼庫,選擇添加庫,可以選擇新建代碼庫或者匯入GitHub/碼云等其他代碼托管平臺的專案,
1、如果新建代碼庫,本地通過URL提交專案至該代碼庫,
2、如果匯入其他平臺倉庫,如碼云,則本地可以仍舊提交至原來平臺,云效自動拉取該平臺資料,

我這邊是新建了代碼庫來測驗,點擊克隆下載,復制HTTPS,在本地使用PlasticSCM 推送了新建的專案,如下圖,
需要安裝plastic可參考此博客:https://blog.csdn.net/qq_43505432/article/details/108347792

用Jenkins做持續集成時,一般會使用webhooks觸發構建,或者定時構建,這里記錄用URL的方式觸發Jenkins構建,
點擊右邊設定,先來設定以下WebHooks,

可以看到,創建webhooks需要URL(專案網址)和Secret Token(秘密令牌),下面教一下怎么獲取,
2、獲取Secret Token,創建Webhooks



可以參考此博客:https://www.cnblogs.com/tyrionyang/p/8183819.html
3、創建流水線,添加執行命令


添加執行命令

執行命令獲取方式:
登錄Jenkins,點擊用戶串列,選擇指定用戶,點擊設定,點擊"添加新Token",生成Token,及時復制保存,后面就看不到了,

打開之前創建的任務,勾選觸發遠程構建,輸入身份驗證令牌(自己隨便定義)

根據以上資訊,就可以創建一條這樣的命令:
curl -X POST http://(用戶名):(Token)@(IP地址:埠號)/jenkins/job/(任務路徑)/build?token= (身份驗證令牌)
如我創建的URL:
http://chengliang:11b7asd91cff77c690a6dcf1375634b4e@http://172.12.115.66:8080/jenkins/job/Test3/build?token= 123456
填入命令,保存并運行,即可在Jenkins中看到正在構建


可參考此博客:
https://blog.csdn.net/yaocsu/article/details/118528153
https://www.cnblogs.com/tyrionyang/p/8183819.html
4、云效專案如何部署密鑰
云效官方檔案: https://help.aliyun.com/document_detail/153876.html
5、云效如何配置個人SSH密鑰
云效官方檔案:https://help.aliyun.com/document_detail/153709.html?spm=a2cl9.codeup_devops2020_goldlog_projectSettings.0.0.60ea657aFsn0eO


根據路徑找到公鑰(id_rsa.pub)和私鑰(id_rsa),可以直接用記事本等文本工具打開,注意私鑰檔案不要輕易泄露,

五、其他問題解決辦法
1、訪問localhost:8080,提示無法訪問此網站
可能埠被占用,關閉這些行程
先查看埠占用情況
netstat -aon|findstr "8080"
埠“8080”被PID(行程號)為21808的行程占用,按行程號關閉行程
taskkill /pid 21808
taskkill /f /pid 21808//強制關閉行程

關閉后重新再查看一次埠占用情況,如果顯示還未關閉,可以強制關閉此行程,
訪問http://localhost:8080/,如果仍然提示無法訪問此網站,那就運行java -jar jenkins.war,一直掛著命令提示符不要關閉,即可進入此網站,
命令列查看埠占用:https://www.cnblogs.com/rainman/p/3457227.html
2、構建專案報錯
Aborting batchmode due to failure: Couldn’t set project path to: E:/***

因為在任務中沒有配置作業空間,打開工程配置,點擊右側“高級”,填入專案路徑,起個名稱,

3、Jenkins插件安裝失敗處理方法
https://www.cnblogs.com/sxdcgaq8080/p/10489326.html
4、Jenkins防止跨站點請求偽造(CSRF)
在Jenkins啟動前加入相關取消保護的引數配置后啟動Jenkins,即可關閉CSRF,配置內容如下:
-Dhudson.security.csrf.GlobalCrumbIssuerConfiguration.DISABLE_CSRF_PROTECTION=true
Jenkins若是跑在Tomcat下,只需在tomcat啟動腳本中加入配置即可;若是以jar包形式部署的,只需在啟動時加上配置引數即可,
配置后重啟Jenkins,在全域安全配置中可看到CSRF保護功能已關閉,

5、Unity制作批量打包工具
參考此博客:https://blog.csdn.net/qq_43505432/article/details/118418767
6、查看本地或域用戶
whoami
hostname

7、獲取本機IP地址
ipconfig 或 ipconfig/all

轉載請註明出處,本文鏈接:https://www.uj5u.com/yidong/299371.html
標籤:其他
上一篇:Android——自定義View
