JavaからSpring Bootへ。注文明細の合計を出すAPIを作る4ステップのアイキャッチ

設計・テスト・レビュー

JavaからSpring Bootまでの学習順|注文明細の合計を出すAPIを4ステップで作る

この記事でわかること

「数量2、単価1,200円」と「数量1、単価350円」から、見積合計2,750円を出します。Javaの配列から始め、入力を明細クラスにまとめ、JUnitで境界を確認して、最後にSpring BootのPOSTから同じ計算を使います。

新人SE
新人SE
Javaの練習問題は解けます。でもSpring Bootの課題を渡されると、どのファイルから書き始めたらいいか迷います。
ポンコツSE
ポンコツSE
見積の明細2行から、合計1つを返す課題で試しましょう。先にJavaだけで2,750円を出せば、Springを加えたときに新しく確かめる箇所が分かります。

対象は、Javaの変数・配列・条件分岐を読めて、業務コードの置き場所やSpringへ進む順番に迷っている人です。各段階の終わりに確認する値を置いたので、説明できる段階は飛ばして構いません。作るのは、送られてきた明細から円単位の合計を返す学習用の見積です。

4ステップを同じフォルダで試す

Javaの配列版、明細と合計を扱うクラス、JUnit、Spring Bootの起動設定、MockMvc、POSTに使うJSONを収録。JDK 17とMaven 3.9系を使い、ZIPを展開したフォルダで mvn clean test を実行すると全16件を確認できます。

最初に決めるのは、どの入力に何を返すか

たとえば、社内の購買画面で注文前に概算を表示するとします。明細が1行のうちは動いても、2行目を足すと合計が変わらない、空欄を無料として扱ってしまう、上限の見積で金額が壊れるといった不具合が起きます。そこで、まず画面の見た目を離れて、入力と期待する結果を決めます。

  • 明細は1〜50件。数量は1〜100、単価は0〜1,000,000円。すべて整数です。
  • 数量と単価を掛けてから全行を足します。2 × 1,200 + 1 × 350 = 2,750円です。
  • 単価0円は有効です。単価の入力がない場合は見積を返さず、修正が必要なことを伝えます。
同じ2,750円を、各段階でどう確かめるか
  1. 1. Java基礎1行ずつ足して標準出力に2,750
  2. 2. クラス設計明細2件に分け、合計は2,750のまま
  3. 3. JUnit2,750を固定し、最大額と拒否条件も確認
  4. 4. Spring同じ2件をJSONで送り、200と2,750を確認

最初の動作確認では2,750円を目印にします。正常な計算が合っていることを起点に、明細が規定を外れたときと、送信されたJSONを読めないときを別々に足します。この切り分けができると、画面から400が返ったときに、金額計算とHTTP入力のどちらを見直すか判断しやすくなります。

1. Javaの繰り返しで2,750円を出す

最初は、数量の配列と単価の配列を並べます。添字0は数量2と単価1,200、添字1は数量1と単価350です。total は0で始まり、1行目を通ると2,400、2行目を通ると2,750になります。次の段階でコードを分けても、この結果は維持します。

package example.orderquote;

/** 学習用。個数・単価の配列が対応し、値は有効だと仮定する。 */
public final class QuoteFromArrays {
    public static void main(String[] args) {
        int[] quantities = {2, 1};
        int[] unitPrices = {1200, 350};

        long total = 0;
        for (int index = 0; index < quantities.length; index++) {
            total += (long) quantities[index] * unitPrices[index];
        }
        System.out.println(total); // 2750
    }
}

ここでは2つの配列の長さが同じで、どの値も有効だと仮定しています。練習を一歩進めるなら、両方の配列に数量3・単価100の行を足し、出力が3,050円になるか見てください。単価だけに行を足すと、繰り返しは数量の配列の長さで止まるため3行目は集計されません。2つの配列の対応関係を呼び出し側が守る必要があると、ここで見えてきます。

