在C#中做最浅层复制的最快方法

时间:2009-06-08 19:13:19

标签: c# cloning shallow-copy

我想知道在C#中进行浅层复制的最快方法是什么?我只知道有两种方法可以做浅拷贝:

  1. MemberwiseClone
  2. 逐个复制每个字段(手动)
  3. 我发现(2)比(1)快。我想知道是否有另一种方法可以进行浅层复制?

8 个答案:

答案 0 :(得分:70)

这是一个复杂的主题,有很多可能的解决方案,每个都有很多优点和缺点。有一篇精彩的文章here概述了在C#中制作副本的几种不同方法。总结一下:

  1. 手动克隆 繁琐但高水平的控制。

  2. 使用MemberwiseClone克隆 仅创建浅层副本,即对于引用类型字段,原始对象及其克隆引用同一对象。

  3. 用反射克隆 默认情况下是浅拷贝,可以重写进行深拷贝。优势:自动化。缺点:反射很慢。

  4. 使用序列化克隆 简单,自动化。放弃一些控制和序列化是最慢的。

  5. 用IL克隆,用扩展方法克隆 更高级的解决方案,并不常见。

答案 1 :(得分:28)

我很困惑。 MemberwiseClone()消灭其他任何内容的表现以获得浅色副本。在CLI中,RCW以外的任何类型都应该能够按以下顺序进行浅层复制:

  • 在托儿所中为该类型分配内存。
  • memcpy从原始数据到新数据。由于目标位于托儿所,因此不需要写入障碍。
  • 如果对象具有用户定义的终结器,请将其添加到待完成的GC列表中。
    • 如果源对象已调用SuppressFinalize并且此标志存储在对象标头中,请在克隆中取消设置。

CLR内部小组的某个人可以解释为什么不是这种情况吗?

答案 2 :(得分:24)

我想从几个引号开始:

  

事实上,MemberwiseClone通常比其他人好得多,特别是对于复杂类型。

  

我很困惑。 MemberwiseClone()应该消除浅拷贝的其他任何东西的性能。 [...]

理论上,浅拷贝的最佳实现是C ++拷贝构造函数:它知道编译时的大小,然后对所有字段进行成员克隆。接下来最好的事情是使用memcpy或类似的东西,这基本上是MemberwiseClone应该如何工作的。这意味着,理论上它应该在性能方面消除所有其他可能性。

......但显然它并不快速,并没有消除所有其他解决方案。在底部我实际上发布了一个超过2倍的解决方案。所以:错了。

测试MemberwiseClone的内部结构

让我们从使用简单blittable类型的一点测试开始,检查这里关于性能的基本假设:

[StructLayout(LayoutKind.Sequential)]
public class ShallowCloneTest
{
    public int Foo;
    public long Bar;

    public ShallowCloneTest Clone()
    {
        return (ShallowCloneTest)base.MemberwiseClone();
    }
}

测试的设计方式是我们可以检查MemberwiseClone agaist raw memcpy的性能,这是可能的,因为这是一个blittable类型。

要自己测试,使用不安全的代码进行编译,禁用JIT抑制,编译发布模式并进行测试。我也把时间安排在相关的每一行之后。

实施1

ShallowCloneTest t1 = new ShallowCloneTest() { Bar = 1, Foo = 2 };
Stopwatch sw = Stopwatch.StartNew();
int total = 0;
for (int i = 0; i < 10000000; ++i)
{
    var cloned = t1.Clone();                                    // 0.40s
    total += cloned.Foo;
}

Console.WriteLine("Took {0:0.00}s", sw.Elapsed.TotalSeconds);

基本上我经常运行这些测试,检查程序集输出以确保没有优化的东西等等。最终的结果是我知道这一行代码花费了多少秒,这是在我的电脑上0.40秒。这是我们使用MemberwiseClone的基线。

实施2

sw = Stopwatch.StartNew();

total = 0;
uint bytes = (uint)Marshal.SizeOf(t1.GetType());
GCHandle handle1 = GCHandle.Alloc(t1, GCHandleType.Pinned);
IntPtr ptr1 = handle1.AddrOfPinnedObject();

