帳票のプレビューと保存を伴う確定を、メソッド名で分ける記事のアイキャッチ

設計・テスト・レビュー

Javaのboolean引数が読みにくい|プレビューと確定をメソッド名で分ける

経理の帳票画面で「プレビュー」を押しただけなのに、正式な帳票が保存されました。表示された合計は合っているので、画面を見ただけでは気づきません。プレビュー画面のコードを開くと、帳票を作る generate の最後に true が渡されていました。

帳票の計算は同じでも、表示するだけの操作と、保存を伴う操作では約束が違います。呼ぶ側が preview と publish を選べるようにし、合計を求める処理だけを共通にします。

この記事でわかること

  • generate(..., true) の呼び出しで、プレビューが保存される理由
  • preview と publish を分けながら、帳票の計算を一か所に置く方法
  • booleanを残す場面と、戻り値・保存件数で変更を確かめる方法

記事と同じコードを実行する

ZIPを展開し、JDK 17とMaven 3.9系で mvn test を実行します。修正版のJava、旧プレビューを再現するテスト用コード、JUnitテスト、pom.xml、READMEを収録。保存回数はテストごとのリストで確認できます。

サンプルZIPをダウンロード GitHubでコード全文と実行手順を見る

プレビューの呼び出しがtrueを渡し、正式な帳票を1件保存した

2026年11月5日の購入明細1,200円と800円を帳票にします。プレビュー画面は合計2,000円を表示するだけのはずです。旧コードでは LegacyReportScreen.showPreview が generate(reportDate, amountsYen, true) を呼び、generate は save が真なら帳票を保存します。

旧プレビューの呼び出し(再現用コードの抜粋)

Report showPreview(LocalDate reportDate, List<Integer> amountsYen) {
    return service.generate(reportDate, amountsYen, true);
}

最後の true を見ても、帳票を表示するか、保存するかは呼び出し行だけでは分かりません。メソッド定義で引数名が save だと分かって初めて、「プレビューなのに保存する」という矛盾が読めます。false を渡せば帳票は同じで、保存だけが起きなくなります。

LegacyReportScreen.java(全文)
package info.syachiku.reports;

import java.time.LocalDate;
import java.util.List;

final class LegacyReportScreen {
    private final LegacyReportService service;

    LegacyReportScreen(LegacyReportService service) {
        this.service = service;
    }

    Report showPreview(LocalDate reportDate, List<Integer> amountsYen) {
        return service.generate(reportDate, amountsYen, true);
    }
}

final class LegacyReportService {
    private final ReportStore store;

    LegacyReportService(ReportStore store) {
        this.store = store;
    }

    Report generate(LocalDate reportDate, List<Integer> amountsYen, boolean save) {
        long totalYen = amountsYen.stream().mapToLong(Integer::longValue).sum();
        Report report = new Report(reportDate, totalYen);
        if (save) {
            store.save(report);
        }
        return report;
    }
}

配布ZIPでは旧画面と旧サービスをテスト専用のファイルに置いています。再現テストは、誤った呼び出しで2,000円の帳票が返り、保存も1回起きることをあえて期待します。テストが緑になった理由は、不具合が起きる条件を確認できたためです。画面を直した後の「保存0回」は、別のテストで確かめます。

同じ明細から同じ帳票を返し、確定だけが保存する

操作返す帳票保存
プレビュー2026年11月5日、合計2,000円0回
確定2026年11月5日、合計2,000円返した帳票を1回保存

確定の前にプレビューを何度見ても、正式な帳票は増えません。合計だけを確認するテストだと、保存する処理がプレビューに入っても通ります。変更する前に、返す帳票と保存の有無を別々の期待値にしておきます。この例の publish は、計算結果を正式な保存先へ渡す操作です。

操作の入口と保存は分け、帳票の計算は共有する
プレビュー画面preview(...)
確定ボタンpublish(...)
private buildReport(...)1,200円+800円 → 同じ2,000円の帳票
帳票を返す保存0回
保存して帳票を返す保存1回

公開する操作を分け、合計の計算はprivateに置く

ReportService.java(全文)

package info.syachiku.reports;

import java.time.LocalDate;
import java.util.List;

public final class ReportService {
    private final ReportStore store;

    public ReportService(ReportStore store) {
        this.store = store;
    }

    public Report preview(LocalDate reportDate, List<Integer> amountsYen) {
        return buildReport(reportDate, amountsYen);
    }

    public Report publish(LocalDate reportDate, List<Integer> amountsYen) {
        Report report = buildReport(reportDate, amountsYen);
        store.save(report);
        return report;
    }

    private static Report buildReport(LocalDate reportDate, List<Integer> amountsYen) {
        long totalYen = amountsYen.stream().mapToLong(Integer::longValue).sum();
        return new Report(reportDate, totalYen);
    }
}

