探索.NET Core的神秘侦探：CallerMemberName、FilePath、LineNumber

news/2025/2/8 13:18:33 标签: c#, 开发语言

一、引言

在.NET Core 开发的广袤天地中，调试与日志记录堪称开发者手中的两大法宝，它们对于保障程序的稳定运行、快速定位并解决问题起着举足轻重的作用。想象一下，当你的应用程序在生产环境中突然出现异常，没有调试和日志记录的辅助，就如同在黑暗中摸索，根本无从下手。有了它们，你便能清晰地知晓程序的执行路径、变量的变化情况以及错误发生的具体位置，从而迅速找到问题的症结所在。

而今天，我们将深入探寻三个神奇的特性：CallerMemberName、CallerFilePath、CallerLineNumber。它们就像是三位隐藏在幕后的超级助手，默默地为我们收集着关键信息。在接下来的内容中，我们将揭开它们的神秘面纱，深入了解它们的工作原理，并通过丰富的示例代码，展示它们在实际项目中的强大应用，让你在开发过程中如虎添翼。

二、认识三位神秘侦探

2.1 CallerMemberNameAttribute 类

CallerMemberNameAttribute类允许我们获取方法调用方的方法或属性名称。在使用时，需要将CallerMemberName属性应用于具有默认值的可选参数 ，并且必须为可选参数指定显示默认值，不能将此属性应用于未指定为可选参数。

假设我们有一个用于记录方法执行情况的日志方法：

using System;
using System.Runtime.CompilerServices;

public class Logger
{
    public static void Log([CallerMemberName] string memberName = "")
    {
        Console.WriteLine($"方法 {memberName} 被调用");
    }
}

public class Program
{
    public static void Main()
    {
        Logger.Log();
        DoWork();
    }

    public static void DoWork()
    {
        Logger.Log();
    }
}

在上述代码中，Logger.Log方法中的memberName参数应用了CallerMemberName特性。当在Main方法和DoWork方法中调用Logger.Log时，memberName会自动被赋值为调用方的方法名，即Main和DoWork。这样我们就无需手动传递调用方法的名称，减少了代码的重复和出错的可能性。同时，在进行重构时，如果方法名发生改变，CallerMemberName会自动更新，避免了因字符串硬编码导致的不一致问题。

2.2 CallerFilePathAttribute 类

CallerFilePathAttribute类的作用是允许获取包含调用方法的源文件的完整路径，注意这是编译时的文件路径。同样，将该特性应用于具有默认值的可选参数，且必须为可选参数指定显示默认值，不能用于未指定为可选的参数。

下面是一个简单的示例：

using System;
using System.Runtime.CompilerServices;

public class ErrorReporter
{
    public static void ReportError([CallerFilePath] string filePath = "")
    {
        Console.WriteLine($"错误发生在文件: {filePath}");
    }
}

public class Program
{
    public static void Main()
    {
        try
        {
            int result = 10 / 0; // 这里会引发异常
        }
        catch (Exception ex)
        {
            ErrorReporter.ReportError();
        }
    }
}

在这个例子中，当Main方法中发生异常并调用ErrorReporter.ReportError方法时，filePath参数会自动获取到包含Main方法的源文件的完整路径。这对于快速定位错误发生的源文件非常有帮助，尤其是在大型项目中，能够大大提高调试效率。

2.3 CallerLineNumberAttribute 类

CallerLineNumberAttribute类能够让我们获取源文件中调用方法的行号。和前面两个特性一样，使用时需将其应用于具有默认值的可选参数，必须为可选参数指定显式默认值，不能应用于未指定为可选参数。

以下是一个示例：

using System;
using System.Runtime.CompilerServices;

public class TraceHelper
{
    public static void Trace([CallerLineNumber] int lineNumber = 0)
    {
        Console.WriteLine($"当前执行到第 {lineNumber} 行");
    }
}

public class Program
{
    public static void Main()
    {
        TraceHelper.Trace();
        SomeMethod();
    }

    public static void SomeMethod()
    {
        TraceHelper.Trace();
    }
}

