.NET项目升级手记:可为空引用

简介:

.NET项目升级手记:可为空引用

c# 8引入了新特性:“可为空引用”(详情),这个功能个人觉得挺好的,能够非常明确的表现程序设计者的意图,编译器能够进行检查,尽最大可能减小NullReferenceException错误。

如果是新项目,那么上手很简单,一点点搭建起来,遇山开山,遇河渡河。但是对于我这种手头上的项目大多都是以前创建的情况,就要稍微做那边么一点操作了。

要看完整说明,请查看开头的那个链接。

准备
首先评估一下几个条件:

项目可以基于.NET CORE 3.0及以上编译。如果不行,那么就请直接右上角点×。
是不是大多数的变量都需要null引用?如果是的话,个人觉得不值得费劲了。
操作
以一个ASP.NET WEBAPI为例,项目修改前是能够正常编译无错误无警告的。

  1. 启用Nullable(可为空引用类型)
    Nullable默认是不启用的,需要做一些修改以启用。有两种方式:

修改csproj文件,在ProperyGroup里面添加enable项。
对于比较小型的项目,可以直接修改,这样弹出来的警告或者错误会比较少,方便我们快速改正。

使用编译器指令#nullable enable和#nullable restore进行修改。在代码段的开头enable,结尾处restore。
对于中大型项目,直接使用第一种方式进行修改会导致大量的警告,很容易一团糟;可以通过编译器指令对单文件或者单类进行修改操作,一点一点地修改。

  1. 修改代码
    我的项目使用第一种方法的的情况下有24个警告(编译后有67个),也不知道算多还是算少。

实体类
[DataContract]

