C#使用RegNotifyChangeKeyValue監聽註冊表更改的幾種方式

来源:https://www.cnblogs.com/xyycare/p/18226626/csharp-reg-notify
-Advertisement-
Play Games

先上兩個通用Modbus幫助類,下麵這個是多線程不安全版,在多線程多電機同一埠通信下,可能造成步進電機丟步或者輸出口無響應等,還有個多線程安全版,只是基於這個不安全版加上了LOCK,THIS using Modbus.Device; using Sunny.UI; using System; us ...


養成一個好習慣,調用 Windows API 之前一定要先看文檔

RegNotifyChangeKeyValue 函數 (winreg.h) - Win32 apps | Microsoft Learn

同步阻塞模式

RegNotifyChangeKeyValue的最後一個參數傳遞false,表示以同步的方式監聽。
同步模式會阻塞調用線程,直到監聽的目標發生更改才會返回,如果在UI線程上調用,則會導致界面卡死,因此我們一般不會直接在主線程上同步監聽,往往是創建一個新的線程來監聽。

示例代碼因為是控制台程式,因此沒有創建新的線程。

RegistryKey hKey = Registry.CurrentUser.CreateSubKey("SOFTWARE\\1-RegMonitor");
string changeBefore = hKey.GetValue("TestValue").ToString();
Console.WriteLine($"TestValue的當前值是:{changeBefore}, 時間:{DateTime.Now:HH:mm:ss}");

//此處創建一個任務,5s之後修改TestValue的值為一個新的guid
Task.Delay(5000).ContinueWith(t =>
{
    string newValue = Guid.NewGuid().ToString();
    Console.WriteLine($"TestValue的值即將被改為:{newValue}, 時間:{DateTime.Now:HH:mm:ss}");
    hKey.SetValue("TestValue", newValue);
});
int ret = RegNotifyChangeKeyValue(hKey.Handle, false, RegNotifyFilter.ChangeLastSet, new SafeWaitHandle(IntPtr.Zero, true), false);
if(ret != 0)
{
    Console.WriteLine($"出錯了:{ret}");
    return;
}
string currentValue = hKey.GetValue("TestValue").ToString();
Console.WriteLine($"TestValue的最新值是:{currentValue}, 時間:{DateTime.Now:HH:mm:ss}");
hKey.Close();
Console.ReadLine();

運行結果:
image

非同步模式

RegNotifyChangeKeyValue的最後一個參數傳遞true,表示以非同步的方式監聽。
非同步模式的關鍵點是需要創建一個事件,然後RegNotifyChangeKeyValue會立即返回,不會阻塞調用線程,然後需要在其他的線程中等待事件的觸發。
當然也可以在RegNotifyChangeKeyValue返回之後立即等待事件,這樣跟同步阻塞沒有什麼區別,如果不是出於演示目的,則沒什麼意義。

出於演示目的毫無意義的非同步模式示例:

RegistryKey hKey = Registry.CurrentUser.CreateSubKey("SOFTWARE\\1-RegMonitor");
string changeBefore = hKey.GetValue("TestValue").ToString();
Console.WriteLine($"TestValue的當前值是:{changeBefore}, 時間:{DateTime.Now:HH:mm:ss}");

//此處創建一個任務,5s之後修改TestValue的值為一個新的guid
Task.Delay(5000).ContinueWith(t =>
{
    string newValue = Guid.NewGuid().ToString();
    Console.WriteLine($"TestValue的值即將被改為:{newValue}, 時間:{DateTime.Now:HH:mm:ss}");
    hKey.SetValue("TestValue", newValue);
});
ManualResetEvent manualResetEvent = new ManualResetEvent(false);
int ret = RegNotifyChangeKeyValue(hKey.Handle, false, RegNotifyFilter.ChangeLastSet, manualResetEvent.SafeWaitHandle, true);
if(ret != 0)
{
    Console.WriteLine($"出錯了:{ret}");
    return;
}
Console.WriteLine($"RegNotifyChangeKeyValue立即返回,時間:{DateTime.Now:HH:mm:ss}");
manualResetEvent.WaitOne();
string currentValue = hKey.GetValue("TestValue").ToString();
Console.WriteLine($"TestValue的最新值是:{currentValue}, 時間:{DateTime.Now:HH:mm:ss}");
hKey.Close();
manualResetEvent.Close();
Console.WriteLine("收工");
Console.ReadLine();

