![](https://developer.qcloudimg.com/http-save/yehe-11141876/94323489057f8c38a3f1f273ba04483a.png)
介绍一种简单但常见的 Rust 设计模式：newtype，这一模式在 Rust 中很常见，也算是一种常识性的术语了。newtype 是指将一个类型（比较典型的是基本类型，例如 i32, f64, String）包裹进一个元组结构体中，形成一个新的类型，通常会给这个新类型起一个更具有领域含义的名称。例如：

```rust
struct Email(String);
```

这种做法会有以下几点收益（ 本文原文地址：[https://laurence.blog.csdn.net/article/details/168145388](https://laurence.blog.csdn.net/article/details/168145388) ）：

**1. 避免将参数搞混**

在下面这个例子中你会注意到，amount 和 acc_no 都是整型，如果一不注意，就容易传错参数：

```rust
fn transfer(amount: i32, acc_no: i32) {
  // something...
} 

fn main() {
  let amount: i32 = 500;
  let acc_no: i32 = 6514;
  
  // swap args; works ok; incorrect result!
  transfer(acc_no, amount);    
}
```

使用 newtype 包裹之后，由于有类型检查，编译器可以帮助我们检查出这种错误：

```rust
struct Amount(i32);
struct AccNo(i32);

// pass structs as arguments
fn transfer(amount: Amount, acc_no: AccNo) {
  // do something
}

fn main() {
  transfer(Amount(500), AccNo(6514));
}
```

**2. 增加易读性**

这也是显而易见的，下面的示例都能印证这一点：

```rust
struct Meters(f64);
struct Centimeters(f64);
struct Inches(f64);
struct TotalLength(f64);

struct NodeIndex(usize);
struct EdgeIndex(usize);
```

**3. 对包裹类型添加校验**

这也很合理，作为特定值时，对基类型的格式、取值范围往往是有要求的，这些校验、格式化的方法最适合添加在 newtype 上，下面的示例是在初始化方法中添加了校验功能：

```rust
struct Email(String); 

impl Email {
    // validate when creating Email;
    pub fn new(value: String) -> Result<Self, String> {
        if value.contains('@') && value.contains('.') {
            Ok(Email(value))
        } else {
            Err("Missing the `@` and/or the `.`".into())
        }
    }
}

fn main() {
    let valid_email = Email::new("atlas@123.com".to_string());
    assert!(valid_email.is_ok());
}
```

**4. 控制可见性 / 隐藏实现细节**

newtype 的最后一种常见应用场景就是用来控制类型的可见范围。因为 newtype 是用一个新的类型去包裹一个已有的类型，利用定义类型时所处的位置（在哪个 crate 中）以及是否在前面添加 pub 关键字这些差别，就可以有效控制类型的可见性。例如下面这个例子：

```rust
pub struct UserName(pub String); // Username is public; String is public too;
pub struct Password(String); // Password is public; String remains hidden;
struct Email(String); // Email is only visible in crate.
```

实际上，通过控制原始类型和 newtype 类型的可见范围，可以创造出更多组合。在下一篇文章中，我们将会看到 Zed 项目中的一个真实而有力的 newtype 应用示例，在那个实例中就是利用了私有 newtype + 公开的 getter / setter 来控制某些全局状态的读写权限，请关注本公众号的下一篇文章。

最后，解释一下使用 newtype 是否会带来额外的开销，答案是：完全不会。我记得之前我们在[《Rust “多态”的来龙去脉(下)：dyn Trait ( Trait Object ) 到底是什么东西？》](https://laurence.blog.csdn.net/article/details/162490154)一文中介绍过结构体的内存布局：

>根据《Programming Rust, 2nd Edition》第 9 章的介绍，Rust 要求结构体的各个字段统一存放在结构体的内存块中，每个字段保留其原始数据类型在内存中的布局，结构体并不会拆解字段的内存布局，不过 Rust 没有对结构体各个字段在内存中的顺序进行明确规定。

结构体占据的内存就是它所有字段占据的内存总和，结构体本身并不占据额外的内存，实际上，结构体“类型”在运行时基本不存在，字段名、字段类型这些定义只在编译期使用。编译完成后，访问字段被翻译成“起始地址 + 固定偏移量”的内存读写，运行时不需要查询任何结构体描述。所以，newtype 结构体是零成本的，其本身并不会额外占用内存，在编译时，编译器会生成它的 TypeId，这是我们唯一需要的信息，只在编译期有用和有效。

--- 

参考资料

- https://medium.com/@isuru.dex/brief-overview-of-rusts-newtype-design-pattern-8855a44d9e28

介绍一种简单但常见的 Rust 设计模式：newtype，这一模式在 Rust 中很常见，也算是一种常识性的术语了。newtype 是指将一个类型（比较典型的是基本类型，例如 i32, f64, String）包裹进一个元组结构体中，形成一个新的类型，通常会给这个新类型起一个更具有领域含义的名称。例如：

Rust 设计模式：newtype

编程语言

架构设计

Rust newtype模式通过元组结构体包裹基础类型，创建领域专属类型，提升类型安全与代码可读性。它有效防止参数误传，支持添加校验逻辑，并控制字段可见性。该模式零运行时开销，内存布局与原始类型一致，是Rust中常见的高效设计实践。

代码解释

编译器

文章

问答

视频

教程

学习中心

腾讯云实验室

直播

竞赛

腾讯云代码分析专区

腾讯iOA零信任安全管理系统专区

腾讯云架构师技术同盟交流圈

腾讯云数据库专区

腾讯云智能顾问专区

腾讯云原生专区

腾讯混元专区

腾讯云TCE专区

腾讯云Lighthouse专区

腾讯云HAI专区

腾讯云Edgeone专区

腾讯云存储专区

腾讯云智能专区

腾讯轻联专区 

腾讯云开发专区

TAPD专区

腾讯轻量云游戏服专区

EdgeOne AI 安全实战专区

腾讯云最具价值专家

腾讯云架构师技术同盟

腾讯云创作之星

腾讯云开发者先锋

腾讯云代码助手

云原生构建

TAPD 敏捷项目管理

Cloud Studio

SDK中心

API中心

命令行工具

涵盖代码开发、场景应用、自动测试全流程，助你从零构建专属AI助手

一站式MCP教程库，解锁AI应用新玩法

聚焦“写作效率、视觉美观与运行性能”三方面进行全面升级，为您提供更高效、稳定的创作环境

社区富文本&Markdown编辑器全新改版上线，欢迎大家体验!

诚挚邀请您参与本次调研，分享您的真实使用感受与建议。您的反馈至关重要，感谢您的支持与参与！

社区新版编辑器体验调研

Rust 设计模式：newtype-腾讯云开发者社区-腾讯云

Rust 设计模式：newtype

Rust 设计模式：newtype

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