レビュー6観点で合格のcalculateTotalがint溢れで壊れる条件
calculateTotalは6つのレビュー観点で合格する。変数名は明確で、スコープは最小で、再代入もマジックナンバーもない。だがこのメソッドに10億円の価格を3件渡すと、合計は-1,294,967,296になる。読めるコードと壊れないコードは、別の検査で確かめる。
public int calculateTotal(int[] prices) {
int total = 0;
for (int i = 0; i < prices.length; i++) {
total += prices[i];
}
return total;
}
このメソッドは、会話「アルゴリズム解法予想」で出た『良いコード/悪いコードで学ぶ設計入門』(仙塲大也、技術評論社、2022年刊)を起点にした第1問の対象コードである。レビュー観点は6つで、変数名は明確か、スコープは適切か、再代入していないか、命名は処理内容を表すか、定数がマジックナンバーになっていないか、意味や役割がコードから読み取れるか、というものだった。この記事ではその6観点で読んだうえで、6観点では拾えない壊れ方を、検証した数字と一緒に置く。重複排除の順序を扱ったTwo SumはcontainsKeyを先に書く――putが先だと自分とペアになると同じく、1行の書き方の違いが実務の挙動を変える話である。
6つの観点でcalculateTotalを読む
| 観点 | calculateTotalの読み方 |
|---|---|
| 変数名は明確か |
totalは合計、pricesは価格の配列、iは添字。aやtmpのような抽象的な名前はない |
| スコープは適切か |
iはfor文の中だけで生きる。totalだけがループの外で宣言されている |
| 再代入していないか |
totalへの代入は加算だけ。1つの変数が2つの目的に使われていない |
| 命名は処理内容を表すか |
calculateTotalは「合計を計算する」と読める |
| マジックナンバーはないか | 数字の定数は出てこない。0は合計の初期値で、意味は名前から読める |
| 意味や役割が読み取れるか | コメントなしで「価格の配列の合計を返す」と読める |
6観点はすべて合格に見える。totalがループの外で宣言されているのは例外ではなく、合計を保持するには外で宣言するしかない。ループの中で宣言したtotalは1回ごとに消えて、合計にならない。会話の中で出た判断の軸も同じで、変数の目的は明確か、スコープは適切か、不必要に値を変更していないか、処理が複雑になっていないか、仕様変更しやすいか、という5つだった。
6観点で合格でも合計が負になる――intの溢れ
Javaの整数演算は、溢れても例外を出さない。Java言語仕様書4.2.2節は、組み込みの整数演算子は溢れも桁下がりも何も示さないと定めている。total += prices[i]がintの範囲を超えると、結果は黙って折り返す。例外もログも出ない。合計が負になっていても、メソッドは正常にreturnする。
| 入力 |
intの合計 |
正しい合計 |
|---|---|---|
[100, 200, 300] |
600 | 600 |
[2,147,483,647, 1] |
-2,147,483,648 | 2,147,483,648 |
[1,000,000,000, 1,000,000,000, 1,000,000,000] |
-1,294,967,296 | 3,000,000,000 |
Integer.MAX_VALUEは2,147,483,647である。ここに1を足すと-2,147,483,648になる。10億円の価格が3件あるだけで、合計は約-12.9億円になる。請求書の合計が負の数で出て、テストでは小さい金額しか試していなければ、気づかないまま本番へ行く。
直し方は3つある。longに替えると約9.2×10¹⁸まで入る。Math.addExactに替えると、溢れた時点でArithmeticException: integer overflowを投げて止まる。金額ならBigDecimalに替えて、丸めの規則まで一緒に決める。3つの選び方は、合計がどこまで大きくなるかと、溢れたときに黙って進んでいいかで決まる。黙って進んでいい合計は、まずない。
public long calculateTotal(int[] prices) {
long total = 0;
for (int price : prices) {
total = Math.addExact(total, price);
}
return total;
}
Math.addExactはJava 8からある。引数がintの版はintの範囲で検査するので、longの結果が欲しい場合は少なくとも片方をlongにする。addExact(total, price)でtotalがlongなら、longの版が選ばれる。なおpricesがnullの場合は、ループに入る前にNullPointerExceptionになる。空の配列なら合計は0を返す。nullと空は別の入力で、レビューでは区別して読む。
消費税のtaxはスコープの問題ではない――切り捨てが金を削る
会話では、消費税の練習問題が出た。taxをfor文の中で宣言していいか、という問題である。
int total = 0;
for (int price : prices) {
int tax = price / 10;
total += price + tax;
}
return total;
taxは1件ごとの税額で、目的はその回の計算だけである。ループの中で宣言するのが正しい。外で宣言して毎回代入し直しても結果は同じになることを検証で確かめた。スコープの観点では、どちらも合格に近い。だがこのコードの壊れ方は、スコープにはない。price / 10が整数同士の割り算で、端数を切り捨てることにある。
| 価格 | price / 10 |
真の10% |
|---|---|---|
| 105円 | 10円 | 10.5円 |
| 199円 | 19円 | 19.9円 |
| 99円 | 9円 | 9.9円 |
105円の商品が10件あると、切り捨て版の税合計は100円で、真の税合計は105円になる。199円の商品が100件あると、切り捨て版は1,900円で、真の税合計は1,990円になる。90円の差が、請求書に残る。10という数字も、税率を直接埋め込んだマジックナンバーである。税率が10%から8%に変わると、この10を探して直すことになる。丸めの規則も書かれていない。切り捨て、四捨五入、切り上げのどれにするかは、コードからは読めない。
切り上げと切り捨てを混ぜると料金が変わることは、タクシー料金Ver.2をJavaで計算する――深夜20%割増と10%割引は「何に掛けるか」で料金が変わるでも確かめた。税額の計算では、BigDecimalに替えて丸めモードを明示するのが筋である。setScale(0, RoundingMode.HALF_UP)なら四捨五入、RoundingMode.DOWNなら切り捨てで、規則がコードに残る。doubleで金額を足し上げると、199円×100件の真値が1,990.0000000000002になることも検証で確かめた。doubleは金額の入れ物ではない。
割引のcalcは新しいランクが来ると割引なしで通る
会話の最初に出た悪いコードは、会員ランクで割引率を変えるものだった。
double calc(int a, double b) {
if (a == 1) return b * 0.9;
if (a == 2) return b * 0.8;
return b;
}
calcが何をするか分からない。aとbが何か分からない。1や2が何を意味するか分からない。0.9や0.8が何を意味するか分からない。呼び出し側は引数の順番を覚えていないと使えない。改善版は、名前と定数で意味を表に出す。
double calculateDiscountedPrice(int memberRank, double price) {
final int SILVER = 1;
final int GOLD = 2;
if (memberRank == SILVER) {
return price * 0.9;
}
if (memberRank == GOLD) {
return price * 0.8;
}
return price;
}
改善版は6観点で読めるようになる。だが実務の壊れ方は、ここにも残っている。新しいランクが増えたときである。PLATINUMを3として渡すと、どの分岐にも当たらず、return priceで割引なしのまま通る。例外もログも出ない。新しいランクの会員が割引なしで買い物をして、後から気づく。割引なしで通るのは、失敗の仕方として開いたままである。
| ランク | 改善版の結果(10,000円) |
|---|---|
| SILVER(1) | 9,000円 |
| GOLD(2) | 8,000円 |
| PLATINUM(3) | 10,000円(割引なしで通る) |
直し方は、ランクと割引率の対応を1か所に集めて、知らないランクを例外で止めることである。enum Rankに割引率を持たせるか、Map<Rank, BigDecimal>で引く。Mapの版では、未知のランクは例外で止まることを検証で確かめた。対応表が2か所に分かれていると、片方だけ新しいランクを追加して、もう片方が古いままになる。割引率の変更も同じで、0.9という数字が2か所にあれば、片方だけ変わって、同じ会員でも画面と請求書で違う金額になる。重複した対応表のズレは、決済履歴の重複排除と集計をJavaでO(n)で解く――FAILEDも「出現した」として記録する順序で扱った「最初に出現した1回だけを数える」と同じく、数え方を1か所に集める話である。
ループ内の宣言は計算量を変えない――二重ループはO(n²)
会話の最後に出た問題は、二重ループの計算量だった。
for (int i = 0; i < n; i++) {
for (int j = 0; j < n; j++) {
int value = i + j;
}
}
答えはO(n²)である。n=10なら100回、n=100なら10,000回、内側の処理が実行される。valueをループの内側で宣言しても外側で宣言しても、実行回数は変わらない。宣言の位置が変えるのはスコープと可読性で、計算量はループの構造で決まる。変数宣言ではなく、何回処理が実行されるかに注目する、という会話のヒント通りである。
宣言の位置で変わるのは、別の一件である。ループの中でnew ArrayList<>()のように重いオブジェクトを生成すると、生成回数がn回になる。生成コストとGCの負担が増える。int value = i + jのような軽い宣言と、毎回新しいコレクションを作ることは、同じ「ループ内の宣言」でも別問題である。会話でも、この2つは区別されていた。
読めることと壊れないことは別の検査
6つの観点は、コードが読めるかを検査する。calculateTotalは6観点で合格する。だが読めるコードでも、intの合計は溢れるし、税額は切り捨てで削れるし、新しいランクは割引なしで通る。レビューで見る順序は、読めることの検査と、壊れる条件の検査を分けることである。
| 検査 | 見るもの | calculateTotalでの結果 |
|---|---|---|
| 読めること | 名前、スコープ、再代入、マジックナンバー | 6観点で合格 |
| 壊れないこと | 溢れ、切り捨て、未知の入力、null | intの溢れ、nullでNPE |
| 変わるとき | 新しいランク、税率の変更、件数の増加 | 割引なしで通る、税率が埋め込み、件数で溢れる |
レビュー観点に「壊れる条件」を1つ足すと、読む順序が変わる。まず名前とスコープで読めるかを見て、次に型の範囲と端数の扱いと未知の入力で壊れる条件を見る。calculateTotalなら、合計の型はintで足りるか、価格が何件まで来るか、pricesがnullのとき何が起きるか、を聞く。割引なら、新しいランクが来たときに何が起きるか、割引率がどこに1か所だけあるか、を聞く。税額なら、端数をどう丸めるか、税率が変わるときどこを直すか、を聞く。
検証環境
Javaコードはこの環境にJDKがなく、JVMで実行していない。同じ計算をPython 3.12.3に写して確認した。intの32bit符号付きの折り返し、整数除算の0方向への切り捨て、IEEE 754倍精度のdoubleの誤差は、Javaと同じ規則で再現した。Javaコードは目視で構文を確認した。
-
intの合計:[2,147,483,647, 1]は-2,147,483,648、[1,000,000,000 × 3]は-1,294,967,296、long版は3,000,000,000。Math.addExact相当は溢れで例外になることを確認した - 税額:105円は10円、199円は19円、99円は9円。105円×10件で切り捨て版100円・真値105円。199円×100件で切り捨て版1,900円・
doubleで足した真値1,990.0000000000002・Decimalの真値1,990.00。taxをループ内で宣言する版と外で宣言して毎回代入する版は同じ結果になることを確認した -
doubleの誤差:1.1 * 0.9は0.9900000000000001、0.1 + 0.2は0.30000000000000004、19.99 * 0.9は17.991。Decimal版は0.99と17.991で正確になることを確認した - 割引:SILVERは9,000円、GOLDは8,000円、PLATINUM(3)は10,000円で割引なしで通る。
Map版は未知のランクで例外になることを確認した - 二重ループ:n=10で100回、n=100で10,000回。宣言位置を変えても回数は同じ。ループ内の生成はn回になることを確認した
今後見るべきもの
- 会話の第2問が出たら、同じ6観点に「壊れる条件」を足して読む。第1問の対象は
calculateTotalで、次は条件分岐やメソッド設計の話が予告されている - 消費税の練習問題の答え合わせ。
taxはループの中のままでいいが、切り捨てと税率の埋め込みを直す書き方を見る - 二重ループの答えはO(n²)である。内側の処理が重い場合に、回数を減らす書き方(早期終了、事前計算、キャッシュ)を見る
-
Math.addExactを入れる条件。合計がintの範囲を超えうる入力があるか、超えたときに止まるべきか、止まらずにlongへ逃がすべきか - 金額の型の選び方。
intの円、longの円、BigDecimalの使い分けと、丸めモードをどこで決めるか -
enumとMapの選び方。ランクと割引率の対応をどこに1か所だけ置くか、未知のランクを例外で止めるか、設定ファイルへ出すか - レビュー観点の育て方。6観点に「壊れる条件」を足した7観点で、自分のコードを読み直す
会話の続きでは、for文の変数スコープの判断表と、二重ループの計算量の問題が出ている。次回はその答え合わせと、第2問のレビューを扱う。
参考資料
- 良いコード/悪いコードで学ぶ設計入門 : 保守しやすい成長し続けるコードの書き方(CiNii 図書) — 仙塲大也著、技術評論社、2022年5月。会話の出発点になった本。初版の紙版は2022年4月30日発売
-
NUM00-J. Detect or prevent integer overflow(SEI CERT Oracle Coding Standard for Java) — JLS 4.2.2節の引用(整数演算子は溢れも桁下がりも示さない)と、
Math.addExactによる検出 -
Java Math addExact() Method(w3schools) —
addExactは引数の和を返し、溢れるとArithmeticExceptionを投げる。Java 8からある -
Detect Integer Overflow in Java with Math Exact Methods(HowToDoInJava) —
addExact・multiplyExactの使い分けと、longの版を使う条件 - タクシー料金Ver.2をJavaで計算する――深夜20%割増と10%割引は「何に掛けるか」で料金が変わる — 切り上げ・切り捨てと割引の適用対象の話
- Two SumはcontainsKeyを先に書く――putが先だと自分とペアになる — 確認してから登録する順序と、並行処理での壊れ方