(long) quantities[index] * unitPrices[index] は、片方を掛け算の前にlongへ変える書き方です。この実習の仕様では1行の最大額は1億円で、intに入ります。一方、50行を足した50億円はintに入りません。掛け算の型と、何行も足す変数の型を分けて考えます。上限が変わると式の積そのものがあふれる場合もあります。その具体例はint同士の掛け算で起きるオーバーフローの50,000 × 50,000と比較できます。Java言語仕様の数値昇格も参照できます。

2. 数量と単価を明細にまとめ、不正な行を作れないようにする

次は、同じ行の数量と単価をLineItemにまとめます。たとえばnew LineItem(2, 1200)は1行目を表し、amount()は2,400を返します。これで、呼び出し側が二つの配列の長さや添字をそろえる必要がなくなります。数量0の明細はコンストラクタで拒否するため、どこから呼ばれても不正な値を持つ明細が残りません。

package example.orderquote;

public record LineItem(int quantity, int unitPrice) {
    public LineItem {
        if (quantity < 1 || quantity > 100) {
            throw new InvalidQuoteException("数量は1〜100です");
        }
        if (unitPrice < 0 || unitPrice > 1_000_000) {
            throw new InvalidQuoteException("単価は0〜1,000,000円です");
        }
    }

    public long amount() {
        return (long) quantity * unitPrice;
    }
}

LineItemは1行だけを見ます。明細が50件以内かどうかは、1行を作る時点では分かりません。そこで、全行を見るQuoteCalculator.total()に件数のチェックを置きます。料金の条件が変わったときは「一つの行を見れば判断できる条件か」「一覧を見て初めて判断できる条件か」を確認して、変更する場所を決めます。

package example.orderquote;

import java.util.List;

public final class QuoteCalculator {
    public long total(List<LineItem> lines) {
        if (lines == null || lines.isEmpty() || lines.size() > 50) {
            throw new InvalidQuoteException("明細は1〜50件です");
        }

        long total = 0;
        for (LineItem line : lines) {
            if (line == null) {
                throw new InvalidQuoteException("明細に空の行があります");
            }
            total += line.amount();
        }
        return total;
    }
}

もし「単価0円を認める条件を変える」なら修正候補はLineItemです。「明細の上限を100件にする」ならQuoteCalculatorと件数のテストを見直します。その変更後の最大額は100億円なので、戻り値と加算先がlongで足りるかも計算します。呼び出し元がSpringになっても、これらの判断は同じです。

関連記事Javaのクラス設計は何から学ぶ?最初の1冊と「どこに書くか」の考え方 値と処理をどこへ置けばよいか、送料の計算と表示を分ける例から考えます。 記事を読む

3. JUnitで2,750円、50億円、上限超過を確認する

例を手で動かすだけなら、明細2行で2,750円と出ることは確かめられます。しかしその入力では、加算先を誤ってintに変えても同じ値が出ます。そこで50行すべてを数量100・単価1,000,000円にしたテストを足します。期待値は5_000_000_000Lです。

境界を選ぶときは、受け入れる側と拒否する側を一組にします。数量100と件数50は最大額のテストで一緒に通し、数量101と件数51はそれぞれ別に失敗させます。単価0円は数量1・明細1件で確かめ、マイナス1円は拒否させます。たとえば「数量101・単価マイナス・51件」を同時に送ると、どの検証が壊れていても別の検証で失敗できるため、原因を切り分けられません。

package example.orderquote;

import java.util.Collections;
import java.util.List;

import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.CsvSource;
import org.junit.jupiter.params.provider.ValueSource;

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

class QuoteCalculatorTest {
    private final QuoteCalculator calculator = new QuoteCalculator();

    @Test
    void totalsTwoLines() {
        assertEquals(2750L, calculator.total(List.of(new LineItem(2, 1200), new LineItem(1, 350))));
    }

    @Test
    void totalCanExceedTheIntRange() {
        List<LineItem> lines = Collections.nCopies(50, new LineItem(100, 1_000_000));
        assertEquals(5_000_000_000L, calculator.total(lines));
    }

