Java の文字列フォーマット: String.format、printf、書式指定子

整形の2つの方法

Java は、書式指定子（% のプレースホルダー）を含むテンプレートと、そこに差し込む値から文字列を整形します。入口は2つあり、どちらも同一の構文を共有します:

• String.format(template, values...) は新しい String を返します。
• System.out.printf(template, values...) は結果を直接出力します。

public class Main {
    public static void main(String[] args) {
        String name = "Ada";
        int age = 36;

        String line = String.format("%s is %d years old", name, age);
        System.out.println(line);

        System.out.printf("%s is %d years old%n", name, age);
    }
}

どちらも同じテキストを生成します。String.format はそれを返すので保存できます。printf はそれをコンソールに書き込みます。printf テンプレートの末尾にある %n に注目してください - これはプラットフォームに依存しない改行です（書式文字列では \n より優先して使いましょう）。

よく使う書式指定子

各指定子は % で始まり、どの種類の値を期待するかを示す文字で終わります:

public class Main {
    public static void main(String[] args) {
        System.out.printf("string: %s%n", "hello");
        System.out.printf("integer: %d%n", 42);
        System.out.printf("float: %f%n", 3.14);
        System.out.printf("boolean: %b%n", true);
        System.out.printf("char: %c%n", 'A');
        System.out.printf("hex: %x%n", 255);
        System.out.printf("percent sign: %%%n");
    }
}

日常的に使う3つは %s（任意の値、その toString 経由）、%d（整数）、%f（小数）です。リテラルのパーセント記号を出力するには %% を使います。間違った型を渡すと - 例えば %d に String を渡すと - 実行時に IllegalFormatConversionException がスローされます。

小数桁の制御

%f はデフォルトで小数6桁になり、これは望むものであることはまれです。精度を固定するには f の前に .N を置きます（値は丸められます）:

public class Main {
    public static void main(String[] args) {
        double price = 3.14159;

        System.out.printf("%f%n", price);     // 3.141590
        System.out.printf("%.2f%n", price);   // 3.14
        System.out.printf("%.0f%n", price);   // 3
    }
}

大きな数値の桁区切りにはカンマフラグを追加します:

public class Main {
    public static void main(String[] args) {
        double total = 1234567.891;
        System.out.printf("%,.2f%n", total);   // 1,234,567.89
    }
}

幅とパディング

% と型を表す文字の間に置いた数値は最小フィールド幅を設定し、列が揃うようにスペースで埋めます。先頭の - は左揃え、先頭の 0 は数値をゼロで埋めます:

public class Main {
    public static void main(String[] args) {
        System.out.printf("[%10s]%n", "hi");    // right-aligned in 10 cols
        System.out.printf("[%-10s]%n", "hi");   // left-aligned
        System.out.printf("[%05d]%n", 42);      // zero-padded to width 5
    }
}

これこそが、整形された表や揃ったレポートを読みやすくするものです:

public class Main {
    public static void main(String[] args) {
        String[] names = {"Ada", "Boris", "Chen"};
        int[] scores = {95, 8, 142};

        for (int i = 0; i < names.length; i++) {
            System.out.printf("%-8s %5d%n", names[i], scores[i]);
        }
    }
}

%-8s は名前を幅8の列で左揃えにし、%5d はスコアを幅5の列で右揃えにするので、桁数に関係なく数値が揃います。

引数の順序

デフォルトでは、指定子は値を左から右へ消費します。N$（1始まりのインデックス）を使えば値を繰り返したり順序を変えたりでき、同じ値が2回現れるときに便利です:

public class Main {
    public static void main(String[] args) {
        System.out.printf("%1$s, %1$s, hello %2$s%n", "echo", "world");
    }
}

%1$s は両方とも最初の引数を参照するので、echo が2回出力されます。

formatted() メソッド

Java 15 以降、すべての文字列に formatted インスタンスメソッドがあります - String.format と同じエンジンを、テンプレートに対するメソッド呼び出しとして書いたものです:

public class Main {
    public static void main(String[] args) {
        String msg = "%s scored %d".formatted("Ada", 95);
        System.out.println(msg);
    }
}

より大きな整形済み出力を組み立てるとき、テキストブロック（三重引用符の複数行文字列）と特に相性がよいです。

String.format を使わないほうがよい場合

単純な一度きりの連結なら、+ による素朴な連結のほうが明快で速いです:

String greeting = "Hi, " + name + "!";   // simpler than String.format here

固定の小数桁、パディング、揃え、桁区切りといった本当の整形が必要なときに String.format / printf を使いましょう。いくつかの値を貼り合わせるだけのときではありません。

次: 演算子

整形は値をテキストに変えます。そもそもその値を計算するには、Java の演算子 - 算術、比較、論理 - が必要です。それが次のページです。