プレビュー画面からは service.preview(reportDate, amountsYen) を呼び、確定ボタンからは service.publish(reportDate, amountsYen) を呼びます。preview は buildReport が作った帳票を返します。publish は同じ方法で帳票を作り、その値を store.save(report) に渡してから返します。

購入金額を足す処理は private static の buildReport に1か所だけ置きます。金額の集計ルールを変更するときに直すのは、このメソッドです。保存先の実装を差し替えるときは ReportStore を使い、集計を直す必要はありません。集計と保存を分けたので、プレビュー側を読むと、どこまで処理が進むかが分かります。

Report.java(全文)
package info.syachiku.reports;

import java.time.LocalDate;

public record Report(LocalDate reportDate, long totalYen) {
}
ReportStore.java(全文)
package info.syachiku.reports;

@FunctionalInterface
public interface ReportStore {
    void save(Report report);
}
関連記事Javaのメソッド分割の基準|privateに切るか、別クラスにするか 共通処理をprivateへ切り出す場合と、責務を別クラスに分ける場合を、保存回数も確認しながら比較できます。 記事を読む

渡すのが設定値ならboolean、選ぶのが操作ならメソッド名を考える

たとえば通知設定の画面で preferences.setRemindersEnabled(checkbox.isSelected()) と書くなら、booleanは「通知を有効にする設定値」です。メソッド名から、どの項目にどの値を入れるかが読めます。画面が持っている真偽値をそのまま渡せます。

今回の generate(..., true) では、呼ぶ側が選んでいるのは正式に保存する操作です。特にプレビューと確定で画面やボタンが分かれているなら、呼び出しの名前も分けると、レビューで画面の目的とコードを照らせます。Martin FowlerのFlag Argumentも、呼び出し側の意図をメソッド名で表す場面と、真偽値をデータとして渡す場面を分けて説明しています。

古い呼び出し元を一度に変えられない公開APIでは、同じクラスの旧 generate を同じ名前・引数・戻り値・公開範囲で残し、true は publish、false は preview に委譲できます。旧入口の既存動作を保つ移行策です。誤って true を渡す旧プレビュー画面は、呼び出し元を preview へ変えるところまで確認します。旧入口を削る時期は利用側と合わせます。Java 17言語仕様のメソッド変更とバイナリ互換に、名前や引数を変えた場合の扱いがあります。

JUnitで、合計が同じことと保存件数が違うことを別々に確かめる

ZIPを展開し、pom.xml のあるフォルダで mvn test を実行します。JDK 17、Maven 3.9系、JUnit Jupiter 5.12.2、Surefire 3.5.3で確認しています。保存先には、渡された帳票をリストへ入れる saved::add を渡します。プレビューはリストが空、確定は返した帳票だけが1件入ることを比較します。

旧画面で保存1回、旧メソッドに false で0回、修正版のプレビュー0回、確定1回、同じ入力からの帳票一致、プレビュー2回でも保存0回の6件です。同じ入力を使うことで、保存の有無を決めているのは明細や日付ではなく、選んだ操作だと確認できます。

ReportServiceTest.java(全文)
package info.syachiku.reports;

import java.time.LocalDate;
import java.util.ArrayList;
import java.util.List;

import org.junit.jupiter.api.Test;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;

class ReportServiceTest {
    private static final LocalDate REPORT_DATE = LocalDate.of(2026, 11, 5);
    private static final List<Integer> AMOUNTS_YEN = List.of(1_200, 800);
    private static final Report EXPECTED = new Report(REPORT_DATE, 2_000);

    private final List<Report> saved = new ArrayList<>();
    private final ReportService service = new ReportService(saved::add);

    @Test
    void reproducesTheLegacyPreviewSavingAReport() {
        var screen = new LegacyReportScreen(new LegacyReportService(saved::add));

        assertEquals(EXPECTED, screen.showPreview(REPORT_DATE, AMOUNTS_YEN));
        assertEquals(List.of(EXPECTED), saved);
    }

    @Test
    void legacyGenerateWithFalseDoesNotSave() {
        var legacy = new LegacyReportService(saved::add);

        assertEquals(EXPECTED, legacy.generate(REPORT_DATE, AMOUNTS_YEN, false));
        assertTrue(saved.isEmpty());
    }

    @Test
    void previewReturnsReportWithoutSaving() {
        assertEquals(EXPECTED, service.preview(REPORT_DATE, AMOUNTS_YEN));
        assertTrue(saved.isEmpty());
    }

    @Test
    void publishSavesTheReturnedReportExactlyOnce() {
        Report published = service.publish(REPORT_DATE, AMOUNTS_YEN);

        assertEquals(EXPECTED, published);
        assertEquals(List.of(published), saved);
    }

    @Test
    void sameInputProducesTheSameReportOnBothPaths() {
        Report previewed = service.preview(REPORT_DATE, AMOUNTS_YEN);
        Report published = service.publish(REPORT_DATE, AMOUNTS_YEN);

        assertEquals(previewed, published);
        assertEquals(List.of(published), saved);
    }

