Teaching Programming - パート 10

掲示板を作る: EntityとRepositoryの作成

データベースの利用の例として、掲示板を作成してみましょう。

まずは、EntityとRepositoryを作成します。

Entity（JPA Entity）とは、データベースにおける表の個別の行に対応するオブジェクトです。JPAではPOJO（Plain Old Java Object、ごく普通のJavaオブジェクト）にアノテーションを加えるだけで作成できます。今回は単純に、名前と本文だけを保存するようにしてみます。DatabaseConfig.javaの44行目でEntityを示すパッケージを指定しているので、そこにCommentクラスを作成します。

package net.teachingprogramming.myfirstspringapp.entity;

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

/**
 * Comment
 */
@Entity
public class Comment {
    @Id
    @GeneratedValue
    private Long id;
    private String name;
    private String text;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getText() {
        return text;
    }

    public void setText(String text) {
        this.text = text;
    }
}

package net.teachingprogramming.myfirstspringapp.entity;

import javax.persistence.Entity;

import javax.persistence.GeneratedValue;

import javax.persistence.Id;

/**

* Comment

@Entity

public class Comment {

@Id

@GeneratedValue

private Long id;

private String name;

private String text;

public String getName() {

return name;

}

public void setName(String name) {

this.name = name;

}

public String getText() {

return text;

}

public void setText(String text) {

this.text = text;

}

10行目: @EntityアノテーションでEntityであることを示す。
12〜14行目: JPAでは主キーが必要となる。@Idアノテーションで主キーを示す。また@GeneratedValueで値を自動生成することを示す。
15行目: 名前を格納するフィールド。
16行目: 本文を格納するフィールド。
18〜32行目: nameとtextのgetter/setter。getter/setterはメニューから[Code]→[Generate]→[Getter and Setter]で自動生成できる。

このCommentクラスのインスタンスをデータベースに格納するには、Repositoryとよばれる、データベースへの操作を行うためのオブジェクトが必要です。RepositoryはSpring Data JPAに含まれるJpaRepositoryインターフェースを使うと簡単に作成することができます。JpaRepositoryインターフェースを継承することにより、データベースの操作に関するメソッドが自動的に生成されます。

DatabaseConfig.javaの24行目でRepositoryを示すパッケージを指定しているので、そこにCommentRepositoryインターフェースを作成します。

package net.teachingprogramming.myfirstspringapp.repository;

import net.teachingprogramming.myfirstspringapp.entity.Comment;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;

/**
 * CommentRepository
 */
@Repository
public interface CommentRepository extends JpaRepository<Comment, Long> {
}

package net.teachingprogramming.myfirstspringapp.repository;

import net.teachingprogramming.myfirstspringapp.entity.Comment;

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

import org.springframework.stereotype.Repository;

/**

* CommentRepository

@Repository

public interface CommentRepository extends JpaRepository<Comment, Long> {

}

10行目: @RepositoryアノテーションでRepositoryであることを示す。
11、12行目: JpaRepositoryを継承する。型変数はEntityの型とそのEntityの主キーの型を指定する。基本的な機能（メソッド）は自動的に生成されるので、いまのところメソッド等の記述は必要ない。

データベース接続の設定

今回はJPAを使います。実装としてHibernateを利用します。

まず、Spring Data JPA、Hibernate、H2のライブラリをdependenciesに追加します。これまでと同様に、更新とArtifactの設定を行います。

apply plugin: 'java'

sourceCompatibility = 1.5
version = '1.0'

repositories {
    mavenCentral()
}

dependencies {
    compile 'org.springframework:spring-context:4.0.6.RELEASE'
    compile 'org.springframework:spring-webmvc:4.0.6.RELEASE'
    compile 'org.thymeleaf:thymeleaf-spring4:2.1.3.RELEASE'
    compile 'org.springframework.data:spring-data-jpa:1.6.1.RELEASE'
    compile 'org.hibernate:hibernate-entitymanager:4.3.5.Final'
    compile 'com.h2database:h2:1.4.179'
    testCompile group: 'junit', name: 'junit', version: '4.11'
}

apply plugin: 'java'

sourceCompatibility = 1.5

version = '1.0'

repositories {

mavenCentral()

}

dependencies {

compile 'org.springframework:spring-context:4.0.6.RELEASE'

compile 'org.springframework:spring-webmvc:4.0.6.RELEASE'

compile 'org.thymeleaf:thymeleaf-spring4:2.1.3.RELEASE'

compile 'org.springframework.data:spring-data-jpa:1.6.1.RELEASE'

compile 'org.hibernate:hibernate-entitymanager:4.3.5.Final'

compile 'com.h2database:h2:1.4.179'

testCompile group: 'junit', name: 'junit', version: '4.11'

}

次に、設定用のクラスを作成します。Thymeleafの設定と同様に、configパッケージ内にDatabaseConfigクラスを作成します。

package net.teachingprogramming.myfirstspringapp.config;

import org.hibernate.dialect.H2Dialect;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.jpa.repository.config.EnableJpaRepositories;
import org.springframework.jdbc.datasource.DriverManagerDataSource;
import org.springframework.orm.hibernate4.HibernateExceptionTranslator;
import org.springframework.orm.jpa.JpaTransactionManager;
import org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean;
import org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter;
import org.springframework.transaction.PlatformTransactionManager;
import org.springframework.transaction.annotation.EnableTransactionManagement;

import javax.persistence.EntityManagerFactory;
import javax.sql.DataSource;
import java.util.Properties;

/**
 * DatabaseConfig
 */
