何时使用vs ref vs out

前几天有人问我应该使用参数关键字out而不是ref 。 虽然我(我认为)理解refout关键字之间的区别( 之前已经提到过 ),最好的解释似乎是ref == in and out ,什么是一些(假设或代码)示例我应该总是out而不是ref

由于ref更为通用,为什么你想out ? 它只是语法糖吗?

你应该用out除非你需要ref

当数据需要被编组到例如另一个过程时,这会产生很大的不同,这可能是昂贵的。 因此,当方法不使用它时,您希望避免编组初始值。

除此之外,它还向读者显示声明或调用初始值是否相关(并可能保留)或丢弃。

作为次要差异,不需要初始化out参数。

out例子:

 string a, b; person.GetBothNames(out a, out b); 

其中GetBothNames是一种以primefaces方式检索两个值的方法,该方法不会改变a和b的行为。 如果呼叫转到夏威夷的服务器,将初始值从这里复制到夏威夷是浪费带宽。 使用ref的类似代码片段:

 string a = String.Empty, b = String.Empty; person.GetBothNames(ref a, ref b); 

可能会混淆读者,因为看起来a和b的初始值是相关的(尽管方法名称表明它们不是)。

ref示例:

 string name = textbox.Text; bool didModify = validator.SuggestValidName(ref name); 

这里初始值与方法相关。

使用out表示该参数未被使用,仅设置。 这有助于调用者了解您始终初始化参数。

此外,ref和out不仅适用于值类型。 它们还允许您在方法中重置引用类型引用的对象。

你是正确的,在语义上, ref提供“in”和“out”function,而out只提供“out”function。 有一些事情需要考虑:

  1. out要求接受参数的方法必须在返回之前的某个时刻为变量赋值。 您可以在某些键/值数据存储类中找到此模式,例如Dictionary ,其中包含TryGetValue等函数。 此函数采用out参数来保存检索时的值。 调用者将值传递给此函数是没有意义的,因此out用于保证调用后某些值将在变量中,即使它不是“真实”数据(在不存在密钥的TryGetValue )。
  2. 在处理互操作代码时, outref参数的编组方式不同

另外,值得注意的是,虽然引用类型和值类型的值的性质不同,但应用程序中的每个变量都指向一个包含值的内存位置 ,即使对于引用类型也是如此。 只是在引用类型中,内存位置中包含的值是另一个内存位置。 将值传递给函数(或执行任何其他变量赋值)时,该变量的值将复制到另一个变量中。 对于值类型,这意味着将复制该类型的整个内容。 对于引用类型,这意味着将复制内存位置。 无论哪种方式,它确实创建了变量中包含的数据的副本。 唯一真正的相关性涉及赋值语义; 当分配变量或传递值(默认值)时,当对原始(或新)变量进行新赋值时,它不会影响其他变量。 在引用类型的情况下,是的,双方都可以对实例进行更改,但这是因为实际变量只是指向另一个内存位置的指针; 变量的内容 – 内存位置 – 实际上没有改变。

使用ref关键字传递说原始变量函数参数实际上都指向相同的内存位置。 这再次只影响赋值语义。 如果为其中一个变量分配了新值,那么因为另一个指向同一个内存位置,新值将反映在另一侧。

它取决于编译上下文(参见下面的示例)。

outref都表示通过引用传递的变量,但ref要求变量在传递之前被初始化,这可能是Marshaling上下文中的一个重要区别(Interop:UmanagedToManagedTransition,反之亦然)

MSDN警告 :

Do not confuse the concept of passing by reference with the concept of reference types. The two concepts are not the same. A method parameter can be modified by ref regardless of whether it is a value type or a reference type. There is no boxing of a value type when it is passed by reference.

来自官方MSDN文档:

  • out

The out keyword causes arguments to be passed by reference. This is similar to the ref keyword, except that ref requires that the variable be initialized before being passed

  • ref

The ref keyword causes an argument to be passed by reference, not by value. The effect of passing by reference is that any change to the parameter in the method is reflected in the underlying argument variable in the calling method. The value of a reference parameter is always the same as the value of the underlying argument variable.

我们可以在分配参数时validationout和ref是否确实相同:

CIL示例

