.NET/C# 使用 SetWindowsHookEx 监听鼠标或键盘消息以及此方法的坑

2024-01-14 09:10:40

一般来说，大家在需要监听全局消息的时候会考虑 SetWindowsHookEx 这个 API。或者需要处理一些非自己编写的窗口的消息循环的时候，也会考虑使用它。

如果要知道如何使用这个 API，你可以在网上搜到大量这样的文章/博客/教程/文档，然而大多不会提及使用此 API 时遇到的一些坑。阅读本文，你当然也可以知道应该如何使用这个 API，但同时也能了解如何正确使用以避免一些奇怪的问题。

本文内容

基本使用

如果你在阅读本文的时候遇到了一些问题，可考虑去 GitHub 上克隆我的源码，跑一跑试试。在这里：walterlv/Walterlv.Demo.SetWindowsHookEx。

简单一点，先贴出一部分可以工作起来的代码，你直接可以放到你的项目当中运行测试：

public partial class MainWindow : Window
{
    private readonly HookProc _mouseHook;
    private IntPtr _hMouseHook;

    public MainWindow()
    {
        InitializeComponent();
        _mouseHook = onm ouseHook;
        Loaded += onl oaded;
    }

    private void onl oaded(object sender, RoutedEventArgs e)
    {
        var hModule = GetModuleHandle(null);
        // 你可能会在网上搜索到下面注释掉的这种代码，但实际上已经过时了。
        //   下面代码在 .NET Core 3.x 以上可正常工作，在 .NET Framework 4.0 以下可正常工作。
        //   如果不满足此条件，你也可能可以正常工作，详情请阅读本文后续内容。
        // var hModule = Marshal.GetHINSTANCE(Assembly.GetExecutingAssembly().GetModules()[0]);

        _hMouseHook = SetWindowsHookEx(
            HookType.WH_MOUSE_LL,
            _mouseHook,
            hModule,
            0);
        if (_hMouseHook == IntPtr.Zero)
        {
            int errorCode = Marshal.GetLastWin32Error();
            throw new Win32Exception(errorCode);
        }
    }

    private IntPtr onm ouseHook(int nCode, IntPtr wParam, IntPtr lParam)
    {
        // 在这里，你可以处理全局鼠标消息。
        return CallNextHookEx(new IntPtr(0), nCode, wParam, lParam);
    }
}

本文讨论使用 .NET/C# 来完成 SetWindowsHookEx 的调用，所以自然少不了 P/Invoke（平台调用）。因此你必须将以下代码也添加到你的代码仓库中：

[DllImport("kernel32.dll")]
public static extern IntPtr GetModuleHandle(string lpModuleName);

[DllImport("kernel32", SetLastError = true)]
static extern IntPtr LoadLibrary(string lpFileName);

[DllImport("user32.dll")]
static extern uint GetWindowThreadProcessId(IntPtr hWnd, out uint lpdwProcessId);

[DllImport("user32.dll", SetLastError = true)]
static extern IntPtr SetWindowsHookEx(HookType hookType, HookProc lpfn, IntPtr hMod, uint dwThreadId);

[DllImport("user32.dll")]
static extern IntPtr CallNextHookEx(IntPtr hhk, int nCode, IntPtr wParam, IntPtr lParam);

private delegate IntPtr HookProc(int nCode, IntPtr wParam, IntPtr lParam);

public enum HookType : int
{
    WH_JOURNALRECORD = 0,
    WH_JOURNALPLAYBACK = 1,
    WH_KEYBOARD = 2,
    WH_GETMESSAGE = 3,
    WH_CALLWNDPROC = 4,
    WH_CBT = 5,
    WH_SYSMSGFILTER = 6,
    WH_MOUSE = 7,
    WH_HARDWARE = 8,
    WH_DEBUG = 9,
    WH_SHELL = 10,
    WH_FOREGROUNDIDLE = 11,
    WH_CALLWNDPROCRET = 12,
    WH_KEYBOARD_LL = 13,
    WH_MOUSE_LL = 14
}

SetWindowsHookEx

SetWindowsHookEx 的签名如下：

HHOOK SetWindowsHookExA(
  int       idHook,
  HOOKPROC  lpfn,
  HINSTANCE hmod,
  DWORD     dwThreadId
);

当方法执行成功时，返回值是钩子处理函数的句柄，用于在钩子的消息处理中调用 CallNextHookEx 方法。当方法执行失败时，这里返回 0。
idHood 参数表示需要处理的消息类型（我们前面定义成了枚举类型 HookType）
lpfn 是自己定义的钩子的消息处理方法（对应我们前面定义的委托）
hmod 是模块的句柄，在本机代码中，对应 dll 的句柄（可在 dll 的入口函数中获取）；而我们是托管代码
dwThreadId 是线程 Id，传入 0 则为全局所有线程，否则传入特定的线程 Id

需要注意的坑

模块句柄传什么？

本文一开始被注释掉的代码中，我使用 Marshal 直接从托管程序集中获取了模块句柄。

这里需要说明，托管程序集不能注入到其他进程，因此也不可以挂接钩子。但有例外，WH_KEYBOARD_LL 或者 WH_MOUSE_LL 这两个是不需要注入 dll 的，因此可以挂接钩子。

对于 WH_KEYBOARD_LL 和 WH_MOUSE_LL，SetWindowsHookEx 方法里面根本没有使用这个模块做什么真正的事情，它只是验证一下一个模块而已。只要存在于你的进程中。

所以，传入其他的模块都是可以的：

var hModule = LoadLibrary("user32.dll");

传入口模块也是可以的：

var hModule = Marshal.GetHINSTANCE(Assembly.GetEntryAssembly().GetModules()[0]);

