Javaのクーポン割引の按分で、残った1円をどの明細へ配るかを示すアイキャッチ

設計・テスト・レビュー

Javaでクーポン割引を按分すると1円ずれる|明細の合計を合わせる設計とJUnit

AIによる要約

100円引きのクーポンを同額の3明細へ按分し、1円未満を明細ごとに切り捨てると合計は99円です。残った1円をどの明細へ配るかを決め、明細の入力順を変えても配分が同じになることをJUnitで確認します。

新人SE
新人SE
注文画面では100円引きなのに、明細CSVを足すと99円でした。どこを直せばいいですか?
ポンコツSE
ポンコツSE
注文に適用した割引額と明細の合計を合わせましょう。明細を並べ替えても同じ配分になるところまで確認します。

ECの改修で、注文全体に適用したクーポンの割引額を明細CSVへ出すことになりました。注文の値引きは100円と記録されているのに、担当者がCSVの割引欄を足すと99円です。表示を直しても、明細別の金額を使う照合や返品処理には差が残ります。この記事では、整数円で配分した後も合計が一致するように、計算の契約をJavaのクラスへ置きます。

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

JDK 17とMaven 3.9系で試せます。ZIPにはJavaの本体とテスト、pom.xml、READMEを収録しています。

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

100円引きを3明細で切り捨てると、合計は99円になる

明細A・B・Cが各100円で、注文小計は300円です。値引きを小計の比率で分けると、各明細は約33.33円です。下の失敗例では整数の除算を使い、各明細から小数部分が落ちます。明細の割引額がどれも33円なら、注文画面の100円と明細の合計99円に差が出ます。

失敗例の計算を抜粋

int discountPerLine = 100 * 100 / 300;
int discountTotal = discountPerLine * 3;
System.out.println(discountTotal); // 99
各100円の3明細に、100円のクーポンを配る
明細ごとに切り捨てる
  • 明細A33円
  • 明細B33円
  • 明細C33円

割引合計 99円

残り1円 同点はIDの昇順
余りを明細Aへ足す
  • 明細A +1円34円
  • 明細B33円
  • 明細C33円

割引合計 100円

四捨五入へ変えるだけでは、合計が常にそろうとは限りません。たとえば同額の3明細に101円を割り当てると、各明細を四捨五入した結果は34円ずつで、合計は102円です。まず「明細の割引合計を注文の割引額に合わせる」という契約を決め、端数をどこへ置くかをその契約に含めます。

残った円は余りが大きい明細から配り、同点ならIDで決める

このサンプルは、注文全体の固定額クーポン1枚を扱います。金額は整数円で、明細小計は0円以上、注文小計は1円以上です。クーポンは0円から注文小計まで認めます。明細IDは空にできず、注文内で重複できません。次の処理で、IDごとの割引額を決めます。

  1. 明細ごとに クーポン額 × 明細小計 を計算し、注文小計で割った商を割引額として置く。
  2. 余りを大きい順に並べる。余りが同じなら明細IDの昇順を使う。
  3. クーポン額から商の合計を引く。残った円の数だけ、並べた先頭から1円ずつ足す。

明細がA=300円、B=200円、C=100円で100円引きなら、注文小計は600円です。商はA=50、B=33、C=16、余りはA=0、B=200、C=400です。商の合計99円に足りない1円はCへ渡るので、配分はA=50円、B=33円、C=17円になります。分母は同じ600なので、比率を小数に直さず余りを比べられます。Java言語仕様の整数除算と剰余を使います。

各100円の例では余りが3明細とも同じなので、Aへ1円を渡します。入力順だけで決めると、画面で並べ替えたり、取得順が変わったりしたときに同じ注文でも割引先が変わります。ここでのID順はサンプルの仕様です。担当者が別の基準を採用するなら、合計を合わせる条件に加え、同点をどう決めるかも仕様に書きます。

この例では整数円に限っています。単価自体を小数で持つ仕様なら、残す桁と丸め方向も先に決めます。

関連記事BigDecimal.divideでArithmeticExceptionになる原因|割り切れない計算の丸め方 小数を保持する金額計算で割り切れないときに、残す桁と丸め方をどう指定するか確認できます。 記事を読む

配分をクラスへまとめ、画面とCSVは同じ結果を使う

OrderLine は明細IDと小計を持ちます。IDが必須で小計が0円以上という条件は、1件だけ見れば決まるため、生成時に検証します。一方、クーポンの上限やIDの重複は複数の明細を見ないと決まりません。これらの検証と配分は、注文全体を受け取る DiscountAllocator に置きます。

OrderLine.java(全文)

package info.syachiku.discount;

public record OrderLine(String id, int subtotalYen) {
    public OrderLine {
        if (id == null || id.isBlank()) {
            throw new IllegalArgumentException("明細IDは必須です");
        }
        if (subtotalYen < 0) {
            throw new IllegalArgumentException("明細の小計は0円以上です");
        }
    }
}

