#175 Dropping support for legacy serialization

apache · Sep 9, 2024 · 1dc9ca2 · 1dc9ca2
1 parent b94b45a
commit 1dc9ca2
Show file tree

Hide file tree

Showing 19 changed files with 48 additions and 22 deletions.
diff --git a/src/log4net/Appender/FileAppender.cs b/src/log4net/Appender/FileAppender.cs
@@ -86,7 +86,7 @@ public class FileAppender : TextWriterAppender
     /// </summary>
     private sealed class LockingStream : Stream, IDisposable
     {
-      [Serializable]
+      [Log4NetSerializable]
       public sealed class LockStateException : LogException
       {
         public LockStateException(string message)

diff --git a/src/log4net/Config/AliasRepositoryAttribute.cs b/src/log4net/Config/AliasRepositoryAttribute.cs
@@ -41,7 +41,7 @@ namespace log4net.Config
   /// <author>Nicko Cadell</author>
   /// <author>Gert Driesen</author>
   [AttributeUsage(AttributeTargets.Assembly, AllowMultiple = true)]
-  [Serializable]
+  [Log4NetSerializable]
   public sealed class AliasRepositoryAttribute : Attribute
   {
     /// <summary>

diff --git a/src/log4net/Config/PluginAttribute.cs b/src/log4net/Config/PluginAttribute.cs
@@ -39,7 +39,7 @@ namespace log4net.Config
   /// <author>Nicko Cadell</author>
   /// <author>Gert Driesen</author>
   [AttributeUsage(AttributeTargets.Assembly, AllowMultiple = true)]
-  [Serializable]
+  [Log4NetSerializable]
   public sealed class PluginAttribute : Attribute, IPluginFactory
   {
     /// <summary>

diff --git a/src/log4net/Config/RepositoryAttribute.cs b/src/log4net/Config/RepositoryAttribute.cs
@@ -42,7 +42,7 @@ namespace log4net.Config
   /// <author>Nicko Cadell</author>
   /// <author>Gert Driesen</author>
   [AttributeUsage(AttributeTargets.Assembly)]
-  [Serializable]
+  [Log4NetSerializable]
   public sealed class RepositoryAttribute : Attribute
   {
     /// <summary>

diff --git a/src/log4net/Config/SecurityContextProviderAttribute.cs b/src/log4net/Config/SecurityContextProviderAttribute.cs
@@ -42,7 +42,7 @@ namespace log4net.Config
   /// </remarks>
   /// <author>Nicko Cadell</author>
   [AttributeUsage(AttributeTargets.Assembly)]
-  [Serializable]
+  [Log4NetSerializable]
   public sealed class SecurityContextProviderAttribute : ConfiguratorAttribute
   {
     /// <summary>

diff --git a/src/log4net/Config/XmlConfiguratorAttribute.cs b/src/log4net/Config/XmlConfiguratorAttribute.cs
@@ -76,7 +76,7 @@ namespace log4net.Config
   /// <author>Nicko Cadell</author>
   /// <author>Gert Driesen</author>
   [AttributeUsage(AttributeTargets.Assembly)]
-  [Serializable]
+  [Log4NetSerializable]
   public sealed class XmlConfiguratorAttribute : ConfiguratorAttribute
   {
     /// <summary>

diff --git a/src/log4net/Core/Level.cs b/src/log4net/Core/Level.cs
@@ -82,8 +82,8 @@ namespace log4net.Core;
 /// </remarks>
 /// <author>Nicko Cadell</author>
 /// <author>Gert Driesen</author>
-[Serializable]
-public class Level : IComparable, ISerializable, IEquatable<Level>, IComparable<Level>
+[Log4NetSerializable]
+public class Level : IComparable, ILog4NetSerializable, IEquatable<Level>, IComparable<Level>
 {
   /// <summary>
   /// Constructor

diff --git a/src/log4net/Core/LocationInfo.cs b/src/log4net/Core/LocationInfo.cs
@@ -57,8 +57,8 @@ namespace log4net.Core
   /// </remarks>
   /// <author>Nicko Cadell</author>
   /// <author>Gert Driesen</author>
-  [Serializable]
-  public class LocationInfo : ISerializable
+  [Log4NetSerializable]
+  public class LocationInfo : ILog4NetSerializable
   {
     /// <summary>
     /// Constructor

diff --git a/src/log4net/Core/LogException.cs b/src/log4net/Core/LogException.cs
@@ -34,7 +34,7 @@ namespace log4net.Core
   /// </remarks>
   /// <author>Nicko Cadell</author>
   /// <author>Gert Driesen</author>
-  [Serializable]
+  [Log4NetSerializable]
   public class LogException : ApplicationException
   {
     /// <summary>

diff --git a/src/log4net/Core/LoggingEvent.cs b/src/log4net/Core/LoggingEvent.cs
@@ -164,8 +164,8 @@ public struct LoggingEventData
   /// <author>Gert Driesen</author>
   /// <author>Douglas de la Torre</author>
   /// <author>Daniel Cazzulino</author>
-  [Serializable]
-  public class LoggingEvent : ISerializable
+  [Log4NetSerializable]
+  public class LoggingEvent : ILog4NetSerializable
   {
     private static readonly Type declaringType = typeof(LoggingEvent);
 

diff --git a/src/log4net/Core/MethodItem.cs b/src/log4net/Core/MethodItem.cs
@@ -28,7 +28,7 @@ namespace log4net.Core
   /// as that would require that the containing assembly is loaded.
   /// </summary>
   /// 
-  [Serializable]
+  [Log4NetSerializable]
   public class MethodItem
   {
     /// <summary>

diff --git a/src/log4net/Core/Serializable.cs b/src/log4net/Core/Serializable.cs
@@ -0,0 +1,22 @@
+#if NET462_OR_GREATER
+global using Log4NetSerializableAttribute = System.SerializableAttribute;
+global using ILog4NetSerializable = System.Runtime.Serialization.ISerializable;
+#else
+global using Log4NetSerializableAttribute = log4net.Core.EmptyAttribute;
+global using ILog4NetSerializable = log4net.Core.IEmptyInterface;
+#endif
+
+namespace log4net.Core;
+#if !NET462_OR_GREATER
+/// <summary>
+/// Empty Interface (as replacement for <see cref="System.Runtime.Serialization.ISerializable"/>)
+/// </summary>
+internal interface IEmptyInterface
+{ }
+
+/// <summary>
+/// Empty Attribute (as replacement for <see cref="System.SerializableAttribute"/>)
+/// </summary>
+internal sealed class EmptyAttribute : System.Attribute
+{ }
+#endif
diff --git a/src/log4net/Core/StackFrameItem.cs b/src/log4net/Core/StackFrameItem.cs
@@ -28,7 +28,7 @@ namespace log4net.Core
   /// Provides stack frame information without actually referencing a System.Diagnostics.StackFrame
   /// as that would require that the containing assembly is loaded.
   /// </summary>
-  [Serializable]
+  [Log4NetSerializable]
   public class StackFrameItem
   {
     /// <summary>

diff --git a/src/log4net/Util/EmptyCollection.cs b/src/log4net/Util/EmptyCollection.cs
@@ -33,7 +33,7 @@ namespace log4net.Util
   /// </remarks>
   /// <author>Nicko Cadell</author>
   /// <author>Gert Driesen</author>
-  [Serializable]
+  [Log4NetSerializable]
   public sealed class EmptyCollection : ICollection
   {
     /// <summary>

diff --git a/src/log4net/Util/EmptyDictionary.cs b/src/log4net/Util/EmptyDictionary.cs
@@ -33,7 +33,7 @@ namespace log4net.Util
   /// </remarks>
   /// <author>Nicko Cadell</author>
   /// <author>Gert Driesen</author>
-  [Serializable]
+  [Log4NetSerializable]
   public sealed class EmptyDictionary : IDictionary
   {
     /// <summary>

diff --git a/src/log4net/Util/PropertiesDictionary.cs b/src/log4net/Util/PropertiesDictionary.cs
@@ -36,8 +36,8 @@ namespace log4net.Util
   /// </remarks>
   /// <author>Nicko Cadell</author>
   /// <author>Gert Driesen</author>
-  [Serializable]
-  public sealed class PropertiesDictionary : ReadOnlyPropertiesDictionary, ISerializable, IDictionary
+  [Log4NetSerializable]
+  public sealed class PropertiesDictionary : ReadOnlyPropertiesDictionary, ILog4NetSerializable, IDictionary
   {
     /// <summary>
     /// Constructor

diff --git a/src/log4net/Util/ReadOnlyPropertiesDictionary.cs b/src/log4net/Util/ReadOnlyPropertiesDictionary.cs
@@ -40,8 +40,8 @@ namespace log4net.Util
   /// </remarks>
   /// <author>Nicko Cadell</author>
   /// <author>Gert Driesen</author>
-  [Serializable]
-  public class ReadOnlyPropertiesDictionary : ISerializable, IDictionary, IDictionary<string, object?>
+  [Log4NetSerializable]
+  public class ReadOnlyPropertiesDictionary : ILog4NetSerializable, IDictionary, IDictionary<string, object?>
   {
     private const string ReadOnlyMessage = "This is a read-only dictionary and cannot be modified";
 

diff --git a/src/log4net/Util/TypeConverters/ConversionNotSupportedException.cs b/src/log4net/Util/TypeConverters/ConversionNotSupportedException.cs
@@ -34,7 +34,7 @@ namespace log4net.Util.TypeConverters
   /// </remarks>
   /// <author>Nicko Cadell</author>
   /// <author>Gert Driesen</author>
-  [Serializable]
+  [Log4NetSerializable]
   public class ConversionNotSupportedException : ApplicationException
   {
     /// <summary>

diff --git a/src/site/xdoc/release/release-notes.xml b/src/site/xdoc/release/release-notes.xml
@@ -137,6 +137,10 @@ limitations under the License.
                 <code>log4net.Appender.NetSendAppender</code>
                 <a href="https://github.com/apache/logging-log4net/pull/158">NetSendAdapter removed</a>
               </li>
+              <li>
+                <code>Serializable Support removed (for .netstandard)</code>
+                <a href="https://github.com/apache/logging-log4net/discussions/175">Removing legacy serialization from log4net </a>
+              </li>
             </ul>
           </p>
           <br/>