[Table("recordinfo")]
public class RecordInfo : InfoBase
{
    /// <summary>
    /// 记录ID
    /// </summary>
    [DataMember]
    [Key]
    public string RecordNum { get; set; }
    /// <summary>
    /// 车辆RFID号码
    /// </summary>
    [DataMember]
    public string CarID { get; set; }

RecordNum为主键,通过EF进行映射,结果也不会为null,所以声明应该保持原样即可。CarID不是主键,有可能是null,因此应当显式声明为string?,表示可以为空,删除警告。

编译器检查,RecordNum没有被初始化,我们的设计意图告诉编译器了,但是代码还没有保证这个不能为空,因此需要修改代码保证RecordNum不为空。

这里使用null包容运算符(!)来进行操作,提示编译器这个位置实际上不会为null。

//string的default为null,通过增加!告诉编译器,这块初始化的时候实际上是不为空的。
public string RecordNum { get; set; } = default!;
null包容运算符并不能确保不是null,如果可以使用代码确保不为null,那么使用代码会是更优选择。考虑如下代码:

//我经常使用String.IsNullOrWhiteSpace来进行检查,空文本对我的业务没有意义,因此适用。
public string RecordNum { get; set; } = "";
特别提示:
可为空引用类型检查是编译器的行为,它可以提供编译时检查,但是不提供运行时检查,如果使用外部代码调用,那么是否为空都可以进行赋值。

很明显,上面代码运行时也很难保证不是null,我们可以再改进一下。

public string RecordNum
{

get => recordNum;
set => recordNum = value ?? "";

}
private string recordNum = "";
官方推荐对POCO类使用构造函数保证不为空。

DataContext类
DataContext也是类似的,主要是DbSet对象的引用问题。

来自.NET Class Library
//BaseDirectory的返回是string?类型的
var baseDirectory = System.AppDomain.CurrentDomain.BaseDirectory;
//Path.Combine()不接受string?,提示错误。
var xmlPath = Path.Combine(baseDirectory, System.AppDomain.CurrentDomain.FriendlyName + ".xml");
这是一个潜在的bug点,对于以上代码,很显然BaseDirectory的返回为null不符合我们的设计,我们可以进行如下改造。

var baseDirectory = System.AppDomain.CurrentDomain.BaseDirectory;
if (baseDirectory == null) throw new ArgumentNullException("baseDirectory");
var xmlPath = Path.Combine(baseDirectory, System.AppDomain.CurrentDomain.FriendlyName + ".xml");
泛型类
public class ReturnData
{

//整个类型会提示Data未能初始化,ErrorMsg未能初始化。
public ReturnData(){ }
public ReturnData(T data) => Data = data;
public ReturnData(string error) => ErrorMsg = error;
/// <summary>
/// 页面数据
/// </summary>
public T Data { get; set; }
public string ErrorMsg { get; set; }

}
设计意图:Data与ErrorMsg不同时为空,也不同时有值。

基于设计,可以做如下修改。注意添加了class约束。

public class ReturnData

where T: class

{

public ReturnData(){ }
public ReturnData(T data) => Data = data;
public ReturnData(string error) => ErrorMsg = error;
/// <summary>
/// 页面数据
/// </summary>
public T? Data { get; set; }
public string? ErrorMsg { get; set; }

}
其他例子
using ManageDataContext context = new ManageDataContext();
var props = contextType.GetProperty($"{namestring}s");
//props提示有可能为null
var dbset = (props.GetValue(context) as DbSet);
//提示dbset可能为null
var res = await dbset.FindAsync(value);
可以调整为下面的形式:

using ManageDataContext context = new ManageDataContext();
var props = contextType.GetProperty($"{namestring}s");
//判断props可以解决问题。
if (props == null) throw new ArgumentNullException("Props");
var dbset = (props.GetValue(context) as DbSet);
//判断dbset可以解决问题。
if (dbset == null) throw new ArgumentNullException("dbset");
var res = await dbset.FindAsync(value);
注意,将as替换为强制转换,并不能消除警告。

总结
最后消除了所有的警告,改造结束。

这个新的语言特性可以帮助我们发现一些潜在的bug点,帮助我们养成良好的编程习惯,也便于我们告诉其他人我们的设计意图。

编译器能帮我们做的工作,就没必要自己再费劲做了,懒的不行,我得歇会儿。

原文地址https://www.cnblogs.com/podolski/p/12692888.html

相关文章
|
7月前
|
安全 Linux 开发工具
【Azure Function】分享把Function App从.NET 6.0升级到.NET 8.0 Isolated的步骤
本文介绍了将Azure Function App从.NET 6.0升级到.NET 8.0 Isolated的步骤。.NET 6.0作为长期支持版本,生命周期至2024年11月结束。为确保持续支持,建议升级至更新版本。升级步骤包括安装.NET 8 SDK、更新Azure Functions Core Tools、修改项目文件目标框架为net8.0、更新兼容的NuGet包、本地测试以及重新发布到Azure。更多详细信息可参考官方文档。
317 9
|
11月前
|
安全 C# 开发工具
将 EasySQLite 从 .NET 8 升级到 .NET 9
将 EasySQLite 从 .NET 8 升级到 .NET 9
173 31
|
11月前
|
开发框架 前端开发 .NET
一个适用于 .NET 的开源整洁架构项目模板
一个适用于 .NET 的开源整洁架构项目模板
196 26
|
11月前
|
开发框架 安全 .NET
【Azure Developer】.NET Aspire 项目本地调试遇 Grpc.Core.RpcException 异常( Error starting gRPC call ... )
Error starting gRPC call. HttpRequestException: The SSL connection could not be established, see inner exception. AuthenticationException: The remote certificate is invalid because of errors in the certificate chain: UntrustedRoot
283 12
|
10月前
|
人工智能 自然语言处理 机器人
D1net阅闻 | 大模型军备竞赛升级:GPT-4.5/Grok 3同日官宣
D1net阅闻 | 大模型军备竞赛升级:GPT-4.5/Grok 3同日官宣
|
10月前
|
传感器 人工智能 机器人
D1net阅闻|OpenAI机器人项目招新 或自研传感器
D1net阅闻|OpenAI机器人项目招新 或自研传感器
|
开发框架 网络协议 .NET
C#/.NET/.NET Core优秀项目和框架2024年10月简报
C#/.NET/.NET Core优秀项目和框架2024年10月简报
357 3
|
开发框架 缓存 监控
NET Framework 到 .NET 5/6 的迁移是重大的升级
本文详细介绍了从 .NET Framework 4.8 迁移到 .NET 5/6 的过程,通过具体案例分析了迁移策略与最佳实践,包括技术栈评估、代码迁移、依赖项更新及数据库访问层的调整,强调了分阶段迁移、保持代码可维护性及性能监控的重要性。
194 3
|
开发框架 前端开发 API
C#/.NET/.NET Core优秀项目和框架2024年9月简报
C#/.NET/.NET Core优秀项目和框架2024年9月简报
279 1