"ISerializable" should be implemented correctly
https://rules.sonarsource.com/csharp/RSPEC-3925
The ISerializable
interface is the mechanism to control the type serialization process. If not implemented correctly this could result in an invalid serialization and hard to detect bugs.
This rules raises an issue on types that implement ISerializable
without following the serialization pattern recommended by Microsoft.
Specifically this rule checks for these problems:
- The
System.SerializableAttribute
attribute is missing. - Non-serializable fields are not marked with the
System.NonSerializedAttribute
attribute. - There is no serialization constructor.
- An unsealed type has a serialization constructor that is not
protected
. - A sealed type has a serialization constructor that is not
private
. - An unsealed type has a
ISerializable.GetObjectData
that is not bothpublic
andvirtual
. - A derived type has a serialization constructor that does not call the
base
constructor. - A derived type has a
ISerializable.GetObjectData
method that does not call thebase
method. - A derived type has serializable fields but the
ISerializable.GetObjectData
method is not overridden.
What is the correct way to make a custom .NET Exception serializable?
Exception is already serializable, but you need to override the GetObjectData
method to store your variables and provide a constructor which can be called when re-hydrating your object.
So your example becomes:
[Serializable]
public class MyException : Exception
{
private readonly string resourceName;
private readonly IList<string> validationErrors;
public MyException(string resourceName, IList<string> validationErrors)
{
this.resourceName = resourceName;
this.validationErrors = validationErrors;
}
public string ResourceName
{
get { return this.resourceName; }
}
public IList<string> ValidationErrors
{
get { return this.validationErrors; }
}
[SecurityPermissionAttribute(SecurityAction.Demand, SerializationFormatter=true)]
protected MyException(SerializationInfo info, StreamingContext context) : base (info, context)
{
this.resourceName = info.GetString("MyException.ResourceName");
this.validationErrors = info.GetValue("MyException.ValidationErrors", typeof(IList<string>));
}
[SecurityPermissionAttribute(SecurityAction.Demand, SerializationFormatter=true)]
public override void GetObjectData(SerializationInfo info, StreamingContext context)
{
base.GetObjectData(info, context);
info.AddValue("MyException.ResourceName", this.ResourceName);
// Note: if "List<T>" isn't serializable you may need to work out another
// method of adding your list, this is just for show...
info.AddValue("MyException.ValidationErrors", this.ValidationErrors, typeof(IList<string>));
}
}
作者:Chuck Lu GitHub |
【推荐】国内首个AI IDE,深度理解中文开发场景,立即下载体验Trae
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· 记一次.NET内存居高不下排查解决与启示
· 探究高空视频全景AR技术的实现原理
· 理解Rust引用及其生命周期标识(上)
· 浏览器原生「磁吸」效果!Anchor Positioning 锚点定位神器解析
· 没有源码,如何修改代码逻辑?
· 全程不用写代码,我用AI程序员写了一个飞机大战
· DeepSeek 开源周回顾「GitHub 热点速览」
· MongoDB 8.0这个新功能碉堡了,比商业数据库还牛
· 记一次.NET内存居高不下排查解决与启示
· 白话解读 Dapr 1.15:你的「微服务管家」又秀新绝活了
2019-06-10 sql server查询结果复制出来,没有换行(存进去的数据是换行的)