Java | オブジェクト指向:toString のオーバーライド

Java Java
スポンサーリンク

toString をオーバーライドする意味

toString は「そのオブジェクトを人間が読める文字列にする」ためのメソッドです。デフォルトはクラス名+ハッシュ(例: com.example.User@1a2b3c)で、ほとんど役に立ちません。オーバーライドして意味のある情報(主要フィールド、状態の要約)を返すと、ログ・デバッグ・例外メッセージ・REPLでの確認が段違いに楽になります。


どんな情報を出すべきか(重要ポイントの深掘り)

主要な識別情報と要約

「そのインスタンスが何であるか」がひと目で分かる文字列にします。ID、名前、重要な数値、状態フラグなど、読み取りに必要な最小限に絞るのがコツです。

public final class User {
    private final String id;
    private final String name;
    private final boolean active;

    public User(String id, String name, boolean active) {
        this.id = id; this.name = name; this.active = active;
    }
    @Override public String toString() {
        return "User{id=" + id + ", name=" + name + ", active=" + active + "}";
    }
}
Java

機密情報は出さない

パスワード、トークン、個人情報の生データは toString に含めないでください。ログ経由で漏れます。必要なら「マスク(先頭のみ)」「長さだけ」などに変換します。

public final class Credential {
    private final String token; // 機密
    @Override public String toString() {
        var masked = token == null ? "null" : token.substring(0, Math.min(4, token.length())) + "...";
        return "Credential{token=" + masked + "}";
    }
}
Java

再帰や巨大データは避ける

相互参照するオブジェクトや巨大コレクションをそのまま展開すると、無限ループ・超長文・性能劣化を招きます。サイズや件数の要約に留めましょう。

public final class Cart {
    private final java.util.List<Item> items;
    @Override public String toString() {
        return "Cart{items=" + items.size() + "}";
    }
}
Java

実装の型とフォーマットの選び方

人が読む形式(Key=Value の簡潔表記)

読みやすさ最優先なら「Class{key=value, …}」形式が定番です。フィールド順は「識別 → 名前 → 主要値→ 状態」のように論理順に。

@Override public String toString() {
    return "Order{id=" + id + ", total=" + total + ", status=" + status + "}";
}
Java

JSON風の表記(機械処理にも親和性)

ログを後処理したいなら簡易JSON風にすると解析しやすくなります(完全なJSONはシリアライザに任せるのが本来は安全)。

@Override public String toString() {
    return "{\"id\":\"" + id + "\",\"total\":" + total + ",\"status\":\"" + status + "\"}";
}
Java

可変長テキストは短縮

説明文や本文など長い文字列は先頭数十文字+長さの要約に。行を増やす改行は基本避け、ログ1行で読める形に。

private static String preview(String s, int n) {
    if (s == null) return "null";
    return (s.length() <= n) ? s : (s.substring(0, n) + "...(" + s.length() + ")");
}
Java

equals/hashCode と toString の関係(重要ポイントの深掘り)

比較基準と表示の一貫性

equals/hashCode で同値とみなすフィールドが、toString にも含まれていると読解が楽になります。厳密な義務ではありませんが、ログで「同値に見えるのに表示が違う」混乱を避けられます。

変更可能フィールドの扱い

可変フィールドを多く含めた詳細 toString は、ログの時点での“スナップショット”になります。追跡に有用ですが、巨大化・機密漏洩に注意し、要約+識別子中心にするのが安全です。


例外・ログでの使いどころ

例外メッセージに差し込む

失敗時に「何がダメだったか」を toString で簡潔に出せると、調査が飛躍的に速くなります。

if (total < 0) throw new IllegalArgumentException("invalid " + order);
Java

構造化ログのキーとして

toString では要約を、詳細は別の構造化フィールド(JSON)に分ける設計も有効。表示と解析の両立が取れます。


コレクション・ネストのベストプラクティス

コレクションは件数+代表例

全件を展開せず、size と数件の代表(先頭1〜3件)だけを載せると、情報量と読みやすさのバランスが取れます。

private static String summary(java.util.List<String> xs) {
    int n = xs.size();
    var head = xs.stream().limit(3).toList();
    return "size=" + n + ", head=" + head;
}
Java

ネストは深さを制限

入れ子の toString 呼び出しは1〜2段まで。深すぎる構造は「idのみ」「件数のみ」に切り替えます。


レコードや自動生成の活用

record の自動 toString

record はフィールドを列挙した toString を自動生成します。簡潔で有用ですが、機密・巨大データが含まれる場合は明示オーバーライドでマスク・要約を入れます。

public record Point(int x, int y) {
    // 既定の toString: Point[x=..., y=...]
}
Java

Lombok の @ToString

Lombok を使うなら @ToString(exclude = “secret”) や @ToString.Include で制御可能。ただし機密方針は明示的なコードで担保する癖をつけると安全です。


例題で身につける

例 1: 読みやすさ重視の toString

public final class Order {
    private final String id;
    private final int total;
    private final String status;
    private final java.util.List<String> items;
    public Order(String id, int total, String status, java.util.List<String> items) {
        this.id = id; this.total = total; this.status = status; this.items = java.util.List.copyOf(items);
    }
    @Override public String toString() {
        return "Order{id=" + id + ", total=" + total + ", status=" + status + ", items(" + items.size() + ")}";
    }
}
Java

例 2: 機密マスク+要約

public final class Payment {
    private final String cardNumber;  // 機密
    private final String holder;
    @Override public String toString() {
        var mask = (cardNumber == null || cardNumber.length() < 4)
            ? "****" : "****-****-****-" + cardNumber.substring(cardNumber.length() - 4);
        return "Payment{card=" + mask + ", holder=" + holder + "}";
    }
}
Java

例 3: 大きな本文を短縮して表示

public final class Article {
    private final String id;
    private final String title;
    private final String body; // 長文
    @Override public String toString() {
        return "Article{id=" + id + ", title=" + title + ", body=" + preview(body, 40) + "}";
    }
    private static String preview(String s, int n) {
        if (s == null) return "null";
        return (s.length() <= n) ? s : (s.substring(0, n) + "...(" + s.length() + ")");
    }
}
Java

仕上げのアドバイス(重要部分のまとめ)

toString は「人が状況を一瞬で掴むための窓」。主要識別子と要約を短く、機密は出さず、巨大データは縮約。再帰・膨張を避け、equals/hashCode の基準と表示の意図を揃えると、ログ・デバッグ・例外調査が劇的に楽になります。まずは「Class{key=value}」の定番形で始め、必要に応じて要約・マスクを組み込みましょう。

タイトルとURLをコピーしました