for (int i = 0; i < 10000000; ++i)
{
    ShallowCloneTest t2 = new ShallowCloneTest();               // 0.03s
    GCHandle handle2 = GCHandle.Alloc(t2, GCHandleType.Pinned); // 0.75s (+ 'Free' call)
    IntPtr ptr2 = handle2.AddrOfPinnedObject();                 // 0.06s
    memcpy(ptr2, ptr1, new UIntPtr(bytes));                     // 0.17s
    handle2.Free();

    total += t2.Foo;
}

handle1.Free();
Console.WriteLine("Took {0:0.00}s", sw.Elapsed.TotalSeconds);

如果仔细观察这些数字,你会发现一些事情:

  • 创建对象并复制它大约需要0.20秒。在正常情况下,这是您可以拥有的最快的代码。
  • 但是,为此,您需要固定和取消固定对象。这将花费0.81秒。

那为什么所有这一切都这么慢?

我的解释是它与GC有关。基本上,实现不能依赖于内存在完整GC之前和之后保持不变的事实(在GC期间可以更改内存的地址,这可能在任何时刻发生,包括在浅拷贝期间)。这意味着您只有两种可能的选择:

  1. 固定数据并进行复制。请注意GCHandle.Alloc只是执行此操作的方法之一,众所周知,像C ++ / CLI这样的东西会为您提供更好的性能。
  2. 枚举字段。这将确保GC之间收集您不需要做任何花哨的事情,并且在GC收集期间,您可以使用GC功能修改移动对象堆栈上的地址。
  3. MemberwiseClone将使用方法1,这意味着由于固定程序,您将获得性能损失。

    实施(更快)

    在所有情况下,我们的非托管代码都不能对类型的大小做出假设,并且必须固定数据。对大小做出假设使编译器能够进行更好的优化,例如循环展开,寄存器分配等(就像C ++拷贝ctor比memcpy更快)。无需固定数据意味着我们不会获得额外的性能影响。从.NET JIT到汇编程序,理论上这意味着我们应该能够使用简单的IL发射来实现更快的实现,并允许编译器对其进行优化。

    总结一下为什么这比原生实现更快?

    1. 不需要固定物体;移动的对象由GC处理 - 实际上,这是不断优化的。
    2. 它可以对要复制的结构的大小做出假设,因此可以更好地进行寄存器分配,循环展开等。
    3. 我们的目标是原始memcpy或更好的表现:0.17s。

      要做到这一点,我们基本上不能只使用call,创建对象,并执行一堆copy指令。它看起来有点像上面的Cloner实现,但有一些重要的区别(最重要的是:没有Dictionary而没有多余的CreateDelegate调用)。这是:

      public static class Cloner<T>
      {
          private static Func<T, T> cloner = CreateCloner();
      
          private static Func<T, T> CreateCloner()
          {
              var cloneMethod = new DynamicMethod("CloneImplementation", typeof(T), new Type[] { typeof(T) }, true);
              var defaultCtor = typeof(T).GetConstructor(new Type[] { });
      
              var generator = cloneMethod .GetILGenerator();
      
              var loc1 = generator.DeclareLocal(typeof(T));
      
              generator.Emit(OpCodes.Newobj, defaultCtor);
              generator.Emit(OpCodes.Stloc, loc1);
      
              foreach (var field in typeof(T).GetFields(BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic))
              {
                  generator.Emit(OpCodes.Ldloc, loc1);
                  generator.Emit(OpCodes.Ldarg_0);
                  generator.Emit(OpCodes.Ldfld, field);
                  generator.Emit(OpCodes.Stfld, field);
              }
      
              generator.Emit(OpCodes.Ldloc, loc1);
              generator.Emit(OpCodes.Ret);
      
              return ((Func<T, T>)cloneMethod.CreateDelegate(typeof(Func<T, T>)));
          }
      
          public static T Clone(T myObject)
          {
              return cloner(myObject);
          }
      }
      

      我已经用结果测试了这段代码:0.16s。这意味着它比MemberwiseClone快约2.5倍。

      更重要的是,这个速度与memcpy相当,这或多或少是“正常情况下的最佳解决方案”。

      就我个人而言,我认为这是最快的解决方案 - 最好的部分是:如果.NET运行时变得更快(对SSE指令的适当支持等),那么这个解决方案也是如此。

