如何使用java.util.Scanner从 System.in 正确读取用户输入并采取行动?

How to use java.util.Scanner to correctly read user input from System.in and act on it?

提问人: 提问时间:10/19/2014 更新时间:9/11/2018 访问量:27067

问:

这是一个规范的问题/答案,可以用作 重复目标。这些要求基于最常见的 每天发布问题,并可能根据需要添加。他们都是 需要相同的基本代码结构才能访问每个方案 它们通常相互依赖。


Scanner 似乎是一个“简单”的类,这就是第一个错误所在。这并不简单,它有各种不明显的副作用和异常行为,以非常微妙的方式打破了最小惊讶原则

因此,对于这门课来说,这似乎是矫枉过正,但剥洋葱的错误和问题都很简单,但由于它们的相互作用和副作用,它们加在一起非常复杂。这就是为什么每天在 Stack Overflow 上有很多关于它的问题。

常见的扫描仪问题:

大多数问题包括对其中不止一件事情的失败尝试。Scanner

  1. 我希望我的程序能够在每个前一个输入之后自动等待下一个输入。

  2. 我想知道如何检测退出命令并在输入该命令时结束我的程序。

  3. 我想知道如何以不区分大小写的方式匹配退出命令的多个命令。

  4. 我希望能够匹配正则表达式模式以及内置的基元。例如,如何匹配看似日期 ( ) 的内容?2014/10/18

  5. 我想知道如何匹配那些可能不容易用正则表达式匹配实现的东西 - 例如,URL ( )。http://google.com

赋予动机:

在Java的世界里,是一个特例,这是一个非常挑剔的班级,老师不应该给新生使用指令。在大多数情况下,教师甚至不知道如何正确使用它。它几乎从未在专业生产代码中使用过,因此它对学生的价值非常值得怀疑。Scanner

使用意味着本问答提到的所有其他内容。它从来都不仅仅是关于如何解决这些常见问题,而这些问题在几乎所有出错的问题中总是共病的问题。这绝不仅仅是关于 next()nextLine(),这只是类实现挑剔的症状,在询问 .ScannerScannerScannerScannerScanner

答案显示了 99% 在 StackOverflow 上使用和询问的案例的完整、惯用的实现。Scanner

尤其是在初学者代码中。如果您认为这个答案太复杂,那么在解释其行为的复杂性、怪癖、不明显的副作用和特殊性之前,先向告诉新学生使用的教师抱怨。Scanner

Scanner这是一个很好的教学时刻,说明最小惊讶原则的重要性,以及为什么一致的行为和语义在命名方法和方法论证中很重要。

学生须知:

您可能永远不会真正看到用于 专业/商业业务线应用程序,因为一切 做现实世界的软件必须是 比允许您编写的更具弹性和可维护性 法典。真实世界的软件使用标准化的文件格式解析器和 记录的文件格式,而不是您使用的临时输入格式 在独立作业中给出。ScannerScanner

Java java.util.scanner system.in

评论


答:

25赞 27 revsuser177800 #1

惯用的例子:

以下是如何正确使用类以交互方式正确读取用户输入(有时称为 ,特别是在 C、C++ 和其他语言以及 Unix 和 Linux 中)。它惯用地展示了要求完成的最常见的事情。java.util.ScannerSystem.instdin

package com.stackoverflow.scanner;

import javax.annotation.Nonnull;
import java.math.BigInteger;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.*;
import java.util.regex.Pattern;

import static java.lang.String.format;

public class ScannerExample
{
    private static final Set<String> EXIT_COMMANDS;
    private static final Set<String> HELP_COMMANDS;
    private static final Pattern DATE_PATTERN;
    private static final String HELP_MESSAGE;

    static
    {
        final SortedSet<String> ecmds = new TreeSet<String>(String.CASE_INSENSITIVE_ORDER);
        ecmds.addAll(Arrays.asList("exit", "done", "quit", "end", "fino"));
        EXIT_COMMANDS = Collections.unmodifiableSortedSet(ecmds);
        final SortedSet<String> hcmds = new TreeSet<String>(String.CASE_INSENSITIVE_ORDER);
        hcmds.addAll(Arrays.asList("help", "helpi", "?"));
        HELP_COMMANDS = Collections.unmodifiableSet(hcmds);
        DATE_PATTERN = Pattern.compile("\\d{4}([-\\/])\\d{2}\\1\\d{2}"); // http://regex101.com/r/xB8dR3/1
        HELP_MESSAGE = format("Please enter some data or enter one of the following commands to exit %s", EXIT_COMMANDS);
    }

    /**
     * Using exceptions to control execution flow is always bad.
     * That is why this is encapsulated in a method, this is done this
     * way specifically so as not to introduce any external libraries
     * so that this is a completely self contained example.
     * @param s possible url
     * @return true if s represents a valid url, false otherwise
     */
    private static boolean isValidURL(@Nonnull final String s)
    {
        try { new URL(s); return true; }
        catch (final MalformedURLException e) { return false; }
    }

    private static void output(@Nonnull final String format, @Nonnull final Object... args)
    {
        System.out.println(format(format, args));
    }

