Как проверить, сериализуем ли объект в C#

Question

Я ищу простой способ проверить, является ли объект в C# сериализуемым.

Как мы знаем, вы делаете сериализуемый объект, либо реализуя интерфейс ISerializable, либо помещая [Serializable] вверху класса.

То, что я ищу, это быстрый способ проверить это без необходимости отражать класс, чтобы получить его атрибуты. Интерфейс будет быстрым, используя оператор is.

Используя предложение @Flard, это код, который я придумал, кричать, что есть лучший способ.

private static bool IsSerializable(T obj)
{
    return ((obj is ISerializable) || (Attribute.IsDefined(typeof (T), typeof (SerializableAttribute))));
}

Или даже лучше просто получить тип объекта и затем использовать свойство IsSerializable для типа:

typeof(T).IsSerializable

Помните, что это кажется только тем классом, с которым мы имеем дело, если класс содержит другие классы, вы, вероятно, захотите проверить их все или попробовать и сериализовать и ждать ошибок, как указано в @pb.

Answer 1

У вас есть прекрасная собственность на Type класс называется IsSerializable,

Answer 2

Вам нужно будет проверить все типы в графе сериализуемых объектов на предмет атрибута serializable. Самый простой способ - попытаться сериализовать объект и поймать исключение. (Но это не самое чистое решение). Type.IsSerializable и проверка атрибута serializalbe не учитывают график.

Образец

[Serializable]
public class A
{
    public B B = new B();
}

public class B
{
   public string a = "b";
}

[Serializable]
public class C
{
    public D D = new D();
}

[Serializable]
public class D
{
    public string d = "D";
}


class Program
{
    static void Main(string[] args)
    {

        var a = typeof(A);

        var aa = new A();

        Console.WriteLine("A: {0}", a.IsSerializable);  // true (WRONG!)

        var c = typeof(C);

        Console.WriteLine("C: {0}", c.IsSerializable); //true

        var form = new BinaryFormatter();
        // throws
        form.Serialize(new MemoryStream(), aa);
    }
}

Answer 3

Это старый вопрос, который может потребоваться обновить для.NET 3.5+. Type.IsSerializable может фактически возвращать false, если класс использует атрибут DataContract. Вот фрагмент, который я использую, если он воняет, дайте мне знать:)

public static bool IsSerializable(this object obj)
{
    Type t = obj.GetType();

     return  Attribute.IsDefined(t, typeof(DataContractAttribute)) || t.IsSerializable || (obj is IXmlSerializable)

}

Answer 4

Используйте Type.IsSerializable, как указали другие.

Вероятно, не стоит пытаться отразить и проверить, все ли элементы в графе объектов являются сериализуемыми.

Элемент может быть объявлен как сериализуемый тип, но фактически может быть создан как производный тип, который не сериализуем, как в следующем надуманном примере:

[Serializable]
public class MyClass
{
   public Exception TheException; // serializable
}

public class MyNonSerializableException : Exception
{
...
}

...
MyClass myClass = new MyClass();
myClass.TheException = new MyNonSerializableException();
// myClass now has a non-serializable member

Поэтому, даже если вы определите, что конкретный экземпляр вашего типа является сериализуемым, вы не можете в целом быть уверенным, что это будет верно для всех экземпляров.

Answer 5

Attribute.IsDefined(typeof (YourClass), typeof (SerializableAttribute));

Наверное, подразумевает отражение под водой, но самый простой способ?

Answer 6

Вот вариант 3.5, который делает его доступным для всех классов, использующих метод расширения.

public static bool IsSerializable(this object obj)
{
    if (obj is ISerializable)
        return true;
    return Attribute.IsDefined(obj.GetType(), typeof(SerializableAttribute));
}

Answer 7

