解析.net中ref和out的实质(转http://www.cnblogs.com/davyli/archive/2008/11/01/1324352.html)

Coordinator
Dec 15, 2011 at 8:26 AM
可能是.net中的value type和reference type的关系遇到给函数传递参数的情况时,在我们的脑海里就会浮现按值和按引用传递的概念。如果看见下面这个函数(代码1)我们就会条件反射似的说要给参数加上ref才能使函数内部修改参数的值。

  //代码1

void Change(int a, int b)
{
  int tmp = a;
  a = b;
  b = tmp
}

  ok,那继续看下面这个代码

  //代码2

void Change2(object o)
{
  o = new object();
}
 
static void Main()
{
  object obj = null;
  Change2(obj);
  Console.WriteLine(obj ?? "null");
}

  null? object不是引用类型吗,为什么在函数内对引用类型赋值却没有改变参数的值呢?因为答案只有一个:“所有的参数传递都是按值传递的”。 不要被值类型和引用类型所迷惑,也不要被ref,out关键字所迷惑。如果你了解c或者c++那么这个问题很好理解,所谓ref,out关键字(这两个关键字在IL级别上是相同的,只是在语法上规定ref修饰的参数必须赋值,out修饰的参数可以不赋值。以此区分out这个语义)对于c来说ref int == int*而ref object == object**,而对于c++来说ref int == int&而ref object == object*&.如果你不懂c和c++也没关系,下面我通过反汇编来说明ref和out的本质,有如下测试代码:

  //代码3

static void Ref_Out(ref int a, out int b, int c)
{
  a = 15;
  b = 127;
  c = 99;
}
static void Main()
{
   int i1 = -1;   //ref要有初始值
   int i2;     //out不需要
   Ref_Out(ref i1, out i2, i1);
   Console.WriteLine(i1.ToString() + " " + i2.ToString());  //15 127
}

 

ok让我们运行程序吧,请在上面代码行12出设置断点。程序运行到断点后查看一下当前寄存器状态

  EBP = 0012F480(栈底)  ESP = 0012F440(栈顶)  EIP = 0103009D

  这时候我们单步进入Ref_Out函数并在代码行03出设置断点,这时候的寄存器状态为

  EBP = 0012F434 ESP = 0012F3F4 EIP = 010300ab ECX = 0012F444 EDX = 0012F440 ESI = 0012F440 EDI = 0012F444

  然后我们看看栈的当前状态(通过SOS的clrstack -a命令)    

!clrstack -a
PDB symbol for mscorwks.dll not loaded
OS Thread Id: 0x12c (300)
ESP    EIP  
0012f3f4 0103011d test_console.Class1.Ref_Out(Int32 ByRef, Int32 ByRef, Int32)
  PARAMETERS:
    a = 0x0012f444
    b = 0x0012f440
    c = 0xffffffff
  
0012f440 010300ad test_console.Class1.Main()
  LOCALS:
    0x0012f444 = 0xffffffff
    0x0012f440 = 0x00000000
  
0012f69c 79e88f63 [GCFrame: 0012f69c]

  我们可以看出Ref_Out中的参数a,b的值就是Main函数中i1,i2两个局部变量的栈上地址,所以ref,out修饰的作用就是取得变量的地址并传入给Ref_Out方法,而此时参数c的值就是i1的值(-1)。因此参数都是按值传递的,也就是拷贝传递。让我们来看看栈底(EBP)的情况

  0x0012F434:0012f480 010300ad ffffffff(offset = 8,参数c)

  这三个值分别是Main函数运行时的EBP值,Ref_Out函数调用完成后的下一条指令地址,参数c的值(a,b两个参数由ECX,EDX传入并保存),这时我们可以查看Ref_Out函数对应的反汇编

 

      a = 15;  //得到a中保存的地址,并将15赋值给该地址上的变量i1
00000026 mov     dword ptr [edi],0Fh 
      b = 127; //得到b中保存的地址,并将127赋值给该地址上的变量i2
0000002c mov     dword ptr [esi],7Fh 
      c = 99;  //0x0012f434 + 8上的数据为ffffffff也就是c的位置
00000032 mov     dword ptr [ebp+8],63h
然后我们将断点设置到代码行07处,这时候再次查看栈底的情况
0x0012F434 0012f480 010300ad 00000063
而这时i1,i2则是
0012f440 010300ad test_console.Class1.Main()
  LOCALS:
    0x0012f444 = 0x0000000f -- 15
    0x0012f440 = 0x0000007f -- 127

  我们可以退出Ref_Out方法了,这时的寄存器状态为

  EBP = 0012F480(这个值正是Ref_Out方法执行是EBP所指地址处的值)  ESP = 0012F440  EIP = 010300AD

  通过上面的仔细分析你应该已经明白了代码2中为什么方法改变不了参数o的之值了吧,即使它是一个引用类型。还不明白?ok我再唠叨一边,因为在 Change2方法中只是保存了obj这个对象在托管堆上的地址,相当于在[EBP + 8]上保存了obj的地址(0x00000000),而操作o = new object();只是把新new出来的对象地址赋值给[EBP + 8]位置,所以函数调用结束后obj还是null。从语法上看加与不加ref,out在操作参数时都是相同的,所以我们必须了解底层运行机理才能深入理解.net语法。

 

-----------------------------------------------------------------------------------------------------------------------------------------------

 

C#中有三个关键字-ref,out ,params,虽然本人不喜欢这三个关键字,因为它们疑似破坏面向对象特性。但是既然m$把融入在c#体系中,那么我们就来认识一下参数修饰符ref,out ,params吧,还有它们的区别。

NO.1 params
一个可以让方法(函数)的拥有可变参数的关键字。

原则:在方法声明中的 params 关键字之后不允许任何其他参数,并且在方法声明中只允许一个 params 关键字。

示例(拷贝到vs2005中即可用,下面不再说明)
public partial class Form1 : Form
...{
public static void UseParams(params int[] list)
...{
string temp = "";
for (int i = 0; i < list.Length; i++)
temp = temp +" " +list[i].ToString();
MessageBox.Show(temp);
}

public static void UseParams2(params object[] list)
...{
string temp = "";
for (int i = 0; i < list.Length; i++)
temp = temp + " " + list[i].ToString();
MessageBox.Show(temp);
}

public Form1()
...{
InitializeComponent();
}

private void button1_Click(object sender, EventArgs e)
...{
UseParams(1, 2, 3); //看参数是3个
UseParams(1, 2); //看参数是2个,可变吧


UseParams2(1, 'a', "test");

int[] myarray = new int[3] ...{ 10, 11, 12 };
UseParams(myarray); //看也可以是容器类,可变吧:)
}
}


NO.2 out
这是一个引用传递L。
原则一:当一个方法(函数)在使用out作为参数时,在方法中(函数)对out参数所做的任何更改都将反映在该变量中。
原则二:当希望方法返回多个值时,声明 out 方法非常有用。使用 out 参数的方法仍然可以返回一个值。一个方法可以有一个以上的 out 参数。
原则三:若要使用 out 参数,必须将参数作为 out 参数显式传递到方法。out 参数的值不会传递到 out 参数。
原则四:不必初始化作为 out 参数传递的变量,因为out 参数在进入方法(函数)时后清空自己,使自己变成一个干净的参数,也因为这个原因必须在方法返回之前为 out 参数赋值(只有地址没有值的参数是不能被.net接受的)。
原则五:属性不是变量,不能作为 out 参数传递。
原则六:如果两个方法的声明仅在 out 的使用方面不同,则会发生重载。不过,无法定义仅在 ref 和 out 方面不同的重载。例如,以下重载声明是有效的:
class MyClass
{
public void MyMethod(int i) {i = 10; }
public void MyMethod(out int i) {i = 10; }
}
而以下重载声明是无效的:
class MyClass
{
public void MyMethod(out int i) {i = 10; }
public void MyMethod(ref int i) {i = 10; }
}
有关传递数组的信息,请参见使用 ref 和 out 传递数组。
示例附后


NO.2 ref
ref仅仅是一个地址!!!
原则一:当一个方法(函数)在使用ref作为参数时,在方法中(函数)对ref参数所做的任何更改都将反映在该变量中。
原则二:调用方法时,在方法中对参数所做的任何更改都将反映在该变量中。
原则三:若要使用 ref 参数,必须将参数作为 ref 参数显式传递到方法。ref 参数的值可以被传递到 ref 参数。
原则四:ref参数传递的变量必须初始化,因为ref参数在进入方法(函数)时后还是它自己,它这个地址指向的还是原来的值,也因为这个原因ref参数也可以在使用它的方法内部不操作。
原则六:如果两种方法的声明仅在它们对 ref 的使用方面不同,则将出现重载。但是,无法定义仅在 ref 和 out 方面不同的重载。例如,以下重载声明是有效的:
class MyClass
{
public void MyMethod(int i) {i = 10; }
public void MyMethod(ref int i) {i = 10; }
}
但以下重载声明是无效的:
class MyClass
{
public void MyMethod(out int i) {i = 10; }
public void MyMethod(ref int i) {i = 10; }
}
有关传递数组的信息,请参见使用 ref 和 out 传递数组。
示例


public static string TestOut(out string i)
...{
i = "out b";
return "return value";
}


public static void TestRef(ref string i)
...{
//改变参数
i = "ref b";
}

public static void TestNoRef(string refi)
...{
// 不用改变任何东西,这个太明显了
refi = "on c";
}

public Form1()
...{
InitializeComponent();
}

private void button1_Click(object sender, EventArgs e)
...{
string outi; //不需要初始化
MessageBox.Show(TestOut(out outi)); //返回值
//输出"return value";
MessageBox.Show(outi); //调用后的out参数
//输出"out b";


string refi = "a"; // 必须初始化
TestRef(ref refi); // 调用参数
MessageBox.Show(refi);
//输出"ref b";
TestNoRef(refi); //不使用ref
MessageBox.Show(refi);
//输出"ref b";
}

 

------------------------------------------------------------------------------------------------------------------

在C# 中,既可以通过值也可以通过引用传递参数。通过引用传递参数允许函数成员更改参数的值,并保持该更改。若要通过引用传递参数, 可使用ref或out关键字。ref和out这两个关键字都能够提供相似的功效,其作用也很像C中的指针变量。它们的区别是:

1、使用ref型参数时,传入的参数必须先被初始化。对out而言,必须在方法中对其完成初始化。

2、使用ref和out时,在方法的参数和执行方法时,都要加Ref或Out关键字。以满足匹配。

3、out适合用在需要retrun多个返回值的地方,而ref则用在需要被调用的方法修改调用者的引用的时候。

注:在C#中,方法的参数传递有四种类型:传值(by value),传址(by reference),输出参数(by output),数组参数(by array)。传值参数无需额外的修饰符,传址参数需要修饰符ref,输出参数需要修饰符out,数组参数需要修饰符params。传值参数在方法调用过程中如果改变了参数的值,那么传入方法的参数在方法调用完成以后并不因此而改变,而是保留原来传入时的值。传址参数恰恰相反,如果方法调用过程改变了参数的值,那么传入方法的参数在调用完成以后也随之改变。实际上从名称上我们可以清楚地看出两者的含义--传值参数传递的是调用参数的一份拷贝,而传址参数传递的是调用参数的内存地址,该参数在方法内外指向的是同一个存储位置。