webdevqa.jp.net

どのようにして.NETでオブジェクトのディープコピーをするのですか(特にC#)。

真のディープコピーが欲しいのですが。 Javaでは、これは簡単でしたが、C#でどのようにしますか。

531
user18931

私はこれに対するいくつかの異なるアプローチを見ました、しかし私はそのように一般的な効用方法を使います:

public static T DeepClone<T>(T obj)
{
 using (var ms = new MemoryStream())
 {
   var formatter = new BinaryFormatter();
   formatter.Serialize(ms, obj);
   ms.Position = 0;

   return (T) formatter.Deserialize(ms);
 }
}

ノート:

  • これが機能するためには、あなたのクラスは[Serializable]としてマークされなければなりません。
  • ソースファイルには次のコードを含める必要があります。

    using System.Runtime.Serialization.Formatters.Binary;
    using System.IO;
    
579
Kilhoffer

再帰的な "MemberwiseClone" に基づいて、I ディープオブジェクトコピー拡張メソッドを書いた 。それは速く( BinaryFormatterよりも3倍速い )、そしてどんなオブジェクトでも動作します。デフォルトのコンストラクタや直列化可能な属性は必要ありません。

ソースコード:

using System.Collections.Generic;
using System.Reflection;
using System.ArrayExtensions;

namespace System
{
    public static class ObjectExtensions
    {
        private static readonly MethodInfo CloneMethod = typeof(Object).GetMethod("MemberwiseClone", BindingFlags.NonPublic | BindingFlags.Instance);

        public static bool IsPrimitive(this Type type)
        {
            if (type == typeof(String)) return true;
            return (type.IsValueType & type.IsPrimitive);
        }

        public static Object Copy(this Object originalObject)
        {
            return InternalCopy(originalObject, new Dictionary<Object, Object>(new ReferenceEqualityComparer()));
        }
        private static Object InternalCopy(Object originalObject, IDictionary<Object, Object> visited)
        {
            if (originalObject == null) return null;
            var typeToReflect = originalObject.GetType();
            if (IsPrimitive(typeToReflect)) return originalObject;
            if (visited.ContainsKey(originalObject)) return visited[originalObject];
            if (typeof(Delegate).IsAssignableFrom(typeToReflect)) return null;
            var cloneObject = CloneMethod.Invoke(originalObject, null);
            if (typeToReflect.IsArray)
            {
                var arrayType = typeToReflect.GetElementType();
                if (IsPrimitive(arrayType) == false)
                {
                    Array clonedArray = (Array)cloneObject;
                    clonedArray.ForEach((array, indices) => array.SetValue(InternalCopy(clonedArray.GetValue(indices), visited), indices));
                }

            }
            visited.Add(originalObject, cloneObject);
            CopyFields(originalObject, visited, cloneObject, typeToReflect);
            RecursiveCopyBaseTypePrivateFields(originalObject, visited, cloneObject, typeToReflect);
            return cloneObject;
        }

        private static void RecursiveCopyBaseTypePrivateFields(object originalObject, IDictionary<object, object> visited, object cloneObject, Type typeToReflect)
        {
            if (typeToReflect.BaseType != null)
            {
                RecursiveCopyBaseTypePrivateFields(originalObject, visited, cloneObject, typeToReflect.BaseType);
                CopyFields(originalObject, visited, cloneObject, typeToReflect.BaseType, BindingFlags.Instance | BindingFlags.NonPublic, info => info.IsPrivate);
            }
        }

        private static void CopyFields(object originalObject, IDictionary<object, object> visited, object cloneObject, Type typeToReflect, BindingFlags bindingFlags = BindingFlags.Instance | BindingFlags.NonPublic | BindingFlags.Public | BindingFlags.FlattenHierarchy, Func<FieldInfo, bool> filter = null)
        {
            foreach (FieldInfo fieldInfo in typeToReflect.GetFields(bindingFlags))
            {
                if (filter != null && filter(fieldInfo) == false) continue;
                if (IsPrimitive(fieldInfo.FieldType)) continue;
                var originalFieldValue = fieldInfo.GetValue(originalObject);
                var clonedFieldValue = InternalCopy(originalFieldValue, visited);
                fieldInfo.SetValue(cloneObject, clonedFieldValue);
            }
        }
        public static T Copy<T>(this T original)
        {
            return (T)Copy((Object)original);
        }
    }

    public class ReferenceEqualityComparer : EqualityComparer<Object>
    {
        public override bool Equals(object x, object y)
        {
            return ReferenceEquals(x, y);
        }
        public override int GetHashCode(object obj)
        {
            if (obj == null) return 0;
            return obj.GetHashCode();
        }
    }

    namespace ArrayExtensions
    {
        public static class ArrayExtensions
        {
            public static void ForEach(this Array array, Action<Array, int[]> action)
            {
                if (array.LongLength == 0) return;
                ArrayTraverse walker = new ArrayTraverse(array);
                do action(array, walker.Position);
                while (walker.Step());
            }
        }

        internal class ArrayTraverse
        {
            public int[] Position;
            private int[] maxLengths;

            public ArrayTraverse(Array array)
            {
                maxLengths = new int[array.Rank];
                for (int i = 0; i < array.Rank; ++i)
                {
                    maxLengths[i] = array.GetLength(i) - 1;
                }
                Position = new int[array.Rank];
            }

            public bool Step()
            {
                for (int i = 0; i < Position.Length; ++i)
                {
                    if (Position[i] < maxLengths[i])
                    {
                        Position[i]++;
                        for (int j = 0; j < i; j++)
                        {
                            Position[j] = 0;
                        }
                        return true;
                    }
                }
                return false;
            }
        }
    }

}
284
Alex Burtsev

Kilhofferのソリューションに基づいて構築しています...

C#3.0では、次のように拡張メソッドを作成できます。

public static class ExtensionMethods
{
    // Deep clone
    public static T DeepClone<T>(this T a)
    {
        using (MemoryStream stream = new MemoryStream())
        {
            BinaryFormatter formatter = new BinaryFormatter();
            formatter.Serialize(stream, a);
            stream.Position = 0;
            return (T) formatter.Deserialize(stream);
        }
    }
}

deepCloneメソッドを使用して[Serializable]としてマークされているクラスを拡張します。

MyClass copy = obj.DeepClone();
158
Neil

入れ子になったMemberwiseCloneを使ってディープコピーを行うことができます。。構造体の値をコピーするのとほぼ同じ速度で、(a)リフレクションや(b)シリアライゼーションよりも桁違いに高速です。このページ)。

