.NET 数据拷贝方案选择

95 阅读5分钟

前言

应用中我们经常使用到数据的复制,在.NET中有多种方式可以实现复制数据或对象。选择哪种方式、是浅拷贝还是深拷贝,具体需求场景可以取决于对象的复杂性、数据量等,本文我们介绍主要的拷贝方式以及相对高性能的方案。

MemberwiseClone拷贝

浅拷贝 Object.MemberwiseClone 方法 (System) | Microsoft Learn,指针对对象执行非静态字段的浅复制操作

字段是基础类型如string、int,会全部复制过来,是全新的值

字段是引用类型,则会则复制对象的引用,而不复制对象,二者对象是一个内存地址

深拷贝,则不管是字段还是引用类型,均完全实现全新的复现。

一般深拷贝可以手动实现,对象类内部添加Clone方法(也可以实现内置的统一接口ICloneable),将所有字段重新赋值一遍、返回一个新对象。那也可以基于MemberwiseClone方案之上,对引用类型重新赋值一个新对象,实现深拷贝

深拷贝,内部克隆的对象字段可以修改,不会影响原来对象的值。

参考如下代码:

public class MemberwiseCloneModel
{
    public int Age { get; set; }
    public string Name { get; set; }
    public TestMode Mode { get; set; }
    public MemberwiseCloneModel ShallowClone()
    {
        return (MemberwiseCloneModel)this.MemberwiseClone();
    }
    public MemberwiseCloneModel DeepCopy()
    {
        var clone = (MemberwiseCloneModel)this.MemberwiseClone();
        clone.Mode = new TestMode() { Data = this.Mode?.Data ?? string.Empty };
        return clone;
    }
}

Record的with数据拷贝

这是针对Record数据类的一类拷贝方式,只在C#9以上支持,详见Record - C# reference | Microsoft Learn

record因为是标记数据类,可以只有属性,所以RecordModel可以简写为RecordModel1结构:

public record class RecordModel
{
    public string Name { get; set; }
    public int Age { get; set; }
    public TestMode Mode { get; set; }
}
public record RecordModel1(string Name, int Age, TestMode Mode);

with相当于MemberwiseClone浅拷贝,对值类型字段可以全新复制,但引用类型操作后还是同一对象 with 表达式 - 创建新对象,这些对象是现有对象的修改副本 - C# reference | Microsoft Learn

写个demo:

public static void TestRecordWith()
{
    var original = new RecordModel() { Name = "Test", Age = 20, Mode = new TestMode() { Data = "data" } };
    var clone = original with { };
    Debug.WriteLine($"referenceEquals:{ReferenceEquals(original, clone)}");
    Debug.WriteLine($"clone:{clone.Name},{clone.Age},{clone.Mode.Data}");
    clone.Name = "Test1";
    clone.Age = 21;
    clone.Mode.Data = "data1";
    Debug.WriteLine($"original after modified clone:{original.Name},{original.Age},{original.Mode.Data}");
}

上面demo输出结果,基础类型不会被修改:

另外,with也可以同时给属性赋新值,var clone = original with { Name = "Test0" };

序列化实现数据拷贝

可以通过将对象序列化为二进制、XML 或 JSON 等格式,然后再反序列化为新对象来实现深拷贝。此方法对内部引用对象字段,也适用

1、二进制格式实现比例简单,直接粘贴代码,如下:

public static T DeepCopy<T>(T obj)
{
    using (MemoryStream memoryStream = new MemoryStream())
    {
        IFormatter formatter = new BinaryFormatter();
        formatter.Serialize(memoryStream, obj);
        memoryStream.Seek(0, SeekOrigin.Begin);
        return (T)formatter.Deserialize(memoryStream);
    }
}

但BinaryFormatter在.NET5之后标记废弃了,原因是安全漏洞:使用 BinaryFormatter 和相关类型时的反序列化风险 - .NET | Microsoft Learn。官方推荐使用XML以及Json序列化等

2、XML序列化需要添加属性标记DataContract、DataMember(推荐Json序列化也添加此标记)

[DataContract]
public class SerializerModel
{
    [DataMember]
    public string Name { get; set; }
    [DataMember]
    public int Age { get; set; }
    [DataMember]
    public TestMode Mode { get; set;     }
}

DataContractSerializerDataContractSerializer 类 (System.Runtime.Serialization) | Microsoft Learn实现XML序列化:

public static T DeepCopyBySerializer<T>(T obj)
{
    using var stream = new MemoryStream();
    var serializer = new DataContractSerializer(typeof(T));
    serializer.WriteObject(stream, obj);
    stream.Position = 0;
    return (T)serializer.ReadObject(stream);
}

XML序列化还有一个XmlSerializer,就不介绍了。