@Configuration
@EnableTransactionManagement
@EnableJpaRepositories("net.teachingprogramming.myfirstspringapp.repository")
public class DatabaseConfig {

    @Bean
    public DataSource dataSource() {
        DriverManagerDataSource dataSource = new DriverManagerDataSource();
        dataSource.setDriverClassName(org.h2.Driver.class.getName());
        dataSource.setUrl("jdbc:h2:tcp://localhost/~/tmp/myfirstspringapp");
        dataSource.setUsername("sa");
        dataSource.setPassword("password");
        return dataSource;
    }

    @Bean
    public EntityManagerFactory entityManagerFactory() {
        HibernateJpaVendorAdapter vendorAdapter = new HibernateJpaVendorAdapter();
        vendorAdapter.setShowSql(true); // デバッグ用

        LocalContainerEntityManagerFactoryBean factory = new LocalContainerEntityManagerFactoryBean();
        factory.setJpaVendorAdapter(vendorAdapter);
        factory.setPackagesToScan("net.teachingprogramming.myfirstspringapp.entity");
        factory.setDataSource(dataSource());

        Properties properties = new Properties();
        properties.setProperty("hibernate.dialect", H2Dialect.class.getName());
        properties.setProperty("hibernate.hbm2ddl.auto", "create-drop");
        factory.setJpaProperties(properties);
        factory.afterPropertiesSet();

        return factory.getObject();
    }

    @Bean
    public PlatformTransactionManager transactionManager() {
        JpaTransactionManager txManager = new JpaTransactionManager();
        txManager.setEntityManagerFactory(entityManagerFactory());
        return txManager;
    }

    @Bean
    public HibernateExceptionTranslator hibernateExceptionTranslator() {
        return new HibernateExceptionTranslator();
    }

}

package net.teachingprogramming.myfirstspringapp.config;

import org.hibernate.dialect.H2Dialect;

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;

import org.springframework.data.jpa.repository.config.EnableJpaRepositories;

import org.springframework.jdbc.datasource.DriverManagerDataSource;

import org.springframework.orm.hibernate4.HibernateExceptionTranslator;

import org.springframework.orm.jpa.JpaTransactionManager;

import org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean;

import org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter;

import org.springframework.transaction.PlatformTransactionManager;

import org.springframework.transaction.annotation.EnableTransactionManagement;

import javax.persistence.EntityManagerFactory;

import javax.sql.DataSource;

import java.util.Properties;

