Sway 中的 Methods 方法详解：从 `impl` 声明、`self` 语义到引用传递与枚举方法

Sway 中的 Methods 方法详解：从impl声明、self语义到引用传递与枚举方法

【免费下载链接】sway🌴 Empowering everyone to build reliable and efficient smart contracts.项目地址: https://gitcode.com/GitHub_Trending/sw/sway

本篇指南聚焦 Fuel 生态的 Sway 语言中"方法（Methods）"这一核心概念，讲解如何在struct与enum的上下文中通过impl关键字声明方法、理解首个参数self的三种接收形式（按值、ref mut、ref），以及如何用点号语法调用方法。文章以 官方文档 为主线，并结合 配套示例代码 与仓库中的可运行工程示例，帮助你写出可编译、可验证的 Sway 方法代码。

什么是方法

方法是定义在某个具体类型上下文中的函数。在 Sway 中，这个"上下文"通常是 struct 或 enum。方法与该类型绑定，要么**读取（refer to）该类型的成员数据，要么修改（mutate）**该类型实例的内部状态。

方法的第一个参数永远是self，它代表"方法被调用时所在的那个类型实例"。self的出现是方法区别于普通函数、也区别于 关联函数（Associated Functions） 的关键标志——关联函数同样定义在impl块中，但不接收self。

说明：Sway 的方法语义与 Rust 高度相似，如果你熟悉 Rust 的impl块与self参数，可以很快迁移；不熟悉也无需担心，本文会从零逐步拆解。

声明方法：impl块与self参数

定义载体类型

首先定义一个用于承载方法的类型。以struct为例（源码片段）：

struct Foo { bar: u64, }

原文档特别指出：示例虽然用struct演示，但enum的声明与使用方式完全相同——你也可以为枚举类型编写impl块并定义方法。

编写impl块

使用impl（implementation，实现）关键字，后跟类型名，将函数"挂"到该类型上，从而形成方法（源码片段）：

