SpringBoot + h2 + mybatisでHelloWorld

ハンズオン用のメモです
開発環境はIntellij、ビルドツールはgradleです

今回のゴール
プロジェクトを新規作成する
SpringBootでHello
h2 + mybatis

今回のゴール

SpringBoot + h2 + mybatisなアプリケーションをIntellij + gradleで作成すること
APIは以下の3本を作成すること

API名	説明	METHOD	URL	RESPONSE
HELLO	ただhelloを返す	GET	http://localhost:8080/hello	`{"response":"hello"}`
LIST	DBのデータをリストで返す	GET	http://localhost:8080/list	`{"response":["2018-11-28T07:29:19.596"]}`
INSERT	DBに挿入する	GET	http://localhost:8080/insert	`{"response":{"id":2,"event_date_time":"2018-11-28T07:30:35.264"}}`

プロジェクトを新規作成する

File -> New -> Projectで作ります

f:id:naosim:20181128074202p:plain
Gradleを選択し、Javaにチェックを入れてNext

f:id:naosim:20181128074231p:plain
GroupIdに自分のパッケージ名をいれ、ArtifactIdにプロジェクト名をいれてNext

f:id:naosim:20181128074253p:plain
Use auto-importにチェックを入れます。そうするとimport文を自動的に最適化してくれます
あとはそのままでNext

次もNext

これで完了
いろいろロードされるのでしばし待つ

SpringBootでHello

build.gradleを編集する

buildscriptを追加する

springのプラグインを使いたいので、pluginsの上にbuildscriptを書く

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath("org.springframework.boot:spring-boot-gradle-plugin:2.0.5.RELEASE")
    }
}

pluginにspringを追加する

先ほどのbuildscriptを書いた上で以下を追加

plugins {
    id 'java'
    id 'eclipse'
    id 'idea'
}

apply plugin: 'org.springframework.boot'
apply plugin: 'io.spring.dependency-management'

pluginsに追加したらうまく動かなかったのでapply pluginにした
pluginsがダメな理由はよくわからない

dependenciesにspringを追加する

dependencies {
    compile("org.springframework.boot:spring-boot-starter-web")
    compileOnly group: 'org.projectlombok', name: 'lombok', version: '1.16.20'

    testCompile group: 'junit', name: 'junit', version: '4.12'
}

最小構成としてはspring-boot-starter-webだけで良い
個人的にlombokも使いたいので追加

build.gradle全体

全体はこんな感じ

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath("org.springframework.boot:spring-boot-gradle-plugin:2.0.5.RELEASE")
    }
}

plugins {
    id 'java'
    id 'eclipse'
    id 'idea'
}

apply plugin: 'org.springframework.boot'
apply plugin: 'io.spring.dependency-management'

group 'com.naosim'
version '1.0-SNAPSHOT'

sourceCompatibility = 1.8

repositories {
    mavenCentral()
}

dependencies {
    compile("org.springframework.boot:spring-boot-starter-web")
    compileOnly group: 'org.projectlombok', name: 'lombok', version: '1.16.20'

    testCompile group: 'junit', name: 'junit', version: '4.12'
}

Applicationにmain関数を書く

要するにメイン関数を記述します
パス: ./src/main/java/com/naosim/dddspringh2/Application.java

package com.naosim.dddspringh2;


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

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

Applicationクラスのパッケージ名がとても重要です
なぜならこのパッケージ配下は後記述する@Autowiredが自動的に聞きますがパッケージ配下以外の場合は設定をしないと効かないから
なので何も考えないのであればApplicationクラスは出来るだけ上位のパッケージに作った方がいいです

ControllerにhelloのAPIを作成する

helloを返すだけのAPIを作ります

package com.naosim.dddspringh2;

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

import java.util.HashMap;
import java.util.Map;

@RestController
@AllArgsConstructor
public class Controller {
    
    @RequestMapping(value = "/hello", method = RequestMethod.GET)
    public Map hello() {
        Map<String, Object> res = new HashMap<>();
        res.put("response", "hello");
        return res;
    }
}

@RequestMappingでURLのパスやメソッドを設定します
hello()の戻り値をMapにすると自動的にJSON形式に変換してくれます
なのでこのAPIの挙動としては

GET http://localhost:8080/hello

を投げると

{"response":"hello"}

を返すカタチになります

アプリケーションを実行してみる

実行の仕方もたくさんあるので紹介します
intelljがたまにおかしくなるので、やり方は全部知っておいた方がいいです

