# 加餐｜代码即数据：为什么我们需要宏编程能力？

    你好，我是陈天。

应广大同学的呼吁，今天我们来讲讲宏编程。

最初设计课程的时候考虑知识点的系统性，Rust 的元编程能力声明宏、过程宏各安排了一讲，但宏编程是高阶内容后来删减掉了。其实如果你初步学习Rust，不用太深究宏，大多数应用的场景，你会使用标准库或者第三方库提供的宏就行。不会做宏编程，并不影响你日常的开发。

不过很多同学对宏有兴趣，我们今天就深入聊一聊。在讲如何使用宏、如何构建宏之前，我们要先搞清楚为什么会出现宏。

## 为什么我们需要宏编程能力？

我们从设计非常独特的Lisp语言讲起。在 Lisp 的世界里，有句名言：代码即数据，数据即代码（Code is data, data is code）。

如果你有一点 Lisp 相关的开发经验，或者听说过任何一种 Lisp 方言，你可能知道，和普通编程语言不同的是，**Lisp 的语言直接把 AST（抽象语法树）暴露给开发者，开发者写的每一行代码，其实就是在描述这段代码的 AST**。

这个特点如果你没有太看明白，我们结合一个具体例子来理解。这段代码是 6 年前，2048 游戏很火的时候，我用 Lisp 的一种方言 Racket 撰写的[2048 的实现](https://github.com/tyrchen/racket-book/blob/master/code/my-2048.rkt)片段：

```lisp
; e.g. '(2 2 2 4 4 4 8) -> '(4 2 8 4 8)
(define (merge row)
  (cond [(<= (length row) 1) row]
        [(= (first row) (second row))
         (cons (* 2 (first row)) (merge (drop row 2)))]
        [else (cons (first row) (merge (rest row)))]))

```

这段代码的算法不难理解，给定一个 row：

*   如果它只有一个值，那么直接返回；
*   如果头两个元素相等，那么把第一个元素乘以 2，与头两个元素之后的所有元素 merge 的结果（此处有递归），组成一个新的 list 返回；
*   否则，就把第一个元素和之后的所有元素 merge 的结果组成一个新的 list 返回（此处也是递归）。

看着这段代码，相信只要你花些耐心就可以写出对应的语法树：

![图片](https://static001.geekbang.org/resource/image/6e/aa/6efea8de02ff09942e4c2f54330166aa.png?wh=1191x939)

你会发现，撰写 Lisp 代码，就相当于直接在描述语法树。

从语法树的角度看，编程语言其实也没有什么了不起的，它操作和执行的数据结构不过就是这样的一棵棵树，就跟我们开发者平日里编程操作的各种数据结构一样。

**如果一门编程语言把它在解析过程中产生的语法树暴露给开发者，允许开发者对语法树进行裁剪和嫁接这样移花接木的处理，那么这门语言就具备了元编程的能力**。

语言对这样处理的限制越少，元编程的能力就越强，当然作为一枚硬币的反面，语言就会过度灵活，无法无天，甚至反噬语言本身；反之，语言对开发者操作语法树的限制越多，元编程能力就越弱，语言虽然丧失了灵活性，但是更加规矩。

Lisp 语言，作为元编程能力的天花板，毫无保留地把语法树像数据一样敞露给开发者，让开发者不光在编译期，甚至在运行期，都可以随意改变代码的行为，这也是Lisp“代码即数据，数据即代码”思路的直接体现。

在《[黑客与画家](https://book.douban.com/subject/6021440/)》一书里（p196），PG 引用了“[格林斯潘第十定律](https://en.wikipedia.org/wiki/Greenspun%27s_tenth_rule)”：

> 任何C或Fortran程序复杂到一定程度之后，都会包含一个临时开发的、只有一半功能的、不完全符合规格的、到处都是bug的、运行速度很慢的Common Lisp实现。

虽然这是 Lisp 拥趸对其他语言的极尽嘲讽，不过也说明了一个不争的事实：一门设计再精妙、提供再丰富生态的语言，在实际的使用场景中，都不可避免地需要具备某种用代码生成代码的能力，来大大减轻开发者不断撰写结构和模式相同的重复脚手架代码的需求。

幸运的是，Rust 这门语言提供了足够强大的宏编程能力，让我们在需要的时候，可以通过撰写宏来避免重复的脚手架代码，同时，Rust 对宏的使用还有足够的限制，在保证灵活性的前提下，防止我们过度使用让代码失控。

那Rust到底提供了哪些宏呢？

## Rust 对宏编程有哪些支持？

在过去的课程中，我们经历了各种各样的宏，比如创建 Vec<T> 的 vec! 宏、为数据结构添加各种 trait 支持的 `#[derive(Debug, Default, ...)]`、条件编译时使用的 #\[cfg(test)\] 宏等等。

其实Rust中的宏就两大类：**对代码模板做简单替换的声明宏（declarative macro）、可以深度定制和生成代码的过程宏（procedural macro）**。  
![](https://static001.geekbang.org/resource/image/28/46/282416a7cfe83092d9c959602667ea46.jpg?wh=2312x1379)

### 声明宏

首先是声明宏（declarative macro），课程里出现过的比如像 `vec![]`、`println!`、以及 `info!`，它们都是声明宏。

声明宏可以用 `macro_rules!` 来描述，我们看一个常用的 tracing log 的宏定义（[代码](https://docs.rs/tracing/latest/src/tracing/macros.rs.html#2288-2311)）：

```rust
macro_rules! __tracing_log {
    (target: $target:expr, $level:expr, $($field:tt)+ ) => {
        $crate::if_log_enabled! { $level, {
            use $crate::log;
            let level = $crate::level_to_log!($level);
            if level <= log::max_level() {
                let log_meta = log::Metadata::builder()
                    .level(level)
                    .target($target)
                    .build();
                let logger = log::logger();
                if logger.enabled(&log_meta) {
                    logger.log(&log::Record::builder()
                        .file(Some(file!()))
                        .module_path(Some(module_path!()))
                        .line(Some(line!()))
                        .metadata(log_meta)
                        .args($crate::__mk_format_args!($($field)+))
                        .build());
                }
            }
        }}
    };
}

```

可以看到，**它主要做的就是通过简单的接口，把不断重复的逻辑包装起来，然后在调用的地方展开而已，不涉及语法树的操作**。

如果你用过 C/C++，那么Rust的声明宏和 C/C++ 里面的宏类似，承载同样的目的。只不过 Rust 的声明宏更加安全，你无法在需要出现标识符的地方出现表达式，也无法让宏内部定义的变量污染外部的世界。比如在 C 中，你可以这样声明一个宏：

```rust
#define MUL(a, b) a * b

```

这个宏是期望调用者传入两个标识符，执行这两个标识符对应值的乘法操作，但实际我们可以对 a 传入 1 + 2，对 b 传入 4 - 3，导致结果完全错误。

### 过程宏

除了做简单替换的声明宏，Rust 还支持允许我们深度操作和改写 Rust 代码语法树的过程宏（procedural macro），更加灵活，更为强大。

Rust 的过程宏分为三种：

1.  **函数宏（function-like macro）**：看起来像函数的宏，但在编译期进行处理。比如我们之前用过的 sqlx 里的 [query](https://docs.rs/sqlx/0.5.10/src/sqlx/macros.rs.html#302-318) 宏，它内部展开出一个 [expand\_query](https://github.com/launchbadge/sqlx/blob/335eed45455daf5b65b9e36d44d7f4343ba421e6/sqlx-macros/src/lib.rs#L27-L42) 函数宏。你可能想象不到，看上去一个简单的 query 处理，内部有多么庞大的代码结构。
2.  **属性宏（attribute macro）**：可以在其他代码块上添加属性，为代码块提供更多功能。比如 rocket 的 [get / put](https://docs.rs/rocket_codegen/0.4.10/src/rocket_codegen/lib.rs.html#329) 等路由属性。
3.  **派生宏（derive macro）**：为 derive 属性添加新的功能。这是我们平时使用最多的宏，比如 `#[derive(Debug)]` 为我们的数据结构提供 Debug trait 的实现、`#[derive(Serialize, Deserialize)]`为我们的数据结构提供 serde 相关 trait 的实现。

![](https://static001.geekbang.org/resource/image/89/4e/89d8fafa46e80a6d4596yy0bf008f94e.jpg?wh=2312x1379)

## 什么情况可以用宏

前面讲过，宏的主要作用是避免我们创建大量结构相同的脚手架代码。那么我们在什么情况下可以使用宏呢？

首先说声明宏。**如果重复性的代码无法用函数来封装，那么声明宏就是一个好的选择**，比如 Rust 早期版本中的`try!`，它是`?` 操作符的前身。

再比如 futures 库的`ready!` 宏：

```rust
#[macro_export]
macro_rules! ready {
    ($e:expr $(,)?) => {
        match $e {
            $crate::task::Poll::Ready(t) => t,
            $crate::task::Poll::Pending => return $crate::task::Poll::Pending,
        }
    };
}

```

这样的结构，因为涉及提早 return，无法用函数封装，所以用声明宏就很简洁。

过程宏里，先说最复杂的派生宏，因为派生宏会在特定的场景使用，所以如果你有需要可以使用。

比如一个数据结构，我们希望它能提供 Debug trait 的能力，但为自己定义的每个数据结构实现 Debug trait 太过繁琐，而且代码所做的操作又都是一样的，这时候就可以考虑使用派生宏来简化这个操作。

**一般来说，如果你定义的 trait 别人实现起来有固定的模式可循，那么可以考虑为其构建派生宏**。serde 在 Rust 的世界里这么流行、这么好用，很大程度上也是因为基本上你的数据结构只需要添加 `#[derive(Serialize, Deserialize)]`，就可以轻松序列化成 JSON、YAML 等好多种类型（或者从这些类型中反序列化）。

函数宏和属性宏并没有特定的使用场景。sqlx 用函数宏来处理 SQL query、tokio 使用属性宏 #\[tokio::main\] 来引入 runtime。它们可以帮助目标代码的实现逻辑变得更加简单，**但一般除非特别必要，否则我并不推荐写**。

好，学到这里你已经了解了足够多的关于宏的基础知识，欢迎在留言区交流你对宏的理解。

如果你对撰写宏有兴趣，下一讲我们会手写声明宏和过程宏来深入理解宏到底做了什么。我们下一讲见！