    public static void main(final String[] args)
    {
        final Scanner sis = new Scanner(System.in);
        output(HELP_MESSAGE);
        while (sis.hasNext())
        {
            if (sis.hasNextInt())
            {
                final int next = sis.nextInt();
                output("You entered an Integer = %d", next);
            }
            else if (sis.hasNextLong())
            {
                final long next = sis.nextLong();
                output("You entered a Long = %d", next);
            }
            else if (sis.hasNextDouble())
            {
                final double next = sis.nextDouble();
                output("You entered a Double = %f", next);
            }
            else if (sis.hasNext("\\d+"))
            {
                final BigInteger next = sis.nextBigInteger();
                output("You entered a BigInteger = %s", next);
            }
            else if (sis.hasNextBoolean())
            {
                final boolean next = sis.nextBoolean();
                output("You entered a Boolean representation = %s", next);
            }
            else if (sis.hasNext(DATE_PATTERN))
            {
                final String next = sis.next(DATE_PATTERN);
                output("You entered a Date representation = %s", next);
            }
            else // unclassified
            {
                final String next = sis.next();
                if (isValidURL(next))
                {
                    output("You entered a valid URL = %s", next);
                }
                else
                {
                    if (EXIT_COMMANDS.contains(next))
                    {
                        output("Exit command %s issued, exiting!", next);
                        break;
                    }
                    else if (HELP_COMMANDS.contains(next)) { output(HELP_MESSAGE); }
                    else { output("You entered an unclassified String = %s", next); }
                }
            }
        }
        /*
           This will close the underlying InputStream, in this case System.in, and free those resources.
           WARNING: You will not be able to read from System.in anymore after you call .close().
           If you wanted to use System.in for something else, then don't close the Scanner.
        */
        sis.close();
        System.exit(0);
    }
}

笔记:

这可能看起来像很多代码,但它说明了最小值 正确使用类需要付出努力,而不必这样做 处理困扰新手的微妙错误和副作用 编程和这个非常实现的类称为 .它试图说明哪些惯用的 Java 代码 应该看起来像和表现得像。Scannerjava.util.Scanner

以下是我在写这个例子时考虑的一些事情:

JDK版本:

我特意让这个例子与 JDK 6 兼容。如果某些场景确实需要 JDK 7/8 的功能,我或其他人将发布一个新的答案,其中包含有关如何为该版本 JDK 修改此功能的详细信息。

关于这门课的大多数问题都来自学生,他们通常对可以用来解决问题的内容有限制,所以我尽可能地限制了这一点,以展示如何在没有任何其他依赖关系的情况下做常见的事情。在 22+ 年中,我一直在使用 Java 并咨询大部分时间,在我见过的数百万行源代码的 10 中,我从未遇到过专业使用此类的情况。

处理命令:

这准确地显示了如何以交互方式从用户那里读取命令并调度这些命令。大多数问题都是关于当我进入某些特定的输入类别时如何让我的程序退出。这清楚地表明了这一点。java.util.Scanner

朴素调度程序

调度逻辑是故意幼稚的,以免使新读者的解决方案复杂化。基于 或 模式的调度程序将更适合于更复杂的现实世界问题。Strategy PatternChain Of Responsibility

错误处理

该代码的结构是故意设计的,不需要处理,因为不存在某些数据可能不正确的情况。Exception

.hasNext().hasNextXxx()

我很少看到有人正确使用 ,通过测试泛型来控制事件循环,然后使用惯用语可以让你决定如何以及如何处理你的代码,而不必担心在没有可用代码时请求,因此没有异常处理代码。.hasNext().hasNext()if(.hasNextXxx())int

.nextXXX().nextLine()

这是破坏每个人代码的东西。这是一个挑剔的细节,不应该被处理,并且有一个非常混乱的错误,很难推理,因为它打破了最小惊讶的原则

这些方法不使用行尾。 确实如此。.nextXXX().nextLine()

这意味着紧随其后的调用将只返回行尾。您必须再次调用它才能实际获取下一行。.nextLine().nextXXX()

这就是为什么许多人主张要么只使用方法,要么只使用但不同时使用这两种方法,这样这种挑剔的行为就不会绊倒你。就我个人而言,我认为类型安全方法比必须手动测试、解析和捕获错误要好得多。.nextXXX().nextLine()

不变性:

请注意,代码中没有使用可变变量,这对于学习如何操作很重要,它消除了运行时错误和细微错误的四个最主要来源。

  1. 不意味着没有可能!nullsNullPointerExceptions

  2. 无可变性意味着您不必担心方法参数更改或其他任何更改。当您逐步调试时,您永远不必使用来查看哪些变量更改为哪些值(如果它们正在更改)。这使得逻辑在阅读时 100% 确定。watch

  3. 无可变性意味着您的代码自动是线程安全的。

  4. 无副作用。如果什么都不能改变,你就不必担心一些边缘情况会意外改变一些微妙的副作用!

如果您不了解如何在自己的代码中应用最后一个关键字,请阅读本文。

使用 Set 代替 massive 或 blocks:switchif/elseif

请注意,我如何使用 a 和 use 来对命令进行分类,而不是使用大量或怪物,这会使您的代码膨胀,更重要的是使维护成为一场噩梦!添加新的重载命令就像在构造函数中向数组添加一个新命令一样简单。Set<String>.contains()switchif/elseifString

这也适用于 和 适当的. A 可以让您以很少的开销获得多种语言支持!i18ni10nResourceBundlesMap<Locale,Set<String>>

@Nonnull

我已经决定我所有的代码都应该明确声明某些东西是 or 。它让您的 IDE 帮助警告您潜在的危险以及您何时不必检查。@Nonnull@NullableNullPointerException

最重要的是,它记录了对未来读者的期望,即这些方法参数都不应该是 。null

调用 .close()

在你做之前,真的想一想这个。

如果你打电话,你认为会发生什么?请参阅上面列表中的评论。System.insis.close()

分叉并发送拉取请求,我将针对其他基本使用场景更新此问题和答案。

评论

28赞 corsiKa 8/16/2017
我认为这个答案中的信噪比太低了。它应该是关于 Scanner 的,但还有诸如不变性、集合与开关以及许多其他东西之类的东西。当你四处走动,将可以在 3 行代码中回答的问题标记为重复时,你只会混淆它们。与 NRE 规范相比,NRE 需要这种深度。扫描仪没有。