Spring Boot/第四回 Spring Bootで REST

Spring Bootを使うと、RESTの実装が簡単に出来るので試してみる。
試しに簡単な顧客管理のシステムを実装する。

REST

REST について、詳しい説明は他のサイトを参照してほしいが、要は CRUD のそれぞれを HTTP メソッドで表現するWebサービスの考え方のこと。

CRUD HTTPメソッド
Create POST
Read GET
Update PUT
Delete DELETE

何に対する CURD 操作なのかは URL で表す。
たとえば /api/customer に対して GET を送ると「顧客情報の取得」といった具合。

今回は下記の実装を試してみる。

API HTTPメソッド リソースパス 正常時HTTPレスポンスステータス
顧客全件取得 GET /api/customer 200 OK
顧客一件取得 GET /api/customer/{id} 200 OK
顧客一件作成 POST /api/customer 201 CREATED
顧客一件更新 PUT /api/customer/{id} 200 OK
顧客一件削除 DELETE /api/customer/{id} 204 NO CONTENT

{id}の部分にユニークなIDを渡して特定の顧客を取得したり更新したり削除したりする。

Maven

pom.xmlに追加する依存関係は下記の通り。

  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>3.8.1</version>
      <scope>test</scope>
    </dependency>
    <dependency>  <!-- a -->
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>  <!-- b -->
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>
    <dependency>  <!-- c -->
      <groupId>com.h2database</groupId>
      <artifactId>h2</artifactId>
    </dependency>
    <dependency>  <!-- d -->
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <version>1.14.0</version>
      <scope>provided</scope>
    </dependency>
  </dependencies>

a -> Spring BootでWebアプリを作成するための依存関係。
b -> Spring BootでJPAを扱うための依存関係。
c -> H2の依存関係。
d -> Lombokの依存関係。

Repository

階層の一番下。
Repositoryから実装する。

まずは顧客情報を入れるデータベースの設定から。
pom.xmlに書いた依存関係の通り、データベースはH2を使用する。
プロジェクトがあるフォルダから相対パスで testdb フォルダ内に H2 のデータベースを作成する。
src/main/resources/application.yml に下記を記載。

spring:
  datasource:
    driverClassName: org.h2.Driver
    url: jdbc:h2:file:testdb/testdb
    username: sa
    password:
  jpa:
    hibernate:
      ddl-auto: none

データソースの URL の通り、testdb フォルダ内に testdb というデータベースファイルを指定する。
JPA プロバイダは Hibernate を使用するので、その設定も併せて行う。

続いてテーブル定義。
DDL は下記の通りで src/main/resources/schema.sql に記載する。

create table if not exists customer (
    id int primary key auto_increment,
    name varchar(50) not null,
    email varchar(50) not null
);

id -> プライマリキー。オートインクリメントで一意の値を自動で割り当てる。
name -> 名前を格納。
email -> メールアドレスを格納。


Hibernate はエンティティクラスからテーブルを自動作成する機能があるが、application.yml の「ddl-auto: none」の通り作成は行わない。
そのかわり、Spring Boot の機能で schema.sqlDDL を書いて、そちらでテーブルを作ってもらう。

続いてエンティティ定義。
src/main/java/toolsspringsample/springsample04/domain/Customer.java に記載する。

package tools.springsample.springsample04.domain;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import javax.persistence.Table;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Entity    // a
@Table(name="customer")    // b
@Data    // c
@AllArgsConstructor    // d
@NoArgsConstructor    // e
public class Customer {
    @Id    // f
    @GeneratedValue    // g
    private Integer id;

    @Column(nullable=false)    // h
    private String name;

    @Column(nullable=false)    // h
    private String email;
}

JPAの記述とLombokの記述が入り乱れているので注意が必要。

a -> JPA: エンティティクラスであることを記すアノテーション
b -> JPA: どのテーブルとマッピングするのか指定する。
c -> Lombok: すべてのフィールドに対するsetter/getterメソッド、equalsメソッド、hashCodeメソッド、toStringメソッドが生成される。
d -> Lombok: すべてのフィールドを初期化する引数を持つコンストラクタが生成される。
e -> Lombok: 引数なしのデフォルトコンストラクタが生成される。
f -> JPA: フィールドidがエンティティの主キーであることを表す。
g -> JPA: 自動採番する主キーであることを表す。
h -> JPA: テーブルに該当するカラムであることを表す。nullでの更新を抑制する。


最後にリポジトリ定義。
src/main/java/toolsspringsample/springsample04/repository/CustomerRepository.java に記載する。

package tools.springsample.springsample04.repository;

import tools.springsample.springsample04.domain.Customer;

import org.springframework.data.jpa.repository.JpaRepository;

public interface CustomerRepository
    extends JpaRepository<Customer, Integer> {    // a
}

a -> JpaRepositoryを拡張したインターフェースを定義。

まだ複雑な実装がないので、定義はとてもシンプル。
JpaRepositoryを拡張すると、実行時に実装クラスが自動生成される。
ジェネリクスで永続化対象のクラス「Customer」を指定し、キー項目の型を「Integer」と指定する。

Service

サービスはビジネスロジックを書くが、今回は処理らしい処理は書かずに下位層のリポジトリの呼び出しのみを行う。
src/main/java/toolsspringsample/springsample04/service/CustomerService.java に記載する。

package tools.springsample.springsample04.service;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

import tools.springsample.springsample04.domain.Customer;
import tools.springsample.springsample04.repository.CustomerRepository;

@Service    // a
@Transactional    // b
public class CustomerService {
    @Autowired    // c
    CustomerRepository repository;    // d

    // 顧客全件取得
    public List<Customer> findAll() {    // e
        return repository.findAll();
    }

    // 顧客一件取得
    public Customer findOne(Integer id) {    // f
        return repository.findOne(id);
    }