    @Test
    void acceptsOneFreeLine() {
        assertEquals(0L, calculator.total(List.of(new LineItem(1, 0))));
    }

    @ParameterizedTest
    @CsvSource(delimiter = '|', value = {
            "0 | 350 | 数量は1〜100です",
            "101 | 350 | 数量は1〜100です",
            "1 | -1 | 単価は0〜1,000,000円です",
            "1 | 1000001 | 単価は0〜1,000,000円です"
    })
    void rejectsAnInvalidLine(int quantity, int unitPrice, String message) {
        var error = assertThrows(InvalidQuoteException.class, () -> new LineItem(quantity, unitPrice));
        assertEquals(message, error.getMessage());
    }

    @ParameterizedTest
    @ValueSource(ints = {0, 51})
    void rejectsAnInvalidNumberOfLines(int count) {
        var lines = Collections.nCopies(count, new LineItem(1, 350));
        var error = assertThrows(InvalidQuoteException.class, () -> calculator.total(lines));
        assertEquals("明細は1〜50件です", error.getMessage());
    }
}

mvn -Dtest=QuoteCalculatorTest testを実行すると、パラメータごとの実行を含めて9件成功します。あえてQuoteCalculatorの加算先をint totalにすると、50億円を確認するテストだけが落ちます。戻り値がlongのままでも、加算の途中で値が壊れるからです。修正後に50億円のテストと2,750円のテストが両方成功することまで確認します。

4. Spring BootでJSONを受け取り、計算済みの合計を返す

POST /order-quotesへ、2行の明細をJSONで送ります。@RequestBodyが本文をリクエスト用の型に読み込み、ControllerがLineItemへ変換してからQuoteCalculatorを呼びます。Controllerに新しい掛け算はありません。正常時はHTTP 200と{"total":2750}を返します。このAPIは見積を計算して返す処理なので、注文を作成するときの201や保存の確認は対象外です。

{"lines":[{"quantity":2,"unitPrice":1200},{"quantity":1,"unitPrice":350}]}

リクエストの数量と単価はIntegerにします。これで「単価の項目が来なかったのでnull」と「単価0円を明示した」を区別できます。Controllerで項目を確認した後、LineItemに渡す段階でintになります。一方、数字を文字列や小数で送ったときに整数へ自動変換されると判断がぶれるため、サンプルのapplication.propertiesでJacksonの型変換を抑えています。Spring公式のリクエスト本文の変換も参照できます。

package example.orderquote;

import java.util.ArrayList;
import java.util.List;

import org.springframework.http.HttpStatus;
import org.springframework.http.converter.HttpMessageNotReadableException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class QuoteController {
    private final QuoteCalculator calculator;

    public QuoteController(QuoteCalculator calculator) {
        this.calculator = calculator;
    }

    @PostMapping("/order-quotes")
    public QuoteResponse quote(@RequestBody QuoteRequest request) {
        if (request.lines() == null) {
            throw new InvalidBodyException("linesが必要です");
        }

        List<LineItem> lines = new ArrayList<>();
        for (LineRequest line : request.lines()) {
            if (line == null || line.quantity() == null || line.unitPrice() == null) {
                throw new InvalidBodyException("各明細にquantityとunitPriceが必要です");
            }
            lines.add(new LineItem(line.quantity(), line.unitPrice()));
        }
        return new QuoteResponse(calculator.total(lines));
    }

    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(InvalidBodyException.class)
    public QuoteError invalidBody(InvalidBodyException error) {
        return new QuoteError("INVALID_BODY", error.getMessage());
    }

    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(InvalidQuoteException.class)
    public QuoteError invalidQuote(InvalidQuoteException error) {
        return new QuoteError("INVALID_QUOTE", error.getMessage());
    }

    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(HttpMessageNotReadableException.class)
    public QuoteError unreadableJson() {
        return new QuoteError("INVALID_JSON", "本文を整数の明細を持つJSONとして読み取れません");
    }

    public record QuoteRequest(List<LineRequest> lines) {}

    public record LineRequest(Integer quantity, Integer unitPrice) {}

    public record QuoteResponse(long total) {}

    public record QuoteError(String code, String message) {}

    private static final class InvalidBodyException extends RuntimeException {
        InvalidBodyException(String message) {
            super(message);
        }
    }
}

