C#的in关键字有什么作用？如何传递只读引用？-C#.Net教程-PHP中文网

in关键字用于传递大型值类型的只读引用，避免复制开销，提升性能。它适用于大型struct的高频调用场景，确保方法内无法修改原始数据，兼具性能与安全。与ref（读写引用）和out（输出引用）不同，in仅用于输入且不可修改，不适用于小型值类型或需修改参数的场景，调用时可省略in但建议显式标注以明确意图。

c#的in关键字有什么作用？如何传递只读引用？

C#的

in

登录后复制

关键字主要用于将参数以只读引用的方式传递给方法。它的核心作用在于，当你需要传递一个大型值类型（比如一个大的

struct

登录后复制

）作为参数时，它可以避免昂贵的复制操作，从而提升性能，同时又保证了方法内部无法修改原始数据，实现了“只读引用”的效果。

解决方案

在C#中，值类型（如

struct

登录后复制

）在作为方法参数传递时，默认是按值传递的，这意味着会创建一个原始数据的一个完整副本。对于小型值类型（如

int

登录后复制

、

bool

登录后复制

），这种复制的开销几乎可以忽略不计。然而，当一个

struct

登录后复制

包含大量字段或是一个复杂的数据结构时，每次方法调用都进行复制就会产生显著的性能损耗，尤其是在高频调用的场景下。

in

登录后复制

关键字正是为了解决这个问题而生。它允许你将值类型作为引用传递，这样方法就不需要复制整个数据，而是直接操作原始数据的内存地址。但与

ref

登录后复制

关键字不同的是，

in

登录后复制

参数在方法内部是只读的，你不能给它重新赋值，也不能调用任何会修改其内部状态的成员方法。这提供了一个非常好的平衡点：既获得了引用的性能优势，又保持了值类型参数的“不变性”或“只读”语义，避免了意外的副作用。

例如：

public struct LargeStruct
{
    public int X;
    public int Y;
    // 更多字段...
    public long[] Data; // 假设这是一个大型数组
}

public void ProcessByValue(LargeStruct data)
{
    // data 是原始数据的一个副本
    // 修改 data 不会影响原始数据
    data.X = 100; 
}

public void ProcessByIn(in LargeStruct data)
{
    // data 是原始数据的只读引用
    // 尝试修改 data.X 会导致编译错误
    // data.X = 100; // 编译错误！
    Console.WriteLine($"Processing data: {data.X}");
}

// 调用示例
LargeStruct myStruct = new LargeStruct { X = 1, Y = 2, Data = new long[1000] };

ProcessByValue(myStruct); // 复制了整个 LargeStruct
Console.WriteLine($"After ProcessByValue: {myStruct.X}"); // 输出 1

ProcessByIn(myStruct); // 传递只读引用
Console.WriteLine($"After ProcessByIn: {myStruct.X}"); // 输出 1

登录后复制

为什么我们需要

in

登录后复制

关键字？它解决了哪些性能痛点？

在我看来，

in

登录后复制

关键字的引入，是C#在追求高性能计算时，对值类型传递机制的一个精妙优化。我们知道，C#一直致力于在易用性和性能之间找到最佳平衡点。对于引用类型，我们默认就是传递引用，这很自然。但对于值类型，尤其是那些设计得比较“胖”的

struct

登录后复制

，按值传递的语义虽然清晰，却可能成为性能瓶颈。

想象一下，你有一个

Vector3D

登录后复制

或

Matrix4x4

登录后复制

这样的结构体，它可能包含十几个

float

登录后复制

或

double

登录后复制

字段。如果在一个物理引擎或图形渲染循环中，每秒需要对成千上万个这样的结构体进行计算和传递，每次都完整复制一份，那内存带宽和CPU缓存的压力会非常大。这就像你每次去图书馆借书，不是只拿书的借阅卡，而是把整本书都抄一遍带回家——效率可想而知。

in

登录后复制

关键字直接解决了这个“深拷贝”的性能痛点。它允许我们只传递一个指向原始数据内存位置的指针（或者说引用），而不是复制数据本身。这样一来，方法内部可以直接读取原始数据，而不需要付出复制的开销。这对于那些需要频繁访问大型值类型，但又不需要修改它们的场景来说，简直是性能的福音。它能显著减少内存分配和GC压力，让性能敏感的代码跑得更快。这对我来说，是C#语言设计者在底层性能优化上的一次深思熟虑。

何时应该使用

in

登录后复制

参数？有哪些最佳实践和注意事项？

使用

in

登录后复制

参数并非没有策略，在我看来，它更像是一种“高级工具”，需要我们根据具体场景来判断。

最佳使用场景：

阿里云-虚拟数字人

阿里云-虚拟数字人是什么？ ...

查看详情