allocate は、呼び出し元の明細リストを並べ替えず、余りの一覧だけを並べ替えます。戻り値は明細IDから割引額を引く表です。画面やCSVを生成する側は、自分の表示順で明細をたどり、対応するIDの割引額を使います。表示用の金額文字列やCSVの列名は、この計算クラスに持たせません。

DiscountAllocator.java(全文)

package info.syachiku.discount;

import java.util.ArrayList;
import java.util.Comparator;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;

public final class DiscountAllocator {
    public Map<String, Integer> allocate(List<OrderLine> lines, int couponYen) {
        var ids = new HashSet<String>();
        long orderSubtotal = 0;
        for (OrderLine line : lines) {
            if (!ids.add(line.id())) {
                throw new IllegalArgumentException("明細IDが重複しています");
            }
            orderSubtotal += line.subtotalYen();
        }
        if (orderSubtotal == 0 || couponYen < 0 || couponYen > orderSubtotal) {
            throw new IllegalArgumentException("注文小計とクーポン額を確認してください");
        }

        var allocations = new HashMap<String, Integer>();
        var shares = new ArrayList<Share>();
        int allocated = 0;
        for (OrderLine line : lines) {
            long weighted = (long) couponYen * line.subtotalYen();
            int base = (int) (weighted / orderSubtotal);
            allocations.put(line.id(), base);
            allocated += base;
            shares.add(new Share(line.id(), weighted % orderSubtotal));
        }

        shares.sort(Comparator.comparingLong(Share::remainder)
                .reversed().thenComparing(Share::lineId));
        int remaining = couponYen - allocated;
        for (int i = 0; i < remaining; i++) {
            String id = shares.get(i).lineId();
            allocations.put(id, allocations.get(id) + 1);
        }
        return Map.copyOf(allocations);
    }

    private record Share(String lineId, long remainder) {
    }
}

積を求める行の (long) は、乗算の前に適用します。クーポン額と明細小計はそれぞれ int に収まっても、二つの積や注文の合計は int の上限を超える場合があるからです。クーポン額を注文小計以下に制限しているので、各明細に配る額の合計はクーポン額を超えず、最終的な明細ごとの割引額は int に収まります。

たとえば画面とCSVの両方に「同点ならID順」の分岐があると、仕様変更で片方だけ修正してしまう恐れがあります。二つの出力が参照する共通の計算としてクラスへ置けば、次の改修でも、変更すべき条件と確認すべきテストを同じ場所から探せます。

JUnitで総額と、並び替え後の明細別の値を確かめる

ZIPを展開して pom.xml のある場所で mvn test を実行します。 総額を確認するテストと、同じ注文を逆順で渡すテストを分けます。総額が100円でも、余り1円の行き先が変わることがあるためです。

DiscountAllocatorTest.java(全文)
package info.syachiku.discount;

import java.util.List;
import java.util.Map;

import org.junit.jupiter.api.Test;

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

class DiscountAllocatorTest {
    private final DiscountAllocator allocator = new DiscountAllocator();

    @Test
    void equalLinesKeepCouponTotal() {
        var result = allocator.allocate(List.of(line("A", 100), line("B", 100), line("C", 100)), 100);

        assertEquals(100, result.values().stream().mapToInt(Integer::intValue).sum());
        assertEquals(Map.of("A", 34, "B", 33, "C", 33), result);
    }

    @Test
    void sameRemainderDoesNotDependOnInputOrder() {
        OrderLine a = line("A", 100);
        OrderLine b = line("B", 100);
        OrderLine c = line("C", 100);

        assertEquals(allocator.allocate(List.of(a, b, c), 100),
                allocator.allocate(List.of(c, b, a), 100));
    }

    @Test
    void givesOneYenToTheLargestRemainder() {
        var result = allocator.allocate(List.of(line("A", 300), line("B", 200), line("C", 100)), 100);

        assertEquals(Map.of("A", 50, "B", 33, "C", 17), result);
    }

    @Test
    void zeroCouponAssignsZeroToEveryLine() {
        assertEquals(Map.of("A", 0, "B", 0),
                allocator.allocate(List.of(line("A", 30), line("B", 70)), 0));
    }

    @Test
    void zeroPriceLineGetsNoDiscount() {
        var result = allocator.allocate(List.of(line("C", 0), line("B", 100), line("A", 100)), 1);

        assertEquals(0, result.get("C"));
    }

    @Test
    void couponEqualToSubtotalCanCoverEveryLine() {
        assertEquals(Map.of("A", 30, "B", 70),
                allocator.allocate(List.of(line("A", 30), line("B", 70)), 100));
    }

