今回もデータベースとのやりとりをやってみる。

Accessing JPA Data with RESTをやってみる

まずはbuild.gradleを編集する。

dependencies {
//    compile("org.springframework.boot:spring-boot-starter-web:1.2.2.RELEASE")
//    compile("org.springframework.boot:spring-boot-starter-actuator:1.2.2.RELEASE")
    compile("org.springframework.boot:spring-boot-starter-thymeleaf:1.2.2.RELEASE")
    compile("org.springframework.boot:spring-boot-starter-security:1.2.2.RELEASE")
    compile("org.springframework.boot:spring-boot-starter-data-rest:1.2.2.RELEASE")
    compile("org.springframework.boot:spring-boot-starter-data-jpa:1.2.2.RELEASE")
    compile("com.h2database:h2:1.4.183")

    compile("org.webjars:jquery:2.1.3")
    testCompile("org.springframework.boot:spring-boot-starter-test:1.2.2.RELEASE")
}

Spring Bootのバージョンが1.2.2になったらしいので、全体的に1.2.2にしておいた。

ドメインオブジェクトを作る

Personクラスを定義する。

package sample;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;

@Entity
public class Person {

    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private long id;
    private String firstName;
    private String lastName;

    public String getFirstName() {
        return firstName;
    }

    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }
}

そしてPerson Repositoryを作成。

package sample;

import org.springframework.data.repository.PagingAndSortingRepository;
import org.springframework.data.repository.query.Param;
import org.springframework.data.rest.core.annotation.RepositoryRestResource;

import java.util.List;

@RepositoryRestResource(collectionResourceRel = "people", path = "people")
public interface PersonRepository extends PagingAndSortingRepository<Person, Long> {
    List<Person> findByLastName(@Param("name") String name);
}

@RepositoryRestResourceアノテーションは、RESTfulなエンドポイントを作成する。ここでは/peopleになるように設定されているみたいだ。

これでgradle bootRunを実行すると、http://localhost:8080/peopleにRESTfulなエンドポイントが出来上がっていた。

実験的に、例であるようにcurlを使ってアクセスしてみる。

# GET
curl http://localhost:8080/people
# POST
curl -i -X POST -H "Content-Type:application/json" -d '{  "firstName" : "Frodo",  "lastName" : "Baggins" }' http://localhost:8080/people
# GET
curl http://localhost:8080/people/1
# PATCH
curl -X PATCH -H "Content-Type:application/json" -d '{ "firstName": "Bilbo Jr." }' http://localhost:8080/people/1
# GET
curl http://localhost:8080/people/search
# GET
curl http://localhost:8080/people/search/findByLastName?name=Baggins

@RepositoryRestResourceアノテーションを設定するだけでここまでやってくれるのはすごいなー。

次はHypermedia Driven REST web serviceをやってみようと思う。

というかそろそろなんか作ってみたほうがいいのかもしれない…。

Tweet

今回はデータベースとのデータのやり取りについてやっていきたい。

Accessing Data with JPAをやってみる

Javaでデータベースを扱う方法でやったことがあるのはJDBCとOrmLiteくらいだったので、JPAは多分初めて使う。

まずはbuild.gradleを変更する。

dependencies {
//    compile("org.springframework.boot:spring-boot-starter-web:1.2.1.RELEASE")
//    compile("org.springframework.boot:spring-boot-starter-actuator:1.2.1.RELEASE")
    compile("org.springframework.boot:spring-boot-starter-thymeleaf:1.2.1.RELEASE")
    compile("org.springframework.boot:spring-boot-starter-security:1.2.1.RELEASE")
    compile("org.springframework.boot:spring-boot-starter-data-jpa:1.2.1.RELEASE")
    compile("com.h2database:h2:1.4.183")

    compile("org.webjars:jquery:2.1.3")
    testCompile("org.springframework.boot:spring-boot-starter-test:1.2.1.RELEASE")
}

