在 .NET 控制台应用程序中监听按键

Question

如何继续运行我的控制台应用程序，直到按键（如Esc被按下？）

我假设它围绕着一个while循环。 我不喜欢ReadKey ，因为它会阻止操作并要求输入一个键，而不是继续听按键。

如何才能做到这一点？

Answer 1

使用Console.KeyAvailable以便仅在知道它不会阻塞时调用ReadKey ：

Console.WriteLine("Press ESC to stop");
do {
    while (! Console.KeyAvailable) {
        // Do something
   }       
} while (Console.ReadKey(true).Key != ConsoleKey.Escape);

Answer 2

您可以稍微改变您的方法 - 使用Console.ReadKey()停止您的应用程序，但在后台线程中执行您的工作：

static void Main(string[] args)
{
    var myWorker = new MyWorker();
    myWorker.DoStuff();
    Console.WriteLine("Press any key to stop...");
    Console.ReadKey();
}

在myWorker.DoStuff() function 中，您将在后台线程上调用另一个 function （使用Action<>()或Func<>()是一种简单的方法），然后立即返回。

Answer 3

最短的方法：

Console.WriteLine("Press ESC to stop");

while (!(Console.KeyAvailable && Console.ReadKey(true).Key == ConsoleKey.Escape))
{
    // do something
}

Console.ReadKey()是一个阻塞的 function，它停止程序的执行并等待按键，但是由于首先检查了Console.KeyAvailable ， while循环没有被阻塞，而是一直运行到Esc被按下。

Answer 4

来自 Jason Roberts 在http://www.pluralsight.Z4D23619A2D4BEC505C

我们可以执行以下操作以拥有多个正在运行的进程

  static void Main(string[] args)
    {
        Console.CancelKeyPress += (sender, e) =>
        {

            Console.WriteLine("Exiting...");
            Environment.Exit(0);
        };

        Console.WriteLine("Press ESC to Exit");

        var taskKeys = new Task(ReadKeys);
        var taskProcessFiles = new Task(ProcessFiles);

        taskKeys.Start();
        taskProcessFiles.Start();

        var tasks = new[] { taskKeys };
        Task.WaitAll(tasks);
    }

    private static void ProcessFiles()
    {
        var files = Enumerable.Range(1, 100).Select(n => "File" + n + ".txt");

        var taskBusy = new Task(BusyIndicator);
        taskBusy.Start();

        foreach (var file in files)
        {
            Thread.Sleep(1000);
            Console.WriteLine("Procesing file {0}", file);
        }
    }

    private static void BusyIndicator()
    {
        var busy = new ConsoleBusyIndicator();
        busy.UpdateProgress();
    }

    private static void ReadKeys()
    {
        ConsoleKeyInfo key = new ConsoleKeyInfo();

        while (!Console.KeyAvailable && key.Key != ConsoleKey.Escape)
        {

            key = Console.ReadKey(true);

            switch (key.Key)
            {
                case ConsoleKey.UpArrow:
                    Console.WriteLine("UpArrow was pressed");
                    break;
                case ConsoleKey.DownArrow:
                    Console.WriteLine("DownArrow was pressed");
                    break;

                case ConsoleKey.RightArrow:
                    Console.WriteLine("RightArrow was pressed");
                    break;

                case ConsoleKey.LeftArrow:
                    Console.WriteLine("LeftArrow was pressed");
                    break;

                case ConsoleKey.Escape:
                    break;

                default:
                    if (Console.CapsLock && Console.NumberLock)
                    {
                        Console.WriteLine(key.KeyChar);
                    }
                    break;
            }
        }
    }
}

internal class ConsoleBusyIndicator
{
    int _currentBusySymbol;

    public char[] BusySymbols { get; set; }

    public ConsoleBusyIndicator()
    {
        BusySymbols = new[] { '|', '/', '-', '\\' };
    }
    public void UpdateProgress()
    {
        while (true)
        {
            Thread.Sleep(100);
            var originalX = Console.CursorLeft;
            var originalY = Console.CursorTop;

            Console.Write(BusySymbols[_currentBusySymbol]);

            _currentBusySymbol++;

            if (_currentBusySymbol == BusySymbols.Length)
            {
                _currentBusySymbol = 0;
            }

            Console.SetCursorPosition(originalX, originalY);
        }
    }

Answer 5

这是一种让您在不同线程上做某事并开始监听不同线程中按下的键的方法。 当您的实际进程结束或用户按Esc键终止进程时，控制台将停止其处理。

class SplitAnalyser
{
    public static bool stopProcessor = false;
    public static bool Terminate = false;

    static void Main(string[] args)
    {
        Console.ForegroundColor = ConsoleColor.Green;
        Console.WriteLine("Split Analyser starts");
        Console.ForegroundColor = ConsoleColor.Red;
        Console.WriteLine("Press Esc to quit.....");
        Thread MainThread = new Thread(new ThreadStart(startProcess));
        Thread ConsoleKeyListener = new Thread(new ThreadStart(ListerKeyBoardEvent));
        MainThread.Name = "Processor";
        ConsoleKeyListener.Name = "KeyListener";
        MainThread.Start();
        ConsoleKeyListener.Start();

        while (true) 
        {
            if (Terminate)
            {
                Console.WriteLine("Terminating Process...");
                MainThread.Abort();
                ConsoleKeyListener.Abort();
                Thread.Sleep(2000);
                Thread.CurrentThread.Abort();
                return;
            }

            if (stopProcessor)
            {
                Console.WriteLine("Ending Process...");
                MainThread.Abort();
                ConsoleKeyListener.Abort();
                Thread.Sleep(2000);
                Thread.CurrentThread.Abort();
                return;
            }
        } 
    }