    @Test
    void rejectsCouponAboveSubtotal() {
        assertThrows(IllegalArgumentException.class,
                () -> allocator.allocate(List.of(line("A", 100)), 101));
    }

    @Test
    void rejectsNegativeCoupon() {
        assertThrows(IllegalArgumentException.class,
                () -> allocator.allocate(List.of(line("A", 100)), -1));
    }

    @Test
    void rejectsDuplicateLineId() {
        var lines = List.of(line("A", 40), line("A", 60));

        assertThrows(IllegalArgumentException.class, () -> allocator.allocate(lines, 100));
    }

    @Test
    void rejectsZeroSubtotal() {
        assertThrows(IllegalArgumentException.class,
                () -> allocator.allocate(List.of(line("A", 0)), 0));
    }

    @Test
    void widensSumAndProductBeforeDivision() {
        var lines = List.of(line("A", Integer.MAX_VALUE), line("B", Integer.MAX_VALUE));

        assertEquals(Map.of("A", 1_073_741_824, "B", 1_073_741_823),
                allocator.allocate(lines, Integer.MAX_VALUE));
    }

    @Test
    void rejectsNegativeLineSubtotal() {
        assertThrows(IllegalArgumentException.class, () -> line("A", -1));
    }

    private OrderLine line(String id, int yen) {
        return new OrderLine(id, yen);
    }
}
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>java-coupon-discount-allocation</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>
最初に確認する3件
入力期待する結果
各100円 × 3明細、100円引きA=34円、B=33円、C=33円。合計100円。
上の明細を C、B、A の順で渡す明細IDごとの割引額は同じ。
300円、200円、100円、100円引きA=50円、B=33円、C=17円。

正常版は12件が通ります。手元の作業用コピーで、int remaining = couponYen - allocated; を int remaining = 0; に変えて再実行すると、総額を見る equalLinesKeepCouponTotal が期待100に対して実際99で失敗します。余りの大きさを比べるケースと大きい金額のケースも失敗します。

元に戻し、今度は .thenComparing(Share::lineId) だけを外します。同額の明細を逆順で渡したとき、追加の1円がAからCへ移り、sameRemainderDoesNotDependOnInputOrder の1件が失敗します。最後にIDの比較を戻し、12件が再び通ることを確かめます。

レビューでは1円の行き先まで仕様で答えられるかを確認する

レビューで「100円引きの配分は、画面を並べ替えた場合も同じですか?」と聞かれたら、「IDが同じなら割引額も同じです。同じ余りならIDの昇順を使い、明細を逆順に渡すJUnitで確認しました」と答えられます。注文の値引き合計と明細の合計が一致する結果も一緒に示せば、レビュアーは金額の照合と配分先の両方を確認できます。

  • 注文のクーポン額と、明細に配った整数円の合計は同じか。
  • 余りが同じときに使う基準が、入力順と独立しているか。
  • 0円の明細、クーポンなし、クーポン額が小計と同額のときの結果を示せるか。
  • クーポン額が上限を超えた場合や、明細IDが重複した場合の扱いを決めたか。

サンプルの範囲は、整数円・固定額クーポン1枚の配分です。税、ポイントとの併用、対象外商品、負額の返品明細があるシステムでは、配分対象と金額の決め方を個別に確認します。

「何を一つのクラスにまとめ、何を画面側に残すか」で迷うときは、『改訂新版 良いコード/悪いコードで学ぶ設計入門』を参考にできます。今回の例なら、配分の判定と計算を DiscountAllocator へまとめ、表示は受け取った結果を使う、という分け方を考えるときに役立ちます。

書籍「改訂新版 良いコード/悪いコードで学ぶ設計入門」の表紙
商品画像:Amazon.co.jp
PR Java新人・若手向け

改訂新版 良いコード/悪いコードで学ぶ設計入門

仙塲 大也 (著)

レビューで直される理由を、Javaの具体例から理解する。

命名、責務、クラス設計、不変性などを良い例と悪い例で比較できます。現場のコードレビューと結びつけやすい一冊です。

  • 設計の悪さを具体例から学びたい
  • レビュー指摘の判断軸を増やしたい

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

関連記事Javaのクラス設計は何から学ぶ?最初の1冊と「どこに書くか」の考え方 金額を決める処理や表示をどこに置くかを、短い実例から考えます。 記事を読む 関連記事テストケースの作り方|仕様・境界値・期待結果をJUnitと対応させる実例 0円や上限ちょうどのように、仕様から入力と期待値を取り出してJUnitへ書く手順を確認できます。 記事を読む

まとめ

クーポンを明細へ按分する処理では、配分後の合計と注文のクーポン額を一致させます。整数の商を置いた後、残った円を余り順に配り、同点の扱いを決めます。修正後は総額だけでなく、同じ明細を別の順番で渡してもIDごとの配分が変わらないことを確認してください。

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