大型值类型（
struct
登录后复制
）作为参数：这是
```
in
```
登录后复制
关键字最主要的应用场景。当你的
```
struct
```
登录后复制
包含多个字段，或者内部包含数组、其他复杂结构时，考虑使用
```
in
```
登录后复制
来避免复制。
性能敏感的代码路径： 如果你的方法在一个循环中被频繁调用，或者在一个对性能要求极高的模块中，并且传递的是大型
```
struct
```
登录后复制
，那么
```
in
```
登录后复制
可以带来显著的性能提升。
强调参数的只读性： 即使是小型
```
struct
```
登录后复制
，如果你想明确地向代码阅读者表明“这个参数是只读的，我不会修改它”，使用
```
in
```
登录后复制
也能起到文档化的作用，增强代码的清晰度。

何时不建议使用（或需谨慎）：

小型值类型（
int
登录后复制
,
bool
登录后复制
,
float
登录后复制
,
Guid
登录后复制
等）：对于这些类型，复制的开销通常小于传递引用并进行间接访问的开销。使用
```
in
```
登录后复制
反而可能导致轻微的性能下降。
方法内部需要修改参数： 如果你确实需要在方法内部修改参数的值，那么
```
in
```
登录后复制
就不适用了，你应该考虑使用
```
ref
```
登录后复制
。
API设计： 在设计公共API时，如果
```
in
```
登录后复制
参数的性能优势不明显，或者会增加API的复杂性，有时为了简洁性，可以考虑不使用。毕竟，代码的可读性和维护性也很重要。

注意事项：

调用方也需要显式使用
in
登录后复制
（可选）：调用带有
```
in
```
登录后复制
参数的方法时，你可以选择显式地在参数前加上
```
in
```
登录后复制
关键字，如
```
MyMethod(in myStruct)
```
登录后复制
。如果省略
```
in
```
登录后复制
，编译器会隐式地将参数按
```
in
```
登录后复制
传递。但如果参数是字面量或
```
const
```
登录后复制
变量，则必须显式使用
```
in
```
登录后复制
。我个人倾向于在调用时也加上
```
in
```
登录后复制
，这样能更清晰地表明意图。
属性不能作为
in
登录后复制
参数：属性本质上是方法（
```
get
```
登录后复制
和
```
set
```
登录后复制
），不能直接作为
```
in
```
登录后复制
参数传递，你需要先将属性值赋给一个局部变量，再传递这个变量。
默认值：
```
in
```
登录后复制
参数不能有默认值。

in

登录后复制

、

ref

登录后复制

、

out

登录后复制

之间有什么区别？它们各自的适用场景是什么？

这三个关键字常常让人混淆，但它们各自有着非常明确且不可替代的职责。在我看来，它们是C#在参数传递机制上提供的三把“瑞士军刀”，各有锋芒。

```
in
```
登录后复制
关键字：只读引用
- 作用： 将参数作为引用传递，但方法内部不能修改参数的值（或其成员）。主要用于避免大型值类型的复制开销。
- 传递方向： 从调用方到方法（输入）。
- 初始化要求： 调用方在传递前必须初始化参数。方法内部不能对参数重新赋值。
- 适用场景： 性能优化，当需要传递大型
```
struct
```
  登录后复制
  且不希望其被修改时。例如，一个数学库中的矩阵乘法函数，接收两个大型矩阵作为输入，计算结果但不修改原始矩阵。
```
void CalculateSum(in int a, in int b) 
{
    // a = 10; // 编译错误
    Console.WriteLine(a + b); 
}
```
登录后复制
```
ref
```
登录后复制
关键字：读写引用
- 作用： 将参数作为引用传递，方法内部可以读取和修改参数的值。对参数的修改会反映到原始变量上。
- 传递方向： 双向（输入和输出）。
- 初始化要求： 调用方在传递前必须初始化参数。方法内部可以读取和修改参数。
- 适用场景： 当方法需要修改调用方传入的变量时。例如，一个交换两个变量值的函数，或者一个需要更新计数器的函数。
```
void Swap(ref int x, ref int y)
{
    int temp = x;
    x = y;
    y = temp;
}
```
登录后复制
```
out
```
登录后复制
关键字：输出引用
- 作用： 将参数作为引用传递，但方法内部必须在返回前对参数进行赋值。调用方在传递前无需初始化参数，因为其目的是从方法中“输出”一个值。
- 传递方向： 从方法到调用方（输出）。
- 初始化要求： 调用方在传递前无需初始化参数（编译器会忽略其初始值）。方法内部必须在返回前对
```
out
```
  登录后复制
  参数赋值。
- 适用场景： 当方法需要返回多个值时（因为方法只能有一个返回值），或者在
```
Try...Parse
```
  登录后复制
  这类模式中，指示操作是否成功并返回结果。
```
bool TryParse(string s, out int result)
{
    // 尝试解析s
    if (int.TryParse(s, out result))
    {
        return true;
    }
    result = 0; // 必须赋值
    return false;
}
```
登录后复制