复盘一个诡异的Bug之MethodNotFoundException

今天又碰到一个Bug：

保存一个设置时报了MethodNotFoundException，是一个名为GetPropertyDesc的方法找不到，查看代码却始终得不出原因。

存在却找不到的方法

GetPropertyDesc方法由一个公共组件SysConfig提供，用于解析子类属性定义的DescriptionAttribute，作为该属性的描述，定义如下：

/// <summary>
/// 读取属性的描述文本
/// </summary>
/// <param name="property">属性名</param>
/// <param name="obj">该属性所依赖的对象</param>
/// <returns>描述</returns>
protected string GetPropertyDesc(string property, object obj = null)
{
    try
    {
        var type = obj == null ? this.GetType() : obj.GetType();
        PropertyDescriptor pd = TypeDescriptor.GetProperties(type)[property];
        var description = pd == null ? 
                                null 
                                : pd.Attributes[typeof(DescriptionAttribute)] as DescriptionAttribute;
        return description == null ? string.Empty : description.Description;
    }
    catch (Exception ex)
    {
        LogUtil.WriteLog($"{typeof(ConfigService).FullName}.{nameof(GetPropertyDesc)}", ex);
        return string.Empty;
    }
}

考虑到主程序上个月初刚更新了SysConfig的版本，既然此前的版本在生产环境下都没出现问题，那么会不会是新版本的组件方法签名改变导致的呢？

SysConfig也是我开发的，可当我查看该组件的源代码时，发现GetPropertyDesc方法原原本本就在那里，从表面上看签名也能对得上，看来不是这个原因。

回到主程序，调用GetPropertyDesc的代码是这么写的：

/// <summary>
/// 运行日志保持天数
/// </summary>
private int m_LogKeepDays = -99999;

/// <summary>
/// 设置或获取运行日志保持天数
/// </summary>
[Description("运行日志保持天数")]
public int LogKeepDays
{
    get => m_LogKeepDays;
    set
    {
        if (m_Init)
        {
            if (value >= 0 && m_LogKeepDays != value)
            {
                int oldValue = m_LogKeepDays;
                m_LogKeepDays = value;
                string desc = GetPropertyDesc(nameof(LogKeepDays));
                m_ConfigDA.ModifyConfig(SECTION_NAME_SYS, KEY_LOG_KEEP_DAYS, value.ToString(), desc);
                OnConfigItemChanged(KEY_LOG_KEEP_DAYS, desc, oldValue, m_LogKeepDays);
            }
        }
    }
}

如果是找不到方法，怎么编译通过了呢？

于是我想到了第二个可能性——Nuget缓存。

Nuget缓存

这个组件是通过内部搭建的Nuget服务安装的，此前有过发包后出现Bug撤回重新发布但不更改版本号的操作。为了确定原因，使用VS查看该组件的源代码，终于看出了一丝端倪：

主程序编译时的方法签名跟组件对应版本果然不一致，可我的确没有重新发版不改版本号的印象。

两个不同的版本

看来只有第三种可能——主程序有多个项目引用了SysConfig，而上月初更新时有遗漏。

在Nuget包管理器里，的的确确引用了两个不同版本，统一版本后，问题得以解决。

好在这只是个使用频次很低的功能，要不是最近有个别机器需要开启定时删除过时日志的需求，还不知道这个Bug要在生产环境中存在多久。

整个排查过程不超过半小时，得出的教训却很深刻，公共组件中方法签名不能随意修改，更新组件时一定要详细测试。

2024年3月18日星期一