C# 参数修饰符:ref、out、in 与 params

1556 字
8 分钟
C# 参数修饰符:ref、out、in 与 params

先回顾:默认是按值传递#

C# 默认按值传参:传进方法的是变量内容的副本。对值类型来说副本是数据本身,对引用类型来说副本是引用(详见 值类型与引用类型)。

ref、out、in 改变的是这一点:传进去的是变量本身(变量的地址),而不是副本。

ref、out、in 对比#

refoutin
传递方式按引用按引用按引用
调用前必须赋值是否是
方法内可以读是赋值之后才能读是
方法内可以写是必须在返回前赋值不能(只读)
调用处要写关键字必须写 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 = 1

out#

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 和迭代器。目的都是保证它只存在于栈上,不会被保存到堆中。

文章分享

如果这篇文章对你有帮助,欢迎分享给更多人!

C# 参数修饰符:ref、out、in 与 params
https://xslab.cloud/posts/csharp/keywords/parameter-modifiers/
作者
LuxFire
发布于
2026-10-10
许可协议
CC BY-NC-SA 4.0
相关文章 智能推荐
1
C# 访问修饰符与类型修饰符
C#底层/关键字 六种访问级别的可见范围对比,protected internal 与 private protected 的区别,各种成员的默认访问级别;以及 static、sealed、abstract、partial 修饰类型时的含义和限制,附 Unity 中 asmdef 与静态字段的注意点。
2
C# 关键字速查
C#底层/关键字 按类别整理 C# 常用关键字,每个一两句话说明用途和要点,复杂的关键字链接到专题文章。适合复习时快速过一遍。
3
C# 常量与只读:const、readonly 与 static readonly
C#底层/关键字 const 与 readonly 的本质区别(编译期常量与运行时只读),为什么修改 const 要重新编译引用方,readonly 引用类型字段的误区,readonly struct、readonly 成员与防御性复制,以及 init 访问器。
4
C# 继承与多态关键字:virtual、override、new、abstract、sealed
C#底层/关键字 virtual 与 override 如何实现运行时多态,override 与 new 的本质区别,abstract 与 sealed 的用法,base 和 this,构造函数的执行顺序与构造函数中调用虚方法的陷阱,以及 Unity 中 Awake、Update 等消息方法的继承写法。
5
C# 迭代器与 async/await 原理:编译器生成的状态机
C#底层/关键字 yield return 和 async/await 编译后分别变成了什么;状态机如何保存局部变量、如何从中断处继续;awaiter 模式;async 状态机什么时候会分配堆内存;SynchronizationContext 决定 await 之后在哪个线程继续;以及"异步不等于多线程"。
随机文章 随机推荐
Profile Image of the Author
LuxFire
Hello, I'm LuxFire.
公告
欢迎来到我的博客!这是一则示例公告。
音乐
封面

音乐

暂未播放

0:00 0:00
暂无歌词
分类
标签
站点统计
文章
60
分类
6
标签
164
总字数
171,869
运行时长
0 天
最后活动
0 天前

文章目录