同じHTTP 400でも、対応が変わります。INVALID_JSONなら構文と型を直し、INVALID_BODYなら欠けている項目を入れます。INVALID_QUOTEなら数量・単価・件数を仕様の範囲へ直します。対象の例外を個別に処理することで、プログラムの別の不具合までまとめて「入力が悪い」と返すことを避けます。

同じURLに送る内容と、戻る値の違い
送る内容HTTP応答JSON
正常な明細2件200{"total":2750}
単価0円を明示200{"total":0}
単価の項目がない400INVALID_BODY
数量101400INVALID_QUOTE
構文不正、文字列の数量、小数の数量400INVALID_JSON

mvn -Dtest=OrderQuoteHttpTest testは、アプリと同じ設定でMockMvcにリクエストを渡します。テストは7件で、構文不正・数字を囲んだ文字列・小数をそれぞれ試します。実際にアプリを起動して送信するときは、プロジェクト直下でmvn spring-boot:runを実行し、別ターミナルから下のコマンドを使います。初回に依存ライブラリを取得する時間がかかる場合があります。

curl -i http://localhost:8080/order-quotes \
  -H 'Content-Type: application/json' --data @requests/valid.json

curl -i http://localhost:8080/order-quotes \
  -H 'Content-Type: application/json' --data @requests/missing-price.json

curl -i http://localhost:8080/order-quotes \
  -H 'Content-Type: application/json' --data @requests/invalid-quantity.json
OrderQuoteHttpTest.javaの全文を見る
package example.orderquote;

import java.nio.file.Files;
import java.nio.file.Path;

import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.http.MediaType;
import org.springframework.test.web.servlet.MockMvc;

import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

@SpringBootTest
@AutoConfigureMockMvc
class OrderQuoteHttpTest {
    @Autowired
    private MockMvc mvc;

    @Test
    void returns200WithTheTotal() throws Exception {
        mvc.perform(post("/order-quotes")
                .contentType(MediaType.APPLICATION_JSON)
                .content(example("valid.json")))
                .andExpect(status().isOk())
                .andExpect(jsonPath("$.total").value(2750));
    }

    @Test
    void acceptsAnExplicitZeroPrice() throws Exception {
        mvc.perform(post("/order-quotes").contentType(MediaType.APPLICATION_JSON)
                .content("""
                        {"lines":[{"quantity":1,"unitPrice":0}]}
                        """))
                .andExpect(status().isOk())
                .andExpect(jsonPath("$.total").value(0));
    }

    @Test
    void returns400ForAMissingPrice() throws Exception {
        mvc.perform(post("/order-quotes")
                .contentType(MediaType.APPLICATION_JSON)
                .content(example("missing-price.json")))
                .andExpect(status().isBadRequest())
                .andExpect(jsonPath("$.code").value("INVALID_BODY"));
    }

    @Test
    void returns400ForQuantityOutsideTheBusinessRange() throws Exception {
        mvc.perform(post("/order-quotes")
                .contentType(MediaType.APPLICATION_JSON)
                .content(example("invalid-quantity.json")))
                .andExpect(status().isBadRequest())
                .andExpect(jsonPath("$.code").value("INVALID_QUOTE"));
    }

    @ParameterizedTest
    @ValueSource(strings = {
            "{",
            "{\"lines\":[{\"quantity\":\"1\",\"unitPrice\":350}]}",
            "{\"lines\":[{\"quantity\":1.5,\"unitPrice\":350}]}"
    })
    void returns400ForJsonThatCannotBeReadAsIntegerLines(String json) throws Exception {
        mvc.perform(post("/order-quotes").contentType(MediaType.APPLICATION_JSON).content(json))
                .andExpect(status().isBadRequest())
                .andExpect(jsonPath("$.code").value("INVALID_JSON"));
    }