impl Foo { // 只读访问：通过 `self` 引用 `bar` fn add_number(self, number: u64) -> u64 { self.bar + number } // 修改 `bar`：使用 `ref mut self` 声明可变引用 fn increment(ref mut self, number: u64) { self.bar += number; } }

这个示例同时展示了self的两种典型形态：

• 按值self：方法拥有实例的访问权，但不会修改实例。上面的add_number只是把self.bar与number相加并返回计算结果，foo本身没有变化。
• ref mut self：以可变引用形式接收实例，可以直接修改实例字段。increment中self.bar += number会把bar原地更新。

补充：除按值与ref mut之外，Sway 也支持只读引用形态ref self，用于既想避免拷贝、又不需要修改实例的场景。这与仓库中 ref_mut_params 示例 对ref mut的用法一脉相承（该示例中普通函数同样支持ref mut num: u32等引用参数写法）。

枚举上的方法：以官方 style-guide 片段为例

方法并不局限于struct。例如在 style-guide 的 getters 示例 中，可以为枚举类型实现带self的方法，用点号语法访问枚举变体携带的数据；仓库中 examples/enums 等工程也大量使用impl+self的组合。原文档的表述"an enum will work in the same way"在语法层面意味着：impl块、self参数、点号调用三点均与 struct 完全一致。

调用方法：点号语法

方法通过点号语法调用：<变量名>.<方法名>()（源码片段）：

fn method_usage() { let mut foo = Foo { bar: 42 }; let result = foo.add_number(5); // 计算结果为 47 foo.increment(5); // `foo` 内的 `bar` 从 42 变为 47 }

要点拆解：

1. let mut foo是必须的：要调用修改型方法（接收ref mut self），变量必须用mut声明，否则编译器会报错，提示无法对不可变绑定做可变借用。
2. 返回值可用变量承接：add_number返回u64，因此foo.add_number(5)的计算结果 47 被存入result。
3. 修改型方法就地生效：foo.increment(5)没有返回值（返回单元类型），但它把foo.bar从 42 更新为 47，此后对foo的任何读取都会看到新值。

可运行验证：仓库中的真实示例

仓库 examples/ref_mut_params/src/main.sw 提供了一个完整可运行的脚本工程，其中恰好有一段与本文完全对应的方法写法：

struct Coordinates { x: u64, y: u64, } impl Coordinates { fn move_right(ref mut self, distance: u64) { self.x += distance; } } fn main() { let mut point = Coordinates { x: 1, y: 1 }; point.move_right(5); assert(point.x == 6); // move_right 修改了 point.x assert(point.y == 1); // y 不受影响 }

该示例通过assert断言验证了方法对实例数据的就地修改：调用point.move_right(5)后point.x从 1 变为 6，而point.y保持不变。这既证明了ref mut self的可变性语义，也展示了 Sway 工程中"方法 + 断言"的常规自测写法。你可以通过forc test或直接编译运行该脚本来复现这一行为。

方法与关联函数、普通函数的区别

理解方法最有效的方式，是把它与另外两类函数放在一起对比：

其中，关联函数是方法的"近亲"：它同样写在impl块里，但不接收self，因此不接触任何实例数据。最常见的关联函数是构造函数，例如 lib.sw 中的Foo::new：

impl Foo { // 这是关联函数：不接收 self // 同时也是构造函数：实例化并返回一个新的 Foo fn new(number: u64) -> Self { Self { bar: number } } } fn associated_usage() { let foo = Foo::new(42); // 通过类型名 + 双冒号调用 }

注意两者的调用差异：方法用.（点），关联函数用::（双冒号）且以类型名为前缀。关于关联函数与构造函数的完整讨论，参见 associated-function.md。

进阶：self引用语义与 Trait 方法

self的本质

从语法与类型系统角度看，self并不是什么特殊魔法——它就是"方法所在的类型"的一个参数，编译器会把它推导为该类型（或其引用）。因此self.bar等同于在普通函数中通过参数访问结构体字段。这也解释了为什么方法必须定义在impl块内：编译器需要知道self的具体类型。

Trait 中的方法

方法机制与 Sway 的 Trait 系统 紧密配合。Trait 中的方法签名同样以self开头，实现方在impl Trait for Type中提供方法体。例如 Trait 定义：

trait Trait { fn fn_sig(self, b: Self) -> bool; }

这里self与Self（类型占位符）同时出现：self是被调用实例，Self指代实现该 Trait 的具体类型。继承自 Rust 语义，Sway 的Self在impl块与 Trait 中都是一个隐式类型参数，指向"当前实现的类型"。

三种self形态速查

选择建议：若方法需要原地修改实例状态，使用ref mut self；若只读取数据且实例较大，可用ref self减少拷贝；小型类型直接用self即可。

方法在标准库中的体现

Sway 标准库 sway-lib-std 大量使用了方法机制，是观察方法实战的最佳素材。例如：

• vec.sw 中的Vec类型定义了push、pop、len等方法，通过my_vec.push(x)点号调用；
• bytes.sw、string.sw 同样为各自容器类型提供方法式 API；
• storage.sw 为存储类型提供read/write等方法，体现"方法 = 类型的行为接口"这一设计思想。

阅读这些标准库源码，可以看到impl<T> Vec、impl StorageKey等泛型/非泛型impl块中方法声明与本文所述模式完全一致——方法正是 Sway 将数据与行为绑定在一起的主要手段。

小结

• 方法定义在impl块内，首个参数固定为self，代表被调用的类型实例；
• struct与enum均可承载方法，声明与调用语法一致；
• 调用用点号语法<变量>.<方法>()，修改型方法要求变量以mut声明，并使用ref mut self接收；
• 方法（self）、关联函数（无self，用::调用）与普通函数（顶层函数）三者定位不同，应结合场景选用；
• 可运行验证参考 ref_mut_params 示例，标准库参考 sway-lib-std/src/vec.sw 等文件。

【免费下载链接】sway🌴 Empowering everyone to build reliable and efficient smart contracts.项目地址: https://gitcode.com/GitHub_Trending/sw/sway