intellijのgradleから実行する

intellijの右側のバーからgradleを選択し、Tasks->application->bootRunをダブルクリックすると実行されます
intellijの停止ボタンを押すと停止できます
停止せずに別のアプリを起動するとポートが被るために起動できないことがあるので、実行が終わったら必ず停止しましょう

Applicationクラスから実行する

Applicationクラスのソースコードを表示すると、クラス名とメソッド名の左に再生ボタンが表示されています
これをクリックし、Run'Application.main()'を選択すると実行できます

ターミナルから実行する

ターミナルから

./gradlew bootRun

で実行できます
停止はcontrol + cです
intellijがおかしくなったらこのやり方が最強ですたまにintellijだとエラーだけどターミナルからなら実行出来ることがありますがこの場合、ソースコードは間違ってないです
intellijの何かがうまくいってないだけです
intellijを再起動するなり、ネットワーク周りの設定を見直すなりしましょう

動作確認

前置きが長くなりましたが動作確認ですアプリケーションを実行した状態で

http://localhost:8080/hello

にアクセスすると想定通りのjsonが表示されます

{"response":"hello"}

ここまででSpringBootでhelloを返すAPIができました

h2 + mybatis

ここから先はDBを扱う設定の話です

build.gradleにh2とmybatisを追加する

まずはbuild.gradleにライブラリを追加します

dependencies {
    compile("org.springframework.boot:spring-boot-starter-web")
    compileOnly group: 'org.projectlombok', name: 'lombok', version: '1.16.20'

    compile group: 'com.h2database', name: 'h2', version: '1.4.197'// 追加
    compile group: 'org.mybatis.spring.boot', name: 'mybatis-spring-boot-starter', version: '1.3.2'// 追加

    testCompile group: 'junit', name: 'junit', version: '4.12'
}

application.ymlにh2の設定を書く

リソースにh2の設定を記述しますパス: ./src/main/resources/application.yml

spring.datasource.url: jdbc:h2:mem:AZ;DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=TRUE
spring.datasource.driverClassName: org.h2.Driver
spring.datasource.username: sa
spring.datasource.password:
spring.h2.console.enabled: true

今回はインメモリの設定で書きました
もしもアプリケーションが終了してもデータが消えないようにしたいなら spring.datasource.urlの値をこんな感じにすると良いです

spring.datasource.url=jdbc:h2:file:./target/db/testdb

最後の./target/db/testdbがファイルの出力先になるので適宜変更してください

DBのセットアップ処理を書く

リソースにCreateTable文や初期状態のinsert文を書きます

schema.sql

schema.sql起動時に最初に呼んでくれるsqlです
ここにCreateTable文を書きます

DROP TABLE IF EXISTS time_event;
CREATE TABLE time_event (
    id INT PRIMARY KEY AUTO_INCREMENT,
    event_date_time DATETIME
);

DROP TABLE IF EXISTSはテーブルがあったら一旦消すコマンドですインメモリだから2回目の起動を意識する必要はないけど念のため決しておきます

data.sql

schema.sqlの次に呼んでくれるsqlです
ここにDBの初期状態を書いておきます

INSERT INTO time_event (event_date_time) VALUES (sysdate);

マッパーにDB操作のメソッドを書く

Event

後に記述するマッパーで利用するためのEventクラスを作ります作成したテーブルのカラム名と本クラスのフィールド名を一致させるのがミソですパス: ./src/main/java/com/naosim/dddspringh2/datasource/Event.java

package com.naosim.dddspringh2.datasource;

import java.time.LocalDateTime;

public class Event {
    public int id;
    public LocalDateTime event_date_time;
}

DbMapper

マッパーでDBの操作を書きますパス: ./src/main/java/com/naosim/dddspringh2/datasource/DbMapper.java

package com.naosim.dddspringh2.datasource;

import org.apache.ibatis.annotations.Insert;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.annotations.Select;

import java.time.LocalDateTime;
import java.util.List;

@Mapper
public interface DbMapper {
    @Select("SELECT * FROM time_event ORDER BY id")
    List<Event> select();

    @Insert("INSERT INTO time_event (event_date_time) VALUES (#{datetime});")
    void insert(@Param("datetime")LocalDateTime localDateTime);
}

interfaceで作ります interfaceに@Mapperを付けるとmybatisとして処理されます

select()の解説

@Select("SELECT * FROM time_event ORDER BY id")
List<Event> select();

