c#基础系列之ref和out的深入理解

2020-01-24 00:15:09

字体：大中小

来源：转载

供稿：网友

扩展阅读

c#基础系列1---深入理解值类型和引用类型

c#基础系列2---深入理解 String

引言

在上篇文章深入理解值类型和引用类型的时候，有的小伙伴就推荐说一说ref和out 关键字，昨天晚上彻夜难眠在想是否要谈一下呢，因为可谈的不是太多，也可能是我理解的不够深刻。

C#有两种参数传递方式：传值和引用，传值就是变量的值，而引用则是传递的变量的地址；

本文中说的Ref和Out都是引用传递，Ref的重点是把值传给调用方法，Out则是得到调用方法的值，类似于有返回类型的方法返回的值；

在使用两者时一定要注意一下两点，否则编译出现错误

a) ref 变量使用前要先声明同时要赋值 a=20；

b)方法调用参数要加上相应的关键字 ref or out;

应用场景

out

修饰函数参数，以传递引用的方式向函数传递参数。
out 关键字也可与泛型类型参数结合使用，以指定该类型参数是协变参数

ref

修饰函数参数，以传递引用的方式向函数传递参数。
在方法签名中，按引用将值返回给调用方。此功能在c# 7.0中新加。即：引用返回值。例如：

 static ref int GetUserId(int[] allUserid) {    return ref allUserid[1]; }

修饰局部变量。（c#7.0新增）

 int x = 3; ref int x1 = ref x; //注意这里,我们通过ref关键字 把x赋给了x1 x1 = 2; Console.WriteLine($"改变后的变量 {nameof(x)} 值为: {x}");

运行结果为 2

在struct声明中声明 ref struct 或 ref readonly struct，来实现值类型的引用语义（c#7.2新增，此处不做讨论）

相同之处

ref 和out都可以修饰函数的参数，指示参数是以引用方式传递的。

ref和out在c#编译器下生成的IL代码是相同的。生成的元数据是几乎相同的。有的网络文章说元数据也是一模一样的其实是错误的。元数据中其实是有一位来标志是ref还是out的，仅仅是一个bit的不同。要不然你以为程序执行时怎么区分是ref还是out的呢^ ~ ^

用ref或者out修饰的函数参数不能设置默认值。因为没有办法为这些参数传递一个有意义的默认值。

如果一个函数的参数用ref或者out所修饰，那这个函数的调用者传递的参数类型必须和函数定义的相同（继承关系的也不行）。下列的代码是编译不通过的

 static void Main(string[] args)   {    MyClass c = new MyClass();    //以下语句编译报错的    Testref(out c);    Console.Read();   }     static void Testref(out object c1)   {    c1 = new object();   }      class MyClass   {    public int Id { get; set; }   }

不同之处

编译之后的元数据有一个bit的差别，上边已经提及，此处不过多阐述。

对于方法的重载，c#编译器是不允许只有ref和out区别的重载方法。以下方法的重载形式是不允许的。

 void test(ref int) { } void test(out int) { }

ref和out对于c#编译器表达的意图是不一样的。ref告诉编译器调用函数之前必须初始化；out则反之，调用函数之前不必初始化。这其实也证实了“ref用于输入，out用于输出”的说法是有一点道理的，但是不是完全正确，难道我ref不能用于方法的输出吗？呵呵呵

 class Program  {   static void Main(string[] args)   {    int i = 10;    Console.WriteLine(i);    Test(ref i);    Test(ref i);    Console.WriteLine(i);    Console.Read();   }   static void Test(ref int i)   {    i += 10;   }  }

运行结果：

10
30

所以我认为真正的用法是：

ref是有进有出，而out是只出不进。

out修饰的函数变量在被调用方法中初始化之前是只写的（不能读取），而且函数执行完之前必须被初始化。以下方法编译是报错的，因为没有对out参数进行初始化

 static void Testref(out MyClass c1)   {       }

ref则是可写可读的。

性能

其实明白了ref和out的基本原理和作用之后，怎么用能提高性能其实已经很明了了。值类型参数如果比较大，业务又没有复制修改的需求，当然以引用方式会比较合理。至于引用类型无特殊需求场景我觉得没有必要添加ref或者out来画蛇添足。

其他

ref和out修饰引用类型参数

有的同学会问，引用类型参数本来不就是以引用方式传递的吗，在加ref或者out标记有什么意义吗？的确，大多数情况下引用类型参数的传递没有必要添加ref或者out来修饰，但是如果方法体内我修改了指针的指向的内存地址，我们的方法调用者又需要这个新的内存地址呢？例如：以下为一个连续读取N个文件的需求：

 static void Main(string[] args)   {    FileStream fs = new FileStream("新文件地址", FileMode.Open);    //第一个文件的操作省略    //接下来连续读取N个文件内容    bool isHaveFile = true;    for (; fs!=null; ReadFile(ref fs, isHaveFile))    {     fs.Read(.............);     //添加判断是否还有文件可读     // isHaveFile = false;    }    Console.Read();   }   static void ReadFile(ref FileStream fs,bool isHaveFile=true)   {    fs.Close();    if (!isHaveFile) fs = null;    else    {     fs = new FileStream("新文件地址", FileMode.Open);    }   }

可见引用类型添加ref或者out 在一些特定场景下是有必要的。