答案 3 :(得分:13)

为什么复杂化? MemberwiseClone就足够了。

public class ClassA : ICloneable
{
   public object Clone()
   {
      return this.MemberwiseClone();
   }
}

// let's say you want to copy the value (not reference) of the member of that class.
public class Main()
{
    ClassA myClassB = new ClassA();
    ClassA myClassC = new ClassA();
    myClassB = (ClassA) myClassC.Clone();
}

答案 4 :(得分:8)

这是使用动态IL生成的方法。我在网上找到了它:

public static class Cloner
{
    static Dictionary<Type, Delegate> _cachedIL = new Dictionary<Type, Delegate>();

    public static T Clone<T>(T myObject)
    {
        Delegate myExec = null;

        if (!_cachedIL.TryGetValue(typeof(T), out myExec))
        {
            var dymMethod = new DynamicMethod("DoClone", typeof(T), new Type[] { typeof(T) }, true);
            var cInfo = myObject.GetType().GetConstructor(new Type[] { });

            var generator = dymMethod.GetILGenerator();

            var lbf = generator.DeclareLocal(typeof(T));

            generator.Emit(OpCodes.Newobj, cInfo);
            generator.Emit(OpCodes.Stloc_0);

            foreach (var field in myObject.GetType().GetFields(BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic))
            {
                // Load the new object on the eval stack... (currently 1 item on eval stack)
                generator.Emit(OpCodes.Ldloc_0);
                // Load initial object (parameter)          (currently 2 items on eval stack)
                generator.Emit(OpCodes.Ldarg_0);
                // Replace value by field value             (still currently 2 items on eval stack)
                generator.Emit(OpCodes.Ldfld, field);
                // Store the value of the top on the eval stack into the object underneath that value on the value stack.
                //  (0 items on eval stack)
                generator.Emit(OpCodes.Stfld, field);
            }

            // Load new constructed obj on eval stack -> 1 item on stack
            generator.Emit(OpCodes.Ldloc_0);
            // Return constructed object.   --> 0 items on stack
            generator.Emit(OpCodes.Ret);

            myExec = dymMethod.CreateDelegate(typeof(Func<T, T>));

            _cachedIL.Add(typeof(T), myExec);
        }

        return ((Func<T, T>)myExec)(myObject);
    }
}

答案 5 :(得分:5)

事实上,MemberwiseClone通常比其他人好得多,特别是对于复杂类型。

原因是:如果你手动创建一个副本,它必须调用一个类型的构造函数,但是使用成员克隆,我猜它只是复制一块内存。对于那些类型具有非常昂贵的构造动作,成员克隆绝对是最好的方法。

Onece我写了这样的类型: {string A = Guid.NewGuid()。ToString()},我发现成员克隆比创建新实例和手动分配成员更快。

以下代码的结果:

手动复印:00:00:00.0017099

MemberwiseClone:00:00:00.0009911

namespace MoeCard.TestConsole
{
    class Program
    {
        static void Main(string[] args)
        {
            Program p = new Program() { AAA = Guid.NewGuid().ToString(), BBB = 123 };
            Stopwatch sw = Stopwatch.StartNew();
            for (int i = 0; i < 10000; i++)
            {
                p.Copy1();
            }
            sw.Stop();
            Console.WriteLine("Manual Copy:" + sw.Elapsed);

            sw.Restart();
            for (int i = 0; i < 10000; i++)
            {
                p.Copy2();
            }
            sw.Stop();
            Console.WriteLine("MemberwiseClone:" + sw.Elapsed);
            Console.ReadLine();
        }

        public string AAA;

        public int BBB;

        public Class1 CCC = new Class1();

        public Program Copy1()
        {
            return new Program() { AAA = AAA, BBB = BBB, CCC = CCC };
        }
        public Program Copy2()
        {
            return this.MemberwiseClone() as Program;
        }

        public class Class1
        {
            public DateTime Date = DateTime.Now;
        }
    }

}

