如何序列化包含BitmapImage的类？

Question

我有一个DeepCopy方法，该方法序列化传入参数的对象，然后返回反序列化的对象以进行深度复制。

我的方法是：

public static class GenericCopier<T>
{     
           public static T DeepCopy(object objectToCopy)
            {
                using (MemoryStream memoryStream = new MemoryStream())
                {
                    BinaryFormatter binaryFormatter = new BinaryFormatter();
                    binaryFormatter.Serialize(memoryStream, objectToCopy);
                    memoryStream.Seek(0, SeekOrigin.Begin);
                    return (T)binaryFormatter.Deserialize(memoryStream);
                }
            }
}

如果传递给该参数的对象不包含任何BitmapImage字段和属性，则此方法效果很好。

public class MyClass
{
  public string TestString {get; set;}
  public BitmapImage TestImage { get; set;}
}

如果我制作MyClass的DeepCopy，

MyClass orginal = new MyClass(){ TestString = "Test"};
MyClass copy = GenericCopier<MyClass>.DeepCopy(orginal);

它引发异常

程序集中的类型'System.Windows.Media.Imaging.BitmapImage'未标记为可序列化

我在这里找到了一种序列化BitmapImage的方法

但是，如何混合两种序列化类型（BinaryFormatter和PngBitmapEncoder）来序列化MyClass？

Answer 1

您在这里有两个选择：

选项1：实施ISerializable和快照到PNG

您必须在这里执行的所有类都包含实现了ISerializable接口的BitmapImage ，然后在GetObjectData中返回表示图像编码的字节数组，例如PNG。 然后在反序列化构造函数中，将PNG解码为新的BitmapImage 。

请注意，这会对图像进行快照，因此可能会丢失一些WPF数据。

由于您可能有多个包含BitmapImage类，因此最简单的方法是引入一些包装器结构，并在BitmapImage进行隐式转换，例如：

[Serializable]
public struct SerializableBitmapImageWrapper : ISerializable
{
    readonly BitmapImage bitmapImage;

    public static implicit operator BitmapImage(SerializableBitmapImageWrapper wrapper)
    {
        return wrapper.BitmapImage;
    }

    public static implicit operator SerializableBitmapImageWrapper(BitmapImage bitmapImage)
    {
        return new SerializableBitmapImageWrapper(bitmapImage);
    }

    public BitmapImage BitmapImage { get { return bitmapImage; } }

    public SerializableBitmapImageWrapper(BitmapImage bitmapImage)
    {
        this.bitmapImage = bitmapImage;
    }

    public SerializableBitmapImageWrapper(SerializationInfo info, StreamingContext context)
    {
        byte[] imageBytes = (byte[])info.GetValue("image", typeof(byte[]));
        if (imageBytes == null)
            bitmapImage = null;
        else
        {
            using (var ms = new MemoryStream(imageBytes))
            {
                var bitmap = new BitmapImage();
                bitmap.BeginInit();
                bitmap.CacheOption = BitmapCacheOption.OnLoad;
                bitmap.StreamSource = ms;
                bitmap.EndInit();
                bitmapImage = bitmap;
            }
        }
    }

    #region ISerializable Members

    void ISerializable.GetObjectData(SerializationInfo info, StreamingContext context)
    {
        byte [] imageBytes;
        if (bitmapImage == null)
            imageBytes = null;
        else
            using (var ms = new MemoryStream())
            {
                BitmapImage.SaveToPng(ms);
                imageBytes = ms.ToArray();
            }
        info.AddValue("image", imageBytes);
    }

    #endregion
}

public static class BitmapHelper
{
    public static void SaveToPng(this BitmapSource bitmap, Stream stream)
    {
        var encoder = new PngBitmapEncoder();
        SaveUsingEncoder(bitmap, stream, encoder);
    }

    public static void SaveUsingEncoder(this BitmapSource bitmap, Stream stream, BitmapEncoder encoder)
    {
        BitmapFrame frame = BitmapFrame.Create(bitmap);
        encoder.Frames.Add(frame);
        encoder.Save(stream);
    }

    public static BitmapImage FromUri(string path)
    {
        var bitmap = new BitmapImage();
        bitmap.BeginInit();
        bitmap.UriSource = new Uri(path);
        bitmap.EndInit();
        return bitmap;
    }
}

然后按以下方式使用它：

