【Springフレームワーク】jsonを取得するREST APIを作成しよう!

今回は、Springフレームワークについて取り上げたいと思います。

はじめに

前回まで取り上げていたStruts2でも同じことができるのですが、今回は今一番ホットなSpringで、jsonを返すREST APIを作成したいと思います。

また、REST APIには、jsonを返すパターンとxmlを返すパターンがあるのですが、それぞれ得意不得意な表現があり、どちらを使えばいいか一概に言えませんが、今回はjsonを返すプログラムで作成していきます。

jsonは、「JavaScript Object Notaion」の略でどのようなデータを持つかを示すデータ定義言語です。

詳しくは下記サイトを参考にして下さい。

開発環境

開発環境は下記の通りです。

Spring5.2.1.RELEASE
Jackson2.9.0

プロジェクトの作成

  • 「ファイル>新規>Spring レガシー・プロジェクト」を選択します。
  • プロジェクト名を入力し、デフォルト・ロケーションを使用をチェック、「Simple Spring Web Maven」を選択し、完了をクリックします。

pom.xmlの編集

  • pom.xmlを下記の通り編集します。

Jackson関連のライブラリを追加しておかないと、Rest Controllerからオブジェクトを返してもエラーとなり、Jsonに変換してくれません。

<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>org.springframework.samples.service.service</groupId>
  <artifactId>SpringRest</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <packaging>war</packaging>

    <properties>

        <!-- Generic properties -->
        <java.version>1.8</java.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>

        <!-- Web -->
        <jsp.version>2.2</jsp.version>
        <jstl.version>1.2</jstl.version>
        <servlet.version>3.1.0</servlet.version>

        <!-- Spring -->
        <spring-framework.version>5.2.1.RELEASE</spring-framework.version>

        <!-- Hibernate / JPA -->
        <hibernate.version>5.2.10.Final</hibernate.version>

        <!-- Logging -->
        <logback.version>1.2.3</logback.version>
        <slf4j.version>1.7.25</slf4j.version>

        <!-- Test -->
        <junit.version>4.12</junit.version>

        <!-- Jackson -->
        <jackson-version>2.9.0</jackson-version>

    </properties>

    <dependencies>

        <!-- Spring MVC -->    
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>${spring-framework.version}</version>
        </dependency>

        <!-- Other Web dependencies -->
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>jstl</artifactId>
            <version>${jstl.version}</version>
        </dependency>
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>${servlet.version}</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>javax.servlet.jsp</groupId>
            <artifactId>jsp-api</artifactId>
            <version>${jsp.version}</version>
            <scope>provided</scope>
        </dependency>

        <!-- Spring and Transactions -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-tx</artifactId>
            <version>${spring-framework.version}</version>
        </dependency>

        <!-- Logging with SLF4J & LogBack -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>${slf4j.version}</version>
            <scope>compile</scope>
        </dependency>
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>${logback.version}</version>
            <scope>runtime</scope>
        </dependency>

        <!-- Hibernate -->
        <dependency>
            <groupId>org.hibernate</groupId>
            <artifactId>hibernate-entitymanager</artifactId>
            <version>${hibernate.version}</version>
        </dependency>

        <!-- Test Artifacts -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-test</artifactId>
            <version>${spring-framework.version}</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>${junit.version}</version>
            <scope>test</scope>
        </dependency>

        <!-- Jackson -->
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-core</artifactId>
            <version>${jackson-version}</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>${jackson-version}</version>
        </dependency>
        <!-- 
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-annotations</artifactId>
            <version>${jackson-version}</version>
        </dependency>
         -->

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.6.1</version>
                <configuration>
                    <encoding>UTF-8</encoding>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

コントローラの作成

Restコントローラを作成します。

  • ソースフォルダを右クリックし、「新規>クラス」を選択します。
  • パッケージ名、クラス名を入力し、完了をクリックします。
  1. Restコントローラにするには、「@RestController」アノテーションを付けます。
  2. 「@RequestMapping」アノテーションでアクセスするパスを設定します。
  3. Mapオブジェクトを返せば、Jacksonが自動的にJsonに変換してくれます。
package com.pom2019.controller;

import java.util.LinkedHashMap;
import java.util.Map;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class RestTest {

    @RequestMapping(value="/getJson", method = RequestMethod.GET)
    public Map<String, Object> getJson() {
        Map<String, Object> map = new LinkedHashMap<>();
        map.put("title", "ITエンジニアぽむの備忘録");
        map.put("url", "https://pom2019.hatenablog.com/");
        map.put("description", "IT系で気になったことを書き留めておく備忘録です。");
        return map;
    }
}

mvc-config.xmlの編集

mvc-config.xmlを編集します。

  1. コンポネートスキャンに先程作成したRestTestクラスまでのパッケージを指定します。
<?xml version="1.0" encoding="UTF-8"?>

<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:mvc="http://www.springframework.org/schema/mvc" xmlns:context="http://www.springframework.org/schema/context"
    xsi:schemaLocation="http://www.springframework.org/schema/mvc https://www.springframework.org/schema/mvc/spring-mvc.xsd
        http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd">

     <context:component-scan
            base-package="com.pom2019.controller"/>

    <mvc:annotation-driven />

    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
            <!-- Example: a logical view name of 'showMessage' is mapped to '/WEB-INF/jsp/showMessage.jsp' -->
            <property name="prefix" value="/WEB-INF/view/"/>
            <property name="suffix" value=".jsp"/>
    </bean>

</beans>

実行結果

Pivotal tc Serverを起動し、「http://localhost:8080/SpringRest/getJson」にアクセスします。

正しく表示されました!

まとめ

RestTestクラスを正しく作成していましたが、コンポネートスキャンをしていなくて、サーバエラーが出てしまい、気付くのに時間が掛かってしまいました。。

コンポネートスキャンしたパッケージは、サブパッケージまでスキャンしてくれるようです。

コンポネートスキャンで複数のパッケージを指定したい場合は、コンマで区切るようです。

最後までお読み頂きありがとうございました。

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です