    @Test
    void repeatingPreviewDoesNotSave() {
        service.preview(REPORT_DATE, AMOUNTS_YEN);
        service.preview(REPORT_DATE, AMOUNTS_YEN);

        assertTrue(saved.isEmpty());
    }
}
pom.xml(全文)
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>info.syachiku</groupId>
  <artifactId>boolean-argument-sample</artifactId>
  <version>1.0.0</version>
  <properties>
    <maven.compiler.release>17</maven.compiler.release>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>
  <dependencies>
    <dependency>
      <groupId>org.junit.jupiter</groupId>
      <artifactId>junit-jupiter</artifactId>
      <version>5.12.2</version>
      <scope>test</scope>
    </dependency>
  </dependencies>
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-resources-plugin</artifactId>
        <version>3.3.1</version>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>3.14.1</version>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-surefire-plugin</artifactId>
        <version>3.5.3</version>
      </plugin>
    </plugins>
  </build>
</project>

修正版は6件成功します。別の場所に展開して preview の return buildReport(reportDate, amountsYen); を return publish(reportDate, amountsYen); に置き換えると、プレビューで保存が発生して3件が失敗します。もう一つの展開先で publish の store.save(report); を削ると、保存を確認する2件が失敗します。どちらも金額を求める計算は変えていません。

正常時と保存の処理を変えたときのログ抜粋

修正版の mvn test
[INFO] Tests run: 6, Failures: 0, Errors: 0, Skipped: 0

プレビューから確定を呼ぶ版の mvn test
[ERROR]   ReportServiceTest.previewReturnsReportWithoutSaving:39 expected: <true> but was: <false>
[ERROR] Tests run: 6, Failures: 3, Errors: 0, Skipped: 0

確定から保存を削った版の mvn test
[ERROR]   ReportServiceTest.publishSavesTheReturnedReportExactlyOnce:47 expected: <[Report[reportDate=2026-11-05, totalYen=2000]]> but was: <[]>
[ERROR] Tests run: 6, Failures: 2, Errors: 0, Skipped: 0

レビューでは、画面の操作と保存の約束を照らす

レビューコメント例「プレビュー画面では正式な帳票を保存しないので、ここは preview を呼びましょう。確定ボタンは publish のままで、両方に同じ明細を渡すテストに保存件数も入れてください。合計2,000円が返る確認だけでは、保存の誤りを見つけられません。」

実際の修正では、メソッド名だけで機械的に置換する前に、呼び出し元の画面やバッチが何の操作をするかを確認します。たとえば旧プレビューの true をそのまま publish へ移すと、今回の誤保存が残ります。画面の仕様を基準に、新しい呼び出しとテストを選びます。

提出前に、プレビュー0回と確定1回を確認する

  • 呼び出し行を読んで、プレビューか確定かを説明できる。
  • 帳票日と合計の計算は一か所にあり、同じ明細で同じ帳票を返す。
  • プレビューを繰り返しても保存0回、確定1回につき返した帳票を1回保存する。
  • 旧APIを残す場合は真偽値の既存の意味を維持し、呼び出し側は操作の意図を見て移行する。

メソッド名と引数の決め方を別の例でも考えたいなら、『Effective Java 第3版』の第8章「メソッド」が参考になります。メソッドのシグネチャを設計する箇所を読み、呼び出し行で操作の意味が伝わるか、引数にどの情報を持たせるかを見直せます。

書籍「Effective Java 第3版」の表紙
商品画像:Amazon.co.jp
PR Java基礎を終えた若手向け

Effective Java 第3版

Joshua Bloch (著), 柴田 芳樹 (翻訳)

Javaらしい設計と実装の判断基準を深める定番書。

equals、例外、ジェネリクス、ラムダ式などを、設計上の原則から学べます。初学者の一冊目ではなく、実務経験後の振り返り向けです。

  • Javaコードの設計判断を深めたい
  • レビュー指摘の背景まで理解したい

当サイトはAmazonアソシエイト・プログラムの参加者です。価格・在庫・配送条件はAmazonでご確認ください。

関連記事Javaのクラス設計は何から学ぶ?最初の1冊と「どこに書くか」の考え方 別々に変わる要件をどこへ書くか、動作するコードと書籍を使って考えられます。 記事を読む 関連記事テストケースの作り方|仕様・境界値・期待結果をJUnitと対応させる実例 仕様にある入力・戻り値・処理後の状態を、JUnitの期待値にする手順を学べます。 記事を読む

まとめ

プレビューと確定のように、操作によって保存の有無が変わる場合は、呼ぶメソッドの名前でその違いを表します。共通の計算はprivateメソッドに残し、同じ帳票が返ることと、保存が0回・1回に分かれることをテストします。

-設計・テスト・レビュー
-, ,