DataContractSerializer使用的是一种流式序列化方式,复杂对象、数据量较大时,DataContractSerializer比 XmlSerializer基于反射的序列化更快。如果是需要可视化可读性强的XML、数据量小、性能要求不高,可以使用XmlSerializer

3、再说说Json序列化

已知最强的2个Json序列化器:微软的System.Text.Json和第三方成熟Newtonsoft.Json

如果是.NET版本推荐System.Text.Json,Framework版本使用Newtonsoft.Json。

之前有统计过俩个方案的性能 .NET Json序列化方案选择 - 唐宋元明清2188 - 博客园

后面关注.NET8+,所以看System.Text.Json就好:

public static T DeepCopyByJson<T>(T obj)
{
    var data = System.Text.Json.JsonSerializer.Serialize(obj);
    return System.Text.Json.JsonSerializer.Deserialize<T>(data);
}

性能测试Benchmark

准备同样一个大小数据,Benchmark代码如下:

[MemoryDiagnoser]
public class BenchmarkTest
{
    private readonly BenchmarkTestMode _data;

    public BenchmarkTest()
    {
        _data = GetData();
    }
    [Benchmark]
    public void ShallowCloneByMemberwiseClone()
    {
        var original = _data;
        for (int i = 0; i < 1000; i++)
        {
            var clone = original.ShallowClone();
        }
    }
    [Benchmark]
    public void ShallowCloneByRecordWith()
    {
        var original = _data;
        for (int i = 0; i < 1000; i++)
        {
            var clone = original with { };
        }
    }
    [Benchmark]
    public void DeepCloneByManual()
    {
        var original = _data;
        for (int i = 0; i < 1000; i++)
        {
            var benchmarkTestMode = new BenchmarkTestMode()
            {
                Angle = original.Angle,
                Name = original.Name,
                Points = original.Points.Select(i => new Point(i.X, i.Y)).ToList()
            };
        }
    }
    [Benchmark]
    public void DeepCloneByMemberwiseCloneManual()
    {
        var original = _data;
        for (int i = 0; i < 1000; i++)
        {
            var clone = original.DeepClone();
        }
    }
    [Benchmark]
    public void DeepCloneByDataContractSerializer()
    {
        var original = _data;
        for (int i = 0; i < 1000; i++)
        {
            using var stream = new MemoryStream();
            var serializer = new DataContractSerializer(typeof(BenchmarkTestMode));
            serializer.WriteObject(stream, original);
            stream.Position = 0;
            var clone = (BenchmarkTestMode)serializer.ReadObject(stream);
        }
    }
    [Benchmark]
    public void DeepCloneBySystemTextJson()
    {
        var original = _data;
        for (int i = 0; i < 1000; i++)
        {
            var data = System.Text.Json.JsonSerializer.Serialize(original);
            var clone = System.Text.Json.JsonSerializer.Deserialize<BenchmarkTestMode>(data);
        }
    }

    private BenchmarkTestMode GetData()
    {
        var original = new BenchmarkTestMode() { Name = "Test", Angle = 20 };
        original.Points = new List<Point>();
        for (int i = 0; i < 1000; i++)
        {
            original.Points.Add(new Point(i, 1000 - i));
        }
        return original;
    }
}

然后我们使用release把test跑起来

var summary = BenchmarkRunner.Run<BenchmarkTest>();
Console.WriteLine(summary);

1、浅拷贝,我们对比MemberwiseClone 、Record数据类With

看下面测试结果,Record-with性能强的不是一丁点:

浅拷贝推荐Record数据类With操作,所以我们可以把record使用起来,record不只是简化以及可读性好。如果追求极致性能的话,可以使用record struct结构体

2、深拷贝,主要有MemberwiseClone结合手动复制、手动复制、XML序列化、JSON序列化

XML/JSON序列化 性能远远小于 MemberwiseClone结合手动复制、手动复制。另外,序列化操作我们可以看到内存总量增加超级多,运行期间会带来一定的内存暴涨问题

所以大量数据场景,深拷贝推荐手动复制(可以结合MemberwiseClone),可以在组件库自定义一套解析、反解析接口,在团队内统一使用。如果只是快速实现功能、性能要求不高,可以使用XML/JSON序列化

最后

如果你觉得这篇文章对你有帮助,不妨点个赞支持一下!你的支持是我继续分享知识的动力。如果有任何疑问或需要进一步的帮助,欢迎随时留言。

也可以加入微信公众号 [DotNet技术匠] 社区,与其他热爱技术的同行一起交流心得,共同成长!

优秀是一种习惯,欢迎大家留言学习!

作者:唐宋元明清2188

出处:cnblogs.com/kybs0/p/18669035

声明:网络内容,仅供学习,尊重版权,侵权速删,歉意致谢!