Deep Copy of a C# Object

Question

I am working on some code that is written in C#. In this app, I have a custom collection defined as follows:

public class ResultList<T> : IEnumerable<T>
{
  public List<T> Results { get; set; }
  public decimal CenterLatitude { get; set; }
  public decimal CenterLongitude { get; set; }
}

The type used by Results are one of three custom types. The properties of each of the custom types are just primitive types (ints, strings, bools, int?, bool?). Here is an example of one of the custom types:

public class ResultItem
{
  public int ID { get; set; }
  public string Name { get; set; }
  public bool? isLegit { get; set; }
}

How do I perform a deep copy of a ResultList object that I've created. I found this post: Generic method to create deep copy of all elements in a collection. However, I can't figure out how to do it.

What have you tried? What error message you got? Jon Skeet's code you found simply works as far as I can see. — Jirka Hanika
– Jirka Hanika, Commented Jun 17, 2012 at 20:06
Shallow or deep copy? stackoverflow.com/questions/11073196/… — L.B
– L.B, Commented Jun 17, 2012 at 20:07
Why are you and the OP of this queston seeming to use the exact same data structure in your example? — Kirk Woll
– Kirk Woll, Commented Jun 17, 2012 at 20:21

Community · Accepted Answer · 2017-05-23 12:02:22Z

16

The approach involving the least coding effort is that of serializing and deserializing through a BinaryFormatter.

You could define the following extension method (taken from Kilhoffer’s answer):

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);
    }
}

…and then just call:

ResultList<T> clone = DeepClone(original);

edited May 23, 2017 at 12:02

CommunityBot

11 silver badge

answered Jun 17, 2012 at 20:07

Douglas

55.1k14 gold badges145 silver badges193 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Community · Accepted Answer · 2017-05-23 11:54:54Z

One of the reasons why your ResultList class won't work with Jon Skeet's example is because it does not implement the ICloneable interface.

Implement ICloneable on all the classes that you need cloned, e.g.

public class ResultItem : ICloneable
{
  public object Clone()
  {
    var item = new ResultItem
                 {
                   ID = ID,
                   Name = Name,
                   isLegit = isLegit
                 };
    return item;
  }
}

And also on ResultList:

public class ResultList<T> : IEnumerable<T>, ICloneable where T : ICloneable
{
  public List<T> Results { get; set; }
  public decimal CenterLatitude { get; set; }
  public decimal CenterLongitude { get; set; }

  public object Clone()
  {
    var list = new ResultList<T>
                 {
                   CenterLatitude = CenterLatitude,
                   CenterLongitude = CenterLongitude,
                   Results = Results.Select(x => x.Clone()).Cast<T>().ToList()
                 };
    return list;
  }
}

Then to make a deep copy of your object:

resultList.clone();

argyle · Accepted Answer · 2015-01-14 15:54:02Z

4

Expanding on @Georgi-it, I had to modify his code to handle properties whose type inherits List:

public static class ObjectCloner {
    public static T Clone<T>(object obj, bool deep = false) where T : new() {
        if (!(obj is T)) {
            throw new Exception("Cloning object must match output type");
        }

        return (T)Clone(obj, deep);
    }

    public static object Clone(object obj, bool deep) {
        if (obj == null) {
            return null;
        }

        Type objType = obj.GetType();

        if (objType.IsPrimitive || objType == typeof(string) || objType.GetConstructors().FirstOrDefault(x => x.GetParameters().Length == 0) == null) {
            return obj;
        }

        List<PropertyInfo> properties = objType.GetProperties().ToList();
        if (deep) {
            properties.AddRange(objType.GetProperties(BindingFlags.Instance | BindingFlags.NonPublic));
        }

        object newObj = Activator.CreateInstance(objType);

        foreach (var prop in properties) {
            if (prop.GetSetMethod() != null) {
                var proceed = true;
                if (obj is IList) {
                    var listType = obj.GetType().GetProperty("Item").PropertyType;
                    if (prop.PropertyType == listType) {
                        proceed = false;
                        foreach (var item in obj as IList) {
                            object clone = Clone(item, deep);
                            (newObj as IList).Add(clone);                               
                        }                           
                    }                       
                }

                if (proceed) {
                    object propValue = prop.GetValue(obj, null);
                    object clone = Clone(propValue, deep);
                    prop.SetValue(newObj, clone, null);
                }                   
            }
        }

        return newObj;
    }
}

answered Jan 14, 2015 at 15:54

argyle

1,3392 gold badges15 silver badges28 bronze badges

2 Comments

sborfedor Over a year ago

This code is wrong: for deep coping a string you way use "return String.Copy(obj as string);"

Georgi-it Over a year ago

@sborfedor String.Copy is obsolete. The string is immutable anyways. The only way to modify the same reference is with unsafe code. In that case you probably won't copy-paste this solution anyways.

Georgi-it · Accepted Answer · 2014-03-11 14:31:20Z

2

Here is something that I needed and wrote, it uses reflection to copy every property (and private ones if specified)

public static class ObjectCloner
{
    public static T Clone<T>(object obj, bool deep = false) where T : new()
    {
        if (!(obj is T))
        {
            throw new Exception("Cloning object must match output type");
        }

        return (T)Clone(obj, deep);
    }

    public static object Clone(object obj, bool deep)
    {
        if (obj == null)
        {
            return null;
        }

        Type objType = obj.GetType();

        if (objType.IsPrimitive || objType == typeof(string) || objType.GetConstructors().FirstOrDefault(x => x.GetParameters().Length == 0) == null)
        {
            return obj;
        }

        List<PropertyInfo> properties = objType.GetProperties().ToList();
        if (deep)
        {
            properties.AddRange(objType.GetProperties(BindingFlags.Instance | BindingFlags.NonPublic)); 
        }

        object newObj = Activator.CreateInstance(objType);

        foreach (var prop in properties)
        {
            if (prop.GetSetMethod() != null)
            {
                object propValue = prop.GetValue(obj, null);
                object clone = Clone(propValue, deep);
                prop.SetValue(newObj, clone, null);
            }
        }

        return newObj;
    }
}

answered Mar 11, 2014 at 14:31

Georgi-it

3,6861 gold badge22 silver badges25 bronze badges

3 Comments

argyle Over a year ago

Handle objects that inherit List<T>: I'll just create a second answer since code in the comments suck.

sborfedor Over a year ago

This code is wrong: for deep coping a string you way use "return String.Copy(obj as string);"

Georgi-it Over a year ago

@sborfedor String.Copy is obsolete. The string is immutable anyways. The only way to modify the same reference is with unsafe code. In that case you probably won't copy-paste this solution anyways.

sborfedor · Accepted Answer · 2021-03-11 09:56:01Z

1

For deep coping of an object you can use this code:

public static T DeepCopy<T>(T obj) {
    var str = Newtonsoft.Json.JsonConvert.SerializeObject(obj);
    var ret = Newtonsoft.Json.JsonConvert.DeserializeObject<T>(str);
    return ret;
}

answered Mar 11, 2021 at 9:56

sborfedor

3111 gold badge10 silver badges26 bronze badges

1 Comment

aca Over a year ago

Newtonsoft.Json.JsonSerializationException error when tried this code on a complex model

Collectives™ on Stack Overflow

Deep Copy of a C# Object

5 Answers 5

Comments

Comments

2 Comments

3 Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

5 Answers 5

Comments

Comments

2 Comments

3 Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related