CefSharp自定义KeyboardHandler中EvaluateScriptAsync无返回值问题

问题核心原因 #

你碰到的是典型的CEF线程死锁问题：

• IKeyboardHandler的OnKeyEvent回调本身是运行在CEF的内部渲染主线程上的
• EvaluateScriptAsync方法的执行逻辑需要把JS执行请求投递到CEF主线程的消息队列等待执行，你在回调里直接调用Wait()或者同步阻塞等待任务结果，会直接卡死CEF主线程，导致JS请求永远得不到处理，任务永远不会完成。

解决方案 #

方案1：异步处理结果，不阻塞回调线程（推荐） #

不要在OnKeyEvent里同步等待结果，把JS执行后的后续逻辑全部放到异步回调里，不要调用Wait()或者访问Result属性：

public class KeyboardHandler : IKeyboardHandler
{
    public bool OnKeyEvent(IWebBrowser browserControl, IBrowser browser, KeyType type, int windowsKeyCode, int nativeKeyCode, CefEventFlags modifiers, bool isSystemKey)
    {
        // 加按键类型判断，避免按下、弹起过程触发多次回调
        if (windowsKeyCode == 0x0D && type == KeyType.RawKeyDown) 
        {
            string script = @"(function(){
                return 1 + 1;
            })();";
            // 异步执行，不阻塞当前CEF线程
            EvaluateScriptAsync(script, browserControl);
            return true;
        }
        return false;
    }

    private async void EvaluateScriptAsync(string script, IWebBrowser browserControl)
    {
        var browser = (CefSharp.WinForms.ChromiumWebBrowser)browserControl;
        if (!browser.IsBrowserInitialized || browser.IsDisposed || browser.Disposing)
        {
            return;
        }
        try
        {
            var response = await browser.EvaluateScriptAsync(script, TimeSpan.FromSeconds(10));
            if (response.Success)
            {
                var result = response.Result ?? "null";
                // 这里处理返回结果，如果要更新WinForm控件，需要Invoke到程序的UI线程执行
                // 示例：yourForm.Invoke(new Action(() => { 你的UI更新逻辑 }));
                Console.WriteLine($"JS执行结果：{result}");
            }
            else
            {
                Console.WriteLine($"JS执行失败：{response.Message}");
            }
        }
        catch (Exception ex)
        {
            Console.WriteLine($"执行出错：{ex.Message}");
        }
    }
}

方案2：必须同步获取结果的处理方式 #

如果你的业务逻辑必须拿到JS返回值才能继续后续操作，可以把执行请求投递到主程序的UI线程（不是CEF线程）去执行，避免阻塞CEF主线程：

public bool OnKeyEvent(IWebBrowser browserControl, IBrowser browser, KeyType type, int windowsKeyCode, int nativeKeyCode, CefEventFlags modifiers, bool isSystemKey)
{
    if (windowsKeyCode == 0x0D && type == KeyType.RawKeyDown)
    {
        string script = @"(function(){
            return 1 + 1;
        })();";
        // yourForm替换为你实际的WinForm窗体实例
        yourForm.Invoke(new Action(async () =>
        {
            var response = await browserControl.EvaluateScriptAsync(script, TimeSpan.FromSeconds(10));
            // 这里处理返回结果即可
        }));
        return true;
    }
    return false;
}

额外注意点 #

• 不要在CEF的任何回调接口（包括键盘、鼠标、生命周期回调等）中做同步阻塞等待操作，非常容易触发死锁
• JS执行完成后如果需要操作WinForm控件，必须用Invoke/BeginInvoke投递到程序的UI线程操作，否则会报跨线程访问错误

内容的提问来源于stack exchange，提问作者Simmy