最后,我在这里提供了我的代码:

    #region 数据克隆
    /// <summary>
    /// 依据不同类型所存储的克隆句柄集合
    /// </summary>
    private static readonly Dictionary<Type, Func<object, object>> CloneHandlers = new Dictionary<Type, Func<object, object>>();

    /// <summary>
    /// 根据指定的实例,克隆一份新的实例
    /// </summary>
    /// <param name="source">待克隆的实例</param>
    /// <returns>被克隆的新的实例</returns>
    public static object CloneInstance(object source)
    {
        if (source == null)
        {
            return null;
        }
        Func<object, object> handler = TryGetOrAdd(CloneHandlers, source.GetType(), CreateCloneHandler);
        return handler(source);
    }

    /// <summary>
    /// 根据指定的类型,创建对应的克隆句柄
    /// </summary>
    /// <param name="type">数据类型</param>
    /// <returns>数据克隆句柄</returns>
    private static Func<object, object> CreateCloneHandler(Type type)
    {
        return Delegate.CreateDelegate(typeof(Func<object, object>), new Func<object, object>(CloneAs<object>).Method.GetGenericMethodDefinition().MakeGenericMethod(type)) as Func<object, object>;
    }

    /// <summary>
    /// 克隆一个类
    /// </summary>
    /// <typeparam name="TValue"></typeparam>
    /// <param name="value"></param>
    /// <returns></returns>
    private static object CloneAs<TValue>(object value)
    {
        return Copier<TValue>.Clone((TValue)value);
    }
    /// <summary>
    /// 生成一份指定数据的克隆体
    /// </summary>
    /// <typeparam name="TValue">数据的类型</typeparam>
    /// <param name="value">需要克隆的值</param>
    /// <returns>克隆后的数据</returns>
    public static TValue Clone<TValue>(TValue value)
    {
        if (value == null)
        {
            return value;
        }
        return Copier<TValue>.Clone(value);
    }

    /// <summary>
    /// 辅助类,完成数据克隆
    /// </summary>
    /// <typeparam name="TValue">数据类型</typeparam>
    private static class Copier<TValue>
    {
        /// <summary>
        /// 用于克隆的句柄
        /// </summary>
        internal static readonly Func<TValue, TValue> Clone;

        /// <summary>
        /// 初始化
        /// </summary>
        static Copier()
        {
            MethodFactory<Func<TValue, TValue>> method = MethodFactory.Create<Func<TValue, TValue>>();
            Type type = typeof(TValue);
            if (type == typeof(object))
            {
                method.LoadArg(0).Return();
                return;
            }
            switch (Type.GetTypeCode(type))
            {
                case TypeCode.Object:
                    if (type.IsClass)
                    {
                        method.LoadArg(0).Call(Reflector.GetMethod(typeof(object), "MemberwiseClone")).Cast(typeof(object), typeof(TValue)).Return();
                    }
                    else
                    {
                        method.LoadArg(0).Return();
                    }
                    break;
                default:
                    method.LoadArg(0).Return();
                    break;
            }
            Clone = method.Delegation;
        }

    }
    #endregion

答案 6 :(得分:4)

MemberwiseClone需要较少的维护。我不知道默认属性值是否有帮助,可能会忽略具有默认值的项目。

答案 7 :(得分:1)

这是一个小的帮助器类,该类使用反射来访问MemberwiseClone,然后缓存该委托以避免不必要地使用反射。

public static class CloneUtil<T>
{
    private static readonly Func<T, object> clone;

    static CloneUtil()
    {
        var cloneMethod = typeof(T).GetMethod("MemberwiseClone", System.Reflection.BindingFlags.Instance | System.Reflection.BindingFlags.NonPublic);
        clone = (Func<T, object>)cloneMethod.CreateDelegate(typeof(Func<T, object>));
    }

    public static T ShallowClone(T obj) => (T)clone(obj);
}

public static class CloneUtil
{
    public static T ShallowClone<T>(this T obj) => CloneUtil<T>.ShallowClone(obj);
}

您可以这样称呼它:

Person b = a.ShallowClone();