Web系開発メモ

Java, C#, HTML, CSS, JavaScript のことなどを書いてます。

SpringBoot リクエストのJSONをバインドする方法

Spring Boot の Webアプリで、リクエストの JSON をオブジェクトにバインドする方法を書いていきます。

バージョン

動作確認で使用した製品のバージョンは以下の通りです。

1. モデルの作成

JSON の値をバインドするクラスを作成します。

src/main/java/org/example/model/Person.java

package org.example.model;

import lombok.Getter;
import lombok.Setter;

@Getter @Setter
public class Person {
  private long id;
  private String name;
  private int age;
}

プロパティ名と JSONのキー名を同じにする必要があります。

2. コントローラーの作成

メソッドの引数にアノテーション @RequestBody を定義すると、JSONの値がオブジェクトに設定されます。

package org.example.controller;

import org.example.model.Person;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class PersonController {
  @PostMapping("/person")
  public Person create(@RequestBody Person person) {
    person.setId(1);
    return person;
  }
}

3. 動作確認

Windowscurl コマンドで動作確認をしました。

> curl -d "{\"name\":\"John\", \"age\":\"30\"}" -H "Content-Type: application/json" -X POST http://localhost:8080/person
{"id":1,"name":"John","age":30}

Windowscurl は、JSONの二重引用符を「\」でエスケープする必要があります。

4. 動作確認用資源

動作確認のために、以下のアプリ起動クラスを作成しました。

src/main/java/org/example/SpringApp.java

package org.example;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

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

Maven のビルドファイルは以下の通りです。

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 http://maven.apache.org/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>3.0.1</version>
    <relativePath/> <!-- lookup parent from repository -->
  </parent>

  <groupId>org.example</groupId>
  <artifactId>spring-bind-json</artifactId>
  <version>1.0.0</version>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    <java.version>17</java.version>
  </properties>

  <dependencies>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <scope>provided</scope>
    </dependency>
  </dependencies>

  <build>
    <plugins>
      <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
      </plugin>
    </plugins>
  </build>
</project>