    // 顧客一件作成
    public Customer create(Customer customer) {    // g
        return repository.save(customer);
    }

    // 顧客一件更新
    public Customer update(Customer customer) {    // h
        return repository.save(customer);
    }

    // 顧客一件削除
    public void delete(Integer id) {    // i
        repository.delete(id);
    }
}

a -> サービスクラスであることを記すアノテーション
b -> トランザクションを扱うクラスであることを記すアノテーション
   DIからの CustomerService クラスのメソッド呼び出し時に自動的にトランザクション処理を行う。
   つまり例外が発生したらロールバックし、発生しなかったらコミットする。
c -> DIコンテナからインスタンスを取得する。
d -> リポジトリクラスの参照。
e -> 顧客全件取得処理。
f -> 顧客一件取得処理。
g -> 顧客一件作成処理。
h -> 顧客一件更新処理。
i -> 顧客一件削除処理。

このように今回は下位層のリポジトリの呼び出しのみを行う。

RestController

RestController は、URLと処理をマッピングし、そこからサービスの呼び出しを行う。

src/main/java/toolsspringsample/springsample04/api/CustomerRestController.java に記載する。

package tools.springsample.springsample04.api;

import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestController;

import tools.springsample.springsample04.domain.Customer;
import tools.springsample.springsample04.service.CustomerService;

@RestController    // a
@RequestMapping("api/customer")    // b
public class CustomerRestController {
    @Autowired    // c
    CustomerService service;    // d

    // 顧客全件取得
    @RequestMapping(method=RequestMethod.GET)    // e
    public List<Customer> getCustomer() {
        return service.findAll();
    }

    // 顧客一件取得
    @RequestMapping(method=RequestMethod.GET, value="{id}")    // f
    public Customer getCustomer(@PathVariable Integer id) {
        return service.findOne(id);
    }

    // 顧客一件作成
    @RequestMapping(method=RequestMethod.POST)    // g
    @ResponseStatus(HttpStatus.CREATED)    // h
    public Customer postCustomer(@RequestBody Customer customer) {
        return service.create(customer);
    }

    // 顧客一件更新
    @RequestMapping(method=RequestMethod.PUT, value="{id}")    // i
    public Customer putCustomer(@PathVariable Integer id,
                                @RequestBody Customer customer) {
        customer.setId(id);
        return service.update(customer);
    }

    // 顧客一件削除
    @RequestMapping(method=RequestMethod.DELETE, value="{id}")    // j
    @ResponseStatus(HttpStatus.NO_CONTENT)    // k
    public void deleteCustomer(@PathVariable Integer id) {
        service.delete(id);
    }
}

a -> RESTコントローラクラスであることを記すアノテーション
b -> URL(api/customer)とマッピングさせることを定義。
c -> DIコンテナからインスタンスを取得する。
d -> サービスクラスの参照。
e -> 顧客全件取得処理を HTTP の GET メソッドマッピングする。
f -> 顧客一件取得処理を HTTP の GET メソッドマッピングする。
   URLの最後に付加したIDを取得し、@PathVariable でその URL の ID と引数をマッピングする。
g -> 顧客一件作成処理を HTTP の POST メソッドマッピングする。
   POST 時の HTTP ボディを @RequestBody で引数とマッピングする。
h -> 正常時のレスポンスコードを CREATED (201) とする
i -> 顧客一件更新処理を HTTP の PUT メソッドマッピングする。
   URLの最後に付加したIDを取得し、@PathVariable でその URL の ID と引数をマッピングする。
   PUT 時の HTTP ボディを @RequestBody で引数とマッピングする。
j -> 顧客一件削除処理を HTTP の DELETE メソッドマッピングする。
   URLの最後に付加したIDを取得し、@PathVariable でその URL の ID と引数をマッピングする。

テスト用HTTPクライアント

REST を試すのに各種 HTTP メソッドをブラウザから送信するのは大変なので、コマンドラインから動作する HTTP クライアントの「curl」を使用する。
http://www.paehl.com/open_source/?Welcome

ブラウザでページを表示し、左側の「CURL」からダウンロード。
ZIPを解凍してコマンドにパスを通して動作できるようにする。

コンパイルして実行

以下のようにコンパイルする。

mvn package

続いて起動

mvn spring-boot:run
顧客一件作成

まずはcurlを使って顧客一件作成。

curl http://localhost:8080/api/customer -v -X POST -H "Content-Type: application/json" -d "{\"name\":\"name01\", \"email\":\"name01@test\"}"

curl コマンドのすぐ後で指定する URL が RestController の @RequestMapping の通りであることを確認。
-X で HTTP メソッドの「POST」を送り、CustomerRestControllerクラス の postCustomer メソッドを呼ぶ。
-H でボディの内容をJSONで送ることを指定。
-d でボディの内容を記載。

実行結果は下記の通り。

