回擼Rust China Conf 2020 之《Rust企業級應用最佳實踐》

本篇回擼一把《Rust企業級應用最佳實踐》,講者分享了Rust應用的“最后一公里”中所解決的問題和有效實踐,非常接地氣。

Speaker: Liao Yiming (廖意明)

視頻 PDF

1. 面向CI的Cargo工具

stages:
    - build
build_release:
    stage: build
    script:
        - ...
        - cargo fmt
        - cargo fix
        - cargo fix
        - RUSTFLAGS="-D warnings" cargo clippy
        - cargo build --release

本章節分享的最佳實踐:在做人工的Code Review之前,盡可能的利用自動化檢查工具進行預審查,并展示了一個構件腳本。

這個腳本要求開發者在提交時,要在本地做好cargo fmt、fixclippy,否則CI流水線是無法通過的。

腳本中有兩處cargo fix,這是一個trick:如果在第一處cargo fix修改了代碼,就會導致第二個cargo fix因為code dirty而無法通過。

接下來的cargo clippy-D warnings參數,表示構建不接受warning,開發者可以在代碼中添加#![deny(warnings)],或者在本地運行cargo clippy -- -D warnings來檢查是否滿足該要求。

2. SemVer

image

本章節介紹了定義依賴時的語義化版本的概念,如上圖。

下面是一些自定義升級策略的例子。其中"^0.2.3"之所以不能自動升級到“1.0.0”是因為在語義化版本中,第一位Major位為0,表示不穩定,所以升級幅度會有限制。

[dependencies]
kov = "=1.2.3"          # 可用版本:1.2.
kov = "^1.2.3"          # 可用版本:>= 1.2.3 且 < 2.0.0
kov = "^1.2"            # 可用版本:>= 1.2.0 且 < 2.0.0
kov = "^1"              # 可用版本:>= 1.0.0 且 < 2.0.0
kov = "^0.2.3"          # 可用版本:>= 0.2.3 且 < 0.3.0
kov = "^0.2"            # 可用版本:>= 0.2.0 且 < 0.3.0
kov = "^0.0.3"          # 可用版本:>= 0.0.3 且 < 0.0.4
kov = "^0.0"            # 可用版本:>= 0.0.0 且 < 0.1.0
kov = "^0"              # 可用版本:>= 0.0.0 且 < 1.0.0
kov = "*"               # 可用版本:>= 0.0.0
kov = "1.*"             # 可用版本:>= 1.0.0 且 < 2.0.0
kov = "1.2.*"           # 可用版本:>= 1.0.0 且 < 2.0.0
kov = ">1.2.3"          # 可用版本:> 1.2.3
kov = ">1.2.3 <1.2.17"  # 可用版本:> 1.2.3 且 < 1.2.17
kov = "<=1.2.3"         # 可用版本:<= 1.2.3

如果大家想去試更多的case,可以試下這個在線計算器semver calculator。

講者在本章節分享了自己遇到的幾次“飯后編譯失敗”的經歷。造成的原因是:語義化版本的兼容性,是由開發者人為保證的,所以有可能出錯。如果出現了因為Cargo Update導致的編譯失敗,可以通過前面的kov = "=1.2.3"強制鎖定版本來解決。

本章關于語義化版本的最佳實踐:

  • 不要使用通配符*
  • 盡可能明確版本“x.y.z”,并通過cargo update -p cratename來指定升級,而不要cargo update進行大面積升級;
  • 對于crate提供者,一旦出現兼容性問題,馬上進行cargo yank,可以阻止還沒用過問題版本的用戶看到此版本。

3. 私庫依賴

Cargo.toml中的依賴,除了指定語義化版本之外,在私有代碼場景中,可以用git依賴的方式,比如下面列舉的默認分支、指定分支、commit id、tag等等。

rand = {git="https://github.com/rust-lang-nursey/rand"}
rand = {git="https://github.com/rust-lang-nursey/rand", branch="next"}
rand = {git="https://github.com/rust-lang-nursey/rand", rev="39a7x2"}
rand = {git="https://github.com/rust-lang-nursey/rand",tag="0.3.1"}

但是,這會帶來“多模塊依賴問題”的問題。如下圖所示:

image

<figcaption style="margin-top: 0.66667em; padding: 0px 1em; font-size: 0.9em; line-height: 1.5; text-align: center; color: rgb(153, 153, 153);">來源:講者PPT</figcaption>

Error: perhaps two different version of crate 'x' are being used?

講者分享了他發現的一個解決方案:在Rust 1.34.0引入的Alternate Register,可以向私有庫進行語義化版本的發布:

  • ~/.cargo/config
[registries]
my-registry={index="https://my-intranet:8080/git/index"}
  • cargo login --registry=my-registry
  • cargo publish --registry=my-registry
  • Cargo.toml
[dependencies]
other-crate={version="1.0",registry="my-registry"}

本章的建議:避免由開發者在本地進行隨意的發布,應該在CI流水線在合適的時機進行自動化發布

4. 構建腳本

本章分享了Rust的構建腳本,在Cargo.toml中的package中添加build項,如下圖所示。其中build.rs文件目錄同Cargo.toml即可。

[package]
name = "demo"
version = "1.0.0"
edition = "2018"
build = "build.rs"

構建腳本,可以把很多額外的信息動態加入到編譯后的可執行文件中,包括可執行文件的當前版本、編譯環境、系統版本等,方便追溯。

為了更快捷的創建構建腳本,講者開源了一個構建腳本工具shadow-rs:shadow-rs allows you to recall properties of the build process and environment at runtime, including:

  • Cargo.toml project version
  • Dependency information
  • The Git commit that produced the build artifact (binary)
  • What version of the rust toolchain was used in compilation
  • The build variant, e.g. debug or release
  • (And more)

來加顆star吧。

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,818評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,185評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事?!?“怎么了?”我有些...
    開封第一講書人閱讀 175,656評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,647評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,446評論 6 405
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,951評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,041評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,189評論 0 287
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,718評論 1 333
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,602評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,800評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,316評論 5 358
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,045評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,419評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,671評論 1 281
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,420評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,755評論 2 371

推薦閱讀更多精彩內容