[Serializable]
public class MyClass
{
    SerializableBitmapImageWrapper testImage;

    public string TestString { get; set; }
    public BitmapImage TestImage { get { return testImage; } set { testImage = value; } }
}

public static class GenericCopier
{
    public static T DeepCopy<T>(T objectToCopy)
    {
        using (MemoryStream memoryStream = new MemoryStream())
        {
            BinaryFormatter binaryFormatter = new BinaryFormatter();
            binaryFormatter.Serialize(memoryStream, objectToCopy);
            memoryStream.Seek(0, SeekOrigin.Begin);
            return (T)binaryFormatter.Deserialize(memoryStream);
        }
    }
}

选项2：使用序列化替代项直接克隆BitmapImage

事实证明， BitmapImage具有Clone()方法，因此可以合理地提出这样一个问题：是否可以以某种方式重写二进制序列化以用克隆替换原始序列，而无需实际序列化？ 这样做将避免快照到PNG的潜在数据丢失，因此显得可取。

实际上，可以使用序列化代理以IObjectReference代理替换位图图像，该代理包含由代理创建的克隆副本的ID。

public static class GenericCopier
{
    public static T DeepCopy<T>(T objectToCopy)
    {
        var selector = new SurrogateSelector();
        var imageSurrogate = new BitmapImageCloneSurrogate();
        imageSurrogate.Register(selector);

        BinaryFormatter binaryFormatter = new BinaryFormatter(selector, new StreamingContext(StreamingContextStates.Clone));

        using (MemoryStream memoryStream = new MemoryStream())
        {
            binaryFormatter.Serialize(memoryStream, objectToCopy);
            memoryStream.Seek(0, SeekOrigin.Begin);
            return (T)binaryFormatter.Deserialize(memoryStream);
        }
    }
}

class CloneWrapper<T> : IObjectReference
{
    public T Clone { get; set; }

    #region IObjectReference Members

    object IObjectReference.GetRealObject(StreamingContext context)
    {
        return Clone;
    }

    #endregion
}

public abstract class CloneSurrogate<T> : ISerializationSurrogate where T : class
{
    readonly Dictionary<T, long> OriginalToId = new Dictionary<T, long>();
    readonly Dictionary<long, T> IdToClone = new Dictionary<long, T>();

    public void Register(SurrogateSelector selector)
    {
        foreach (var type in Types)
            selector.AddSurrogate(type, new StreamingContext(StreamingContextStates.Clone), this);
    }

    IEnumerable<Type> Types
    {
        get
        {
            yield return typeof(T);
            yield return typeof(CloneWrapper<T>);
        }
    }

    protected abstract T Clone(T original);

    #region ISerializationSurrogate Members

    public void GetObjectData(object obj, SerializationInfo info, StreamingContext context)
    {
        var original = (T)obj;
        long cloneId;
        if (original == null)
        {
            cloneId = -1;
        }
        else
        {
            if (!OriginalToId.TryGetValue(original, out cloneId))
            {
                Debug.Assert(OriginalToId.Count == IdToClone.Count);
                cloneId = OriginalToId.Count;
                OriginalToId[original] = cloneId;
                IdToClone[cloneId] = Clone(original);
            }
        }
        info.AddValue("cloneId", cloneId);
        info.SetType(typeof(CloneWrapper<T>));
    }

    public object SetObjectData(object obj, SerializationInfo info, StreamingContext context, ISurrogateSelector selector)
    {
        var wrapper = (CloneWrapper<T>)obj;
        var cloneId = info.GetInt64("cloneId");
        if (cloneId != -1)
            wrapper.Clone = IdToClone[cloneId];
        return wrapper;
    }

    #endregion
}

public sealed class BitmapImageCloneSurrogate : CloneSurrogate<BitmapImage>
{
    protected override BitmapImage Clone(BitmapImage original)
    {
        return original == null ? null : original.Clone();
    }
}

在此实现中，您的主要类保持不变：

[Serializable]
public class MyClass
{
    BitmapImage testImage;

    public string TestString { get; set; }
    public BitmapImage TestImage { get { return testImage; } set { testImage = value; } }
}

尴尬的是，虽然BitmapImage具有Clone方法，但实际上并没有实现ICloneable接口。 如果有的话，上面的代码看起来更简洁，因为我们可以简单地克隆每个可克隆对象，而不用为BitmapImage调用特定方法。