Метод Arrays.deepToString() в Java

Метод Arrays.deepToString() в Java возвращает строковое представление многомерного массива: он рекурсивно обходит вложенные массивы и выделяет каждый уровень квадратными скобками. Это самый короткий способ вывести двумерный или многомерный массив в консоль без циклов. Метод объявлен в классе java.util.Arrays:

public static String deepToString(Object[] a)

Пример: двумерный массив в строку

Передадим методу двумерный массив строк — Arrays.deepToString() вернёт содержимое обоих уровней вложенности:

import java.util.Arrays;

public class ArraysDeepToStringExample {
    public static void main(String[] args) {
        String[][] array = {{"один-один", "один-два", "один-три"},
                {"два-один", "два-два", "два-три"}};
        System.out.println(Arrays.deepToString(array));
    }
}

Вывод программы:

[[один-один, один-два, один-три], [два-один, два-два, два-три]]

Внешние скобки соответствуют всему массиву, внутренние — каждой его строке. Метод работает с любой глубиной вложенности: трёхмерный массив даст три уровня скобок, и так далее.

Отличие от Arrays.toString()

У класса Arrays есть похожий метод — Arrays.toString(). Он обходит только первый уровень массива: каждый элемент преобразуется вызовом его собственного toString(). Для двумерного массива элементами первого уровня являются вложенные массивы, а массивы не переопределяют toString() — поэтому вместо содержимого печатаются тип и хеш-код:

String[][] array = {{"один-один", "один-два"}, {"два-один", "два-два"}};

System.out.println(Arrays.toString(array));
System.out.println(Arrays.deepToString(array));

Вывод программы:

[[Ljava.lang.String;@1b6d3586, [Ljava.lang.String;@4554617c]
[[один-один, один-два], [два-один, два-два]]

Массивы примитивов

Двумерный массив примитивов, например int[][], передать в deepToString() можно: его элементы первого уровня — это объекты типа int[], поэтому такой массив совместим с параметром Object[]:

int[][] matrix = {{1, 2, 3}, {4, 5, 6}};
System.out.println(Arrays.deepToString(matrix));

Вывод программы:

[[1, 2, 3], [4, 5, 6]]

null и самоссылающиеся массивы

Метод аккуратно обрабатывает граничные случаи, на которых «ручной» рекурсивный вывод обычно падает:

• если аргумент равен null, возвращается строка "null";
• вложенные null-элементы также печатаются как null;
• если массив прямо или косвенно содержит ссылку на самого себя, вместо бесконечной рекурсии на этом месте выводится "[...]".

Object[] selfRef = new Object[2];
selfRef[0] = "первый";
selfRef[1] = selfRef; // массив ссылается сам на себя

System.out.println(Arrays.deepToString(selfRef));

Вывод программы:

[первый, [...]]

Для сравнения и хеширования многомерных массивов в классе Arrays есть парные методы с той же «глубокой» семантикой — Arrays.deepEquals() и Arrays.deepHashCode().

Презентация с видео на Patreon →