ifディープコピーにNested MemberwiseCloneを使用する場合は、クラス内のネストされた各レベルにShallowCopyを手動で実装する必要があります。)これは簡単です。合計数行だけで、下のデモコードを見てください。

これは相対的なパフォーマンスの違いを示すコードの出力です(深い入れ子になったMemberwiseCopyの場合は4.77秒、シリアル化の場合は39.93秒)。入れ子になったMemberwiseCopyを使用することは構造体をコピーするのと同じくらい速いです、そして、構造体をコピーすることは.NETが可能である理論上の最高速度にかなり近づいています。この主張を確認するには、同等のベンチマークを実行する必要があります。

    Demo of shallow and deep copy, using classes and MemberwiseClone:
      Create Bob
        Bob.Age=30, Bob.Purchase.Description=Lamborghini
      Clone Bob >> BobsSon
      Adjust BobsSon details
        BobsSon.Age=2, BobsSon.Purchase.Description=Toy car
      Proof of deep copy: If BobsSon is a true clone, then adjusting BobsSon details will not affect Bob:
        Bob.Age=30, Bob.Purchase.Description=Lamborghini
      Elapsed time: 00:00:04.7795670,30000000
    Demo of shallow and deep copy, using structs and value copying:
      Create Bob
        Bob.Age=30, Bob.Purchase.Description=Lamborghini
      Clone Bob >> BobsSon
      Adjust BobsSon details:
        BobsSon.Age=2, BobsSon.Purchase.Description=Toy car
      Proof of deep copy: If BobsSon is a true clone, then adjusting BobsSon details will not affect Bob:
        Bob.Age=30, Bob.Purchase.Description=Lamborghini
      Elapsed time: 00:00:01.0875454,30000000
    Demo of deep copy, using class and serialize/deserialize:
      Elapsed time: 00:00:39.9339425,30000000

MemberwiseCopyを使用してディープコピーを実行する方法を理解するために、これがデモプロジェクトです。

