04 get hands dirty：来写个实用的CLI小工具 你好，我是陈天。
在上一讲里，我们已经接触了 Rust 的基本语法。你是不是已经按捺不住自己的洪荒之力，想马上用 Rust 写点什么练练手，但是又发现自己好像有点“拔剑四顾心茫然”呢？
那这周我们就来玩个新花样，做一周“learning by example”的挑战，来尝试用 Rust 写三个非常有实际价值的小应用，感受下 Rust 的魅力在哪里，解决真实问题的能力到底如何。
你是不是有点担心，我才刚学了最基本语法，还啥都不知道呢，这就能开始写小应用了？那我碰到不理解的知识怎么办？
不要担心，因为你肯定会碰到不太懂的语法，但是，先不要强求自己理解，当成文言文抄写就可以了，哪怕这会不明白，只要你跟着课程节奏，通过撰写、编译和运行，你也能直观感受到 Rust 的魅力，就像小时候背唐诗一样。
好，我们开始今天的挑战。
HTTPie
为了覆盖绝大多数同学的需求，这次挑选的例子是工作中普遍会遇到的：写一个 CLI 工具，辅助我们处理各种任务。
我们就以实现 HTTPie 为例，看看用 Rust 怎么做 CLI。HTTPie 是用 Python 开发的，一个类似 cURL 但对用户更加友善的命令行工具，它可以帮助我们更好地诊断 HTTP 服务。
下图是用 HTTPie 发送了一个 post 请求的界面，你可以看到，相比 cURL，它在可用性上做了很多工作，包括对不同信息的语法高亮显示：
你可以先想一想，如果用你最熟悉的语言实现 HTTPie ，要怎么设计、需要用到些什么库、大概用多少行代码？如果用 Rust 的话，又大概会要多少行代码？
带着你自己的这些想法，开始动手用 Rust 构建这个工具吧！我们的目标是，用大约 200 行代码实现这个需求。
功能分析
要做一个 HTTPie 这样的工具，我们先梳理一下要实现哪些主要功能：
- 首先是做命令行解析，处理子命令和各种参数，验证用户的输入，并且将这些输入转换成我们内部能理解的参数；
- 之后根据解析好的参数，发送一个 HTTP 请求，获得响应；
- 最后用对用户友好的方式输出响应。
这个流程你可以再看下图：
我们来看要实现这些功能对应需要用到的库：
- 对于命令行解析，Rust 有很多库可以满足这个需求，我们今天使用官方比较推荐的 clap。
- 对于 HTTP 客户端，在上一讲我们已经接触过 reqwest，我们就继续使用它，只不过我们这次尝个鲜，使用它的异步接口。
- 对于格式化输出，为了让输出像 Python 版本的 HTTPie 那样显得生动可读，我们可以引入一个命令终端多彩显示的库，这里我们选择比较简单的 colored。
- 除此之外，我们还需要一些额外的库：用 anyhow 做错误处理、用 jsonxf 格式化 JSON 响应、用 mime 处理 mime 类型，以及引入 tokio 做异步处理。
CLI 处理
好，有了基本的思路，我们来创建一个项目，名字就叫
httpie ： cargo new httpie cd httpie
然后，用 VSCode 打开项目所在的目录，编辑 Cargo.toml 文件，添加所需要的依赖（注意：以下代码用到了 beta 版本的 crate，可能未来会有破坏性更新，如果在本地无法编译，请参考 GitHub repo 中的代码）：
[package] name = “httpie” version = “0.1.0” edition = “2018” [dependencies] anyhow = “1” /# 错误处理 clap = “3.0.0-beta.4” /# 命令行解析 colored = “2” /# 命令终端多彩显示 jsonxf = “1.1” /# JSON pretty print 格式化 mime = “0.3” /# 处理 mime 类型 reqwest = { version = “0.11”, features = [“json”] } /# HTTP 客户端 tokio = { version = “1”, features = [“full”] } /# 异步处理库
我们先在 main.rs 添加处理 CLI 相关的代码：
use clap::{AppSettings, Clap}; // 定义 HTTPie 的 CLI 的主入口，它包含若干个子命令 // 下面 /// 的注释是文档，clap 会将其作为 CLI 的帮助 /// A naive httpie implementation with Rust, can you imagine how easy it is? /#[derive(Clap, Debug)] /#[clap(version = “1.0”, author = “Tyr Chen <[email protected]>”)] /#[clap(setting = AppSettings::ColoredHelp)] struct Opts { /#[clap(subcommand)] subcmd: SubCommand, } // 子命令分别对应不同的 HTTP 方法，目前只支持 get/post /#[derive(Clap, Debug)] enum SubCommand { Get(Get), Post(Post), // 我们暂且不支持其它 HTTP 方法 } // get 子命令 /// feed get with an url and we will retrieve the response for you /#[derive(Clap, Debug)] struct Get { /// HTTP 请求的 URL url: String, } // post 子命令。需要输入一个 URL，和若干个可选的 key=value，用于提供 json body /// feed post with an url and optional key=value pairs. We will post the data /// as JSON, and retrieve the response for you /#[derive(Clap, Debug)] struct Post { /// HTTP 请求的 URL url: String, /// HTTP 请求的 body body: Vec
代码中用到了 clap 提供的宏来让 CLI 的定义变得简单，这个宏能够生成一些额外的代码帮我们处理 CLI 的解析。通过 clap ，我们只需要先用一个数据结构 T 描述 CLI 都会捕获什么数据，之后通过 T::parse() 就可以解析出各种命令行参数了。parse() 函数我们并没有定义，它是 /#[derive(Clap)] 自动生成的。
目前我们定义了两个子命令，在 Rust 中子命令可以通过 enum 定义，每个子命令的参数又由它们各自的数据结构 Get 和 Post 来定义。
我们运行一下： ❯ cargo build –quiet && target/debug/httpie post httpbin.org/post a=1 b=2 Opts { subcmd: Post(Post { url: “httpbin.org/post”, body: [“a=1”, “b=2”] }) }
默认情况下，cargo build 编译出来的二进制，在项目根目录的 target/debug 下。可以看到，命令行解析成功，达到了我们想要的功能。
加入验证
然而，现在我们还没对用户输入做任何检验，如果有这样的输入，URL 就完全解析错误了： ❯ cargo build –quiet && target/debug/httpie post a=1 b=2 Opts { subcmd: Post(Post { url: “a=1”, body: [“b=2”] }) }
所以，我们需要加入验证。输入有两项，就要做两个验证，一是验证 URL，另一个是验证body。
首先来验证 URL 是合法的：
use anyhow::Result; use reqwest::Url; /#[derive(Clap, Debug)] struct Get { /// HTTP 请求的 URL /#[clap(parse(try_from_str = parse_url))] url: String, } fn parse_url(s: &str) -> Result
clap 允许你为每个解析出来的值添加自定义的解析函数，我们这里定义了个 parse_url 检查一下。
然后，我们要确保 body 里每一项都是 key=value 的格式。可以定义一个数据结构 KvPair 来存储这个信息，并且也自定义一个解析函数把解析的结果放入 KvPair：
use std::str::FromStr; use anyhow::{anyhow, Result}; /#[derive(Clap, Debug)] struct Post { /// HTTP 请求的 URL /#[clap(parse(try_from_str = parse_url))] url: String, /// HTTP 请求的 body /#[clap(parse(try_from_str=parse_kv_pair))] body: Vec
这里我们实现了一个 FromStr trait，可以把满足条件的字符串转换成 KvPair。FromStr 是 Rust 标准库定义的 trait，实现它之后，就可以调用字符串的 parse() 泛型函数，很方便地处理字符串到某个类型的转换了。
这样修改完成后，我们的 CLI 就比较健壮了，可以再测试一下：
❯ cargo build –quiet ❯ target/debug/httpie post https://httpbin.org/post a=1 b error: Invalid value for ‘<BODY>…’: Failed to parse b For more information try –help ❯ target/debug/httpie post abc a=1 error: Invalid value for ‘
Cool，我们完成了基本的验证，不过很明显可以看到，我们并没有把各种验证代码一股脑塞在主流程中，而是通过实现额外的验证函数和 trait 来完成的，这些新添加的代码，高度可复用且彼此独立，并不用修改主流程。
这非常符合软件开发的开闭原则（Open-Closed Principle）：Rust 可以通过宏、trait、泛型函数、trait object 等工具，帮助我们更容易写出结构良好、容易维护的代码。
目前你也许还不太明白这些代码的细节，但是不要担心，继续写，今天先把代码跑起来就行了，不需要你搞懂每个知识点，之后我们都会慢慢讲到的。
HTTP 请求
好，接下来我们就继续进行 HTTPie 的核心功能：HTTP 的请求处理了。我们在 main() 函数里添加处理子命令的流程： use reqwest::{header, Client, Response, Url}; /#[tokio::main] async fn main() -> Result<()> { let opts: Opts = Opts::parse(); // 生成一个 HTTP 客户端 let client = Client::new(); let result = match opts.subcmd { SubCommand::Get(ref args) => get(client, args).await?, SubCommand::Post(ref args) => post(client, args).await?, }; Ok(result) }
注意看我们把 main 函数变成了 async fn，它代表异步函数。对于 async main，我们需要使用 /#[tokio::main] 宏来自动添加处理异步的运行时。
然后在 main 函数内部，我们根据子命令的类型，我们分别调用 get 和 post 函数做具体处理，这两个函数实现如下： use std::{collections::HashMap, str::FromStr}; async fn get(client: Client, args: &Get) -> Result<()> { let resp = client.get(&args.url).send().await?; println!(“”, resp.text().await?); Ok(()) } async fn post(client: Client, args: &Post) -> Result<()> { let mut body = HashMap::new(); for pair in args.body.iter() { body.insert(&pair.k, &pair.v); } let resp = client.post(&args.url).json(&body).send().await?; println!(“”, resp.text().await?); Ok(()) }
其中，我们解析出来的 KvPair 列表，需要装入一个 HashMap，然后传给 HTTP client 的 JSON 方法。这样，我们的 HTTPie 的基本功能就完成了。
不过现在打印出来的数据对用户非常不友好，我们需要进一步用不同的颜色打印 HTTP header 和 HTTP body，就像 Python 版本的 HTTPie 那样，这部分代码比较简单，我们就不详细介绍了。
最后，来看完整的代码：
use anyhow::{anyhow, Result}; use clap::{AppSettings, Clap}; use colored::/*; use mime::Mime; use reqwest::{header, Client, Response, Url}; use std::{collections::HashMap, str::FromStr}; // 以下部分用于处理 CLI // 定义 HTTPie 的 CLI 的主入口，它包含若干个子命令 // 下面 /// 的注释是文档，clap 会将其作为 CLI 的帮助 /// A naive httpie implementation with Rust, can you imagine how easy it is? /#[derive(Clap, Debug)] /#[clap(version = “1.0”, author = “Tyr Chen <[email protected]>”)] /#[clap(setting = AppSettings::ColoredHelp)] struct Opts { /#[clap(subcommand)] subcmd: SubCommand, } // 子命令分别对应不同的 HTTP 方法，目前只支持 get/post /#[derive(Clap, Debug)] enum SubCommand { Get(Get), Post(Post), // 我们暂且不支持其它 HTTP 方法 } // get 子命令 /// feed get with an url and we will retrieve the response for you /#[derive(Clap, Debug)] struct Get { /// HTTP 请求的 URL /#[clap(parse(try_from_str = parse_url))] url: String, } // post 子命令。需要输入一个 URL，和若干个可选的 key=value，用于提供 json body /// feed post with an url and optional key=value pairs. We will post the data /// as JSON, and retrieve the response for you /#[derive(Clap, Debug)] struct Post { /// HTTP 请求的 URL /#[clap(parse(try_from_str = parse_url))] url: String, /// HTTP 请求的 body /#[clap(parse(try_from_str=parse_kv_pair))] body: Vec
在这个完整代码的最后，我还撰写了几个单元测试，你可以用 cargo test 运行。Rust 支持条件编译，这里 /#[cfg(test)] 表明整个 mod tests 都只在 cargo test 时才编译。
使用代码行数统计工具 tokei 可以看到，我们总共使用了 139 行代码，就实现了这个功能，其中还包含了约 30 行的单元测试代码： ❯ tokei src/main.rs ——————————————————————————- Language Files Lines Code Comments Blanks ——————————————————————————- Rust 1 200 139 33 28 ——————————————————————————- Total 1 200 139 33 28 ——————————————————————————-
你可以使用 cargo build –release，编译出 release 版本，并将其拷贝到某个在
$PATH 下的目录，然后体验一下：
到这里一个带有完整帮助的 HTTPie 就可以投入使用了。
我们测试一下效果：
这和官方的 HTTPie 效果几乎一样。今天的源代码可以在这里找到.
哈，这个例子我们大获成功。我们只用了 100 行代码出头，就实现了 HTTPie 的核心功能，远低于预期的 200 行。不知道你能否从中隐约感受到 Rust 解决实际问题的能力，以今天实现的 HTTPie 为例，
- 要把命令行解析成数据结构，我们只需要在数据结构上，添加一些简单的标注就能搞定。
- 数据的验证，又可以由单独的、和主流程没有任何耦合关系的函数完成。
- 作为 CLI 解析库，clap 的整体体验和 Python 的 click 非常类似，但比 Golang 的 cobra 要更简单。
这就是 Rust 语言的能力体现，明明是面向系统级开发，却能够做出类似 Python 的抽象和体验，所以一旦你适应了 Rust ，用起来就会感觉非常美妙。
小结
现在你应该有点明白，为什么我会在开篇词中会说，Rust 拥有强大的表现力。
或许你还是有点疑惑，这么学，我也太懵了，跟盲人摸象似的。其实初学者都会以为，必须要先搞明白所有的语法知识，才能动手写代码，不是的。
我们这周写三个实用例子的挑战，就是为了让你，在懵懂地撰写代码的过程中，直观感受 Rust 处理问题、解决问题的方式，同时可以跟你熟悉的语言去类比，无论是 Golang/Java，还是 Python/JavaScript，如果我用自己熟悉的语言怎么解决、Rust 给了我什么样的支持、我感觉它还缺什么。
在这个过程中，你脑子里会产生各种深度的思考，这些思考又必然会引发越来越多的问号，这是好事，带着这些问号，在未来的课程中才能更有目的地学习，也一定会学得深刻而有效。
今天的小挑战并不太难，你可能还意犹未尽。别急，下一讲我们会再写个难度大一点的、工作中都会用到的 Web 服务，继续体验 Rust 的魅力。
思考题
我们只是实现了 HTTP header 和 body 的高亮区分，但是 HTTP body 还是有些不太美观，可以进一步做语法高亮，如果你完成了今天的代码，觉得自己学有余力可以再挑战一下，你不妨试一试用 syntect 继续完善我们的 HTTPie。syntect 是 Rust 的一个语法高亮库，非常强大。
欢迎在留言区分享你的思考。你的 Rust 学习第四次打卡成功，我们下一讲见！
特别说明
注意：本篇文章中依赖用到了 beta 版本的 crate，可能未来会有破坏性更新，如果在本地无法编译，请参考 GitHub repo 中的代码。后续文章中，如果出现类似问题，同样参考GitHub上的最新代码。学习愉快～
参考资料
https://learn.lianglianglee.com/%e4%b8%93%e6%a0%8f/%e9%99%88%e5%a4%a9%20%c2%b7%20Rust%20%e7%bc%96%e7%a8%8b%e7%ac%ac%e4%b8%80%e8%af%be/04%20get%20hands%20dirty%ef%bc%9a%e6%9d%a5%e5%86%99%e4%b8%aa%e5%ae%9e%e7%94%a8%e7%9a%84CLI%e5%b0%8f%e5%b7%a5%e5%85%b7.md
更多学习
更多实时资讯，前沿技术，生活趣事。尽在【老马啸西风】
交流社群：[交流群信息](https://mp.weixin.qq.com/s/rkSvXxiiLGjl3S-ZOZCr0Q)