/**

* DatabaseConfig

@Configuration

@EnableTransactionManagement

@EnableJpaRepositories("net.teachingprogramming.myfirstspringapp.repository")

public class DatabaseConfig {

@Bean

public DataSource dataSource() {

DriverManagerDataSource dataSource = new DriverManagerDataSource();

dataSource.setDriverClassName(org.h2.Driver.class.getName());

dataSource.setUrl("jdbc:h2:tcp://localhost/~/tmp/myfirstspringapp");

dataSource.setUsername("sa");

dataSource.setPassword("password");

return dataSource;

}

@Bean

public EntityManagerFactory entityManagerFactory() {

HibernateJpaVendorAdapter vendorAdapter = new HibernateJpaVendorAdapter();

vendorAdapter.setShowSql(true); // デバッグ用

LocalContainerEntityManagerFactoryBean factory = new LocalContainerEntityManagerFactoryBean();

factory.setJpaVendorAdapter(vendorAdapter);

factory.setPackagesToScan("net.teachingprogramming.myfirstspringapp.entity");

factory.setDataSource(dataSource());

Properties properties = new Properties();

properties.setProperty("hibernate.dialect", H2Dialect.class.getName());

properties.setProperty("hibernate.hbm2ddl.auto", "create-drop");

factory.setJpaProperties(properties);

factory.afterPropertiesSet();

return factory.getObject();

}

@Bean

public PlatformTransactionManager transactionManager() {

JpaTransactionManager txManager = new JpaTransactionManager();

txManager.setEntityManagerFactory(entityManagerFactory());

return txManager;

}

@Bean

public HibernateExceptionTranslator hibernateExceptionTranslator() {

return new HibernateExceptionTranslator();

}

22行目: @Configurationアノテーションで設定用のクラスであることを示す。
23行目: @EnableTransactionManagementアノテーションでトランザクションの管理を有効にする。
23行目: @EnableJpaRepositoriesアノテーションでJPA Repositoriesを有効にする。Repositoryが格納されるパッケージを引数とする。
27〜35行目: データソースをBean登録する。設定内容はH2の設定と同じにする。
37〜54行目: EntityManagerFactoryをBean登録する。44行目で対象となるentityが含まれるパッケージを指定している。48行目でdialectを設定する。これによりHibernateがデータベースに適した動作をするようになる。49行目でテーブル等の自動生成について設定している。「create-drop」はdeply時に、テーブルを削除（drop）して作りなおす（create）という設定である。他に設定可能な値として、

none

何もしない

create

テーブルがない場合に作成する

update

テーブルの構造が変わった時に変更する

validate

テーブルの構造をチェックする

等がある。開発時にはcreate-drop、create、updateを使い、運用時にvalidateにするといった使い分けをする。
56〜61行目: トランザクションマネージャーをBean登録する。
63〜66行目: 例外を変換するTranslatorをBean登録する。

Springにおけるデータベースへのアクセス方法

一般に、Javaにおけるデータベース（RDBMS）へのアクセスには（代表的なものとして）下記の方法が使われます。

JDBC
HibernateやTopLink等のORMライブラリ
Java Persistence API (JPA)
Java Data Object (JDO)

JDBCはデータベースに接続し、SQLによるクエリを実行するためのAPIです。SQLは自分で書かなければいけません。

HibernaeやTopLink等のORMライブラリを利用すると、SQLを（あまり）意識することなくJavaのインスタンスをデータベースに保存できるようになります。ライブラリがSQLを自動生成・実行してくれるわけです。

JPAとJDOは「仕様」のため、様々な実装が存在します。JPAはRDBMSへの操作を抽象化するAPIです。HibernaeやTopLinkもJPAの実装として利用することができます。JDOは永続化そのものを抽象化するAPIで、RDMBS以外のデータベースも対象としています。

Springでは、これらを直接使うのではなく（直接使うこともできますが）、利用をサポートする仕組みが用意されています。例えば、JDBCの場合には、Spring Framework JDBCを使うことで、データベースの接続やトランザクション等を簡単に扱うことができます。
JPAを使う場合には、Spring Dataに含まれるプロジェクトであるSpring Data JPAを利用することで、ページング等を簡単に実現することができます。

H2の起動

データをデータベースに保存できるようにしましょう。

今回はデータベースとしてH2を利用します。

ちなみにGlassFishにはJava DB（中身はDerby）が付属しているので、こちらを利用することもできます。

zipをダウンロードしたら、適当な場所に展開し、次のようにして起動します。

% cd bin
% java -cp h2-1.4.180.jar org.h2.tools.Server &
TCP server running at tcp://XXX.XXX.XXX.XXX:9092 (only local connections)
PG server running at pg://XXX.XXX.XXX.XXX:5435 (only local connections)
Web Console server running at http://XXX.XXX.XXX.XXX:8082 (only local connections)

ブラウザが自動的に開いてH2コンソールが表示されます。各項目を入力して[保存]をクリックします。

設定名: MyFirstSpringApp (Server)
ドライバクラス: org.h2.Driver
JDBC URL: jdbc:h2:tcp://localhost/~/tmp/myfirstspringapp
ユーザ名: sa
パスワード: password

H2console

設定名はなんでもOKです。JDBC URLはアプリケーションからアクセスするときに使うURLです。この場合、起動したユーザのホームディレクトリ（~）のtmpディレクトリに、myfirstspringapp.mv.dbというファイルに保存されるということになります。ユーザ名・パスワードは任意に設定できます。

[接続]もしくは[接続テスト]をクリックして、接続できるか確かめておきます。

ライブラリのアップデート

Spring Framework 4.0.6がリリースされました。バグフィックスも行われているので、アップデートしておきましょう。

dependenciesの追加と同様に、build.gradleの「4.0.5」（2箇所）を「4.0.6」に書き換えて、更新ボタンをクリックします。

注意しなければならないのは、「Artifactの設定は自動的に変わらない」ということです。

Artifact2

赤く表示されている古いライブラリを削除して、Available Elementsにある新しいライブラリを追加します。

パラメータを受け取りコントローラで処理する

パラメータ（HTMLのformで送ることができる値）を受け取ってみましょう。

ここでは例として「足し算」を行います。2つの数値をフォームから送信し、その数値を足し算してページに表示します。

HTMLによるフォームは次のようになります。数値を入力して送信ボタンを押すと、actionで指定したURLにパラメータとともにリクエストされます。input要素のname属性で参照のための名前（ここでは「a」と「b」）を指定します。formのmethod属性では、getかpostが指定できます。getの場合はURLに「?a=1.2&b=3.4」といった形でパラメータが付加されます。

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8" />
    <title>sample3a</title>
</head>
<body>
    <h1>sample3a</h1>
    <form action="sample3b" method="get">
        a: <input type="text" name="a" /><br />
        b: <input type="text" name="b" /><br />
        <input type="submit" />
    </form>
</body>
</html>

<!DOCTYPE html>

<head>

<title>sample3a</title>

</head>

<body>

<h1>sample3a</h1>

a: <input type="text" name="a" /><br />

b: <input type="text" name="b" /><br />

</form>

</body>

</html>

足し算した結果を表示するページは次のようにします。

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8" />
    <title>sample3b</title>
</head>
<body>
    <h1>sample3b</h1>
    <p>
        <span th:text="${a}">a</span>+<span th:text="${b}">b</span>=<span th:text="${sum}">sum</span>
    </p>
</body>
</html>

<!DOCTYPE html>

<head>

<title>sample3b</title>

</head>

<body>

<h1>sample3b</h1>

<p>

</p>

</body>

</html>

コントローラは次のようにします。

package net.teachingprogramming.myfirstspringapp.controller;

import org.springframework.stereotype.Controller;
import org.springframework.ui.ModelMap;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;

/**
 * TopController
 */