// Nested MemberwiseClone example. 
// Added to demo how to deep copy a reference class.
[Serializable] // Not required if using MemberwiseClone, only used for speed comparison using serialization.
public class Person
{
    public Person(int age, string description)
    {
        this.Age = age;
        this.Purchase.Description = description;
    }
    [Serializable] // Not required if using MemberwiseClone
    public class PurchaseType
    {
        public string Description;
        public PurchaseType ShallowCopy()
        {
            return (PurchaseType)this.MemberwiseClone();
        }
    }
    public PurchaseType Purchase = new PurchaseType();
    public int Age;
    // Add this if using nested MemberwiseClone.
    // This is a class, which is a reference type, so cloning is more difficult.
    public Person ShallowCopy()
    {
        return (Person)this.MemberwiseClone();
    }
    // Add this if using nested MemberwiseClone.
    // This is a class, which is a reference type, so cloning is more difficult.
    public Person DeepCopy()
    {
            // Clone the root ...
        Person other = (Person) this.MemberwiseClone();
            // ... then clone the nested class.
        other.Purchase = this.Purchase.ShallowCopy();
        return other;
    }
}
// Added to demo how to copy a value struct (this is easy - a deep copy happens by default)
public struct PersonStruct
{
    public PersonStruct(int age, string description)
    {
        this.Age = age;
        this.Purchase.Description = description;
    }
    public struct PurchaseType
    {
        public string Description;
    }
    public PurchaseType Purchase;
    public int Age;
    // This is a struct, which is a value type, so everything is a clone by default.
    public PersonStruct ShallowCopy()
    {
        return (PersonStruct)this;
    }
    // This is a struct, which is a value type, so everything is a clone by default.
    public PersonStruct DeepCopy()
    {
        return (PersonStruct)this;
    }
}
// Added only for a speed comparison.
public class MyDeepCopy
{
    public static T DeepCopy<T>(T obj)
    {
        object result = null;
        using (var ms = new MemoryStream())
        {
            var formatter = new BinaryFormatter();
            formatter.Serialize(ms, obj);
            ms.Position = 0;
            result = (T)formatter.Deserialize(ms);
            ms.Close();
        }
        return (T)result;
    }
}

次に、mainからデモを呼び出します。

    void MyMain(string[] args)
    {
        {
            Console.Write("Demo of shallow and deep copy, using classes and MemberwiseCopy:\n");
            var Bob = new Person(30, "Lamborghini");
            Console.Write("  Create Bob\n");
            Console.Write("    Bob.Age={0}, Bob.Purchase.Description={1}\n", Bob.Age, Bob.Purchase.Description);
            Console.Write("  Clone Bob >> BobsSon\n");
            var BobsSon = Bob.DeepCopy();
            Console.Write("  Adjust BobsSon details\n");
            BobsSon.Age = 2;
            BobsSon.Purchase.Description = "Toy car";
            Console.Write("    BobsSon.Age={0}, BobsSon.Purchase.Description={1}\n", BobsSon.Age, BobsSon.Purchase.Description);
            Console.Write("  Proof of deep copy: If BobsSon is a true clone, then adjusting BobsSon details will not affect Bob:\n");
            Console.Write("    Bob.Age={0}, Bob.Purchase.Description={1}\n", Bob.Age, Bob.Purchase.Description);
            Debug.Assert(Bob.Age == 30);
            Debug.Assert(Bob.Purchase.Description == "Lamborghini");
            var sw = new Stopwatch();
            sw.Start();
            int total = 0;
            for (int i = 0; i < 100000; i++)
            {
                var n = Bob.DeepCopy();
                total += n.Age;
            }
            Console.Write("  Elapsed time: {0},{1}\n", sw.Elapsed, total);
        }
        {               
            Console.Write("Demo of shallow and deep copy, using structs:\n");
            var Bob = new PersonStruct(30, "Lamborghini");
            Console.Write("  Create Bob\n");
            Console.Write("    Bob.Age={0}, Bob.Purchase.Description={1}\n", Bob.Age, Bob.Purchase.Description);
            Console.Write("  Clone Bob >> BobsSon\n");
            var BobsSon = Bob.DeepCopy();
            Console.Write("  Adjust BobsSon details:\n");
            BobsSon.Age = 2;
            BobsSon.Purchase.Description = "Toy car";
            Console.Write("    BobsSon.Age={0}, BobsSon.Purchase.Description={1}\n", BobsSon.Age, BobsSon.Purchase.Description);
            Console.Write("  Proof of deep copy: If BobsSon is a true clone, then adjusting BobsSon details will not affect Bob:\n");
            Console.Write("    Bob.Age={0}, Bob.Purchase.Description={1}\n", Bob.Age, Bob.Purchase.Description);                
            Debug.Assert(Bob.Age == 30);
            Debug.Assert(Bob.Purchase.Description == "Lamborghini");
            var sw = new Stopwatch();
            sw.Start();
            int total = 0;
            for (int i = 0; i < 100000; i++)
            {
                var n = Bob.DeepCopy();
                total += n.Age;
            }
            Console.Write("  Elapsed time: {0},{1}\n", sw.Elapsed, total);
        }
        {
            Console.Write("Demo of deep copy, using class and serialize/deserialize:\n");
            int total = 0;
            var sw = new Stopwatch();
            sw.Start();
            var Bob = new Person(30, "Lamborghini");
            for (int i = 0; i < 100000; i++)
            {
                var BobsSon = MyDeepCopy.DeepCopy<Person>(Bob);
                total += BobsSon.Age;
            }
            Console.Write("  Elapsed time: {0},{1}\n", sw.Elapsed, total);
        }
        Console.ReadKey();
    }