    private String example(String name) throws Exception {
        return Files.readString(Path.of("requests", name));
    }
}
InvalidQuoteException.javaの全文を見る
package example.orderquote;

public final class InvalidQuoteException extends RuntimeException {
    public InvalidQuoteException(String message) {
        super(message);
    }
}
OrderQuoteApplication.javaの全文を見る
package example.orderquote;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;

@SpringBootApplication
public class OrderQuoteApplication {
    public static void main(String[] args) {
        SpringApplication.run(OrderQuoteApplication.class, args);
    }

    @Bean
    QuoteCalculator quoteCalculator() {
        return new QuoteCalculator();
    }
}
application.propertiesの全文を見る
spring.jackson.mapper.allow-coercion-of-scalars=false
spring.jackson.deserialization.accept-float-as-int=false
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>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>3.5.16</version>
        <relativePath/>
    </parent>
    <groupId>example</groupId>
    <artifactId>order-quote-learning-path</artifactId>
    <version>1.0.0</version>
    <properties>
        <java.version>17</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.mockito</groupId>
                    <artifactId>mockito-core</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>org.mockito</groupId>
                    <artifactId>mockito-junit-jupiter</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

レビューでは、どこを変えればよいかを入力例から説明する

レビューコメント例。「数量101の400と、単価を送っていない400は、利用者が直す箇所が違います。INVALID_QUOTEとINVALID_BODYを別のリクエストで確認し、単価0円は成功することも残しましょう」。このコメントなら、直す理由と、直ったと判断する条件をそのままテストに移せます。

業務に応用するときは、信頼する入力も決めます。この実習は単価を送信者が選べる見積です。販売する注文で同じAPIを使い、送信された単価を信頼すると、利用者は商品を0円に書き換えられます。実際の注文は、明細から受け取る商品IDと数量を起点に、サーバー側で商品価格を取得する設計が必要です。保存や決済を足す前に、計算に使う値をどこから持ってくるかをレビューします。

  • 配列版とHTTP版で、同じ入力が2,750円になることを説明できる。
  • 1行の上限を変える場所と、全明細の上限を変える場所を指せる。
  • 50行の正常テストが、加算先をintにした誤りを見つける理由を言える。
  • 単価を省略した400、数量を超えた400、明示した0円の200を送り分けられる。

自分でSpringの機能を増やすときの一冊

この実習を動かした後で、Controllerへどう依存を渡すか、画面やデータ保存をどこに足すかを学びたいなら『作って学ぶ Spring Boot入門』が使えます。レコードクラス、JUnit、DIを手元で復習し、今回のLineItemやQuoteCalculatorがどの役割に当たるか照らし合わせてみてください。

書籍「作って学ぶ Spring Boot入門」の表紙
商品画像:Amazon.co.jp
PR Java新人・若手向け

作って学ぶ Spring Boot入門

多田 真敏 (著)

Spring Bootを、動くWebアプリを作りながら覚える。

Controller、画面、DB連携などを一つのアプリとして実装できます。Java基礎からSpringの現場へ進む橋渡しに向く一冊です。

  • Spring Bootを手を動かして学びたい
  • Webアプリ開発の流れをつかみたい

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

関連記事Javaのテスト入門におすすめの本|テストケースを選べる最初の1冊 最小値と最大値の次に何を確かめるか迷ったら、仕様からテストケースを選ぶ本を確認できます。 記事を読む 関連記事Spring Boot初心者におすすめの本3冊|現場で必要な力を身につける 見積の次に、注文の保存まで確かめたいときの学び方。HTTPの応答とDBの状態を一緒に確認する例もあります。 記事を読む

2,750円を保ったまま、確かめる範囲を一つずつ広げる

最初は1行ずつ足して2,750円を出します。次に値をまとめる場所を決め、JUnitで50億円や上限超過を確かめ、最後にJSONで同じ計算を呼びます。どこから直せばよいか迷ったら、「明細の値」「全行の計算」「HTTPの入力と応答」のどれが変わったかを、1つの入力と期待する結果で確かめてください。

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