0

0

C#中的nameof表达式有什么妙用?提升C#代码可读性和可维护性的小技巧

月夜之吻

月夜之吻

发布时间:2025-12-29 12:33:19

|

102人浏览过

|

来源于php中文网

原创

nameof 表达式用于获取变量、参数、类型或成员的名称字符串,提升代码安全与可维护性。1. 参数验证中避免硬编码字符串,如 throw new ArgumentNullException(nameof(person));2. 实现 INotifyPropertyChanged 时确保属性名正确,OnPropertyChanged(nameof(Name));3. 日志记录使用 nameof 提高准确性,Console.WriteLine($"{nameof(newValue)} = {newValue}");4. 配置映射与反射场景减少运行时错误,如 Dictionary 映射字段或 GetProperty(nameof(Person.Name))。重构时自动同步,防止命名不一致导致的问题。

c#中的nameof表达式有什么妙用?提升c#代码可读性和可维护性的小技巧

nameof 表达式在 C# 中是一个编译时运算符,用于获取变量、参数、类型或成员的名称字符串。它看起来简单,但在提升代码可读性和可维护性方面非常实用。相比硬编码字符串,nameof 能让代码更安全、更清晰,且重构时不易出错。以下是几个典型妙用场景。

1. 参数验证中的异常消息

方法中经常需要检查参数是否为空或无效,抛出 ArgumentException 及其子类时,传入参数名是常见做法。使用 nameof 可避免手动输入字符串导致拼写错误。

void ProcessPerson(Person person) { if (person == null) throw new ArgumentNullException(nameof(person));
  if (string.IsNullOrWhiteSpace(person.Name))
      throw new ArgumentException("Name cannot be empty", nameof(person.Name));

}

如果之后将参数名从 person 改为 p,IDE 会自动更新 nameof(p),而硬编码的 "person" 则会变成隐患。

2. INotifyPropertyChanged 实现属性变更通知

在 WPF、MVVM 或数据绑定场景中,实现 INotifyPropertyChanged 接口时需传递属性名。使用 nameof 避免魔法字符串,确保属性重命名时事件仍能正确触发。

public class Person : INotifyPropertyChanged { private string name; public string Name { get => name; set { name = value; OnPropertyChanged(nameof(Name)); } }
  public event PropertyChangedEventHandler PropertyChanged;

  protected virtual void OnPropertyChanged(string propertyName)
  {
      PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
  }

}

若将来把 Name 属性改为 FullName,配合重构工具nameof(Name) 会同步更新,防止因字符串未改而导致绑定失效。

3. 日志记录与诊断信息输出

日志中常需输出变量或方法名以辅助调试。使用 nameof 可提高日志准确性。

知鹿匠
知鹿匠

知鹿匠教师AI工具,新课标教案_AI课件PPT_作业批改

下载
void LogProcessingStart() { Console.WriteLine($"Starting to process: {nameof(LogProcessingStart)}"); }

void UpdateValue(int newValue) { Console.WriteLine($"{nameof(newValue)} = {newValue}"); }

这种方式比直接写字符串更可靠,尤其在方法或变量重命名后依然保持一致。

4. 配置映射与反射场景中的键名匹配

在使用配置、序列化或反射时,常需将字符串与成员关联。nameof 能减少因名称不一致引发的运行时错误。

// 示例:映射 JSON 字段到属性(如手动处理) var mapping = new Dictionary> { { nameof(Person.Name), s => person.Name = s }, { nameof(Person.Age), s => person.Age = int.Parse(s) } };

// 使用反射时也可辅助生成更安全的字符串 typeof(Person).GetProperty(nameof(Person.Name))?.SetValue(person, "Alice");

比起写死 "Name" 和 "Age",使用 nameof 让这些映射关系更具可维护性。

基本上就这些。nameof 不复杂但容易忽略,合理使用能让代码更健壮,减少“字符串幻数”带来的潜在问题。尤其是在协作开发和频繁重构的项目中,它是个小而美的工具。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

401

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

528

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

306

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

72

2025.09.10

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

311

2023.08.02

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

227

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

431

2024.03.01

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1429

2023.10.24

ip地址修改教程大全
ip地址修改教程大全

本专题整合了ip地址修改教程大全,阅读下面的文章自行寻找合适的解决教程。

121

2025.12.26

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.1万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号