@Selectの中にSELECT文を書きます
戻り値は今回は複数返るのでListにしています
ジェネリクスで型を指定すると、mybatisがそのクラスをnewしてカラム名と同じ名前のフィールドに値を入れるところまで自動でやってくれます
ちなみに戻り値の数が1つだけの場合はListではなく戻りの型を指定します
この状態でSELECTが複数ヒットした場合は例外になります
必ず1つとわかっているならその記述の方が良いと思います

insert()の解説

@Insert("INSERT INTO time_event (event_date_time) VALUES (#{datetime});")
void insert(@Param("datetime")LocalDateTime localDateTime);

@Insertの中にInsert文を書きます
変数を使う場合は#{datetime}のように書くとSQLインジェクション等をイイ感じに回避してくれます
変数名はメソッド引数の@Paramで指定した文字列と同じものを指定します

ControllerからMapperを使う

Controller.javaにAPIを追加します

マッパーをDIする

@RestController
@AllArgsConstructor
public class Controller {
    @Autowired
    private final DbMapper dbMapper;
...

フィールドにDbMapperを追加し、@Autowiredを付与します
これでController生成時にマッパーを生成してくれます
注意点としては、@AutowiredはDIによって生成されたものの中でだけ効くということたとえばControllerクラスを自分で

Controller c = new Controller();
System.out.print(c.dbMapper);

として場合、Controllerは自分で生成していてAutowiredが聴いていないためdbMapperはnullになりますそれを防ぐ方法としては「@Autowiredを付けるフィールドは必ずfinalを付け、コンストラクタインジェクションにすること」です
DIの方法にはコンストラクタインジェクションとフィールドインジェクションの二種類がありますが、前者の方がいいです理由は...良い記事を見つけたのでリンクを貼っておきます

pppurple.hatenablog.com

今回の例ではDbMapperにfinalを付けて、Controllerクラスに@AllArgsConstructorを書くことでコンストラクタインジェクションにしています

DB内のデータをリストで取得するAPIを作成する

上記のAutowiredでマッパーが使えるようになったのでそれを使ってデータ取得APIを作りますマッパーからデータを取得し、日付だけにして返します

@RequestMapping(value = "/list", method = RequestMethod.GET)
public Map list() {
    Map<String, Object> res = new HashMap<>();
    res.put("response", dbMapper.select().stream().map(v -> v.event_date_time).collect(Collectors.toList()));
    return res;
}

この状態でhttp://localhost:8080/listにアクセスすると

{"response":["2018-11-28T07:29:19.596"]}

のようなデータが取得できます

DBにデータを投入するAPIを作成する

現在日時をinsertするAPIを作成しますインサートしたら、インサートした値をレスポンスで返します

@RequestMapping(value = "/insert", method = RequestMethod.GET)
public Map insert() {
    dbMapper.insert(LocalDateTime.now());

    // 返却値
    List l = dbMapper.select();
    Map<String, Object> res = new HashMap<>();
    res.put("response", l.get(l.size() - 1));
    return res;

}

この状態でhttp://localhost:8080/insertにアクセスすると

{"response":{"id":2,"event_date_time":"2018-11-28T07:30:35.264"}}

のようなデータが返ってきて、挿入できたことが確認できます

Controllerの全体はこんな感じ

package com.naosim.dddspringh2;

import com.naosim.dddspringh2.datasource.DbMapper;
import lombok.AllArgsConstructor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import java.time.LocalDateTime;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;

@RestController
@AllArgsConstructor
public class Controller {
    @Autowired
    private final DbMapper dbMapper;

    @RequestMapping(value = "/hello", method = RequestMethod.GET)
    public Map hello() {
        Map<String, Object> res = new HashMap<>();
        res.put("response", "hello");
        return res;
    }

    @RequestMapping(value = "/list", method = RequestMethod.GET)
    public Map list() {
        Map<String, Object> res = new HashMap<>();
        res.put("response", dbMapper.select().stream().map(v -> v.event_date_time).collect(Collectors.toList()));
        return res;
    }

    @RequestMapping(value = "/insert", method = RequestMethod.GET)
    public Map insert() {
        dbMapper.insert(LocalDateTime.now());

        // 返却値
        List l = dbMapper.select();
        Map<String, Object> res = new HashMap<>();
        res.put("response", l.get(l.size() - 1));
        return res;

    }
}

以上で、ゴール達成です
お疲れ様でした！