BinarySerializationHelper.cs 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126
  1. using System;
  2. using System.IO;
  3. using System.Runtime.Serialization;
  4. using System.Runtime.Serialization.Formatters.Binary;
  5. namespace Abp.Runtime.Serialization
  6. {
  7. /// <summary>
  8. /// This class is used to simplify serialization/deserialization operations.
  9. /// Uses .NET binary serialization.
  10. /// </summary>
  11. public static class BinarySerializationHelper
  12. {
  13. /// <summary>
  14. /// Serializes an object and returns as a byte array.
  15. /// </summary>
  16. /// <param name="obj">object to be serialized</param>
  17. /// <returns>bytes of object</returns>
  18. public static byte[] Serialize(object obj)
  19. {
  20. using (var memoryStream = new MemoryStream())
  21. {
  22. CreateBinaryFormatter().Serialize(memoryStream, obj);
  23. return memoryStream.ToArray();
  24. }
  25. }
  26. /// <summary>
  27. /// Serializes an object into a stream.
  28. /// </summary>
  29. /// <param name="obj">object to be serialized</param>
  30. /// <param name="stream">Stream to serialize in</param>
  31. /// <returns>bytes of object</returns>
  32. public static void Serialize(object obj, Stream stream)
  33. {
  34. CreateBinaryFormatter().Serialize(stream, obj);
  35. }
  36. /// <summary>
  37. /// Deserializes an object from given byte array.
  38. /// </summary>
  39. /// <param name="bytes">The byte array that contains object</param>
  40. /// <returns>deserialized object</returns>
  41. public static object Deserialize(byte[] bytes)
  42. {
  43. using (var memoryStream = new MemoryStream(bytes))
  44. {
  45. return CreateBinaryFormatter().Deserialize(memoryStream);
  46. }
  47. }
  48. /// <summary>
  49. /// Deserializes an object from given stream.
  50. /// </summary>
  51. /// <param name="stream">The stream that contains object</param>
  52. /// <returns>deserialized object</returns>
  53. public static object Deserialize(Stream stream)
  54. {
  55. return CreateBinaryFormatter().Deserialize(stream);
  56. }
  57. /// <summary>
  58. /// Deserializes an object from given byte array.
  59. /// Difference from <see cref="Deserialize(byte[])"/> is that; this method can also deserialize
  60. /// types that are defined in dynamically loaded assemblies (like PlugIns).
  61. /// </summary>
  62. /// <param name="bytes">The byte array that contains object</param>
  63. /// <returns>deserialized object</returns>
  64. public static object DeserializeExtended(byte[] bytes)
  65. {
  66. using (var memoryStream = new MemoryStream(bytes))
  67. {
  68. return CreateBinaryFormatter(true).Deserialize(memoryStream);
  69. }
  70. }
  71. /// <summary>
  72. /// Deserializes an object from given stream.
  73. /// Difference from <see cref="Deserialize(Stream)"/> is that; this method can also deserialize
  74. /// types that are defined in dynamically loaded assemblies (like PlugIns).
  75. /// </summary>
  76. /// <param name="stream">The stream that contains object</param>
  77. /// <returns>deserialized object</returns>
  78. public static object DeserializeExtended(Stream stream)
  79. {
  80. return CreateBinaryFormatter(true).Deserialize(stream);
  81. }
  82. private static BinaryFormatter CreateBinaryFormatter(bool extended = false)
  83. {
  84. if (extended)
  85. {
  86. return new BinaryFormatter
  87. {
  88. //TODO: AssemblyFormat = System.Runtime.Serialization.Formatters.FormatterAssemblyStyle.Simple,
  89. Binder = new ExtendedSerializationBinder()
  90. };
  91. }
  92. else
  93. {
  94. return new BinaryFormatter();
  95. }
  96. }
  97. /// <summary>
  98. /// This class is used in deserializing to allow deserializing objects that are defined
  99. /// in assemlies that are load in runtime (like PlugIns).
  100. /// </summary>
  101. private sealed class ExtendedSerializationBinder : SerializationBinder
  102. {
  103. public override Type BindToType(string assemblyName, string typeName)
  104. {
  105. var toAssemblyName = assemblyName.Split(',')[0];
  106. foreach (var assembly in AppDomain.CurrentDomain.GetAssemblies())
  107. {
  108. if (assembly.FullName.Split(',')[0] == toAssemblyName)
  109. {
  110. return assembly.GetType(typeName);
  111. }
  112. }
  113. return Type.GetType(string.Format("{0}, {1}", typeName, assemblyName));
  114. }
  115. }
  116. }
  117. }