繰り返しますが、ifディープコピーにNested MemberwiseCloneを使用する場合は、クラス内のネストされた各レベルにShallowCopyを手動で実装する必要があります。 clone。これは簡単です:合計でほんの数行で、上のデモコードを見てください。

オブジェクトのクローン作成に関しては、 "struct"と "class"の間には大きな違いがあります。

  • もしあなたが "struct"を持っていれば、それは値型なのであなたはそれをただコピーすることができ、そして内容は複製されるでしょう。
  • あなたが「クラス」を持っていれば、それは参照型なので、あなたがそれをコピーすれば、あなたがしているのはそれへのポインタをコピーすることだけです。真のクローンを作成するには、より創造的になり、元のオブジェクトの別のコピーをメモリ内に作成する方法を使用する必要があります。
  • オブジェクトを誤って複製すると、ピンを突き止めるのが非常に困難なバグにつながる可能性があります。プロダクションコードでは、オブジェクトが正しくクローンされていることと、それを参照することによって破損していないことを二重チェックするチェックサムを実装する傾向があります。このチェックサムは、解放モードではオフにすることができます。
  • 私はこの方法が非常に便利だと思います。多くの場合、オブジェクト全体を複製するのではなく、オブジェクトの一部だけを複製したいのです。また、オブジェクトを変更してから変更したコピーをキューに入れるというユースケースにも不可欠です。

更新

リフレクションを使ってオブジェクトグラフを再帰的に調べてディープコピーを行うことはおそらく可能です。 WCFはこの手法を使用して、そのすべての子を含むオブジェクトをシリアル化します。トリックはそれを発見可能にする属性ですべての子オブジェクトに注釈を付けることです。ただし、パフォーマンス上の利点がいくらか失われる可能性があります。

更新

独立したスピードテストについてのコメント(下記のコメントを参照):

私はNeilのシリアライズ/デシリアライズ拡張方法、ContangoのNested MemberwiseClone、Alex Burtsevのリフレクションベースの拡張方法、そしてAutoMapperをそれぞれ100万回使って自分のスピードテストを実行した。シリアル化 - シリアル化解除は最も遅く、15.7秒かかりました。その後、10.1秒かかり、AutoMapperが登場しました。はるかに速いのは2.4秒かかるリフレクションベースの方法でした。これまでのところ最速は0.1秒かかるNested MemberwiseCloneでした。それを複製するために各クラスにコードを追加することの煩わしさ対パフォーマンスに帰着します。パフォーマンスが問題にならない場合は、Alex Burtsevの方法に従ってください。 - Simon Tewsi

50
Contango

