C# 参数修饰符:ref、out、in 与 params
先回顾:默认是按值传递
C# 默认按值传参:传进方法的是变量内容的副本。对值类型来说副本是数据本身,对引用类型来说副本是引用(详见 值类型与引用类型)。
ref、out、in 改变的是这一点:传进去的是变量本身(变量的地址),而不是副本。
ref、out、in 对比
ref | out | in | |
|---|---|---|---|
| 传递方式 | 按引用 | 按引用 | 按引用 |
| 调用前必须赋值 | 是 | 否 | 是 |
| 方法内可以读 | 是 | 赋值之后才能读 | 是 |
| 方法内可以写 | 是 | 必须在返回前赋值 | 不能(只读) |
| 调用处要写关键字 | 必须写 ref | 必须写 out | 可以省略 |
| 用途 | 让方法修改调用方的变量 | 返回多个值 | 传大的 struct 时避免复制 |
ref
void Swap(ref int a, ref int b) { (a, b) = (b, a); }
int x = 1, y = 2;Swap(ref x, ref y); // x = 2, y = 1out
if (int.TryParse(text, out int value)) { /* 使用 value */ }
// 不需要的结果用弃元 _if (dict.TryGetValue(key, out _)) { }Unity 中很多 API 都用 out 返回结果:
if (Physics.Raycast(ray, out RaycastHit hit)) { Debug.Log(hit.point); }if (TryGetComponent(out Rigidbody rb)) { rb.AddForce(Vector3.up); }TryXxx(out ...) 是 C# 中”尝试获取,失败不抛异常”的标准写法。
in
in 是只读的引用传递,主要用于传递较大的结构体,避免整份复制:
float Distance(in Matrix4x4 m, in Vector3 p) { ... } // Matrix4x4 有 64 字节- 调用时可以省略
in,也可以直接传字面量(编译器会生成一个临时变量)。 - 方法内不能给参数赋值,也不能修改它的字段。
in 什么时候反而更慢
1. 结构体很小时
按引用传递,实际传的是一个地址(8 字节),方法内每次访问都要通过地址间接读取。对于 int、float 或只有几个字段的小结构体,直接复制反而更快。in 只适合比较大的结构体。
2. 防御性复制
struct Data{ public int Value; public int GetValue() => Value; // 不是 readonly 方法}
int Read(in Data d) => d.GetValue();编译器无法确定 GetValue() 会不会修改结构体的字段。为了保证 in 参数”只读”,它会先把 d 复制一份,再在副本上调用方法。这样不但没省掉复制,还多了一次。
解决方法:把结构体声明为 readonly struct,或者把方法标记为 readonly(C# 8),编译器就知道调用不会修改字段,不再复制。详见 常量与只读。
限制
- 不能只靠
ref、out、in的不同来重载方法。比如M(ref int)和M(out int)不能同时存在,但M(int)和M(ref int)可以。 async方法、迭代器方法(yield return)的参数不能是ref、out、in。因为这些方法会被编译成状态机对象存在堆上,而引用参数可能指向栈上的变量,不能保存到堆上。- lambda 不能捕获
ref、out、in参数,原因同上。
params
int Sum(params int[] numbers) { ... }
Sum(1, 2, 3); // 编译器自动生成数组:Sum(new int[] { 1, 2, 3 })Sum(new[] { 1, 2 }); // 也可以直接传数组- 必须是参数列表中的最后一个参数,一个方法只能有一个。
- 每次调用都会创建一个新数组,产生 GC 分配。在 Unity 每帧执行的代码中要注意。常见做法是像
string.Format那样,额外提供固定参数个数的重载:
void Log(string msg, object a);void Log(string msg, object a, object b);void Log(string msg, params object[] args); // 参数多时才走这个ref 返回值与 ref 局部变量
C# 7 起,方法可以返回一个引用,局部变量也可以是一个引用:
Vector3[] points = new Vector3[100];
ref Vector3 GetPoint(int i) => ref points[i];
ref Vector3 p = ref GetPoint(5); // p 是数组元素本身的别名,不是副本p.x = 10; // 直接修改了 points[5]适合频繁修改大型结构体数组中的元素,避免”取出副本、修改、写回”。
- 只能返回在方法结束后仍然有效的引用,比如数组元素、字段、
ref参数。不能返回局部变量的引用,编译器会报错。 ref readonly返回只读引用,调用方只能读不能改。
ref struct
ref struct 是只能存在于栈上的结构体,Span<T> 就是最典型的例子:
Span<int> buffer = stackalloc int[64]; // 在栈上分配,没有 GC为了保证它不会逃逸到堆上,编译器对它有严格限制:
- 不能装箱,不能赋值给
object或接口。 - 不能作为 class 的字段,只能作为另一个
ref struct的字段。 - 不能被 lambda 捕获,不能在
async方法和迭代器中使用。 - 不能作为数组元素。
- 不能实现接口(C# 13 起放宽,Unity 当前的 C# 9 中不行)。
C# 11 新增的
scoped关键字可以进一步限制ref和ref struct的生命周期,Unity 当前的 C# 9 中还不能使用。
栈和堆的详细区别见 值类型与引用类型、栈与堆。
常见追问
ref 和 out 有什么区别?
都是按引用传递。ref 要求调用前已赋值,方法内可读可写;out 不要求调用前赋值,但方法返回前必须赋值。
in 有什么用?什么时候不该用?
只读地按引用传递大结构体,避免复制。结构体很小时间接访问反而更慢;结构体不是 readonly 时,调用它的方法会触发防御性复制,反而多复制一次。
能不能用 ref 和 out 区分重载?
不能。只有”按值”和”按引用”可以区分重载,ref、out、in 之间不行。
为什么 async 方法不能有 ref 参数? async 方法会被编译成状态机,挂起时被移到堆上,而 ref 参数可能指向栈上的变量,方法挂起后那个栈帧可能已经不存在了。
params 有什么性能问题? 每次调用都会新建一个数组,产生 GC 分配。热路径中应提供固定参数个数的重载。
ref struct 有什么限制?为什么? 不能装箱、不能作为 class 字段、不能被 lambda 捕获、不能用于 async 和迭代器。目的都是保证它只存在于栈上,不会被保存到堆中。
文章分享
如果这篇文章对你有帮助,欢迎分享给更多人!