# curl http://localhost:8080/api/customer -v -X POST -H "Content-Type: application/json" -d "{\"name\":\"name01\", \"email\":\"name01@test\"}"
*   Trying ::1...
* Connected to localhost (::1) port 8080 (#0)
> POST /api/customer HTTP/1.1
> User-Agent: curl/7.41.0
> Host: localhost:8080
> Accept: */*
> Content-Type: application/json
> Content-Length: 40
>
* upload completely sent off: 40 out of 40 bytes
< HTTP/1.1 201 Created
< Server: Apache-Coyote/1.1
< Content-Type: application/json;charset=UTF-8
< Transfer-Encoding: chunked
< Date: Thu, 02 Apr 2015 17:28:06 GMT
<
{"id":1,"name":"name01","email":"name01@test"}* Connection #0 to host localhost left intact

最後の行に返ってきた JSON が出力されている。
読みやすくすると以下の通り。

{
    "id":1,
    "name":"name01",
    "email":"name01@test"
}
顧客一件更新

続いて顧客一件更新。

curl http://localhost:8080/api/customer/1 -v -X PUT -H "Content-Type: application/json" -d "{\"name\":\"name01_\", \"email\":\"name01_@test\"}"

URLの最後に更新対象のID「1」を指定する。これは先ほど追加したID。
-X で HTTP メソッドの「PUT」を送り、CustomerRestControllerクラス の putCustomer メソッドを呼ぶ。
-H でボディの内容をJSONで送ることを指定。
-d でボディの内容を記載。

「name01」の部分を「name01_」に変更するリクエストになる。

実行結果は下記の通り。

# curl http://localhost:8080/api/customer/1 -v -X PUT -H "Content-Type: application/json" -d "{\"name\":\"name01_\", \"email\":\"name01_@test\"}"
*   Trying ::1...
* Connected to localhost (::1) port 8080 (#0)
> PUT /api/customer/1 HTTP/1.1
> User-Agent: curl/7.41.0
> Host: localhost:8080
> Accept: */*
> Content-Type: application/json
> Content-Length: 42
>
* upload completely sent off: 42 out of 42 bytes
< HTTP/1.1 200 OK
< Server: Apache-Coyote/1.1
< Content-Type: application/json;charset=UTF-8
< Transfer-Encoding: chunked
< Date: Fri, 03 Apr 2015 03:08:44 GMT
<
{"id":1,"name":"name01_","email":"name01_@test"}* Connection #0 to host localhost left intact

最後の行に返ってきた JSON が出力されている。
読みやすくすると以下の通り。

{
    "id":1,
    "name":"name01_",
    "email":"name01_@test"
}
顧客一件削除

続いて顧客一件削除。

curl http://localhost:8080/api/customer/1 -v -X DELETE

URLの最後に削除対象のID「1」を指定する。これは先ほど追加したID。
-X で HTTP メソッドの「DELETE」を送り、CustomerRestControllerクラス の deleteCustomer メソッドを呼ぶ。
今回はボディは不要なので -H も -d もなし。

実行結果は下記の通り。

# curl http://localhost:8080/api/customer/1 -v -X DELETE
*   Trying ::1...
* Connected to localhost (::1) port 8080 (#0)
> DELETE /api/customer/1 HTTP/1.1
> User-Agent: curl/7.41.0
> Host: localhost:8080
> Accept: */*
>
< HTTP/1.1 204 No Content
< Server: Apache-Coyote/1.1
< Date: Fri, 03 Apr 2015 03:12:59 GMT
<
* Connection #0 to host localhost left intact

deleteCustomer メソッドで @ResponseStatus を NO_CONTENT にしているので戻り値のボディはなし。

顧客全件取得

実際に削除できたのか、顧客全件取得する。

curl http://localhost:8080/api/customer -v -X GET

全件取得なのでURLの最後にIDは指定しない。
-X で HTTP メソッドの「GET」を送り、CustomerRestControllerクラス の引数なしの getCustomer メソッドを呼ぶ。

実行結果は下記の通り。

# curl http://localhost:8080/api/customer -v -X GET
*   Trying ::1...
* Connected to localhost (::1) port 8080 (#0)
> GET /api/customer HTTP/1.1
> User-Agent: curl/7.41.0
> Host: localhost:8080
> Accept: */*
>
< HTTP/1.1 200 OK
< Server: Apache-Coyote/1.1
< Content-Type: application/json;charset=UTF-8
< Transfer-Encoding: chunked
< Date: Fri, 03 Apr 2015 03:17:41 GMT
<
[]* Connection #0 to host localhost left intact

テーブルに一件も入っていなので空のボディが返ってくる。

わかりにくいので下記を実行して 2 件追加する。

curl http://localhost:8080/api/customer -v -X POST -H "Content-Type: application/json" -d "{\"name\":\"name02\", \"email\":\"name02@test\"}"
curl http://localhost:8080/api/customer -v -X POST -H "Content-Type: application/json" -d "{\"name\":\"name03\", \"email\":\"name03@test\"}"

もう一度、顧客全件取得する。

curl http://localhost:8080/api/customer -v -X GET

実行結果は下記の通り。

# curl http://localhost:8080/api/customer -v -X GET
*   Trying ::1...
* Connected to localhost (::1) port 8080 (#0)
> GET /api/customer HTTP/1.1
> User-Agent: curl/7.41.0
> Host: localhost:8080
> Accept: */*
>
< HTTP/1.1 200 OK
< Server: Apache-Coyote/1.1
< Content-Type: application/json;charset=UTF-8
< Transfer-Encoding: chunked
< Date: Fri, 03 Apr 2015 03:28:03 GMT
<
[{"id":2,"name":"name02","email":"name02@test"},{"id":3,"name":"name03","email":"name03@test"}]* Connection #0 to host localhost left intact

読みやすくすると以下の通り。

{
    "id":2,
    "name":"name02",
    "email":"name02@test"
},
{
    "id":3,
    "name":"name03",
    "email":"name03@test"
}
顧客一件取得

まだ実行していない処理、顧客一件取得を試す。

curl http://localhost:8080/api/customer/2 -v -X GET

URLの最後に取得対象のID「2」を指定する。これは先ほど追加したID。
-X で HTTP メソッドの「GET」を送り、CustomerRestControllerクラス の今度は引数ありの getCustomer メソッドを呼ぶ。
   URLの最後に付加したIDを、@PathVariable で引数 id にマッピングする。

実行結果は下記の通り。

# curl http://localhost:8080/api/customer/2 -v -X GET
*   Trying ::1...
* Connected to localhost (::1) port 8080 (#0)
> GET /api/customer/2 HTTP/1.1
> User-Agent: curl/7.41.0
> Host: localhost:8080
> Accept: */*
>
< HTTP/1.1 200 OK
< Server: Apache-Coyote/1.1
< Content-Type: application/json;charset=UTF-8
< Transfer-Encoding: chunked
< Date: Fri, 03 Apr 2015 03:36:28 GMT
<
{"id":2,"name":"name02","email":"name02@test"}* Connection #0 to host localhost left intact

読みやすくすると以下の通り。

{
    "id":2,
    "name":"name02",
    "email":"name02@test"
}

うん。
確かに 1 件だけ取得できた。

まとめ

RestController で REST のリクエストを取得し、
Service でビジネスロジックを書いて(今回は処理らしい処理は書いていないが)、
Repository で永続化をする。
ここまでを一気にまとめた。

次回は Controller と UI まわりをやってみよう。

■ 参考文献 ■

この記事で参考にしたのは「はじめての Spring Boot」です。

Groovyにプロキシ設定

groovyコマンドに下記の引数を追加してプロキシサーバーを指定できる。

groovy -DproxyHost=xxx.xxx.xxx.xxx -DproxyPort=xxx


ただし、コマンドを実行するたびに引数を指定するのは面倒なので、ホームディレクトリに下記フォルダとファイルを作成して、そこに記述すると良い。

Windowsの場合
.groovy/preinit.bat

下記のように記述する。

set JAVA_OPTS=-DproxyHost=xxx.xxx.xxx.xxx -DproxyPort=3128

バッチファイルとして記述する。

UNIX/Linux系の場合
.groovy/startup

下記のように記述する。

JAVA_OPTS="-DproxyHost=xxx.xxx.xxx.xxx -DproxyPort=3128"

シェルとして記述する。

根拠

この辺りのパラメータはstartGroovyを見ると分かる。
Windowsの場合はstartGroovy.batの下記の記述。

if exist "%USERPROFILE%/.groovy/preinit.bat" call "%USERPROFILE%/.groovy/preinit.bat"

UNIX/Linux系の場合はstartGroovyの下記の記述。

GROOVY_STARTUP="$HOME/.groovy/startup"
if [ -r "$GROOVY_STARTUP" ] ; then
    . "$GROOVY_STARTUP"
fi

sourceしているのでstartupには実行権限はいらない。
(たぶん。Windowsでしか試していない・・・)

Spring Boot/第三回 Spring Bootでデータベース操作(JPA編)

Spring Bootでデータベース操作をする。

Spring Bootでのデータベース操作は

の2種類があるが、今回はORマッピングの方の話。
JavaのORマッピングの仕様「JPAJava Persistence APIJavaの永続化のAPI)」でデータベースを操作する。

依存関係の追加

まずはMavenの依存関係の変更。

  <dependencies>
    <!-- append start -->
    <dependency>  <!-- a -->
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>
    <dependency>  <!-- b -->
      <groupId>com.h2database</groupId>
      <artifactId>h2</artifactId>
    </dependency>
    <dependency>  <!-- c -->
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <version>1.14.0</version>
      <scope>provided</scope>
    </dependency>
    <!-- append end -->
  </dependencies>

a -> Spring BootでJPAを扱うための依存関係。
b -> H2の依存関係。
c -> Lombokの依存関係。

JDBCを使うときは「spring-boot-starter-jdbc」だが、JPAを使うときは「spring-boot-starter-data-jpa」を指定する。


依存関係を見てみる

mvn dependency:tree

結果は以下の通り。

[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building SpringSample03 1.0-SNAPSHOT
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- maven-dependency-plugin:2.8:tree (default-cli) @ SpringSample03 ---
[INFO] tools.springsample.springsample03:SpringSample03:jar:1.0-SNAPSHOT
[INFO] +- junit:junit:jar:3.8.1:test
[INFO] +- org.springframework.boot:spring-boot-starter-web:jar:1.1.5.RELEASE:compile
[INFO] |  +- org.springframework.boot:spring-boot-starter:jar:1.1.5.RELEASE:compile
[INFO] |  |  +- org.springframework.boot:spring-boot:jar:1.1.5.RELEASE:compile
[INFO] |  |  +- org.springframework.boot:spring-boot-autoconfigure:jar:1.1.5.RELEASE:compile
[INFO] |  |  +- org.springframework.boot:spring-boot-starter-logging:jar:1.1.5.RELEASE:compile
[INFO] |  |  |  +- org.slf4j:jul-to-slf4j:jar:1.7.7:compile
[INFO] |  |  |  +- org.slf4j:log4j-over-slf4j:jar:1.7.7:compile
[INFO] |  |  |  \- ch.qos.logback:logback-classic:jar:1.1.2:compile
[INFO] |  |  |     \- ch.qos.logback:logback-core:jar:1.1.2:compile
[INFO] |  |  \- org.yaml:snakeyaml:jar:1.13:runtime
[INFO] |  +- org.springframework.boot:spring-boot-starter-tomcat:jar:1.1.5.RELEASE:compile
[INFO] |  |  +- org.apache.tomcat.embed:tomcat-embed-core:jar:7.0.54:compile
[INFO] |  |  +- org.apache.tomcat.embed:tomcat-embed-el:jar:7.0.54:compile
[INFO] |  |  \- org.apache.tomcat.embed:tomcat-embed-logging-juli:jar:7.0.54:compile
[INFO] |  +- com.fasterxml.jackson.core:jackson-databind:jar:2.3.3:compile
[INFO] |  |  +- com.fasterxml.jackson.core:jackson-annotations:jar:2.3.3:compile
[INFO] |  |  \- com.fasterxml.jackson.core:jackson-core:jar:2.3.3:compile
[INFO] |  +- org.hibernate:hibernate-validator:jar:5.0.3.Final:compile
[INFO] |  |  +- javax.validation:validation-api:jar:1.1.0.Final:compile
[INFO] |  |  +- org.jboss.logging:jboss-logging:jar:3.1.1.GA:compile
[INFO] |  |  \- com.fasterxml:classmate:jar:1.0.0:compile
[INFO] |  +- org.springframework:spring-core:jar:4.0.6.RELEASE:compile
[INFO] |  +- org.springframework:spring-web:jar:4.0.6.RELEASE:compile
[INFO] |  |  +- org.springframework:spring-aop:jar:4.0.6.RELEASE:compile
[INFO] |  |  |  \- aopalliance:aopalliance:jar:1.0:compile
[INFO] |  |  +- org.springframework:spring-beans:jar:4.0.6.RELEASE:compile
[INFO] |  |  \- org.springframework:spring-context:jar:4.0.6.RELEASE:compile
[INFO] |  \- org.springframework:spring-webmvc:jar:4.0.6.RELEASE:compile
[INFO] |     \- org.springframework:spring-expression:jar:4.0.6.RELEASE:compile
[INFO] +- org.springframework.boot:spring-boot-starter-test:jar:1.1.5.RELEASE:test
[INFO] |  +- org.mockito:mockito-core:jar:1.9.5:test
[INFO] |  |  \- org.objenesis:objenesis:jar:1.0:test
[INFO] |  +- org.hamcrest:hamcrest-core:jar:1.3:test
[INFO] |  +- org.hamcrest:hamcrest-library:jar:1.3:test
[INFO] |  \- org.springframework:spring-test:jar:4.0.6.RELEASE:test
[INFO] +- org.springframework.boot:spring-boot-starter-data-jpa:jar:1.1.5.RELEASE:compile
[INFO] |  +- org.springframework.boot:spring-boot-starter-aop:jar:1.1.5.RELEASE:compile
[INFO] |  |  +- org.aspectj:aspectjrt:jar:1.8.1:compile
[INFO] |  |  \- org.aspectj:aspectjweaver:jar:1.8.1:compile
[INFO] |  +- org.springframework.boot:spring-boot-starter-jdbc:jar:1.1.5.RELEASE:compile
[INFO] |  |  +- org.springframework:spring-jdbc:jar:4.0.6.RELEASE:compile
[INFO] |  |  +- org.apache.tomcat:tomcat-jdbc:jar:7.0.54:compile
[INFO] |  |  |  \- org.apache.tomcat:tomcat-juli:jar:7.0.54:compile
[INFO] |  |  \- org.springframework:spring-tx:jar:4.0.6.RELEASE:compile
[INFO] |  +- org.hibernate:hibernate-entitymanager:jar:4.3.5.Final:compile
[INFO] |  |  +- org.jboss.logging:jboss-logging-annotations:jar:1.2.0.Beta1:compile
[INFO] |  |  +- org.hibernate:hibernate-core:jar:4.3.5.Final:compile
[INFO] |  |  |  +- antlr:antlr:jar:2.7.7:compile
[INFO] |  |  |  \- org.jboss:jandex:jar:1.1.0.Final:compile
[INFO] |  |  +- dom4j:dom4j:jar:1.6.1:compile
[INFO] |  |  |  \- xml-apis:xml-apis:jar:1.0.b2:compile
[INFO] |  |  +- org.hibernate.common:hibernate-commons-annotations:jar:4.0.4.Final:compile
[INFO] |  |  +- org.hibernate.javax.persistence:hibernate-jpa-2.1-api:jar:1.0.0.Final:compile
[INFO] |  |  +- org.jboss.spec.javax.transaction:jboss-transaction-api_1.2_spec:jar:1.0.0.Final:compile
[INFO] |  |  \- org.javassist:javassist:jar:3.18.1-GA:compile
[INFO] |  +- org.springframework:spring-orm:jar:4.0.6.RELEASE:compile
[INFO] |  +- org.springframework.data:spring-data-jpa:jar:1.6.2.RELEASE:compile
[INFO] |  |  +- org.springframework.data:spring-data-commons:jar:1.8.2.RELEASE:compile
[INFO] |  |  +- org.slf4j:slf4j-api:jar:1.7.7:compile
[INFO] |  |  \- org.slf4j:jcl-over-slf4j:jar:1.7.7:compile
[INFO] |  \- org.springframework:spring-aspects:jar:4.0.6.RELEASE:compile
[INFO] +- com.h2database:h2:jar:1.3.176:compile
[INFO] \- org.projectlombok:lombok:jar:1.14.0:provided
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 2.135 s
[INFO] Finished at: 2015-03-23T00:53:09+09:00
[INFO] Final Memory: 12M/29M
[INFO] ------------------------------------------------------------------------

org.springframework.boot:spring-boot-starter-data-jpaにぶら下がっているのがorg.hibernate:hibernate-entitymanagerであることから、JPAの実装としてHibernateであることがわかる。
JPAは仕様であって、それを実装したライブラリを実際には使用する。
実装したライブラリのことを「JPAプロバイダ」と言う。
なので、「今回のJPAプロバイダはHibernate」となる。

Hibernateの設定

Hibernateの設定をapplication.ymlに追加する。

src/main/resources/application.yml

このファイルに下記の内容を記載する。

spring:
  datasource:
    driverClassName: org.h2.Driver
    url: jdbc:h2:file:testdb/testdb
    username: sa
    password:
  jpa:
    hibernate:
      ddl-auto: update

datasourceの設定は準備編と同じ。
jpaからの設定を追加する。

ddl-autoはHibernateによるテーブル作成をどう制御するかを定義する。
以下のものがある。

  • create-drop -> テーブルがあったら削除してから作り直す。なかったら作る。つまりデータは毎回消える。(UTに便利?)
  • update -> テーブルの作り直しはしないが、なかったら作る。
  • none -> なくても作らない。本番運用向き。

何を基にテーブルを作るかというと、下記で説明するエンティティクラスを基に作る。
なので、準備編で作成したschema.sqlは不要なので削除する。

エンティティクラスを用意する

準備編で作成したCustomerクラスをJPA用にカスタマイズする。

package tools.springsample.springsample03.domain;

import javax.persistence.Entity;
import javax.persistence.Table;
import javax.persistence.Id;
import javax.persistence.GeneratedValue;
import javax.persistence.Column;
import lombok.Data;
import lombok.AllArgsConstructor;
import lombok.NoArgsConstructor;

@Entity    // a
@Table(name="customer")    // b
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Customer {
    @Id    // c
    @GeneratedValue    // d
    private Integer id;

    @Column(nullable=false)    // e
    private String name;

    @Column(nullable=false)    // e
    private String email;
}

JPA用に変更したのは下記の通り。
a -> エンティティクラスであることを記すアノテーション
b -> どのテーブルとマッピングするのか指定する。
c -> フィールドidがエンティティの主キーであることを表す。
d -> 自動採番する主キーであることを表す。
e -> テーブルに該当するカラムであることを表す。nullでの更新を抑制する。

リポジトリクラスを用意する

今まで作成したCustomerRepositoryクラスをJPA用に変更する。
(変更というかほとんど書き換え)

package tools.springsample.springsample03.repository;

import tools.springsample.springsample03.domain.Customer;

import org.springframework.data.jpa.repository.JpaRepository;

public interface CustomerRepository
    extends JpaRepository<Customer, Integer> {
}

クラスではなくインターフェースになる。
JpaRepositoryを拡張すると、実行時に実装クラスが自動生成される。
CRUDの各メソッドが用意されているので、それを呼ぶとデータベースを操作できる。
JPAを使ってSQLがソースから消えた。

コンパイルして実行

JDBC編で作成したAppクラスはそのまま使えるので、ここまでの状態でコンパイルして実行することができる。

mvn package

続いて起動。

java -jar target\SpringSample03-1.0-SNAPSHOT.jar

実行したあとデータベースを見て登録されることを確認すること。

やったことと言えば、1:設定書いて、2:エンティティ作って、3:リポジトリの宣言、の3ステップだけ。
これだけでデータベース更新できてしまうのが、手軽すぎて逆に怖い。

ただ、不明なことも見えてきた。

  • JpaRepositoryを拡張して出来る検索は全検索かPKでの検索だけだが、他のキーで検索するにはどうする?
  • ほかのテーブルをJOINして検索する場合はどうする?
  • JpaRepositoryに主キーを知らせる(今回はInteger)が、複合主キー(複数カラムを用いた主キー)の場合はどうする?

これらは追々。

■ 参考文献 ■

この記事で参考にしたのは「はじめての Spring Boot」です。

Spring Boot/第三回 Spring Bootでデータベース操作(JDBC編)

Spring Bootでデータベース操作をする。
前回の準備編に続いて、今回はデータベースに対してデータの操作を行う。

Spring Bootでのデータベース操作は

の2種類があるが、今回はJDBCの方の話。

依存関係の追加

まずはMavenの依存関係を追加するが、前回の準備編と同じなので、すでに記述していたら不要。

  <dependencies>
    <!-- append start -->
    <dependency>  <!-- a -->
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-jdbc</artifactId>
    </dependency>
    <dependency>  <!-- b -->
      <groupId>com.h2database</groupId>
      <artifactId>h2</artifactId>
    </dependency>
    <dependency>  <!-- c -->
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <version>1.14.0</version>
      <scope>provided</scope>
    </dependency>
    <!-- append end -->
  </dependencies>

a -> Spring BootでJDBCを扱うための依存関係。
b -> H2の依存関係。
c -> Lombokの依存関係。

行挿入

データベース操作はリポジトリの役目なので、CustomerRepositoryクラスに処理を書いて行く。
まずは行挿入から。
(第二回で宣言したgetCustomer()メソッドは不要なので削除した)

package tools.springsample.springsample03.repository;

import tools.springsample.springsample03.domain.Customer;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate;
import org.springframework.jdbc.core.namedparam.SqlParameterSource;
import org.springframework.jdbc.core.namedparam.BeanPropertySqlParameterSource;
import org.springframework.stereotype.Repository;

@Repository
public class CustomerRepository {
    @Autowired
    private NamedParameterJdbcTemplate jdbcTemplate;

    public Customer save(Customer customer) {    // a
        SqlParameterSource param                 // b
            = new BeanPropertySqlParameterSource(customer);  // c

        jdbcTemplate.update("insert into customer(name, email) " +
            " values(:name, :email)", param);  // d

        return customer;
    }
}

a -> 行挿入メソッド。これを実装する。
b -> SqlParameterSourceクラスは後のSQLの「:」で始まるプレースホルダのパラメータを保持するクラス。
c -> プレースホルダマッピングにCustomerクラスのインスタンスを使用する。
   Customerクラスのgetterメソッドを検知してデータを取得し、プレースホルダに当てはめてくれる。
d -> NamedParameterJdbcTemplateを使ってSQLを実行する。
   第一引数がプレースホルダ付のSQL、第二引数がプレースホルダに当てはめる値が入ったcで作ったインスタンス

プレースホルダの「:name」にCustomerクラスのgetName()メソッドで取得した値を、「:email」にgetEmail()メソッドで取得した値を当てはめてSQLを実行する。


続いてこのリポジトリクラスを呼び出すクラスを作成する。

package tools.springsample.springsample03;

import tools.springsample.springsample03.domain.Customer;
import tools.springsample.springsample03.repository.CustomerRepository;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.context.annotation.ComponentScan;

@EnableAutoConfiguration
@ComponentScan
public class App implements CommandLineRunner {
    @Autowired
    private CustomerRepository customerRepository;

    @Override
    public void run(String... strings) throws Exception {
        Customer customer01 = new Customer();  // a
        customer01.setName("user01");          // b
        customer01.setEmail("user01@foo.bar"); // c
        customerRepository.save(customer01);   // d
    }

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

a -> ドメインクラスCustomerのインスタンスを作成。
b -> Customerの初期化。フィールドnameに「user01」を設定する。
c -> Customerの初期化。フィールドemailに「user01@foo.bar」を設定する。
d -> リポジトリクラスの行挿入メソッドを呼び出す。

実行すると以下のようなSQLが実行される。

insert into customer(name, email)
    values('user01', 'user01@foo.bar')

コンパイルして実行

以下のようにコンパイルする。
今回は実行したいのでコンパイルしてJARファイルでパッケージする。

mvn package

続いて起動。
今回はコマンドライン実行する「CommandLineRunner」を拡張したAppクラスなので、下記のコマンドで実行。
JARファイルは適宜読み替えましょう。

java -jar target\SpringSample03-1.0-SNAPSHOT.jar

実行したあとデータベースを見ると下記のように登録される。

ID NAME EMAIL
1 user01 user01@foo.bar

業務でJDBCを使って実装することはまれだと思うので、JDBC編はここまで。

■ 参考文献 ■

この記事で参考にしたのは「はじめての Spring Boot」です。

Spring Boot/第三回 Spring Bootでデータベース操作(準備編)

Spring Bootでデータベース操作をする。
今回は準備編としてSpring Bootでのデータベース接続と、サンプルのドメインオブジェクトを作成する。

依存関係の追加

今回はH2を使う。
まずはMavenの依存関係を追加する。

  <dependencies>
    <!-- append start -->
    <dependency>  <!-- a -->
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-jdbc</artifactId>
    </dependency>
    <dependency>  <!-- b -->
      <groupId>com.h2database</groupId>
      <artifactId>h2</artifactId>
    </dependency>
    <dependency>  <!-- c -->
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <version>1.14.0</version>
      <scope>provided</scope>
    </dependency>
    <!-- append end -->
  </dependencies>

a -> Spring BootでJDBCを扱うための依存関係。
b -> H2の依存関係。
c -> Lombokの依存関係。

LombokはデータベースともSpring Bootとも関係はないが、Javaの短所の一つsetter/getter地獄から解放してくれたり、toString()・equals()メソッドを自動実装してくれたりしてくれるプロダクト。
コードが短くなるのでここで依存関係を追加する。
Lombokについて、詳しくはググりましょう。

データベース接続

アプリケーションが接続する先のデータベースを定義する。
定義は下記のYAML形式のファイルに行う。

src/main/resources/application.yml

このファイルに下記の内容を記載する。

spring:
  datasource:
    driverClassName: org.h2.Driver
    url: jdbc:h2:file:testdb/testdb
    username: sa
    password:

接続先はurlで指定していて、今回はカレントフォルダにtestdbフォルダを作って、その中に作成する。
実行環境によって作成される場所が変わるので注意が必要。


Spring Bootはクラスパス直下に下記のファイルがあると自動で実行する。

  • schema-(platform).sql
  • schema.sql
  • data-(platform).sql
  • data.sql

ファイル名からわかるように、schemaにはテーブル定義用のDDLを、dataには初期データ用のDMLを記載する。
どちらのファイルも起動するたびに実行されるので注意が必要。
つまりDDLはテーブルが存在する場合を考慮しないといけないし、DMLはキー重複しないよう考慮しないといけない。
・・・実際の業務ではあまり使わない機能かと思う。

今回はschema.sqlを使ってサンプルテーブルを作成する。
前述の通り、テーブルが存在する場合を考慮して「if not exists」を入れている。

create table if not exists customer (
    id int primary key auto_increment,
    name varchar(50),
    email varchar(50)
);

ここまででコンパイルする。

mvn compile

続いて起動

mvn spring-boot:run

するとプロジェクトフォルダに「testdb」フォルダが作成され、その中に「testdb.h2.db」と「testdb.lock.db」の2ファイルが生成される。
これがH2のデータベースファイルとなる。

起動後のコンソールの最後のに「Executing SQL script」とあり「schema.sql」を実行したとのことなので、テーブルが出来ているのでしょう。

ドメインオブジェクト

先ほど作ったcustomerテーブルのドメインオブジェクトを作る。

package tools.springsample.springsample03.domain;

public class Customer {
    private Integer id;
    private String name;
    private String email;
}

まずはcustomerテーブルのカラムと同名のフィールドを宣言する。
これだけだとprivateフィールドなのでどこからもアクセスできない。
setter/getter等が必要だが、決まりきった実装をするのが手間なので、ここで先述のLombokの出番となる。

Lombokを使って宣言すると下記のようになる。

package tools.springsample.springsample03.domain;

import lombok.Data;
import lombok.AllArgsConstructor;
import lombok.NoArgsConstructor;

@Data    // a
@AllArgsConstructor  // b
@NoArgsConstructor  // c
public class Customer {
    private Integer id;
    private String name;
    private String email;
}

アノテーションを付けたのと、そのアノテーションのimportを追加した。
アノテーションの意味は下記の通り。
a -> すべてのフィールドに対するsetter/getterメソッド、equalsメソッド、hashCodeメソッド、toStringメソッドが生成される。
b -> すべてのフィールドを初期化する引数を持つコンストラクタが生成される。
c -> 引数なしのデフォルトコンストラクタが生成される。

これらの煩雑なコードを自動的に生成してくれるLombokは便利。
本当に生成されたのか、javapコマンドで見てみる。

Compiled from "Customer.java"
public class tools.springsample.springsample03.domain.Customer {
  public java.lang.Integer getId();
  public java.lang.String getName();
  public java.lang.String getEmail();
  public void setId(java.lang.Integer);
  public void setName(java.lang.String);
  public void setEmail(java.lang.String);
  public boolean equals(java.lang.Object);
  public int hashCode();
  public java.lang.String toString();
  public tools.springsample.springsample03.domain.Customer(java.lang.Integer, java.lang.String, java.lang.String);
  public tools.springsample.springsample03.domain.Customer();
}

@Dataで指定したgetterメソッドが3つ、setterメソッドが3つ、equalsメソッド、hashCodeメソッド、toStringメソッドが、
@AllArgsConstructorで指定した全フィールドを引数を持つコンストラクタが、
@NoArgsConstructorで指定したデフォルトコンストラクタが生成されたのがわかる。

ほかにどのようなアノテーションがあり、何が起きるかは、Lombokのサイトを参照。
http://projectlombok.org/features/index.html


準備編はここまで。

■ 参考文献 ■

この記事で参考にしたのは「はじめての Spring Boot」です。

Spring Boot/第二回 Spring Bootで階層モデル

Spring Bootで階層モデルを実装する。
まずは実装の内容なしで、処理の呼び出しがうまくいくことを確認する。

階層モデルとは

Spring Bootの階層モデルは下記のようになる。
f:id:nave_kazu:20150320013616p:plain
HTTPリクエストを起点にそれぞれの階層でそれぞれの役割を果たして処理をリレーする。

Controller

いわゆるMVCのコントローラ。
HTTPを受け取ってサービスを呼び出し、その結果からUIをコントロールする。

Service

ビジネスロジックを書く。
コントローラからの入力値をチェックしたり、データベースの値と比較したり、データベースへの書き込み要求をしたりする。

Repository

永続化処理を書く。
データベースから値を取ったり書いたりする。

Controller

コントローラは下記のように実装する。
@Controllerアノテーションを付けて宣言すると、そのクラスがコントローラとして機能する。

package tools.springsample.springsample02;

import tools.springsample.springsample02.service.SampleService;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

/**
 * Hello world!
 *
 */
@Controller  // a -> コントローラの目印
@EnableAutoConfiguration  // b -> Springの設定を自動でやってくれるオマジナイ
@ComponentScan  // c -> @Autowiredで指定したコンポーネントをスキャンする場所(パッケージ)を指定
                //      自クラス配下なのでパラメータは不要
public class App {

    @Autowired  // d -> DIコンテナからインスタンスを取得する
    private SampleService sampleService;

    @RequestMapping("/")  // e -> URLとメソッドのマッピング
    @ResponseBody  // f -> 戻り値をレスポンスとして返すという意味
    public String hello() {
        System.out.println("★★★★★ Controller called.");
        return sampleService.getMessage();
    }

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

Service

サービスは下記のように実装する。
これもServiceアノテーションを付けて宣言すると、そのクラスがサービスとして機能する。

package tools.springsample.springsample02.service;

import tools.springsample.springsample02.repository.CustomerRepository;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service  // DIする対象の目印
public class SampleService {
    @Autowired  // d -> DIコンテナからインスタンスを取得する
    private CustomerRepository customerRepository;

    public String getMessage() {
        System.out.println("★★★★★ Service called.");
        return "Hello world. Hello "+customerRepository.getCustomer()+".";
    }
}

Repository

これもRepositoryアノテーションを付けて宣言すると、そのクラスがリポジトリとして機能する。
今は中身は空っぽで。

package tools.springsample.springsample02.repository;

import org.springframework.stereotype.Repository;

@Repository  // DIする対象の目印
public class CustomerRepository {
    public String getCustomer() {
        System.out.println("★★★★★ Repository called.");
        return "Smith";
    }
}

コンパイルして実行

以下のようにコンパイルする。

mvn compile

続いて起動

mvn spring-boot:run

その後、http://localhost:8080/ にアクセスしてコマンドプロンプトに表示される内容を見てみる。

★★★★★ Controller called.
★★★★★ Service called.
★★★★★ Repository called.

お、それぞれの階層の処理が呼ばれている。
今日はここまで。

■ 参考文献 ■

この記事で参考にしたのは「はじめての Spring Boot」です。

Gradleの導入

Gradle徹底入門を買ったので、試してみる。

Gradle徹底入門 次世代ビルドツールによる自動化基盤の構築

Gradle徹底入門 次世代ビルドツールによる自動化基盤の構築


まずはGradleが起動するまで。

Java環境

GradleはGroovyで動くので。
GroovyはJavaで動くので。
Javaは必要。
Javaのインストールフォルダの環境変数JAVA_HOME」が必要なので設定すること。

例えば以下のように。

set JAVA_HOME=C:\Program Files\Java\jdk1.8.0_25

WindowsGUIだと以下のよう。
f:id:nave_kazu:20150221001049p:plain

バイナリダウンロード

Windows以外だとcurlコマンドで最小セットをダウンロードして初回起動にあれこれ自動でダウンロードしてくれるようだけど、Windowsはフルセットのバイナリをダウンロードしないとならないようだ。
Gradle2.3を以下からダウンロード。

https://services.gradle.org/distributions/gradle-2.3-bin.zip

インストール

ZIPファイルを適当なフォルダに解凍して、そこまでのパスを環境変数「GRADLE_HOME」に登録する。
さらに「GRADLE_HOME」の「bin」にパスを通す。

例えば以下のように。

set GRADLE_HOME=D:\Packages\Java\gradle-2.3
set %PATH%;%GRADLE_HOME%\bin

動くか確認

以下のコマンドで確認。

gradle -v

動いた動いた。

# gradle -v

------------------------------------------------------------
Gradle 2.3
------------------------------------------------------------

Build time:   2015-02-16 05:09:33 UTC
Build number: none
Revision:     586be72bf6e3df1ee7676d1f2a3afd9157341274

Groovy:       2.3.9
Ant:          Apache Ant(TM) version 1.9.3 compiled on December 23 2013
JVM:          1.8.0_25 (Oracle Corporation 25.25-b02)
OS:           Windows 7 6.1 x86

今日はここまで。