正确实现浅拷贝和深拷贝

继上一篇“C#:为类型输出格式化字符串”后,本文继续看《编写高质量代码改善C#程序的157个建议》一书第14个建议“正确实现浅拷贝和深拷贝”。喜欢本书请到各大商城购买原书,支持正版。

正文开始:


为对象创建副本的技术称为拷贝(也叫克隆)。我们将拷贝分为浅拷贝和深拷贝。

浅拷贝 将对象中的所有字段复制到新的对象(副本)中。其中,值类型字段的值被复制到副本中后,在副本中的修改不会影响到源对象对应的值。而引用类型的字段被复制到副本中的是引用类型的引用,而不是引用的对象,在副本中对引用类型的字段值做修改会影响到源对象本身。

深拷贝 同样,将对象中的所有字段复制到新的对象中。不过,无论是对象的值类型字段,还是引用类型字段,都会被重新创建并赋值,对于副本的修改,不会影响到源对象本身。

无论是浅拷贝还是深拷贝,微软都建议用类型继承ICloneable接口的方式明确告诉调用者:该类型可以被拷贝。当然,ICloneable接口只提供了一个声明为Clone的方法,我们可以根据需求在Clone方法内实现浅拷贝或深拷贝。一个简单的浅拷贝的实现代码如下所示:

class Employee : ICloneable
{
  public string IDcode { get; set; }
  public int Age { get; set; }
  public Department Department { get; set; }

  #region ICloneable 成员

  public object Clone()
  {
    return this.MemberwiseClone();
  }

  #endregion
}

class Department
{
  public string Name { get; set; }
  public override string ToString()
  {
    return this.Name;
  }
}

调用方代码如下所示:

Employee mike = new Employee()
{
  IDCode = "NB123",
  Age = 30,
  Department = new Department
  {
    Name = "Dep1"
  }
};

Employee rose = mike.Clone() as Employee;

Console.WriteLine(rose.IDCode);
Console.WriteLine(rose.Age);
Console.WriteLine(rose.Department);

Console.WriteLine("开始改变mike的值: ");

mike.IDCode = "NB456";
mike.Age = 60;
mike.Department.Name = "Dep2";

Console.WriteLine(rose.IDCode);
Console.WriteLine(rose.Age);
Console.WriteLine(rose.Department);

输出为:

NB123
30
Dep1
开始改变mike的值:
NB123
30
Dep2

注意到Employee的 IDCode属性是string 类型。理论上 string类型是引用类型,但是由于该引用类型的特殊性(无论是实现还是语义),Object.MemberwiseClone方法仍旧为其创建了副本。也就是说,在浅拷贝过程,我们应该将字符串看成是值类型。

Employee的 Department属性是一个引用类型,所以,如果改变了源对象mike中的值,副本rose中的值也会随之一起变动。

Employee的深拷贝有多种实现方法,最简单的方法是手动对字段逐个进行赋值。但这种方法容易出错,也就是说,如果类型的字段发生变化或有增减,那么该拷贝方法也要发生相应的变化,所以,建议使用序列化的形式来进行深拷贝。Employee深拷贝的一个简单实现代码如下所示:

class Employee : ICloneable
{
  public string IDCode { get; set; }
  public int Age { get; set; }
  public Department Department { get; set; }

  #region ICloneable 成员

  public object Clone()
  {
    using(Stream objectStream = new MemoryStream())
    {
      IFormatter formatter = new BinaryFormatter();
      formatter.Serialize(objectStream, this);
      objectStream.Seek(0, SeekOrigin.Begin);
      return formatter.Deserialize(objectStream) as Employee;
    }
  }

  #endregion
}

站长注:上面的formatter.Serializeformatter.Deserialize提示已过时:

正确实现浅拷贝和深拷贝

虽然上面的代码依旧可以用,但身为一个有代码洁癖的人,还是百度查了下资料,我们使用下面的代码实现克隆,代码参考来自微软官方文档:DataContractSerializer 类。

原理比较简单:将对象序列化和反序列化方法提取出来,序列化即将原对象序列化为xml数据存储,反序列化即读取上一步序列化转换存储的xml数据,再转换为对象。

注意序列化对象EmployeeDepartment的类DataContract特性和属性DataMember特性,有这标识,类才支持xml序列化,及标识属性支持序列化。

public static class SerialHelper
{
  public static void WriteObject<T>(string fileName, T t)
  {
    Console.WriteLine(
      "Creating a Person object and serializing it.");
    FileStream writer = new FileStream(fileName, FileMode.Create);
    DataContractSerializer ser =
      new DataContractSerializer(typeof(T));
    ser.WriteObject(writer, t);
    writer.Close();
  }

  public static T ReadObject<T>(string fileName)
  {
    Console.WriteLine("Deserializing an instance of the object.");
    FileStream fs = new FileStream(fileName,
    FileMode.Open);
    XmlDictionaryReader reader =
      XmlDictionaryReader.CreateTextReader(fs, new XmlDictionaryReaderQuotas());
    DataContractSerializer ser = new DataContractSerializer(typeof(T));

    // Deserialize the data and read it from the instance.
    T t =
      (T)ser.ReadObject(reader, true);
    reader.Close();
    fs.Close();
    return t;
  }
}

[DataContract(Name = "Employee", Namespace = "https://lqclass.com")]
class Employee : ICloneable
{
  [DataMember()]
  public string IDCode { get; set; }
  [DataMember()]
  public int Age { get; set; }
  [DataMember()]
  public Department Department { get; set; }

  #region ICloneable 成员

  public object Clone()
  {
    string fileName = "tmp";
    SerialHelper.WriteObject<Employee>(fileName, this);
    var newOjb = SerialHelper.ReadObject<Employee>(fileName);
    File.Delete(fileName);
    return newOjb;
  }

  #endregion
}

[DataContract(Name = "Department", Namespace = "https://lqclass.com")]
class Department
{
  [DataMember()]
  public string Name { get; set; }
  public override string ToString()
  {
    return this.Name;
  }
}

使用浅拷贝中的调用者代码,输出为:

Creating a Person object and serializing it.
Deserializing an instance of the object.
NB123
30
Dep1
开始改变mike的值:
NB123
30
Dep1

可以发现,再次更改mike的值已经不会影响副本rose的值了。

由于接口ICloneable 只有一个模棱两可的Clone方法,所以,如果要在一个类中同时实现深拷贝和浅拷贝,只能由我们自己实现两个额外的方法,声明为DeepClone和Shallow。Employee的最终版本看起来应该像如下的形式:

[DataContract(Name = "Employee", Namespace = "https://lqclass.com")]
class Employee : ICloneable
{
  [DataMember()]
  public string IDCode { get; set; }
  [DataMember()]
  public int Age { get; set; }
  [DataMember()]
  public Department Department { get; set; }

  #region ICloneable 成员

  public object Clone()
  {
    return this.MemberwiseClone();
  }

  #endregion


  public Employee DeepClone()
  {
    string fileName = "tmp";
    SerialHelper.WriteObject<Employee>(fileName, this);
    var newOjb = SerialHelper.ReadObject<Employee>(fileName);
    File.Delete(fileName);
    return newOjb;
  }

  public Employee ShallowClone()
  {
    return Clone() as Employee;
  }
}

下一篇我们接着读"建议15:使用dynamic来简化反射实现",欢迎关注微信公众号【乐趣课堂】。

原文出处:微信公众号【爱读书 乐趣课堂】

原文链接:https://mp.weixin.qq.com/s/mcTMR7tvxWCNcl3G-0MIHg

本文观点不代表Dotnet9立场,转载请联系原作者。

发表评论

登录后才能评论