    public static void ListerKeyBoardEvent()
    {
        do
        {
            if (Console.ReadKey(true).Key == ConsoleKey.Escape)
            {
                Terminate = true;
            }
        } while (true); 
    }

    public static void startProcess()
    {
        int i = 0;
        while (true)
        {
            if (!stopProcessor && !Terminate)
            {
                Console.ForegroundColor = ConsoleColor.White;
                Console.WriteLine("Processing...." + i++);
                Thread.Sleep(3000);
            }
            if(i==10)
                stopProcessor = true;

        }
    }

}

Answer 6

如果您使用的是 Visual Studio，那么您可以使用“调试”菜单中的“开始时不进行调试”。

它会自动写“按任意键继续......” 应用程序完成后为您发送到控制台，它将使控制台为您打开，直到按下一个键。

Answer 7

解决其他一些答案处理不好的情况：

• 响应式：直接执行按键处理代码； 避免轮询或阻塞延迟的变幻莫测
• 可选性：全局按键是可选的； 否则应用程序应该正常退出
• 关注点分离：侵入性较小的监听代码； 独立于普通控制台应用程序代码运行。

---

此页面上的许多解决方案都涉及轮询Console.KeyAvailable或阻止Console.ReadKey 。 虽然 .NET Console确实在这里不是很合作，但您可以使用Task.Run转向更现代的Async监听模式。

要注意的主要问题是，默认情况下，您的控制台线程未设置为Async操作 - 这意味着，当您从main function 的底部掉出时，您的Async和过程将结束。 解决此问题的正确方法是使用 Stephen Cleary 的AsyncContext在单线程控制台程序中建立完整的Async支持。 但是对于更简单的情况，比如等待按键，安装完整的蹦床可能是矫枉过正。

下面的示例适用于在某种迭代批处理文件中使用的控制台程序。 在这种情况下，当程序完成其工作时，通常它应该在不需要按键的情况下退出，然后我们允许可选按键以防止应用程序退出。 我们可以暂停循环来检查事情，可能会恢复，或者使用暂停作为一个已知的“控制点”，在该控制点处干净地打破批处理文件。

static void Main(String[] args)
{
    Console.WriteLine("Press any key to prevent exit...");
    var tHold = Task.Run(() => Console.ReadKey(true));

    // ... do your console app activity ...

    if (tHold.IsCompleted)
    {
#if false   // For the 'hold' state, you can simply halt forever...
        Console.WriteLine("Holding.");
        Thread.Sleep(Timeout.Infinite);
#else                            // ...or allow continuing to exit
        while (Console.KeyAvailable)
            Console.ReadKey(true);     // flush/consume any extras
        Console.WriteLine("Holding. Press 'Esc' to exit.");
        while (Console.ReadKey(true).Key != ConsoleKey.Escape)
            ;
#endif
    }
}

Answer 8

使用以下代码，您可以在控制台执行过程中侦听空格键并暂停，直到按下另一个键，并额外选择侦听 Escape 键以中断主循环。

static ConsoleKeyInfo cki = new ConsoleKeyInfo();

while(true) {
      if (WaitOrBreak()) break;
      //your main code
}

private static bool WaitOrBreak(){
    if (Console.KeyAvailable) cki = Console.ReadKey(true);
    if (cki.Key == ConsoleKey.Spacebar)
    {
        Console.Write("waiting..");
        while (Console.KeyAvailable == false)
        {
            Thread.Sleep(250);Console.Write(".");
        }
        Console.WriteLine();
        Console.ReadKey(true);
        cki = new ConsoleKeyInfo();
    }
    if (cki.Key == ConsoleKey.Escape) return true;
    return false;
}

Answer 9

根据我的经验，在控制台应用程序中读取最后按下的键的最简单方法如下（箭头键示例）：

ConsoleKey readKey = Console.ReadKey ().Key;
if (readKey == ConsoleKey.LeftArrow) {
    <Method1> ();  //Do something
} else if (readKey == ConsoleKey.RightArrow) {
    <Method2> ();  //Do something
}

我用来避免循环，而是在方法中编写上面的代码，并在“Method1”和“Method2”的末尾调用它，因此，在执行“Method1”或“Method2”之后，Console.ReadKey() .Key 已准备好再次读取密钥。

Answer 10

    Console.WriteLine("Hello");
var key = Console.ReadKey(); 
DateTime start = DateTime.Now;
bool gotKey = Console.KeyAvailable;

while ((DateTime.Now - start).TotalSeconds < 2)                
{
    if (key.Key == ConsoleKey.Escape)
{
   
    Environment.Exit(0);
} 
    else if (key.Key == ConsoleKey.Enter)
{
    break  ;
}