34

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


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

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

常见的扫描仪问题:

大多数Scanner问题包括在不止一项这些事情上的失败尝试。

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

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

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

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

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

动机:

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

使用Scanner意味着这个问题和答案提到的所有其他事情。这不仅仅是关于Scanner如何解决这些常见问题,而这些Scanner问题在几乎所有出错的问题中总是伴随着病态问题Scanner。它不仅仅是关于next()vsnextLine(),这只是类实现的挑剔的一个症状,代码中总是有其他问题发布在询问关于的问题中Scanner

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

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

Scanner是关于最小惊讶原则的重要性以及为什么一致的行为和语义在命名方法和方法参数中很重要的一个很好的教学时刻。

学生须知:

您可能永远不会真正看到Scanner在专业/商业业务线应用程序中使用它,因为它所做的一切都被其他东西做得更好。现实世界的软件必须比Scanner允许您编写代码更具弹性和可维护性。现实世界的软件使用标准化的文件格式解析器和文档化的文件格式,而不是您在独立作业中获得的临时输入格式。

4

1 回答 1

24

惯用例:

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

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);
    }
}

笔记:

这可能看起来像很多代码,但它说明了Scanner正确使用该类所需的最少工作量,并且不必处理困扰那些新编程人员的细微错误和副作用以及这个被称为 java.util.Scanner. 它试图说明惯用的 Java 代码的外观和行为方式。

以下是我在编写此示例时正在考虑的一些事情:

JDK版本:

我故意让这个示例与 JDK 6 兼容。如果某些场景确实需要 JDK 7/8 的功能,我或其他人将发布一个新答案,其中详细说明如何为该版本的 JDK 修改它。

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

处理命令:

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

天真的调度员

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

错误处理

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

.hasNext().hasNextXxx()

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

.nextXXX()对比.nextLine()

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

这些.nextXXX()方法不消耗行尾。.nextLine()做。

这意味着.nextLine()之后立即调用.nextXXX()只会返回行尾。您必须再次调用它才能真正获得下一行。

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

不变性:

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

  1. 没有nulls就没有可能 NullPointerExceptions

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

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

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

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

使用 Set 而不是大块switchif/elseif块:

请注意我如何使用 aSet<String>和 use.contains()来对命令进行分类,而不是使用会导致代码膨胀并且更重要的是使维护成为噩梦的庞大switch或怪物!添加新的重载命令就像在构造函数中向数组if/elseif添加新命令一样简单。String

这也可以很好地与i18nandi10n和 proper一起使用ResourceBundles。AMap<Locale,Set<String>>可以让您以很少的开销获得多语言支持!

@Nonnull

我已经决定我的所有代码都应该明确声明如果某事是@Nonnull@Nullable. 它可以让您的 IDE 帮助警告您潜在的NullPointerException危险以及何时不必检查。

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

调用 .close()

在你做之前真的考虑一下这个。

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

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

于 2014-10-19T02:14:43.283 回答