在上述代码中，当在Main方法和SomeMethod方法中调用TraceHelper.Trace方法时，lineNumber参数会自动获取到调用该方法的行号。通过这种方式，我们可以精确地知道代码执行到了哪一行，对于排查问题、跟踪代码执行流程非常有帮助。

三、使用示例与场景实战

3.1 基础使用示例

下面是一个完整的代码示例，展示了如何在一个方法中同时使用CallerMemberName、CallerFilePath和CallerLineNumber特性，获取调用方法名、文件路径和行号并输出。

using System;
using System.Runtime.CompilerServices;

public class TraceHelper
{
    public static void Trace(string message,
        [CallerMemberName] string memberName = "",
        [CallerFilePath] string sourceFilePath = "",
        [CallerLineNumber] int sourceLineNumber = 0)
    {
        Console.WriteLine($"消息: {message}");
        Console.WriteLine($"调用方法名: {memberName}");
        Console.WriteLine($"源文件路径: {sourceFilePath}");
        Console.WriteLine($"行号: {sourceLineNumber}");
    }
}

public class Program
{
    public static void Main()
    {
        TraceHelper.Trace("程序开始执行");
        DoSomeWork();
        TraceHelper.Trace("程序执行结束");
    }

    public static void DoSomeWork()
    {
        TraceHelper.Trace("执行一些工作");
        // 模拟一些复杂的业务逻辑
        for (int i = 0; i < 10; i++)
        {
            Console.WriteLine($"工作进行中: {i}");
        }
    }
}

在上述代码中，TraceHelper.Trace方法接收一个消息参数，以及三个分别应用了CallerMemberName、CallerFilePath和CallerLineNumber特性的可选参数。在Main方法和DoSomeWork方法中调用TraceHelper.Trace时，这些参数会自动获取到相应的调用信息并输出。运行该程序，你会看到类似如下的输出：

消息: 程序开始执行
调用方法名: Main
源文件路径: C:\Projects\CSharpTest\Program.cs
行号: 17
消息: 执行一些工作
调用方法名: DoSomeWork
源文件路径: C:\Projects\CSharpTest\Program.cs
行号: 21
工作进行中: 0
工作进行中: 1
工作进行中: 2
工作进行中: 3
工作进行中: 4
工作进行中: 5
工作进行中: 6
工作进行中: 7
工作进行中: 8
工作进行中: 9
消息: 程序执行结束
调用方法名: Main
源文件路径: C:\Projects\CSharpTest\Program.cs
行号: 18

通过这个示例，我们可以清晰地看到这三个特性是如何协同工作，为我们提供详细的调用信息的。

3.2 日志记录场景

在日志记录中，CallerMemberName、CallerFilePath和CallerLineNumber特性能够发挥巨大的作用，使日志包含更丰富的上下文信息，这对于调试和排查问题至关重要。

假设我们正在开发一个 Web 应用程序，使用Microsoft.Extensions.Logging进行日志记录。我们可以创建一个自定义的日志扩展方法，利用这三个特性来增强日志记录的内容。

首先，安装Microsoft.Extensions.Logging包。然后，创建如下的日志扩展类：

using Microsoft.Extensions.Logging;
using System.Runtime.CompilerServices;

public static class LoggerExtensions
{
    public static void LogWithDetails(this ILogger logger, LogLevel logLevel, string message,
        [CallerMemberName] string memberName = "",
        [CallerFilePath] string sourceFilePath = "",
        [CallerLineNumber] int sourceLineNumber = 0)
    {
        var logMessage = $"方法: {memberName}, 文件: {sourceFilePath}, 行号: {sourceLineNumber}, 消息: {message}";
        logger.Log(logLevel, logMessage);
    }
}

在控制器或其他需要记录日志的地方，使用该扩展方法：

using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Logging;

public class HomeController : Controller
{
    private readonly ILogger<HomeController> _logger;

    public HomeController(ILogger<HomeController> logger)
    {
        _logger = logger;
    }

    public IActionResult Index()
    {
        _logger.LogWithDetails(LogLevel.Information, "访问首页");
        // 其他业务逻辑
        return View();
    }

