当前位置 博文首页 > 小胖小的博客:如何优雅的打印数组

    小胖小的博客:如何优雅的打印数组

    作者:[db:作者] 时间:2021-07-19 10:17

    如何优雅的打印数组

    以下文章来源于沉默王二 ,作者沉默王二
    https://mp.weixin.qq.com/s/20s0XSsdUE2qJDP4OtM-rw

    ? 在 Java 中,数组虽然是一个对象,但并未明确的定义这样一个类,因此也就没有覆盖 toString() 方法的机会。如果尝试直接打印数组的话,输出的结果并不是我们预期的结果。那有没有一些简单可行的方式呢?

    效果前置:

    package com.yucode.array;
    /*
     *purpose:探究数组打印的方法
     *
     */
    
    import java.util.Arrays;
    import java.util.stream.Stream;
    
    public class soutArray {
        public static void main(String[] args) {
            String[] a = {"小胖小","憔悴的","学Java的码农"};
            //直接打印
            System.out.println(a);
            System.out.println("==========");
            //for循环
            for (int i = 0; i < a.length; i++) {
                System.out.println(a[i]);
            }
            System.out.println("==========");
            //使用Stream
                //第一种
            Arrays.asList(a).stream().forEach(s -> System.out.println(s));
            System.out.println("==========");
                //第二种
            Stream.of(a).forEach(System.out::println);
            System.out.println("==========");
                //第三种
            Arrays.stream(a).forEach(System.out::println);
            System.out.println("==========");
            //Arrays.toString
            System.out.println(Arrays.toString(a));
            System.out.println("==========");
            //Arrays.deepToString
            String[][] deepArray ={{"小胖小","憔悴的"},{"学Java的码农"}};
            System.out.println(Arrays.toString(deepArray));
            System.out.println("==========");
            System.out.println(Arrays.deepToString(deepArray));
        }
    }
    
    

    [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-gMEvOmK1-1577425329167)(https://t1.picb.cc/uploads/2019/12/27/kCvAm6.png)]

    1、直接打印

    String[] a = {"小胖小","憔悴的","学Java的码农"};
            System.out.println(a);
    

    程序打印的结果是:

    [Ljava.lang.String;@7ef20235

    [Ljava.lang.String;表示字符串数组的Class名,@ 后面的是十六进制的hashcode——这样的打印结果太“人性化”了,一般人表示看不懂!为什么会这样显示呢?查看一下 java.lang.Object 类的 toString() 方法就明白了。

    public String toString() {
        return getClass().getName() + "@" + Integer.toHexString(hashCode());
    }
    

    PS:数组虽然没有显式定义成一个类,但它的确是一个对象,继承了祖先类 Object 的所有方法。

    那为什么数组不单独定义一个类来表示呢?就像字符串 String 类那样呢?

    一个合理的解释是 Java 将其隐藏了。假如真的存在一个 Array.java,我们也可以假想它真实的样子,它必须要定义一个容器来存放数组的元素,就像 String 类那样。

    public final class String
        implements java.io.Serializable, Comparable<String>, CharSequence {
        /** The value is used for character storage. */
        private final char value[];
    }
    

    但这样做真的有必要吗?为数组单独定义一个类,是不是有点画蛇添足的意味。

    2、使用 for 循环

    可以使用 for 循环对数组进行变量顺便打印的方式,甚至 for-each 也行。

    for(int i = 0; i < cmowers.length; i++){
        System.out.println(cmowers[i]);
    }
    
    for (String s : cmowers) {
        System.out.println(s);
    }
    

    但如果你是一名有追求的程序员的话,不免觉得这样的方式有点 low。

    3、使用Stream

    如果使用的是 JDK8 以上的版本,我们可以使用 Stream 这种时髦、fashion 的方式来遍历数组,顺带将其打印出来。

    第一种:

    Arrays.asList(cmowers).stream().forEach(s -> System.out.println(s));
    

    第二种:

    Stream.of(cmowers).forEach(System.out::println);
    

    第三种:

    Arrays.stream(cmowers).forEach(System.out::println);
    

    打印的结果如下所示。

    小胖小
    憔悴的
    学Java的码农
    

    没错,这三种方式都可以轻松胜任本职工作,并且显得有点高大上,毕竟用到了 Stream,以及 lambda 表达式。但在我心目中,它们并不是最优雅的方式。

    4、使用 Arrays.toString()

    Arrays.toString() 可以将任意类型的数组转成字符串,包括基本类型数组和引用类型数组,截个图大家感受一下。

    kCvMQT.png

    Arrays 类就不用我多做介绍了吧?虽然我的意思大家懂,但我还是忍不住要废话两句:该类包含了各种操作数组的便捷方法,与其命名为 Arrays,不如命名为 ArrayUtil。

    使用 Arrays.toString() 方法来打印数组再优雅不过了

    让我们来看一下代码示例。

    String[] a = {"小胖小","憔悴的","学Java的码农"};
    System.out.println(Arrays.toString(a));
    

    程序打印结果:

    [小胖小, 憔悴的, 学Java的码农]
    

    哇,打印格式不要太完美,不多不少!完全是我们预期的结果:[] 表明是一个数组,,点和空格用来分割元素。

    顺便再来看一下 toString() 方法的源码。

    public static String toString(Object[] a) {
        if (a == null)
            return "null";
    
        int iMax = a.length - 1;
        if (iMax == -1)
            return "[]";
    
        StringBuilder b = new StringBuilder();
        b.append('[');
        for (int i = 0; ; i++) {
            b.append(String.valueOf(a[i]));
            if (i == iMax)
                return b.append(']').toString();
            b.append(", ");
        }
    }
    

    1)如果数组为 null,那就返回“null”字符串,考虑很周全,省去了 NullPointerException 的麻烦。

    2)如果数组长度为 0,那就返回“[]”字符串。注意,此处没有使用 a.length == 0 进行判空,而是用了 a.length - 1 == -1,又为之后的 for 循环中的 i == iMax 埋下了伏笔,资源一点也没有浪费。

    3)for 循环中字符串的拼接更是巧妙,for 循环的条件中没有判断 i < a.length,而在循环体内使用了 i == iMax,这样有什么好处呢?

    通常来说,一般的程序员拼接字符串的时候是这样做的。

    StringBuilder b = new StringBuilder();
    b.append('[');
    for (int i = 0; i < cmowers.length; i++) {
        b.append(cmowers[i]);
        b.append(", ");
    }
    b.delete(b.length()-2, b.length());
    b.append(']');
    

    没错吧,非常的循规蹈矩,但比起 toString() 方法源码中的写法,就要相形见绌了。情不自禁地感慨一下啊:要想成为一名卓越的程序员,而不只是一名普通的程序员,最快的捷径就是学习 Java 的源码。

    5、使用 Arrays.deepToString()

    如果需要打印多维码数组的话,Arrays.toString() 就无能为力了。

    String[][] deepArray ={{"小胖小","憔悴的"},{"学Java的码农"}};
            System.out.println(Arrays.toString(deepArray));
    

    打印结果如下所示。

    [[Ljava.lang.String;@5f184fc6, [Ljava.lang.String;@3feba861]
    

    不不不,这不是我们期望的结果,怎么办呢?使用 Arrays.deepToString(),专为多维数组而生。

    String[][] deepArray = new String[][] {{"小胖小","憔悴的"},{"学Java的码农"}};
    System.out.println(Arrays.deepToString(deepArray));
    

    打印结果如下所示。

    [[小胖小, 憔悴的], [学Java的码农]]
    
    cs