BinaryFormatterのアプローチは比較的遅いと思います(これは私にとっては驚きでした!) ProtoBufの要件を満たしていれば、一部のオブジェクトにProtoBuf .NETを使用できる可能性があります。 ProtoBuf入門ページから( http://code.google.com/p/protobuf-net/wiki/GettingStarted ):

サポートされている型に関する注意:

以下のカスタムクラス

  • データ契約としてマークされている
  • パラメータなしのコンストラクタを持っている
  • Silverlightの場合:パブリックです
  • 多くの一般的なプリミティブなど.
  • Single次元配列:T []
  • リスト<T>/IList <T>
  • 辞書<TKey、TValue>/IDictionary <TKey、TValue>
  • iEnumerable <T>を実装し、Add(T)メソッドを持つ任意の型

このコードでは、型は選出されたメンバーを中心に変更可能であると想定しています。したがって、カスタム構造体は不変でなければならないため、カスタム構造体はサポートされていません。

あなたのクラスがこれらの要件を満たしているなら、あなたは試すことができます:

public static void deepCopy<T>(ref T object2Copy, ref T objectCopy)
{
    using (var stream = new MemoryStream())
    {
        Serializer.Serialize(stream, object2Copy);
        stream.Position = 0;
        objectCopy = Serializer.Deserialize<T>(stream);
    }
}

どれが本当に速いですか...

編集:

これを修正した作業コードを次に示します(.NET 4.6でテスト済み)。それはSystem.Xml.SerializationとSystem.IOを使います。クラスを直列化可能としてマークする必要はありません。

public void DeepCopy<T>(ref T object2Copy, ref T objectCopy)
{
    using (var stream = new MemoryStream())
    {
        var serializer = new XS.XmlSerializer(typeof(T));

        serializer.Serialize(stream, object2Copy);
        stream.Position = 0;
        objectCopy = (T)serializer.Deserialize(stream);
    }
}
15
Kurt Richardson

あなたはこれを試すことができます

    public static object DeepCopy(object obj)
    {
        if (obj == null)
            return null;
        Type type = obj.GetType();

        if (type.IsValueType || type == typeof(string))
        {
            return obj;
        }
        else if (type.IsArray)
        {
            Type elementType = Type.GetType(
                 type.FullName.Replace("[]", string.Empty));
            var array = obj as Array;
            Array copied = Array.CreateInstance(elementType, array.Length);
            for (int i = 0; i < array.Length; i++)
            {
                copied.SetValue(DeepCopy(array.GetValue(i)), i);
            }
            return Convert.ChangeType(copied, obj.GetType());
        }
        else if (type.IsClass)
        {

            object toret = Activator.CreateInstance(obj.GetType());
            FieldInfo[] fields = type.GetFields(BindingFlags.Public |
                        BindingFlags.NonPublic | BindingFlags.Instance);
            foreach (FieldInfo field in fields)
            {
                object fieldValue = field.GetValue(obj);
                if (fieldValue == null)
                    continue;
                field.SetValue(toret, DeepCopy(fieldValue));
            }
            return toret;
        }
        else
            throw new ArgumentException("Unknown type");
    }

DetoX83 article on code projectに感謝します。

たぶんあなたは浅いコピーだけを必要とします、その場合はObject.MemberWiseClone()を使います。

ディープコピーへの戦略のためのMemberWiseClone()のドキュメントには良いお勧めがあります -

http://msdn.Microsoft.com/ja-jp/library/system.object.memberwiseclone.aspx

5
David Thornley

最善の方法は次のとおりです。

    public interface IDeepClonable<T> where T : class
    {
        T DeepClone();
    }

    public class MyObj : IDeepClonable<MyObj>
    {
        public MyObj Clone()
        {
            var myObj = new MyObj();
            myObj._field1 = _field1;//value type
            myObj._field2 = _field2;//value type
            myObj._field3 = _field3;//value type

            if (_child != null)
            {
                myObj._child = _child.DeepClone(); //reference type .DeepClone() that does the same
            }

            int len = _array.Length;
            myObj._array = new MyObj[len]; // array / collection
            for (int i = 0; i < len; i++)
            {
                myObj._array[i] = _array[i];
            }

            return myObj;
        }

        private bool _field1;
        public bool Field1
        {
            get { return _field1; }
            set { _field1 = value; }
        }

        private int _field2;
        public int Property2
        {
            get { return _field2; }
            set { _field2 = value; }
        }

        private string _field3;
        public string Property3
        {
            get { return _field3; }
            set { _field3 = value; }
        }

        private MyObj _child;
        private MyObj Child
        {
            get { return _child; }
            set { _child = value; }
        }

        private MyObj[] _array = new MyObj[4];
    }
3
alex

MSDNのドキュメントでは、Cloneがディープコピーを実行すべきだと示唆しているようですが、明示的に述べられているわけではありません。

ICloneableインタフェースには、MemberWiseCloneによって提供されるものを超えるクローン作成をサポートすることを目的としたCloneという1つのメンバが含まれています。MemberwiseCloneメソッドは、シャローコピーを作成します。

私の投稿は参考になります。

http://pragmaticcoding.com/index.php/cloning-objects-in-c/

0
Eugene
    public static object CopyObject(object input)
    {
        if (input != null)
        {
            object result = Activator.CreateInstance(input.GetType());
            foreach (FieldInfo field in input.GetType().GetFields(Consts.AppConsts.FullBindingList))
            {
                if (field.FieldType.GetInterface("IList", false) == null)
                {
                    field.SetValue(result, field.GetValue(input));
                }
                else
                {
                    IList listObject = (IList)field.GetValue(result);
                    if (listObject != null)
                    {
                        foreach (object item in ((IList)field.GetValue(input)))
                        {
                            listObject.Add(CopyObject(item));
                        }
                    }
                }
            }
            return result;
        }
        else
        {
            return null;
        }
    }

この方法はBinarySerializationより数倍速いです。そしてこれは[Serializable]属性を必要としません。

0
Basil