Я взял ответ на этот вопрос и ответ здесь и изменил его, чтобы вы получили список типов, которые нельзя сериализовать. Таким образом, вы можете легко узнать, какие из них пометить.

    private static void NonSerializableTypesOfParentType(Type type, List<string> nonSerializableTypes)
    {
        // base case
        if (type.IsValueType || type == typeof(string)) return;

        if (!IsSerializable(type))
            nonSerializableTypes.Add(type.Name);

        foreach (var propertyInfo in type.GetProperties(BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance))
        {
            if (propertyInfo.PropertyType.IsGenericType)
            {
                foreach (var genericArgument in propertyInfo.PropertyType.GetGenericArguments())
                {
                    if (genericArgument == type) continue; // base case for circularly referenced properties
                    NonSerializableTypesOfParentType(genericArgument, nonSerializableTypes);
                }
            }
            else if (propertyInfo.GetType() != type) // base case for circularly referenced properties
                NonSerializableTypesOfParentType(propertyInfo.PropertyType, nonSerializableTypes);
        }
    }

    private static bool IsSerializable(Type type)
    {
        return (Attribute.IsDefined(type, typeof(SerializableAttribute)));
        //return ((type is ISerializable) || (Attribute.IsDefined(type, typeof(SerializableAttribute))));
    }

И тогда ты называешь это...

    List<string> nonSerializableTypes = new List<string>();
    NonSerializableTypesOfParentType(aType, nonSerializableTypes);

При запуске nonSerializableTypes будет иметь список. Возможно, есть лучший способ сделать это, чем передать пустой список в рекурсивный метод. Кто-нибудь поправит меня, если так.

Answer 8

Мое решение, в VB.NET:

Для объектов:

''' <summary>
''' Determines whether an object can be serialized.
''' </summary>
''' <param name="Object">The object.</param>
''' <returns><c>true</c> if object can be serialized; otherwise, <c>false</c>.</returns>
Private Function IsObjectSerializable(ByVal [Object] As Object,
                                      Optional ByVal SerializationFormat As SerializationFormat =
                                                                            SerializationFormat.Xml) As Boolean

    Dim Serializer As Object

    Using fs As New IO.MemoryStream

        Select Case SerializationFormat

            Case Data.SerializationFormat.Binary
                Serializer = New Runtime.Serialization.Formatters.Binary.BinaryFormatter()

            Case Data.SerializationFormat.Xml
                Serializer = New Xml.Serialization.XmlSerializer([Object].GetType)

            Case Else
                Throw New ArgumentException("Invalid SerializationFormat", SerializationFormat)

        End Select

        Try
            Serializer.Serialize(fs, [Object])
            Return True

        Catch ex As InvalidOperationException
            Return False

        End Try

    End Using ' fs As New MemoryStream

End Function

Для типов:

''' <summary>
''' Determines whether a Type can be serialized.
''' </summary>
''' <typeparam name="T"></typeparam>
''' <returns><c>true</c> if Type can be serialized; otherwise, <c>false</c>.</returns>
Private Function IsTypeSerializable(Of T)() As Boolean

    Return Attribute.IsDefined(GetType(T), GetType(SerializableAttribute))

End Function

''' <summary>
''' Determines whether a Type can be serialized.
''' </summary>
''' <typeparam name="T"></typeparam>
''' <param name="Type">The Type.</param>
''' <returns><c>true</c> if Type can be serialized; otherwise, <c>false</c>.</returns>
Private Function IsTypeSerializable(Of T)(ByVal Type As T) As Boolean

    Return Attribute.IsDefined(GetType(T), GetType(SerializableAttribute))

End Function

Answer 9

Объект исключения может быть сериализуемым, но с использованием другого исключения, которого нет. Это то, что я только что сделал с WCF System.ServiceModel.FaultException: FaultException является сериализуемым, а ExceptionDetail - нет!

Поэтому я использую следующее:

// Check if the exception is serializable and also the specific ones if generic
var exceptionType = ex.GetType();
var allSerializable = exceptionType.IsSerializable;
if (exceptionType.IsGenericType)
    {
        Type[] typeArguments = exceptionType.GetGenericArguments();
        allSerializable = typeArguments.Aggregate(allSerializable, (current, tParam) => current & tParam.IsSerializable);
    }
 if (!allSerializable)
    {
        // Create a new Exception for not serializable exceptions!
        ex = new Exception(ex.Message);
    }