《Java解惑》系列——02字符谜题——谜题23：不劳而获（java编程中的一些常见陷阱）

本文链接：https://blog.csdn.net/wangsr4java/article/details/24451405

知识点：

1、当心栅栏柱错误

2、在使用switch语句是，一定要牢记在每个case语句后加break；

3、在编程的时候，一定要使用惯用法和常见的API，当你偏离这个方向的时候，一定要参考相关的帮助文档；

4、在Java中，一个char不是一个string，它更像一个int。

问题：

下面的程序会打印什么？

import java.util.Random; 
public class Rhymes { 
   private static Random rnd = new Random(); 
   public static void main(String[] args) { 
      StringBuffer word = null; 
      switch(rnd.nextInt(2)) { 
          case 1:  word = new StringBuffer('P'); 
          case 2:  word = new StringBuffer('G'); 
          default: word = new StringBuffer('M'); 
      } 
      word.append('a'); 
      word.append('i'); 
      word.append('n'); 
      System.out.println(word); 
   } 
} 

// 期望结果：以相等的概率打印出Pain，Gain 或 Main。
// 实际结果：它总是在打印ain。

结果是不是出乎大家的意料呢？的确如此。
产生这个结果的原因：

乍一看，这个程序可能会在一次又一次的运行中，以相等的概率打印出Pain，
Gain 或 Main。看起来该程序会根据随机数生成器所选取的值来选择单词的第一
个字母：0选M，1选P，2选G。谜题的题目也许已经给你提供了线索，它实际
上既不会打印Pain，也不会打印Gain。也许更令人吃惊的是，它也不会打印Main，
并且它的行为不会在一次又一次的运行中发生变化，它总是在打印ain。

有三个 bug凑到一起引发了这种行为。你完全没有发现它们吗？

第一个 bug是：
所选取的随机数使得 switch语句只能到达其三种情况中的两种。
Random.nextInt(int)的规范描述道：“返回一个伪随机的、均等地分布在从0
（包括）到指定的数值（不包括）之间的一个 int 数值”[Java-API]。这意味着
表达式 rnd.nextInt(2)可能的取值只有 0 和 1，Switch语句将永远也到不了 case
2 分支，这表示程序将永远不会打印Gain。nextInt 的参数应该是3而不是 2。
这是一个相当常见的问题源，被熟知为“栅栏柱错误（fencepost error）”。
这个名字来源于对下面这个问题最常见的但却是错误的答案，如果你要建造一个
100英尺长的栅栏，其栅栏柱间隔为 10英尺，那么你需要多少根栅栏柱呢？11
根或9根都是正确答案，这取决于是否要在栅栏的两端树立栅栏柱，但是 10根
却是错误的。要当心栅栏柱错误，每当你在处理长度、范围或模数的时候，都要
仔细确定其端点是否应该被包括在内，并且要确保你的代码的行为要与其相对
应。

第二个 bug是：
在不同的情况（case）中没有任何 break语句。不论 switch表达
式为何值，该程序都将执行其相对应的 case 以及所有后续的 case[JLS 14.11]。
因此，尽管每一个 case 都对变量word赋了一个值，但是总是最后一个赋值胜出，
覆盖了前面的赋值。最后一个赋值将总是最后一种情况（default），即 new
StringBuffer{'M'}。这表明该程序将总是打印Main，而从来不打印Pain或Gain。
在 switch的各种情况中缺少break语句是非常常见的错误。从5.0版本起，javac
提供了-Xlint:fallthrough标志，当你忘记在一个 case 与下一个 case 之间添
加 break语句是，它可以生成警告信息。不要从一个非空的 case向下进入了另
一个 case。这是一种拙劣的风格，因为它并不常用，因此会误导读者。十次中
有九次它都会包含错误。如果 Java 不是模仿C建模的，那么它倒是有可能不需
要 break。对语言设计者的教训是：应该考虑提供一个结构化的 switch语句。

最后一个：
也是最微妙的一个 bug是表达式 new StringBuffer('M')可能没有做
哪些你希望它做的事情。你可能对StringBuffer(char)构造器并不熟悉，这很
容易解释：它压根就不存在。StringBuffer 有一个无参数的构造器，一个接受
一个String作为字符串缓冲区初始内容的构造器，以及一个接受一个 int 作为
缓冲区初始容量的构造器。在本例中，编译器会选择接受int 的构造器，通过拓
宽原始类型转换把字符数值'M'转换为一个 int 数值77[JLS 5.1.2]。换句话说，
new StringBuffer('M')返回的是一个具有初始容量77的空的字符串缓冲区。该
程序余下的部分将字符 a、i 和 n添加到了这个空字符串缓冲区中，并打印出该
字符串缓冲区那总是 ain 的内容。
为了避免这类问题，不管在什么时候，都要尽可能使用熟悉的惯用法和 API。如
果你必须使用不熟悉的 API，那么请仔细阅读其文档。在本例中，程序应该使用
常用的接受一个String的StringBuffer构造器。

解决方法：

1、解决了以上三个bug之后：

import java.util.Random; 
public class Rhymes1 {    
    private static Random rnd = new Random(); 
    public static void main(String[] args) { 
        StringBuffer word = null; 
        switch(rnd.nextInt(3)) { 
            case 1:   
                word = new StringBuffer("P"); 
                break; 
            case 2:   
                word = new StringBuffer("G"); 
                break; 
            default: 
                word = new StringBuffer("M"); 
                break; 
        } 
        word.append('a'); 
        word.append('i'); 
        word.append('n'); 
        System.out.println(word); 
    } 
}

2、一个比较优雅的版本：

import java.util.Random; 
public class Rhymes2 { 
   private static Random rnd = new Random(); 
   public static void main(String[] args) { 
      System.out.println("PGM".charAt(rnd.nextInt(3)) + "ain"); 
   } 
}

3、一个更加合理的版本：

import java.util.Random; 
public class Rhymes3 { 
   public static void main(String[] args) { 
      String a[] = {"Main","Pain","Gain"}; 
      System.out.println(randomElement(a)); 
   } 
   private static Random rnd = new Random(); 
   private static String randomElement(String[] a){ 
      return a[rnd.nextInt(a.length)]; 
   }       
}

总结：

总结一下：首先，要当心栅栏柱错误。其次，牢记在 switch 语句的每一个 case
中都放置一条 break 语句。第三，要使用常用的惯用法和 API，并且当你在离
开老路子的时候，一定要参考相关的文档。第四，一个 char 不是一个 String，
而是更像一个 int。最后，要提防各种诡异的谜题。