    public IActionResult Error()
    {
        try
        {
            // 模拟一个可能出错的操作
            int result = 10 / 0;
        }
        catch (Exception ex)
        {
            _logger.LogWithDetails(LogLevel.Error, $"发生异常: {ex.Message}");
        }
        return View();
    }
}

这样，在日志文件或日志输出中，我们可以看到类似如下的记录：

[信息] 方法: Index, 文件: C:\Projects\WebApp\Controllers\HomeController.cs, 行号: 15, 消息: 访问首页
[错误] 方法: Error, 文件: C:\Projects\WebApp\Controllers\HomeController.cs, 行号: 23, 消息: 发生异常: 试图除以零。

通过这些详细的日志信息，我们能够快速定位到问题发生的具体位置和相关方法，大大提高了调试和排查问题的效率。

3.3 简化 INotifyPropertyChange 实现

在 WPF 的 MVVM 模式中，INotifyPropertyChanged接口用于实现属性变更通知，当属性值发生变化时，通知绑定的控件进行更新。传统的实现方式通常使用硬编码的字符串来指定属性名称，这种方式存在一些弊端，比如容易出现拼写错误，且在重构时需要手动更新所有相关的字符串。而使用CallerMemberName特性可以很好地解决这些问题。

下面是传统的实现方式：

using System;
using System.ComponentModel;

public class Person : INotifyPropertyChanged
{
    private string _name;

    public string Name
    {
        get { return _name; }
        set
        {
            if (_name!= value)
            {
                _name = value;
                OnPropertyChanged("Name");
            }
        }
    }

    public event PropertyChangedEventHandler PropertyChanged;

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

在上述代码中，OnPropertyChanged方法使用硬编码的字符串"Name"来通知属性变更。如果属性名发生改变，需要手动修改这个字符串，否则属性变更通知将无法正确工作。

使用CallerMemberName特性后的实现方式：

using System;
using System.ComponentModel;
using System.Runtime.CompilerServices;

public class Person : INotifyPropertyChanged
{
    private string _name;

    public string Name
    {
        get { return _name; }
        set
        {
            if (_name!= value)
            {
                _name = value;
                OnPropertyChanged();
            }
        }
    }

    public event PropertyChangedEventHandler PropertyChanged;