運行結果:
image

正經的代碼大概應該這麼寫:

演示代碼請忽略參數未判空,異常未處理等場景

class RegistryMonitor
{
    private Thread m_thread = null;
    private string m_keyName;
    private RegNotifyFilter m_notifyFilter = RegNotifyFilter.ChangeLastSet;

    public event EventHandler RegistryChanged;

    public RegistryMonitor(string keyName, RegNotifyFilter notifyFilter)
    {
        this.m_keyName = keyName;
        this.m_notifyFilter = notifyFilter;
        this.m_thread = new Thread(ThreadAction);
        this.m_thread.IsBackground = true;
    }
    public void Start()
    {
        this.m_thread.Start();
    }
    private void ThreadAction()
    {
        using(RegistryKey hKey = Registry.CurrentUser.CreateSubKey(this.m_keyName))
        {
            using(ManualResetEvent waitHandle = new ManualResetEvent(false))
            {
                int ret = RegNotifyChangeKeyValue(hKey.Handle, false, this.m_notifyFilter, waitHandle.SafeWaitHandle, true);
                waitHandle.WaitOne();
                this.RegistryChanged?.Invoke(this, EventArgs.Empty);
            }
        }
    }
}

static void Main(string[] args)
{
    string keyName = "SOFTWARE\\1-RegMonitor";
    RegistryKey hKey = Registry.CurrentUser.CreateSubKey(keyName);
    string changeBefore = hKey.GetValue("TestValue").ToString();
    Console.WriteLine($"TestValue的當前值是:{changeBefore}, 時間:{DateTime.Now:HH:mm:ss}");

    //此處創建一個任務,5s之後修改TestValue的值為一個新的guid
    Task.Delay(5000).ContinueWith(t =>
    {
        string newValue = Guid.NewGuid().ToString();
        Console.WriteLine($"TestValue的值即將被改為:{newValue}, 時間:{DateTime.Now:HH:mm:ss}");
        hKey.SetValue("TestValue", newValue);
    });

    RegistryMonitor monitor = new RegistryMonitor(keyName, RegNotifyFilter.ChangeLastSet);
    monitor.RegistryChanged += (sender, e) =>
    {
        Console.WriteLine($"{keyName}的值發生了改變");
        string currentValue = hKey.GetValue("TestValue").ToString();
        Console.WriteLine($"TestValue的最新值是:{currentValue}, 時間:{DateTime.Now:HH:mm:ss}");
        hKey.Close();
    };
    monitor.Start();

    Console.WriteLine("收工");
    Console.ReadLine();
}

運行結果:
image

那麼問題來了:

  1. 上面監聽一個路徑就需要創建一個線程,如果要監聽多個路徑,就需要創建多個線程,且他們什麼事都不幹,就在那等,這不太科學。
  2. 經常寫C#的都知道,一般不建議代碼中直接創建Thread
  3. 改成線程池或者Task行不行?如果線上程池或者Task裡面調用WaitOne進行阻塞,那也是不行的。

接下來 ,我們嘗試改造一下

基於線程池的非同步模式

調用線程池的RegisterWaitForSingleObject,給一個事件註冊一個回調,當事件觸發時,則執行指定的回調函數,參考ThreadPool.RegisterWaitForSingleObject 方法 (System.Threading) | Microsoft Learn

代碼實例如下:

class RegistryMonitor
{
    private string m_keyName;
    private RegNotifyFilter m_notifyFilter = RegNotifyFilter.ChangeLastSet;
    private RegisteredWaitHandle m_registered = null;
    private RegistryKey m_key = null;
    private ManualResetEvent m_waitHandle = null;

    public event EventHandler RegistryChanged;

