SpringBoot JSONを返す方法（@RestControllerの使用方法）

Spring Boot を使って、JSON のレスポンスを返却する方法を書いていきます。

バージョン

Spring Boot 3.0.1
Java 17

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

以下の Java プログラムを作成します。

src/main/java/org/sample/controller/HelloController.java

package org.sample.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.Map;

@RestController
public class HelloController {
  @GetMapping("/hello")
  public Map<String, String> hello() {
    return Map.of("msg", "こんにちは。");
  }
}

クラスにアノテーション @RestController を付けると、メソッドの戻り値を JSON に変換してくれます。

1.1. メソッドの戻り値について

メソッドの戻り値を、Bean や他のコレクション（List や配列など）にしても大丈夫です。Spring は JSON変換に Jackson を使っています。

2. 起動クラスの作成

Spring Boot のアプリを起動するコードを作成します。

src/main/java/org/sample/SpringApp.java

package org.sample;

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);
  }
}

3. ビルドファイルの作成

プロジェクトのフォルダの下に、Maven の pom.xml を作成します。

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<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.0.1</version>
    <relativePath/> <!-- lookup parent from repository -->
  </parent>

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

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

  <dependencies>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
  </dependencies>

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

spring-boot-starter-web が利用できれば、他のビルドシステムでも大丈夫です。

4. 動作確認

アプリを起動して以下の URL にアクセスします。

http://localhost:8080/hello

以下の JSON を受け取ることができます。

{"msg":"こんにちは。"}

Web系開発メモ

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