引言
本文之初的目的是讲述设计模式中的 Prototype(原型)模式,但是如果想较清楚地弄明白这个模式,需要了解对象克隆(Object Clone),Clone其实也就是对象复制。复制又分为了浅度复制(Shallow Copy)和深度复制(Deep Copy),浅度复制和深度复制又是以如何复制引用类型成员来划分的。由此又引出了引用类型和值类型,以及相关的对象判等、装箱、拆箱等基础知识。索性从最基础的类型开始自底向上写起。
值类型和引用类型
先简单回顾一下C#中的类型系统。C# 中的类型一共分为两类,一类是值类型(Value Type),一类是引用类型(Reference Type)。值类型和引用类型是以它们在计算机内存中是如何被分配的来划分的。值类型包括结构和枚举,引用类型包括类、接口、委托等。还有一种特殊的值类型,称为简单类型(Simple Type),比如 byte,int等,这些简单类型实际上是FCL类库类型的别名,比如声明一个int类型,实际上是声明一个System.Int32结构类型。因此,在Int32类型中定义的操作,都可以应用在int类型上,比如 "123.Equals(2)"。
所有的值类型都隐式地继承自 System.ValueType类型(注意System.ValueType本身是一个类类型),System.ValueType和所有的引用类型都继承自 System.Object基类。你不能显示地让结构继承一个类,因为C#不支持多重继承,而结构已经隐式继承自ValueType。
NOTE:堆栈(stack)是一种先进后出的数据结构,在内存中,变量会被分配在堆栈上来进行操作。托管堆(heap,不是堆. 堆是c语言中用的,托管堆是c#中用的.它有对托管堆中内存放置位置,指针等处理,这也关系到垃圾收集器的运行机制,垃圾收集器也是c#专有的.)是用于为类型实例(对象)分配空间的内存区域,在托管堆上创建一个对象,会将对象的地址传给堆栈上的变量(反过来叫变量指向此对象,或者变量引用此对象)。
1.值类型
当声明一个值类型的变量(Variable)的时候,变量本身包含了值类型的全部字段,该变量会被分配在线程堆栈(Thread Stack)上。
假如我们有这样一个值类型,它代表了直线上的一点:
public struct ValPoint
{
public int X; public ValPoint(int x)
{
X = x;
}
}
当我们在程序中写下这样的一条变量的声明语句时:
ValPoint vPoint1;
实际产生的效果是声明了vPoint1变量,变量本身包含了值类型的所有字段(即你想要的所有数据)。
编译下面全部代码,用"C:\Program Files (x86)\Microsoft SDKs\Windows\v10.0A\bin\NETFX 4.6.1 Tools\ildasm.exe"(最新)打开编译后的exe。
class Program
{
private static void Main()
{
ValPoint vPoint1;
} public struct ValPoint
{
public int X; public ValPoint(int x)
{
X = x;
}
}
}
NOTE:观察MSIL代码,会发现此时变量还没有被压到栈上,因为.maxstack(最高栈数) 为0。并且没有看到入栈的指令,这说明只有对变量进行操作,才会进行入栈。
因为变量已经包含了值类型的所有字段,所以,此时你已经可以对它进行操作了(对变量进行操作,实际上是一系列的入栈、出栈操作)。
using System; class Program
{
private static void Main()
{
ValPoint vPoint1;
vPoint1.X = ;
Console.WriteLine(vPoint1.X); // 输出 10
} public struct ValPoint
{
public int X; public ValPoint(int x)
{
X = x;
}
}
}
NOTE:如果vPoint1是一个引用类型(比如class),在运行时会抛出NullReferenceException异常。因为vPoint是一个值类型,不存在引用,所以永远也不会抛出NullReferenceException。
如果你不对vPoint1.x进行赋值,直接写Console.WriteLine(vPoint1.x),则会出现编译错误:使用了未赋值的局部变量。产生这个错误是因为.Net的一个约束:所有的元素使用前都必须初始化。
比如这样的语句也会引发这个错误:
int i;
Console.WriteLine(i);
解决这个问题我们可以通过这样一种方式:编译器隐式地会为结构类型创建了无参数构造函数。在这个构造函数中会对结构成员进行初始化,所有的值类型成员被赋予0或相当于0的值(针对Char类型),所有的引用类型被赋予null值。(因此,Struct类型不可以自行声明无参数的构造函数)。所以,我们可以通过隐式声明的构造函数去创建一个ValPoint类型变量:
private static void Main()
{
ValPoint vPoint1 = new ValPoint();
Console.WriteLine(vPoint1.X); // 输出为0
} public struct ValPoint
{
public int X; public ValPoint(int x)
{
X = x;
}
}
我们将上面代码第一句的表达式由"="分隔拆成两部分来看:
- 左边 ValPoint vPoint1,在堆栈上创建一个ValPoint类型的变量vPoint,结构的所有成员均未赋值。在进行new ValPoint()之前,将vPoint压到栈上。
- 右边new ValPoint(),new 操作符不会分配内存,它仅仅调用ValPoint结构的默认构造函数,根据构造函数去初始化vPoint结构的所有字段。
注意上面这句,new 操作符不会分配内存,仅仅调用ValPoint结构的默认构造函数去初始化vPoint的所有字段。
那如果我这样做,又如何解释呢?
Console.WriteLine((new ValPoint()).X); // 正常,输出为0
在这种情况下,会创建一个临时变量,然后使用结构的默认构造函数对此临时变量进行初始化。我知道我这样很没有说服力,所以我们来看下MS IL代码,为了节省篇幅,我只节选了部分:
.locals init ([] valuetype Prototype.ValPoint CS$$) // 声明临时变量
IL_0000: nop
IL_0001: ldloca.s CS$$ // 将临时变量压栈
IL_0003: initobj Prototype.ValPoint // 初始化此变量
而对于 ValPoint vPoint = new ValPoint(); 这种情况,其 MSIL代码是:
.locals init ([] valuetype Prototype.ValPoint vPoint) // 声明vPoint
IL_0000: nop
IL_0001: ldloca.s vPoint // 将vPoint压栈
IL_0003: initobj Prototype.ValPoint // 使用initobj初始化此变量
那么当我们使用自定义的构造函数时,ValPoint vPoint = new ValPoint(10),又会怎么样呢?通过下面的代码我们可以看出,实际上会使用call指令(instruction)调用我们自定义的构造函数,并传递10到参数列表中。
.locals init ([] valuetype Prototype.ValPoint vPoint)
IL_0000: nop
IL_0001: ldloca.s vPoint // 将 vPoint 压栈
IL_0003: ldc.i4.s // 将 10 压栈
IL_0005: call instance void Prototype.ValPoint::.ctor(int32) // 调用构造函数,传递参数
对于上面的MSIL代码不清楚不要紧,有的时候知道结果就已经够用了。
2.引用类型
当声明一个引用类型变量的时候,该引用类型的变量会被分配到堆栈上,这个变量将用于保存位于堆上的该引用类型的实例的内存地址,变量本身不包含对象的数据。此时,如果仅仅声明这样一个变量,由于在堆上还没有创建类型的实例,因此,变量值为null,意思是不指向任何类型实例(堆上的对象)。对于变量的类型声明,用于限制此变量可以保存的类型。
如果我们有一个这样的类,它依然代表直线上的一点:
public class RefPoint
{
public int X; public RefPoint(int x)
{
X = x;
} public RefPoint() {}
}
当我们仅仅写下一条声明语句:
RefPoint rPoint1;
它的效果就向下图一样,仅仅在堆栈上创建一个不包含任何数据,也不指向任何对象(不包含创建再堆上的对象的地址)的变量。
而当我们使用new操作符时:
rPoint1 = new RefPoint();
会发生这样的事:
- 在应用程序堆(Heap)上创建一个引用类型(Type)的实例(Instance)或者叫对象(Object),并为它分配内存地址。
- 自动传递该实例的引用给构造函数。(正因为如此,你才可以在构造函数中使用this来访问这个实例。)
- 调用该类型的构造函数。
- 返回该实例的引用(内存地址),赋值给rPoint变量。
3.关于简单类型
很多文章和书籍中在讲述这类问题的时候,总是喜欢用一个int类型作为值类型和一个Object类型作为引用类型来作说明。本文将采用自定义的一个结构和类分别作值类型和引用类型的说明。这是因为简单类型(比如int)有一些CLR实现了的行为,这些行为会让我们对一些操作产生误解。
举个例子,如果我们想比较两个int类型是否相等,我们会通常这样:
int i = ;
int j = ;
if (i == j) Console.WriteLine("i equals to j");
但是,对于自定义的值类型,比如结构,就不能用 "=="来判断它们是否相等,而需要在变量上使用Equals()方法来完成。
再举个例子,大家知道string是一个引用类型,而我们比较它们是否相等,通常会这样做:
string a = "";
string b = "";
if (a == b) Console.WriteLine("a Equals to b");
实际上,在后面我们就会看到,当使用"=="对引用类型变量进行比较的时候,比较的是它们是否指向的堆上同一个对象。而上面a、b指向的显然是不同的对象,只是对象包含的值相同,所以可见,对于string类型,CLR对它们的比较实际上比较的是值,而不是引用。
string a = "abcdefg";
string b = "abcdefg";
if (a.Equals(b)) Console.WriteLine("a Equals() to b");
为了避免上面这些引起的混淆,在对象判等部分将采用自定义的结构和类来分别说明。
装箱 和 拆箱
简单来说,装箱就是将一个值类型转换成等值的引用类型。它的过程分为这样几步:
- 在堆上为新生成的对象(该对象包含数据,对象本身没有名称)分配内存。
- 将堆栈上值类型变量的值拷贝到堆上的对象中。
- 将堆上创建的对象的地址返回给引用类型变量(从程序员角度看,这个变量的名称就好像堆上对象的名称一样)。
当我们运行这样的代码时:
int i = ;
Object boxed = i;
Console.WriteLine("Boxed Point: " + boxed); //Boxed Point: 1
效果图是这样的:
MSIL代码是这样的:
.method private hidebysig static void Main(string[] args) cil managed
{
.entrypoint
// 代码大小 19 (0x13)
.maxstack // 最高栈数是1,装箱操作后i会出栈
.locals init ([] int32 i, // 声明变量 i(第1个变量,索引为0)
[] object boxed) // 声明变量 boxed (第2个变量,索引为1)
IL_0000: nop
IL_0001: ldc.i4.s //#1 将10压栈
IL_0003: stloc. //#2 10出栈,将值赋给 i
IL_0004: ldloc. //#3 将i压栈
IL_0005: box [mscorlib]System.Int32 //#4 i出栈,对i装箱(复制值到堆,返回地址)
IL_000a: stloc. //#5 将返回值赋给变量 boxed
IL_000b: ldloc. // 将 boxed 压栈
IL_000c: call void [mscorlib]System.Console::WriteLine(object) // 调用WriteLine()方法
IL_0011: nop
IL_0012: ret
} // end of method Program::Main
而拆箱则是将一个 已装箱的引用类型 转换为值类型:
int i = ;
Object boxed = i;
int j;
j = (int)boxed; // 显示声明拆箱后的类型
Console.WriteLine("UnBoxed Point: " + j);
需要注意的是:UnBox 操作需要显示声明拆箱后转换的类型。它分为两步来完成:
- 获取已装箱的对象的地址。
- 将值从堆上的对象中拷贝到堆栈上的值变量中。
对象判等
因为我们要提到对象克隆(复制),那么,我们应该有办法知道复制前后的两个对象是否相等。所以,在进行下面的章节前,我们有必要先了解如何进行对象判等。
NOTE:感谢微软的开源以及 VS2015 的FCL调试功能。关于如何调试 FCL 代码,请参考 Configuring Visual Studio to Debug .NET Framework Source Code。
我们先定义用作范例的两个类型,它们代表直线上的一点,唯一区别是一个是引用类型class,一个是值类型struct:
public class RefPoint // 定义一个引用类型
{
public int X; public RefPoint(int x)
{
X = x;
}
} public struct ValPoint // 定义一个值类型
{
public int X; public ValPoint(int x)
{
X = x;
}
}
1.引用类型判等
我们先进行引用类型对象的判等,我们知道在System.Object基类型中,定义了实例方法Equals(object obj),静态方法 Equals(object objA, object objB),静态方法 ReferenceEquals(object objA, object objB) 来进行对象的判等。
我们先看看这三个方法,注意我在代码中用 #number 标识的地方,后文中我会直接引用:
public static bool ReferenceEquals(Object objA, Object objB)
{
return objA == objB; // #1
} public virtual bool Equals(Object obj)
{
return InternalEquals(this, obj); // #2
} public static bool Equals(Object objA, Object objB)
{
if (objA == objB) // #3
{
return true;
} if (objA == null || objB == null)
{
return false;
} return objA.Equals(objB); // #4
}
参见:https://referencesource.microsoft.com/#mscorlib/system/object.cs。
我们先看ReferenceEquals(object objA, object objB)方法,它实际上简单地返回 objA == objB,所以,在后文中,除非必要,我们统一使用 objA == objB(省去了 ReferenceEquals 方法)。另外,为了范例简单,我们不考虑对象为null的情况。
我们来看第一段代码:
bool result; // 复制对象引用
RefPoint rPoint1 = new RefPoint();
RefPoint rPoint2 = rPoint1; result = (rPoint1 == rPoint2); // #1返回 True;
Console.WriteLine(result); result = rPoint1.Equals(rPoint2); // #2 返回 True;
Console.WriteLine(result);
在阅读本文中,应该时刻在脑子里构思一个堆栈,一个堆,并思考着每条语句会在这两种结构上产生怎么样的效果。
在这段代码中,产生的效果是:
在堆上创建了一个新的RefPoint类型的实例(对象),并将它的X字段初始化为1;
在堆栈上创建变量rPoint1,rPoint1保存堆上这个对象的地址;
将rPoint1 赋值给 rPoint2时,此时并没有在堆上创建一个新的对象,而是将之前创建的对象的地址复制到了rPoint2。
此时,rPoint1和rPoint2指向了堆上同一个对象。
从 ReferenceEquals()这个方法名就可以看出,它判断两个引用变量是不是指向了同一个变量,如果是,那么就返回true。这种相等叫做 引用相等(rPoint1 == rPoint2 等效于 ReferenceEquals)。因为它们指向的是同一个对象,所以对rPoint1的操作将会影响rPoint2:
bool result;
RefPoint rPoint1 = new RefPoint();
RefPoint rPoint2 = rPoint1; // 复制对象引用 result = (rPoint1 == rPoint2); // #1返回 True;
Console.WriteLine(result); result = rPoint1.Equals(rPoint2); // #2 返回 True;
Console.WriteLine(result); Console.WriteLine("rPoint1.X="+rPoint1.X+ "rPoint2.X="+rPoint2.X);
rPoint1.X = ;
Console.WriteLine("rPoint1.X=" + rPoint1.X + "rPoint2.X=" + rPoint2.X);
注意System.Object静态的Equals(Object objA, Object objB)方法,在 #3 处,如果两个变量引用相等,那么将直接返回true。所以,可以预见我们上面的代码rPoint1.Equals(rPoint2); 在 #3 就会返回true。
但是我们没有调用静态Equals(),直接调用了实体方法,最后调用了#2 的 InternalEquals(),返回true。
我们再看引用类型的第二种情况:
bool result;
RefPoint rPoint1 = new RefPoint();
RefPoint rPoint2 = new RefPoint();//创建新引用类型的对象,其成员的值相等 result = (rPoint1 == rPoint2);
Console.WriteLine(result); // #1 返回 false; result = rPoint1.Equals(rPoint2);
Console.WriteLine(result); // #2 返回 false
上面的代码在堆上创建了两个类型实例,并用同样的值初始化它们;然后将它们的地址分别赋值给堆上的变量 rPoint1和rPoint2。此时 #2 返回了false,可以看到,对于引用类型,即使类型的实例(对象)包含的值相等,如果变量指向的是不同的对象,那么也不相等。
2.简单值类型判等
注意本节的标题:简单值类型判等,这个简单是如何定义的呢?如果值类型的成员仅包含值类型,那么我们暂且管它叫简单值类型,如果值类型的成员包含引用类型,我们管它叫复杂值类型。(注意,这只是本文中为了说明,个人作的定义。)
应该还记得我们之前提过,值类型都会隐式地继承自 System.ValueType类型,而ValueType类型覆盖了基类System.Object类型的Equals()方法,在值类型上调用Equals()方法,会调用ValueType的Equals()。所以,我们看看这个方法是什么样的,依然用 #number 标识后面会引用的地方。
public override bool Equals(Object obj)
{
if (null == obj)
{
return false;
}
RuntimeType thisType = (RuntimeType) this.GetType();
RuntimeType thatType = (RuntimeType) obj.GetType(); if (thatType != thisType)
{
return false;// 如果两个对象不是一个类型,直接返回false
} Object thisObj = (Object) this;
Object thisResult, thatResult; if (CanCompareBits(this)) // #5
return FastEqualsCheck(thisObj, obj); // #6 FieldInfo[] thisFields = thisType.GetFields(BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic);// 利用反射获取值类型所有字段 for (int i = ; i < thisFields.Length; i++)// 遍历字段,进行字段对字段比较
{
thisResult = ((RtFieldInfo) thisFields[i]).InternalGetValue(thisObj, false);
thatResult = ((RtFieldInfo) thisFields[i]).InternalGetValue(obj, false); if (thisResult == null)
{
if (thatResult != null)
return false;
}
else if (!thisResult.Equals(thatResult))
{
return false; // #7
}
} return true;
}
参见:https://referencesource.microsoft.com/#mscorlib/system/valuetype.cs
我们先来看看第一段代码:
bool result;
ValPoint vPoint1 = new ValPoint();
ValPoint vPoint2 = vPoint1;// 复制结构变量 //result = (vPoint1 == vPoint2); //编译错误:不能在ValPoint上应用 "==" 操作符
//Console.WriteLine(result); result = Object.ReferenceEquals(vPoint1, vPoint2); // 隐式装箱,指向了堆上的不同对象
Console.WriteLine(result); // 返回false
我们先在堆栈上创建了一个变量vPoint1,变量本身已经包含了所有字段和数据。然后在堆栈上复制了vPoint1的一份拷贝给了vPoint2,从常理思维上来讲,我们认为它应该是相等的。接下来我们就试着去比较它们,可以看到,我们不能用"=="直接去判断,这样会返回一个编译错误。如果我们调用System.Object基类的静态方法ReferenceEquals(),有意思的事情发生了:它返回了false。为什么呢?我们看下ReferenceEquals()方法的签名就可以了,它接受的是Object类型,也就是引用类型,而当我们传递vPoint1和vPoint2这两个值类型的时候,会进行一个隐式的装箱,效果相当于下面的语句:
Object boxPoint1 = vPoint1;
Object boxPoint2 = vPoint2;
result = (boxPoint1 == boxPoint2); // 返回false
Console.WriteLine(result);
而装箱的过程,我们在前面已经讲述过,上面的操作等于是在堆上创建了两个对象,对象包含的内容相同(地址不同),然后将对象地址分别返回给堆栈上的 boxPoint1和boxPoint2,再去比较boxPoint1和boxPoint2是否指向同一个对象,显然不是,所以返回false。
我们继续,添加下面这段代码:
result = vPoint1.Equals(vPoint2); // #5 返回true; #6 返回true;
Console.WriteLine(result); // 输出true
因为它们均继承自ValueType类型,所以此时会调用ValueType上的Equals()方法,在方法体内部,#5 CanCompareBits(this) 返回了true。
CanCompareBits(this)这个方法,按微软的注释,意识是说:如果对象的成员中存在堆上(可以被GC回收)的引用,那么返回false,如果不存在,返回true。 //no GC references in this object 返回true
按照ValPoint的定义,它仅包含一个int类型的字段x,自然不存在对堆上其他对象的引用,所以返回了true。从#5 的名字CanCompareBits,可以看出是判断是否可以进行按位比较,那么返回了true以后,#6 自然是进行按位比较了。//fast memcmp 快速内存比较
接下来,我们对vPoint2做点改动,看看会发生什么:
vPoint2.X = ;
result = vPoint1.Equals(vPoint2); // #5 返回true; #6 返回false; //FALSE
Console.WriteLine(result);
3. 复杂值类型判等
到现在,上面的这些方法,我们还没有走到的位置,就是CanCompareBits返回false以后的部分了。前面我们已经推测出了CanCompareBits返回false的条件(值类型的成员包含引用类型),现在只要实现下就可以了。
我们定义一个新的结构Line,它代表直线上的线段,我们让它的一个成员为值类型ValPoint,一个成员为引用类型RefPoint,然后去作比较。
// 结构类型 ValLine 的定义,
public struct ValLine
{
public RefPoint rPoint; // 引用类型成员
public ValPoint vPoint; // 值类型成员 public ValLine(RefPoint rPoint, ValPoint vPoint)
{
this.rPoint = rPoint;
this.vPoint = vPoint;
}
}
private static void Main()
{
RefPoint rPoint = new RefPoint();
ValPoint vPoint = new ValPoint(); ValLine line1 = new ValLine(rPoint, vPoint);
ValLine line2 = line1; var result=line1.Equals(line2); // 此时已经存在一个装箱操作,调用ValueType.Equals()
//result = (line1 == line2);//运算符“==”无法应用于“Program.ValLine”和“Program.ValLine”类型的操作数
Console.WriteLine(result); // 返回True
}
这个例子的过程要复杂得多。在开始前,我们先思考一下,当我们写下 line1.Equals(line2)时,已经进行了一个装箱的操作。如果要进一步判等,显然不能去判断变量是否引用的堆上同一个对象,这样的话就没有意义了,因为总是会返回false(装箱后堆上创建了两个对象)。那么应该如何判断呢?对堆上对象的成员(字段)进行一对一的比较,而成员又分为两种类型,一种是值类型,一种是引用类型。对于引用类型,去判断是否引用相等;对于值类型,如果是简单值类型,那么如同前一节讲述的去判断;如果是复杂类型,那么当然是递归调用了;最终直到要么是引用类型要么是简单值类型。
NOTE:进行字段对字段的一对一比较,需要用到反射,如果不了解反射,可以参看 .Net中的反射 系列文章。
好了,我们现在看看实际的过程,是不是如同我们料想的那样,为了避免频繁的拖动滚动条查看ValueType的Equals()方法,我拷贝了部分下来:
public override bool Equals(Object obj)
{
//...
if (CanCompareBits(this)) // #5
return FastEqualsCheck(thisObj, obj); // #6
// 利用反射获取类型的所有字段(或者叫类型成员)
FieldInfo[] thisFields = thisType.GetFields(BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic);
// 遍历字段进行比较
for (int i = ; i < thisFields.Length; i++){
thisResult = ((RtFieldInfo) thisFields[i]).InternalGetValue(thisObj);
thatResult = ((RtFieldInfo) thisFields[i]).InternalGetValue(obj); if (thisResult == null){
if (thatResult != null)
return false;
}
else if (!thisResult.Equals(thatResult)){//#7
return false;
}
} return true;
}
进入 ValueType 上的 Equals() 方法,#5 处返回了 false;
- 进入 for 循环,遍历字段。
- 第一个字段是RefPoint引用类型,#7 处,调用 System.Object 的Equals()方法,到达#2,返回true。
- 第二个字段是ValPoint值类型,#7 处,调用 System.ValType的Equals()方法,也就是当前方法本身。此处递归调用。
- 再次进入 ValueType 的 Equals() 方法,因为 ValPoint 为简单值类型,所以 #5 CanCompareBits 返回了true,接着 #6 FastEqualsCheck 返回了 true。
- 里层 Equals()方法返回 true。
- 退出 for 循环。
- 外层 Equals() 方法返回 true。