如何在GetSuggestion执行耗时较长时仍在CLI显示命令建议？

问题描述 #

通过官方指南用C#开发PowerShell命令预测器，已实现基础预测功能，但当GetSuggestion()函数执行时间过长时（如代码中模拟的耗时循环场景），命令行界面（CLI）不再显示生成的建议。测试发现，进入耗时分支后建议被忽略，正常快速返回的建议则能正常展示。

相关代码：

public SuggestionPackage GetSuggestion(PredictionClient client, PredictionContext context, CancellationToken cancellationToken)
{
    string input = context.InputAst.Extent.Text;
    if (string.IsNullOrWhiteSpace(input))
    {
        return default;
    }

    if (input.EndsWith(" "))
    {
        var a = 0;
        for (int i = 0; i < int.MaxValue; i++)
        { 
            a++;
            a--;
        }
            
        return new SuggestionPackage(new List<PredictiveSuggestion>{
        new PredictiveSuggestion(string.Concat(input, a.ToString()))
    });
    }
    
    return new SuggestionPackage(new List<PredictiveSuggestion>{
        new PredictiveSuggestion(string.Concat(input, " example"))
    });
}

原因分析 #

PowerShell的预测器框架对GetSuggestion()的执行有超时限制（默认通常为几百毫秒），如果同步执行耗时任务，超过这个时间后PowerShell会主动放弃等待，导致生成的建议无法被CLI接收并显示。同时同步阻塞还会影响命令行的交互响应性。

解决方案 #

核心思路是异步执行耗时任务，避免阻塞GetSuggestion()主线程，同时正确响应CancellationToken处理PowerShell的取消信号。

1. 修改代码实现异步兼容逻辑 #

将耗时预测逻辑放到异步任务中执行，同时添加超时控制和取消信号检查，确保不会无限阻塞主线程：

public SuggestionPackage GetSuggestion(PredictionClient client, PredictionContext context, CancellationToken cancellationToken)
{
    string input = context.InputAst.Extent.Text;
    if (string.IsNullOrWhiteSpace(input))
    {
        return default;
    }

    if (input.EndsWith(" "))
    {
        try
        {
            // 异步执行耗时任务，同时绑定取消信号
            var resultTask = Task.Run(() =>
            {
                var a = 0;
                // 模拟耗时任务，定期检查取消信号
                for (int i = 0; i < int.MaxValue; i++)
                {
                    cancellationToken.ThrowIfCancellationRequested();
                    a++;
                    a--;
                }
                return a.ToString();
            }, cancellationToken);

            // 设置合理超时时间（示例为2秒，可按需调整）
            if (resultTask.Wait(TimeSpan.FromSeconds(2), cancellationToken))
            {
                return new SuggestionPackage(new List<PredictiveSuggestion>
                {
                    new PredictiveSuggestion(string.Concat(input, resultTask.Result))
                });
            }
            // 超时则返回空或默认建议
            return default;
        }
        catch (OperationCanceledException)
        {
            // 收到取消信号，返回空
            return default;
        }
    }
    
    return new SuggestionPackage(new List<PredictiveSuggestion>
    {
        new PredictiveSuggestion(string.Concat(input, " example"))
    });
}

关键优化点 #

• 异步执行耗时任务：将阻塞操作放到后台线程，避免占用预测器主线程。
• 响应取消信号：在耗时任务中定期检查CancellationToken，当PowerShell取消等待时及时终止任务，避免资源浪费。
• 主动设置超时：通过Wait()方法设置超时时间，即使任务未被取消，也不会无限阻塞，保证CLI的响应性。

进阶建议 #

如果依赖的第三方服务本身提供异步API，直接使用异步调用（如HttpClient.GetAsync），避免用Task.Run包装同步方法，能进一步提升效率。同时可根据实际业务场景调整超时时间，平衡建议准确性与CLI响应速度。

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