    public RegistryMonitor(string keyName, RegNotifyFilter notifyFilter)
    {
        this.m_keyName = keyName;
        this.m_notifyFilter = notifyFilter;
    }
    public void Start()
    {
        this.m_key = Registry.CurrentUser.CreateSubKey(this.m_keyName);
        this.m_waitHandle = new ManualResetEvent(false);
        int ret = RegNotifyChangeKeyValue(this.m_key.Handle, false, this.m_notifyFilter | RegNotifyFilter.ThreadAgnostic, this.m_waitHandle.SafeWaitHandle, true);
        this.m_registered = ThreadPool.RegisterWaitForSingleObject(this.m_waitHandle, Callback, null, Timeout.Infinite, true);

    }
    private void Callback(object state, bool timedOut)
    {
        this.m_registered.Unregister(this.m_waitHandle);
        this.m_waitHandle.Close();
        this.m_key.Close();
        this.RegistryChanged?.Invoke(this, EventArgs.Empty);
    }
}

static void Main(string[] args)
{
    for(int i = 1; i <= 50; i++)
    {
        string keyName = $"SOFTWARE\\1-RegMonitor\\{i}";

        RegistryKey hKey = Registry.CurrentUser.CreateSubKey(keyName);
        hKey.SetValue("TestValue", Guid.NewGuid().ToString());
        string changeBefore = hKey.GetValue("TestValue").ToString();
        Console.WriteLine($"{keyName} TestValue的當前值是:{changeBefore}, 時間:{DateTime.Now:HH:mm:ss}");

        RegistryMonitor monitor = new RegistryMonitor(keyName, RegNotifyFilter.ChangeLastSet);
        monitor.RegistryChanged += (sender, e) =>
        {
            Console.WriteLine($"{keyName}的值發生了改變");
            string currentValue = hKey.GetValue("TestValue").ToString();
            Console.WriteLine($"{keyName} TestValue的最新值是:{currentValue}, 時間:{DateTime.Now:HH:mm:ss}");
            hKey.Close();
        };
        monitor.Start();
        Console.WriteLine($"{keyName}監聽中...");
    }

    Console.WriteLine("收工");
    Console.ReadLine();
}

運行結果:
image
可以看到,創建50個監聽,而進程的匯流排程數只有7個。因此使用線程池是最佳方案。

註意事項

  1. 官方文檔有說明,調用RegNotifyChangeKeyValue需要再持久化的線程中,如果不能保證調用線程持久化(如線上程池中調用),則可以加上REG_NOTIFY_THREAD_AGNOSTIC標識
  2. 示例中的監聽都是一次性的,重覆監聽只需要在事件觸發後再次執行RegNotifyChangeKeyValue的流程即可

基礎代碼