    protected void OnPropertyChanged([CallerMemberName] string propertyName = "")
    {
        PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
    }
}

在这个改进后的版本中，OnPropertyChanged方法的propertyName参数应用了CallerMemberName特性，当属性值发生变化调用OnPropertyChanged时，propertyName会自动获取到调用方的属性名称。这样，无论属性名如何变更，都无需手动修改通知代码，避免了因拼写错误或遗漏更新导致的问题，提高了代码的健壮性和可维护性。

四、总结与展望

在.NET Core 开发领域，CallerMemberName、CallerFilePath 和 CallerLineNumber 这三个特性宛如三把利刃，为开发者在代码调试和维护的战场上披荆斩棘。

CallerMemberName 特性让我们能够轻松获取调用方的方法或属性名称，避免了手动传递和硬编码带来的风险，使得代码在重构时更加安全可靠；CallerFilePath 特性精确地定位到调用方所在的源文件路径，为我们快速找到问题根源提供了关键线索；CallerLineNumber 特性则细致入微，准确地告知我们调用方法的行号，让代码执行流程的追踪变得轻而易举。

在日志记录场景中，它们协同工作，为日志增添了丰富的上下文信息，极大地提高了排查问题的效率；在实现 INotifyPropertyChange 接口时，CallerMemberName 特性简化了代码实现，降低了出错的可能性，提升了代码的可维护性。

展望未来，随着.NET Core 的不断发展和演进，相信这些特性会在更多的场景中发挥作用，为开发者带来更多的便利。同时，也期待更多类似的实用特性出现，进一步提升.NET Core 开发的效率和体验。希望大家在今后的项目中，能够充分利用这三个特性，让自己的代码更加健壮、易于维护。


http://www.niftyadmin.cn/n/5844888.html

相关文章

【DeepSeek论文精读】2. DeepSeek LLM：以长期主义扩展开源语言模型

【DeepSeek论文精读】2. DeepSeek LLM：以长期主义扩展开源语言模型

欢迎关注[【youcans的AGI学习笔记】](https://blog.csdn.net/youcans/category_12244543.html&#xff09;原创作品 【DeepSeek论文精读】1. 从 DeepSeek LLM 到 DeepSeek R1 【DeepSeek论文精读】2. DeepSeek LLM&#xff1a;以长期主义扩展开源语言模型 【DeepSeek论文精读】…
阅读更多...
Mac: docker安装以后报错Command not found: docker

Mac: docker安装以后报错Command not found: docker

文章目录 前言解决办法&#xff08;新的&#xff09;解决步骤&#xff08;原来的&#xff09;不推荐总结 前言 ​本操作参考 http://blog.csdn.net/enhenglhm/article/details/137955756 原作者&#xff0c;更详细请&#xff0c;查看详细内容请关注原作者。 一般&#xff0c;…
阅读更多...
Vue基础：计算属性（描述依赖响应式状态的复杂逻辑）

Vue基础：计算属性（描述依赖响应式状态的复杂逻辑）

文章目录 引言computed() 方法期望接收一个 getter 函数可写计算属性：计算属性的 Setter计算属性的缓存机制调试 Computed引言 推荐使用计算属性来描述依赖响应式状态的复杂逻辑 computed 函数：它接受 getter 函数并为 getter 返回的值返回一个不可变的响应式 ref 对象。 c…
阅读更多...
Linux ftrace 内核跟踪入门

Linux ftrace 内核跟踪入门

文章目录 ftrace介绍开启ftraceftrace使用ftrace跟踪指定内核函数ftrace跟踪指定pid ftrace原理ftrace与stracetrace-cmd 工具KernelShark参考 ftrace介绍 Ftrace is an internal tracer designed to help out developers and designers of systems to find what is going on i…
阅读更多...
第30节课：前端架构与设计模式—构建高效可维护的Web应用

第30节课：前端架构与设计模式—构建高效可维护的Web应用

目录 前端架构设计前端架构的重要性前端架构设计原则模块化可维护性可扩展性性能优化 前端架构设计方法MVC&#xff08;Model-View-Controller&#xff09;MVVM&#xff08;Model-View-ViewModel&#xff09;单页应用&#xff08;SPA&#xff09; 设计模式在前端的应用设计模式…
阅读更多...
机器学习数学基础：19.线性相关与线性无关

机器学习数学基础：19.线性相关与线性无关

一、线性相关与线性无关的定义 &#xff08;一&#xff09;线性相关 想象我们有一组向量&#xff0c;就好比是一群有着不同“力量”和“方向”的小伙伴。给定的向量组 α ⃗ 1 , α ⃗ 2 , ⋯ , α ⃗ m \vec{\alpha}_1, \vec{\alpha}_2, \cdots, \vec{\alpha}_m α 1​,α 2…
阅读更多...
Linux系统安装Nginx详解（适用于CentOS 7）

Linux系统安装Nginx详解（适用于CentOS 7）

目录 1. 更新系统包 2. 安装EPEL仓库 3. 安装Nginx 4. 启动Nginx服务 5. 设置Nginx开机自启 6. 检查Nginx状态 7. 配置防火墙 8. 访问Nginx默认页面 9. 配置Nginx&#xff08;可选&#xff09; 10. 重启Nginx 解决步骤 1. 检查系统版本 2. 移除错误的 Nginx 仓库 …
阅读更多...
unity 音频的使用AudioSource

unity 音频的使用AudioSource

方法一:直接在软件操作给物体添加AudioSource组件 方式二:用脚本控制 软件添加AudioSource 音频文件拖入脚本 脚本附体物体上执行脚本 脚本代码 using System.Collections; using System.Collections.Generic; using UnityEngine; public class NewTest: MonoBehaviour…
阅读更多...
最新文章

Copyright @ 2022~2023