本篇回?cái)]一把《Rust企業(yè)級(jí)應(yīng)用最佳實(shí)踐》，講者分享了Rust應(yīng)用的“最后一公里”中所解決的問題和有效實(shí)踐，非常接地氣。

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

本章節(jié)分享的最佳實(shí)踐：在做人工的Code Review之前，盡可能的利用自動(dòng)化檢查工具進(jìn)行預(yù)審查，并展示了一個(gè)構(gòu)件腳本。

這個(gè)腳本要求開發(fā)者在提交時(shí)，要在本地做好cargo fmt、fix、clippy，否則CI流水線是無法通過的。

腳本中有兩處cargo fix，這是一個(gè)trick：如果在第一處cargo fix修改了代碼，就會(huì)導(dǎo)致第二個(gè)cargo fix因?yàn)閏ode dirty而無法通過。

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

2. SemVer

image

本章節(jié)介紹了定義依賴時(shí)的語義化版本的概念，如上圖。

下面是一些自定義升級(jí)策略的例子。其中"^0.2.3"之所以不能自動(dòng)升級(jí)到“1.0.0”是因?yàn)樵谡Z義化版本中，第一位Major位為0，表示不穩(wěn)定，所以升級(jí)幅度會(huì)有限制。

[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，可以試下這個(gè)在線計(jì)算器semver calculator。

講者在本章節(jié)分享了自己遇到的幾次“飯后編譯失敗”的經(jīng)歷。造成的原因是：語義化版本的兼容性，是由開發(fā)者人為保證的，所以有可能出錯(cuò)。如果出現(xiàn)了因?yàn)?code>Cargo Update導(dǎo)致的編譯失敗，可以通過前面的kov = "=1.2.3"強(qiáng)制鎖定版本來解決。

本章關(guān)于語義化版本的最佳實(shí)踐：

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

3. 私庫(kù)依賴

Cargo.toml中的依賴，除了指定語義化版本之外，在私有代碼場(chǎng)景中，可以用git依賴的方式，比如下面列舉的默認(rèn)分支、指定分支、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"}

但是，這會(huì)帶來“多模塊依賴問題”的問題。如下圖所示：

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?

講者分享了他發(fā)現(xiàn)的一個(gè)解決方案：在Rust 1.34.0引入的Alternate Register，可以向私有庫(kù)進(jìn)行語義化版本的發(fā)布：

• ~/.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"}

本章的建議：避免由開發(fā)者在本地進(jìn)行隨意的發(fā)布，應(yīng)該在CI流水線在合適的時(shí)機(jī)進(jìn)行自動(dòng)化發(fā)布。

4. 構(gòu)建腳本

本章分享了Rust的構(gòu)建腳本，在Cargo.toml中的package中添加build項(xiàng)，如下圖所示。其中build.rs文件目錄同Cargo.toml即可。

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

構(gòu)建腳本，可以把很多額外的信息動(dòng)態(tài)加入到編譯后的可執(zhí)行文件中，包括可執(zhí)行文件的當(dāng)前版本、編譯環(huán)境、系統(tǒng)版本等，方便追溯。

為了更快捷的創(chuàng)建構(gòu)建腳本，講者開源了一個(gè)構(gòu)建腳本工具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吧。