请考虑以下示例

 static class outRefTest{ public static int myfunc(int x){x=0; return x; } public static void myfuncOut(out int x){x=0;} public static void myfuncRef(ref int x){x=0;} public static void myfuncRefEmpty(ref int x){} // Define other methods and classes here } 

在CIL中, myfuncOutmyfuncRef的指令与预期的完全相同。

 outRefTest.myfunc: IL_0000: nop IL_0001: ldc.i4.0 IL_0002: starg.s 00 IL_0004: ldarg.0 IL_0005: stloc.0 IL_0006: br.s IL_0008 IL_0008: ldloc.0 IL_0009: ret outRefTest.myfuncOut: IL_0000: nop IL_0001: ldarg.0 IL_0002: ldc.i4.0 IL_0003: stind.i4 IL_0004: ret outRefTest.myfuncRef: IL_0000: nop IL_0001: ldarg.0 IL_0002: ldc.i4.0 IL_0003: stind.i4 IL_0004: ret outRefTest.myfuncRefEmpty: IL_0000: nop IL_0001: ret 

nop :没有操作, ldloc :load local, stloc :stack local, ldarg :load参数, bs.s :branch to target ….

(参见: CIL指令列表 )

下面是我从C#Out Vs Ref的代码项目文章中提取的一些注释

  1. 只有在我们期望函数或方法的多个输出时才应该使用它。 对结构的思考也可以是一个很好的选择。
  2. REF和OUT是决定数据如何从调用者传递给被调用者的关键字,反之亦然。
  3. 在REF数据传递两种方式。 从呼叫者到被呼叫者,反之亦然。
  4. 在Out数据中,只有一种方式从被调用者传递给调用者。 在这种情况下,如果Caller尝试向被叫方发送数据,则会被忽略/拒绝。

如果你是一个视觉人,请看这个yourtubevideo,它实际上显示了差异https://www.youtube.com/watch?v=lYdcY5zulXA

下图更直观地显示了差异

C#Out Vs Ref

如果计划读取和写入参数,则需要使用ref 。 如果你只打算写,你需要out 。 实际上, out表示何时需要多个返回值,或者当您不想使用正常的返回机制进行输出时(但这应该很少见)。

有语言机制可以帮助这些用例。 Ref参数必须在传递给方法之前已经初始化(强调它们是读写的事实),并且在分配值之前无法读取out参数,并且保证out参数中写入参数。方法的结尾(强调它们只是写的事实)。 违反这些原则会导致编译时错误。

 int x; Foo(ref x); // error: x is uninitialized void Bar(out int x) {} // error: x was not written to 

例如, int.TryParse返回一个bool并接受一个out int参数:

 int value; if (int.TryParse(numericString, out value)) { /* numericString was parsed into value, now do stuff */ } else { /* numericString couldn't be parsed */ } 

这是一个需要输出两个值的情况的明显示例:数字结果以及转换是否成功。 CLR的作者决定选择在这里,因为他们不关心int之前的情况。

对于ref ,你可以看一下Interlocked.Increment

 int x = 4; Interlocked.Increment(ref x); 

Interlocked.Increment以primefaces方式递增x的值。 由于您需要读取x来增加它,因此这种情况下ref更合适。 你完全关心x在传递给Increment之前是什么。

在C#的下一个版本中,甚至可以在out参数中声明变量,更加强调它们的仅输出性质:

 if (int.TryParse(numericString, out int value)) { // 'value' exists and was declared in the `if` statement } else { // conversion didn't work, 'value' doesn't exist here } 

outref更多约束版本。

在方法体中,您需要在离开方法之前分配所有out参数。 同样,将忽略分配给out参数的值,而ref要求分配它们。

所以out允许你这样做:

 int a, b, c = foo(out a, out b); 

其中ref需要分配a和b。

听起来如何:

out =只初始化/填充一个参数(参数必须为空)将其恢复原状

ref = reference,标准参数(可能带有值),但函数可以修改它。

您可以在两个上下文中使用out contextual关键字(每个都是指向详细信息的链接),作为参数修饰符或在接口和委托中的generics类型参数声明中。 本主题讨论参数修饰符,但您可以查看此其他主题以获取有关generics类型参数声明的信息。

out关键字使参数通过引用传递。 这与ref关键字类似,只是ref要求在传递变量之前对其进行初始化。 要使用out参数,方法定义和调用方法都必须显式使用out关键字。 例如:C#

 class OutExample { static void Method(out int i) { i = 44; } static void Main() { int value; Method(out value); // value is now 44 } } 

尽管作为out参数传递的变量在传递之前不必初始化,但是在方法返回之前需要调用方法来赋值。

尽管refout关键字会导致不同的运行时行为,但在编译时它们不会被视为方法签名的一部分。 因此,如果唯一的区别是一个方法采用ref参数而另一个方法采用out参数,则方法不能重载。 例如,以下代码将无法编译:C#

 class CS0663_Example { // Compiler error CS0663: "Cannot define overloaded // methods that differ only on ref and out". public void SampleMethod(out int i) { } public void SampleMethod(ref int i) { } } 

但是,如果一个方法接受refout参数而另一个方法不使用,则可以完成重载,如下所示:C#

 class OutOverloadExample { public void SampleMethod(int i) { } public void SampleMethod(out int i) { i = 5; } } 

属性不是变量,因此不能作为out参数传递。

有关传递数组的信息,请参阅使用refout传递数组(C#编程指南)。

您不能将refout关键字用于以下类型的方法:

 Async methods, which you define by using the async modifier. Iterator methods, which include a yield return or yield break statement. 

当您希望方法返回多个值时,声明out方法很有用。 以下示例使用out通过单个方法调用返回三个变量。 请注意,第三个参数指定为null。 这使方法可以选择性地返回值。 C#

 class OutReturnExample { static void Method(out int i, out string s1, out string s2) { i = 44; s1 = "I've been returned"; s2 = null; } static void Main() { int value; string str1, str2; Method(out value, out str1, out str2); // value is now 44 // str1 is now "I've been returned" // str2 is (still) null; } } 

只是为了澄清OP的注释,对ref和out的使用是“对在方法之外声明的值类型或结构的引用”,这已经在不正确的情况下建立。

考虑在StringBuilder上使用ref,这是一个引用类型:

 private void Nullify(StringBuilder sb, string message) { sb.Append(message); sb = null; } // -- snip -- StringBuilder sb = new StringBuilder(); string message = "Hi Guy"; Nullify(sb, message); System.Console.WriteLine(sb.ToString()); // Output // Hi Guy 

与此相关:

 private void Nullify(ref StringBuilder sb, string message) { sb.Append(message); sb = null; } // -- snip -- StringBuilder sb = new StringBuilder(); string message = "Hi Guy"; Nullify(ref sb, message); System.Console.WriteLine(sb.ToString()); // Output // NullReferenceException 

作为ref传递的参数必须在传递给方法之前初始化,而out参数在传递给方法之前不需要初始化。

为什么你想用完?

让其他人知道变量将在从被调用方法返回时被初始化!

如上所述:“对于out参数, 调用方法需要在方法返回之前分配值 。”

例:

 Car car; SetUpCar(out car); car.drive(); // You know car is initialized. 

基本上, refout用于在方法之间传递对象/值

out关键字使参数通过引用传递。 这与ref关键字类似,只是ref要求在传递变量之前对其进行初始化。

out :参数未初始化,必须在方法中初始化

ref :Argument已经初始化,可以在方法中读取和更新。

参考类型的“ref”有什么用?

您可以将给定引用更改为其他实例。

你知道吗?

  1. 尽管ref和out关键字会导致不同的运行时行为,但在编译时它们不会被视为方法签名的一部分。 因此,如果唯一的区别是一个方法采用ref参数而另一个方法采用out参数,则方法不能重载。

  2. 您不能将ref和out关键字用于以下类型的方法:

    • 异步方法,您可以使用async修饰符定义。
    • 迭代器方法,包括yield return或yield break语句。
  3. 属性不是变量,因此不能作为out参数传递。

关于C#7的额外说明:
在C#7中,不需要使用out预先声明变量。 所以像这样的代码:

 public void PrintCoordinates(Point p) { int x, y; // have to "predeclare" p.GetCoordinates(out x, out y); WriteLine($"({x}, {y})"); } 

可以像这样写:

 public void PrintCoordinates(Point p) { p.GetCoordinates(out int x, out int y); WriteLine($"({x}, {y})"); } 

资料来源: C#7有什么新内容。

如何在C#中使用inoutref

  • C#中的所有关键字都具有相同的function,但具有一些边界
  • in参数不能被被调用的方法修改。
  • ref参数可能会被修改。
  • ref必须在被调用者使用之前初始化,它可以在方法中读取和更新。
  • 必须由调用者修改out参数。
  • out参数必须在方法中初始化
  • 必须在方法调用中传递之前初始化in参数中传递的变量 。 但是,被调用的方法可能不会赋值或修改参数。

您不能对以下类型的方法使用inrefout关键字:

  • 异步方法 ,您可以使用async修饰符定义。
  • 迭代器方法 ,包括yield returnyield break语句。