var hModule = GetModuleHandle(null);

这也是一开始我在 P/Invoke 的方法里面预留了 LoadLibrary 和 GetModuleHandle 方法的原因。

通过调试也能发现这两个的入口模块是相同的：

至于为什么可以用 user32.dll。嗯，反正我们创建窗口监听消息都已经大量调用 user32.dll 的 API 了，这 dll 肯定已经加入到我们的进程中了，所以我们把这个传入到参数中是可以通过验证的。

错误 126：找不到指定的模块。

The specified module could not be found.

如果你只是拿代码做做 demo 可能一切顺利，但放到实际项目里面就挂得一塌糊涂：

这也是我在一开始的 P/Invoke 里面加上了 SetLassError 的重要原因，因为这 API 容易挂。

检查的错误码是 126（0x0000007E）。

然而我的 dll 是存在的呀！

让我们再来看我一开始预留的注释：

// 下面代码在 .NET Core 3.x 以上可正常工作，在 .NET Framework 4.0 以下可正常工作。
// 如果不满足此条件，你也可能可以正常工作，详情请阅读本文后续内容。
var hModule = Marshal.GetHINSTANCE(Assembly.GetExecutingAssembly().GetModules()[0]);

是的，你遇到这样的异常，多半意味着你落入 .NET Framework 4.x 版本的运行时了。

.NET Framework 4.0 相比于之前的 CLR 发生了很大的更改，不再假装 JIT 代码存在一非托管模块中，因此 Marshal.GetHINSTANCE 将不再起作用。

对于低级钩子来说，SetWindowsHookEx 需要一个有效的模块句柄进行检查，但实际上此 API 执行时根本没有使用这个模块。所以更推荐使用前一小节中提供的 LoadLibrary 函数来获取模块句柄，而不是获取当前托管模块的句柄。

解决方法，两/三个：

方法一：使用 LoadLibrary("user32.dll") 获取模块句柄代替 Marshal.GetHINSTANCE
方法二：将获取句柄的模块改为入口程序集（exe），即 Assembly.GetEntryAssembly()。
方法三：升级成纯 .NET Core 程序

错误 1428：没有模块句柄无法设置非本机的挂接。

Cannot set nonlocal hook without a module handle.

对于前面说的 126 错误，你可能从 Assembly.GetExecutingAssembly 改成 Assembly.GetEntryAssembly() 之后会出现此异常。

解决方法：

使用 LoadLibrary("user32.dll") 获取模块句柄代替 Marshal.GetHINSTANCE

错误 1429：此挂接程序只可整体设置。

This hook procedure can only be set globally.

估计找到这里的方式可能是搜索，因为这段中文读起来真的是太晦涩了。不过我把英文贴到上一行了，相信你差不多就知道是怎么回事了。

因为你给 SetWindowsHookEx 方法中传入的 HookType 参数指定了低级类型（Low Level，HookType 枚举后面带了 LL 后缀的），这时只能全局设置钩子。意味着你的第四个参数必须传入 0。

如何只处理特定窗口的消息？

消息循环属于“线程”，而不是属于某个窗口或者进程。在 CreateWindowEx 创建窗口时传入的消息处理函数会仅处理特定窗口的消息，然而当通过钩子的方式来处理消息的话，无法精确定位到某个特定的窗口，只能针对消息循环所在的线程。因此，要处理特定窗口的消息，只能先拿到此窗口所在的线程。

前面的 P/Invoke 中我也预留了获取窗口所在线程的方法。因此，可以直接使用以下调用来获取 hWnd 句柄窗口所在的线程。

var threadId = GetWindowThreadProcessId(hWnd, out _);

本来在 SetWindowsHookEx 最后一个参数传入 0 表示全局钩子的，那么现在传入 threadId 即仅监听此线程的消息。

另外，如果只是打算处理单个窗口的消息，而不是这个线程里的所有消息，那么建议使用子类化的方式来实现。详情可阅读我的另一篇博客：

通过子类化窗口（SubClass）来为现有的某个窗口添加新的窗口处理程序（或者叫钩子，Hook） - walterlv

为什么会导致其他进程闪退？

你可能会发现，明明按照本文所述的方法挂接了钩子，但一运行起来后，其他程序（被挂接的程序）出现了闪退现象。

接下来说明：

在 HookType 的所有种类中，只有 WH_MOUSE_LL 和 WH_KEYBOARD_LL 是不需要注入到目标进程的，其他都必须将 dll 注入到目标进程才可以完成挂接。然而 .NET 程序集无法被注入到其他进程；随便用一个其他 dll 时，里面没有被挂接的函数地址，在注入后就会导致目标进程崩溃。

所以：

如果需要挂接的进程就在本进程内（最后参数指定的线程是本进程内的线程），那么所有种类都可以挂接；
如果需要全局挂接，或者要挂接别的进程，那么 .NET 程序只能使用 WH_MOUSE_LL 和 WH_KEYBOARD_LL 两种挂接类型；

如果就是要挂接其他类型的钩子怎么办？办法总还是有的：

可以考虑做非托管 dll，专门用来挂接；
可以考虑使用 SetWinEventHook，这个是不用注入到目标进程的；
可以考虑使用 System.Windows.Automation 抓取一部分有限的信息。

其他问题

如果你在各种折腾之后还是有问题，可考虑去 GitHub 上克隆我的源码，跑一跑试试。在这里：walterlv/Walterlv.Demo.SetWindowsHookEx。或者通过本文后面附带的联系方式与我联系。

参考资料

本文会经常更新，请阅读原文： https://blog.walterlv.com/post/add-global-windows-hook-in-dotnet.html ，以避免陈旧错误知识的误导，同时有更好的阅读体验。

码农公寓