/// <summary>
/// 指示應報告的更改
/// </summary>
[Flags]
enum RegNotifyFilter
{
    /// <summary>
    /// 通知調用方是添加還是刪除了子項
    /// </summary>
    ChangeName = 0x00000001,
    /// <summary>
    /// 向調用方通知項屬性(例如安全描述符信息)的更改
    /// </summary>
    ChangeAttributes = 0x00000002,
    /// <summary>
    /// 向調用方通知項值的更改。 這包括添加或刪除值,或更改現有值
    /// </summary>
    ChangeLastSet = 0x00000004,
    /// <summary>
    /// 向調用方通知項的安全描述符的更改
    /// </summary>
    ChangeSecurity = 0x00000008,
    /// <summary>
    /// 指示註冊的生存期不得綁定到發出 RegNotifyChangeKeyValue 調用的線程的生存期。<b>註意</b> 此標誌值僅在 Windows 8 及更高版本中受支持。
    /// </summary>
    ThreadAgnostic = 0x10000000
}
/// <summary>
/// 通知調用方對指定註冊表項的屬性或內容的更改。
/// </summary>
/// <param name="hKey">打開的註冊表項的句柄。密鑰必須已使用KEY_NOTIFY訪問許可權打開。</param>
/// <param name="bWatchSubtree">如果此參數為 TRUE,則函數將報告指定鍵及其子項中的更改。 如果參數為 FALSE,則函數僅報告指定鍵中的更改。</param>
/// <param name="dwNotifyFilter">
/// 一個值,該值指示應報告的更改。 此參數可使用以下一個或多個值。<br/>
/// REG_NOTIFY_CHANGE_NAME 0x00000001L 通知調用方是添加還是刪除了子項。<br/>
/// REG_NOTIFY_CHANGE_ATTRIBUTES 0x00000002L 向調用方通知項屬性(例如安全描述符信息)的更改。<br/>
/// REG_NOTIFY_CHANGE_LAST_SET 0x00000004L 向調用方通知項值的更改。 這包括添加或刪除值,或更改現有值。<br/>
/// REG_NOTIFY_CHANGE_SECURITY 0x00000008L 向調用方通知項的安全描述符的更改。<br/>
/// REG_NOTIFY_THREAD_AGNOSTIC 0x10000000L 指示註冊的生存期不得綁定到發出 RegNotifyChangeKeyValue 調用的線程的生存期。<b>註意</b> 此標誌值僅在 Windows 8 及更高版本中受支持。
/// </param>
/// <param name="hEvent">事件的句柄。 如果 fAsynchronous 參數為 TRUE,則函數將立即返回 ,並通過發出此事件信號來報告更改。 如果 fAsynchronous 為 FALSE,則忽略 hEvent 。</param>
/// <param name="fAsynchronous">
/// 如果此參數為 TRUE,則函數將立即返回並通過向指定事件發出信號來報告更改。 如果此參數為 FALSE,則函數在發生更改之前不會返回 。<br/>
/// 如果 hEvent 未指定有效的事件, 則 fAsynchronous 參數不能為 TRUE。
/// </param>
/// <returns></returns>
[DllImport("Advapi32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
private static extern int RegNotifyChangeKeyValue(SafeHandle hKey, bool bWatchSubtree, RegNotifyFilter dwNotifyFilter, SafeHandle hEvent, bool fAsynchronous);


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 要求:調用PLL—IP核,50Mhz晶振輸入,輸出四路時鐘不同信號:100Mhz,25Mhz,50Mhz(90°相位),50Mhz(20%占空比)。 晶元型號:cyclone Ⅳ EP4CE10F17C8 平臺工具:Quartus II 15.0 (64-bit)、Modelsim SE-64 ... ...
  • Redis是基於Reactor模式開發的網路事件處理器,這個處理器是單線程的,所 以redis是單線程的。 為什麼它是單線程還那麼快呢? 主要有以下幾個原因: 一、純記憶體操作 由於Redis是純記憶體操作,相比於磁碟來說,記憶體就快得多,這個是Redis快的主要 原因。 二、多路復用I/O機制(NIO) ...
  • 1. MyBatis中的介面代理機制及其使用 @目錄1. MyBatis中的介面代理機制及其使用2. 實操2.1 準備工作2.2 insert 增加操作2.3 delete 刪除操作2.4 update 修改操作2.5 select 查詢一條記錄操作2.6 select 查詢多條記錄操作3. 總結: ...
  • 最近在項目中,為了演算法結果的可視化,需要用到混淆矩陣(Confusion Matrix),而網上資源大多是基於Python繪製的混淆矩陣,並且是輸出圖片格式,並不能響應用戶點擊,今天以一個簡單的小例子,簡述如何通過WPF繪製混淆矩陣,並可響應用戶點擊事件,僅供學習分享使用,如有不足之處,還請指正。 ...
  • ReZero AP ReZero是一款.NET中間件 : 一款通過界面操作就能生成API , 可以集成到任何.NET6+ API項目,無破壞性,也可讓非.NET用戶使用exe文件 ReZero生成器功能簡介 1、表文檔導出:支持目錄導航 2、線上創建表、線上建庫 3、一鍵導入現有表 4、模版線上調試 ...
  • DeveloperSharp系列近期又被製造業ERP、民航飛行App、建築BIM、電力掌上營業廳、等多家大型採用,站在巨人的肩膀上你能走的更遠。 支持.Net Core2.0及以上,支持.Net Framework4.0及以上 數據分頁,幾乎是任何應用系統的必備功能。但當數據量較大時,分頁操作的效率 ...
  • 為什麼0.1 + 0.2 不等於 0.3?為什麼16777216f 等於 16777217f?為什麼金錢計算都推薦用decimal?本文主要學習瞭解一下數字背後不為人知的存儲秘密。 ...
  • OpenTelemetry 簡介 OpenTelemetry 是一個由 CNCF(Cloud Native Computing Foundation)托管的開源項目,旨在為觀察性(Observability)提供一套全面的工具,包括度量(Metrics)、日誌(Logs)和追蹤(Traces)。它的 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...