@Controller
@RequestMapping("/")
public class TopController {
    @RequestMapping("sample1")
    public String sample1() {
        return "sample1";
    }

    @RequestMapping("sample2")
    public String sample2(ModelMap modelMap) {
        modelMap.addAttribute("message", "こんにちは");
        int dice = 1 + (int) Math.floor(Math.random()*6);
        modelMap.addAttribute("dice", dice);
        return "sample2";
    }

    @RequestMapping("sample3a")
    public String sample3a() {
        return "sample3a";
    }

    @RequestMapping("sample3b")
    public String sample3b(ModelMap modelMap, @RequestParam("a") double a, @RequestParam("b") double b) {
        double sum = a + b;
        modelMap.addAttribute("a", a);
        modelMap.addAttribute("b", b);
        modelMap.addAttribute("sum", sum);
        return "sample3b";
    }

}

@RequestMapping("sample3a")

public String sample3a() {

return "sample3a";

}

@RequestMapping("sample3b")

public String sample3b(ModelMap modelMap, @RequestParam("a") double a, @RequestParam("b") double b) {

double sum = a + b;

modelMap.addAttribute("a", a);

modelMap.addAttribute("b", b);

modelMap.addAttribute("sum", sum);

return "sample3b";

}

受け取りたいパラメータは、@RequestParamアノテーションをつけてメソッドの仮引数として指定します。@RequestParamの後ろのカッコ内には、input要素のname属性と対応するように指定します。このようにすることで、パラメータを普通のメソッドの引数と同じように扱うことができます。

