回撸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 fmtfixclippy,否则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阅读 212,657评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,662评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,143评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,732评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,837评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,036评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,126评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,868评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,315评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,641评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,773评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,470评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,126评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,859评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,095评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,584评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,676评论 2 351

推荐阅读更多精彩内容