H2はJavaでできたデータベースだ。Javaでデータベースを試すのであればこれがお手軽のようだ。

シンプルなEntityクラスを作る

今回はJPAのEntityアノテーションを使ったシンプルなEntityクラスを作るようだ。

package sample;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;

@Entity
public class Customer {

    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private long id;
    private String firstName;
    private String lastName;

    protected Customer(){}

    public Customer(String firstName, String lastName) {
        this.firstName = firstName;
        this.lastName = lastName;
    }

    @Override
    public String toString() {
        return String.format(
                "Customer[id=%d, firstName='%s', lastName='%s']",
                id, firstName, lastName
        );
    }
}

protectedなコンストラクタは直接使うことはしない。そしてpublicなコンストラクタはデータを保存するときに使う。@Tableアノテーションがない場合はCustomerテーブルがあると仮定して動くようだ。
そして、プライマリキーに@Idをつけ、@GeneratedValueアノテーションのstrategyにGenerationType.AUTOを設定することでインクリメントされていくということだろう。

Spring Data JPA

Spring Data JPAはJPAを使ってデータベースにアクセスするためのものだ。interfaceを定義しておいたら、継承したCrudRepositoryが様々な処理を追加してくれるようである。独自に定義したい場合もルールに則ったメソッドを定義しておいたら、おそらくメタプログラミングしてくれるのだろう。

package sample;

import org.springframework.data.repository.CrudRepository;

import java.util.List;

public interface CustomerRepository extends CrudRepository<Customer, Long> {

    List<Customer> findByLastName(String lastName);
}

通常のJavaアプリケーションであれば、CustomerRepositoryクラスを定義するところであろうが、Spring Data JPAはパワフルなのでそんな必要はない、と書いてあった。さぁ！早速試してみようぜ！と書いてあるので試してみよう。

Applicationクラスにrunメソッドを

今回は画面上にではなくて、システムログに出すだけのようだ。
CommandLineRunnerインターフェースを入れたApplicationクラスにするようだ。

package sample;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;

import java.util.Arrays;

@SpringBootApplication
public class Application implements CommandLineRunner {

    @Autowired
    CustomerRepository repository;

    public static void main(String[] args) {
        // 略
    }


    @Override
    public void run(String... args) throws Exception {
        repository.save(new Customer("Jack", "Bauer"));
        repository.save(new Customer("Chloe", "O'Brian"));
        repository.save(new Customer("Kim", "Bauer"));
        repository.save(new Customer("David", "Palmer"));
        repository.save(new Customer("Michelle", "Dessler"));

        // fetch all customers
        System.out.println("Customers found with findAll():");
        System.out.println("-------------------------------");
        for (Customer customer : repository.findAll()) {
            System.out.println(customer);
        }
        System.out.println();

        // fetch an individual customer by ID
        Customer customer = repository.findOne(1L);
        System.out.println("Customer found with findOne(1L):");
        System.out.println("--------------------------------");
        System.out.println(customer);
        System.out.println();

        // fetch customers by last name
        System.out.println("Customer found with findByLastName('Bauer'):");
        System.out.println("--------------------------------------------");
        for (Customer bauer : repository.findByLastName("Bauer")) {
            System.out.println(bauer);
        }
    }
}

CustomerRepositoryインターフェースがSpring Application Contextによって生成されるようなので、newとか別にしなくてもいいらしい。saveメソッドにCustomerインスタンスを渡すと保存されるし、findAllメソッドで全部のデータを持ってこれるし、findOneメソッドでidを指定すれば1件だけ取得することもできる。自分でメソッド名のみ定義したfindByLastNameメソッドも作られていて利用できる。うーむ、すごい。

whereとかはJPAのドキュメントを読めってことだと思うんだけれど、とりあえずここまででサンプルは終わっていて、RESTで使ってみるのは？へのリンクがあったので、次回はそれをやってみようと思う。

Tweet