実行例
Sample3a

Sample3b

もちろん、仮引数の型がdoubleなので、doubleと解釈できない文字列の場合はエラーになります。ビュー側で数値以外が入力できないようにしたり、コントローラではStringで受け取って適切なエラー処理をする等といった処理を（必要に応じて）行うとよいでしょう。

コントローラからビューに値を渡す

コントローラからビューに値を渡す方法（の1つ）に、ModelMapを使う方法があります。

メソッドの仮引数に、ModelMapを指定することで使えるようになります。

ModelMapのaddAttributeメソッドで、名前と値を指定します。ここでは、messageという名前で「こんにちは」を、diceという名前で1〜6の範囲の乱数をビューに渡します。

package net.teachingprogramming.myfirstspringapp.controller;

import org.springframework.stereotype.Controller;
import org.springframework.ui.ModelMap;
import org.springframework.web.bind.annotation.RequestMapping;

/**
 * TopController
 */
@Controller
@RequestMapping("/")
public class TopController {
    @RequestMapping("sample1")
    public String sample1() {
        return "sample1";
    }

    @RequestMapping("sample2")
    public String sample2(ModelMap modelMap) {
        modelMap.addAttribute("message", "こんにちは");
        int dice = 1 + (int) Math.floor(Math.random()*6);
        modelMap.addAttribute("dice", dice);
        return "sample2";
    }

}

package net.teachingprogramming.myfirstspringapp.controller;

import org.springframework.stereotype.Controller;

import org.springframework.ui.ModelMap;

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

/**

* TopController

@Controller

@RequestMapping("/")

public class TopController {

@RequestMapping("sample1")

public String sample1() {

return "sample1";

}

@RequestMapping("sample2")

public String sample2(ModelMap modelMap) {

modelMap.addAttribute("message", "こんにちは");

int dice = 1 + (int) Math.floor(Math.random()*6);

modelMap.addAttribute("dice", dice);

return "sample2";

}

ビューでは、要素の属性としてth:textを追加します。属性の値は${名前}で指定します。これにより、要素の子要素（タグで囲まれた部分）がコントローラーから渡された値で置き換わります。

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8" />
    <title>sample2</title>
</head>
<body>
    <h1>sample2</h1>
    <p th:text="${message}">
        ここに挿入される。
    </p>
    <p>
        サイコロ：<span th:text="${dice}">サイコロの目</span>
    </p>
</body>
</html>

<!DOCTYPE html>

<head>

<title>sample2</title>

</head>

<body>

<h1>sample2</h1>

ここに挿入される。

</p>

<p>

サイコロ：<span th:text="${dice}">サイコロの目</span>

</p>

</body>

</html>

Sample2

ログの確認

正常に動作しない場合は、まずはログを確認します。

ログはRun Tool WindowのGlassfish Logのタブで確認できます。Log Levelを変更することで、各レベルのログを確認することができます。

Log

Glassfishへのdeployと実行

メニューの[Run]→[Edit Configurations]から、 Glassfishへのdeployと実行の設定をします。

＋をクリックして、[Glassfish Server]→[Local]を選択します。

Run1

Before launchのBuildは、次でArtifactを設定すると自動的に追加されます。

Run2

設定済みのArtifactを指定します。OKをクリックして設定完了です。

メニューから[Run]→[Run ‘アプリケーションサーバ名’]をクリックすると、Glassfishが起動し、WARファイルがdeployされます。deployが成功するとブラウザが開きますが、そこはまだ設定がされてないのでエラーになります。URLをhttp://localhost:8080/myfirstspringapp/sample1にすると、ページが表示されます。

Sample1 2

Artifactの設定

Artifactとは、プロジェクトの出力の設定や出力そのものを指します。

GlassfishにDeployするWARファイルを出力するArtifactを設定します。

Artifact

＋をクリックして、「Web Application: Archive」を選択します。

Available Elementsに、出力できるものの一覧があるので、すべて選択し、右クリックから「Put into Default Locations」をクリックします。

最後にOKをクリックしてArtifactの設定は完了です。