Teaching Programming - パート 9

スケジューリング（定期的に処理する）

サーバ側で定期的に処理を行いたい場合、広く使われているのがCronですが、Springではスケジューリングに関する機能があります。このスケジューリング機能を使ってみましょう（参考: 28.4 Annotation Support for Scheduling and Asynchronous Execution）。

まず、スケジューリング機能を有効にします。@EnableSchedulingアノテーションを使います。

package net.teachingprogramming.mybootapp;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.scheduling.annotation.EnableScheduling;

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

package net.teachingprogramming.mybootapp;

import org.springframework.boot.SpringApplication;

import org.springframework.boot.autoconfigure.EnableAutoConfiguration;

import org.springframework.context.annotation.ComponentScan;

import org.springframework.context.annotation.Configuration;

import org.springframework.scheduling.annotation.EnableScheduling;

@Configuration

@EnableAutoConfiguration

@ComponentScan

@EnableScheduling

public class Application {

public static void main(String[] args) {

SpringApplication.run(Application.class, args);

}

次に、定期的に実行したいメソッドに@Scheduledアノテーションをつけます。システムにDIされるオブジェクト（例えばコントローラー）ならばなんでもかまいません。ここでは、@Serviceを指定したクラスにします。

package net.teachingprogramming.mybootapp.service;

import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Service;

@Service
public class ScheduledService {

    @Scheduled(fixedRate = 5000)
    public void fixedRate() {
        System.out.println("5000ms毎に実行");
    }

    @Scheduled(cron="*/10 * * * * MON-FRI")
    public void cron() {
        System.out.println("平日に10秒ごと実行");
    }

}

package net.teachingprogramming.mybootapp.service;

import org.springframework.scheduling.annotation.Scheduled;

import org.springframework.stereotype.Service;

@Service

public class ScheduledService {

@Scheduled(fixedRate = 5000)

public void fixedRate() {

System.out.println("5000ms毎に実行");

}

@Scheduled(cron="*/10 * * * * MON-FRI")

public void cron() {

System.out.println("平日に10秒ごと実行");

}

9行目: fixedRateで実行間隔を指定する。
14行目: cronでcrontabファイルと同様の記法で実行間隔を指定する。

これで定期的に実行されます。

scheduled tasks

ユーザ認証: ログインしたユーザの情報をコントローラで取得する

ログインしたユーザの情報をコントロールで取得してみましょう。

ユーザ名はServletのリクエスト情報を表すHttpServletRequestクラスのオブジェクトのgetRemoteUserメソッドで取得できます。このユーザ名からUserクラスのオブジェクトを取得します。

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

    @RequestMapping("user")
    public String user(ModelMap modelMap, HttpServletRequest httpServletRequest) {
        String username = httpServletRequest.getRemoteUser();
        User user = userRepository.getOne(username);
        modelMap.addAttribute("user", user);
        return "user";
    }

@RequestMapping("user")

public String user(ModelMap modelMap, HttpServletRequest httpServletRequest) {

String username = httpServletRequest.getRemoteUser();

User user = userRepository.getOne(username);

modelMap.addAttribute("user", user);

return "user";

}

1行目: 引数にHttpServletRequestを指定することによってそのオブジェクトが取得できる。
2行目: getRemoteUserメソッドでユーザ名を取得する。
3行目: getOneメソッドは、JpaRepositoryに最初から用意されているメソッドで、IDからインスタンスを取得することができる。
4行目: addAttributeメソッドで、userをビューに送る。String以外のオブジェクトでもビューに送ることができる。

ビューは次のようにします。

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8" />
    <title>user</title>
</head>
<body>
    <h1>ユーザ情報</h1>
    <p>現在、下記のユーザでログインしています。</p>
    <dl>
        <dt>username</dt>
        <dd th:text="${user.username}">username</dd>
        <dt>password</dt>
        <dd th:text="${user.password}">password</dd>
    </dl>
</body>
</html>

<!DOCTYPE html>

<head>

</head>

<body>

<h1>ユーザ情報</h1>

<p>現在、下記のユーザでログインしています。</p>

<dl>

<dt>username</dt>

<dd th:text="${user.username}">username</dd>

<dt>password</dt>

<dd th:text="${user.password}">password</dd>

</dl>

</body>

</html>

12,14行目: コントローラーからビューに送られてきたオブジェクトはgetterが設定されていればフィールドを取得することができます。usernameとpasswordはLombokによってgetUsername、getPasswordというgetterが生成されているため、${user.username}、${user.password}で値を取り出すことができます。

http://localhost:8080/userにアクセスすると（ログインしていない場合はログイン画面になり、ログインすると）ユーザ情報が表示されます。

User

単純なログインでは、ユーザ情報をソースコードに記述し、実行時はAuthenticationManagerBuilderによって作られるメモリ上のデータベースに保存するようになっています。これではユーザの追加のたびにソースコードの修正が必要になってしまうので、ユーザ情報をデータベースに置くように変えていきましょう（参考: 3.5. Authentication）。また、ブラウザからサインアップできるようなインターフェースを作成します。

JDBC Authentication

WebSecurityConfig.javaを次のように修正します。

package net.teachingprogramming.mybootapp.config;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder;
import org.springframework.security.config.annotation.authentication.configurers.GlobalAuthenticationConfigurerAdapter;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
import org.springframework.security.config.annotation.web.servlet.configuration.EnableWebMvcSecurity;

import javax.sql.DataSource;

@Configuration
@EnableWebMvcSecurity
public class WebSecurityConfig extends WebSecurityConfigurerAdapter {

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http.authorizeRequests().antMatchers("/", "/signup").permitAll().anyRequest().authenticated();
        http.formLogin().loginPage("/login").permitAll().and().logout().permitAll();
    }

    @Configuration
    protected static class AuthenticationConfiguration extends GlobalAuthenticationConfigurerAdapter {
        @Autowired
        private DataSource dataSource;

        @Override
        public void init(AuthenticationManagerBuilder auth) throws Exception {
            auth.jdbcAuthentication().dataSource(dataSource);
        }
    }
}

package net.teachingprogramming.mybootapp.config;

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

import org.springframework.context.annotation.Configuration;

import org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder;

import org.springframework.security.config.annotation.authentication.configurers.GlobalAuthenticationConfigurerAdapter;

import org.springframework.security.config.annotation.web.builders.HttpSecurity;

import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;

import org.springframework.security.config.annotation.web.servlet.configuration.EnableWebMvcSecurity;

import javax.sql.DataSource;

@Configuration

@EnableWebMvcSecurity

public class WebSecurityConfig extends WebSecurityConfigurerAdapter {

@Override

protected void configure(HttpSecurity http) throws Exception {

http.authorizeRequests().antMatchers("/", "/signup").permitAll().anyRequest().authenticated();

http.formLogin().loginPage("/login").permitAll().and().logout().permitAll();

}

@Configuration

protected static class AuthenticationConfiguration extends GlobalAuthenticationConfigurerAdapter {

@Autowired

private DataSource dataSource;

@Override

public void init(AuthenticationManagerBuilder auth) throws Exception {

auth.jdbcAuthentication().dataSource(dataSource);

}

19行目: /signupもユーザ認証無しでアクセスできるようにする。
25,26行目: データベースを使うのでDataSourceをDIします。
30行目: AuthenticationManagerBuilderのjdbcAuthenticationメソッドでデータベースからユーザ情報を読み取ることを指定します。dataSourceメソッドで利用するDataSourceを指定します。

3.5.2. JDBC Authenticationでは、withDefaultSchemaメソッドを実行しています。これは、ユーザ情報用のテーブルを用意してくれる機能ですが、ここではこの機能を使わずEntityを自分で作成することにします。

EntityとRepository

ユーザ情報を格納するEntityと、Entityを扱うRepositoryを作成します。

package net.teachingprogramming.mybootapp.entity;

import lombok.Getter;
import lombok.Setter;

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

@Entity
@Table(name = "USERS")
public class User {
    @Id
    @Setter
    @Getter
    private String username;

    @Setter
    @Getter
    private String password;

    @Getter
    @Setter
    private Boolean enabled;
}

package net.teachingprogramming.mybootapp.entity;

import lombok.Getter;

import lombok.Setter;

import javax.persistence.Entity;

import javax.persistence.Id;

import javax.persistence.Table;

@Entity

@Table(name = "USERS")

public class User {

@Id

@Setter

@Getter

private String username;

@Setter

@Getter

private String password;

@Getter

@Setter

private Boolean enabled;

}

11行目: AuthenticationManagerBuilderはテーブル名が「USERS」となっているテーブルから取得するためテーブル名を明示的に指定する（@Tableアノテーションを指定しない場合、テーブル名はクラス名と同じになる）。
14〜23行目: username、password、enabledという3つのフィールド（テーブルのcolumn）が必要となる。Lombokでgetter/setterを生成する。

package net.teachingprogramming.mybootapp.repository;

import net.teachingprogramming.mybootapp.entity.User;
import org.springframework.data.jpa.repository.JpaRepository;

public interface UserRepository extends JpaRepository<User, String>{
}

package net.teachingprogramming.mybootapp.repository;

import net.teachingprogramming.mybootapp.entity.User;

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

public interface UserRepository extends JpaRepository<User, String>{

}

Userと同様に、Authorityを作成する。

package net.teachingprogramming.mybootapp.entity;

import lombok.Getter;
import lombok.Setter;

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

@Entity
@Table(name = "AUTHORITIES")
public class Authority {
    @Id
    @Setter
    @Getter
    private String username;

    @Setter
    @Getter
    private String authority;
}

package net.teachingprogramming.mybootapp.entity;

import lombok.Getter;

import lombok.Setter;

import javax.persistence.Entity;

import javax.persistence.Id;

import javax.persistence.Table;

@Entity

@Table(name = "AUTHORITIES")

public class Authority {

@Id

@Setter

@Getter

private String username;

@Setter

@Getter

private String authority;

}

package net.teachingprogramming.mybootapp.repository;

import net.teachingprogramming.mybootapp.entity.Authority;
import org.springframework.data.jpa.repository.JpaRepository;

public interface AuthorityRepository extends JpaRepository<Authority, String>{
}

package net.teachingprogramming.mybootapp.repository;

import net.teachingprogramming.mybootapp.entity.Authority;

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

public interface AuthorityRepository extends JpaRepository<Authority, String>{

}

View

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8" />
    <title>sign up</title>
</head>
<body>
    <form th:action="@{/signup}" method="post">
        <div><label>ユーザ名: <input type="text" name="username"/> </label></div>
        <div><label>パスワード: <input type="password" name="password"/> </label></div>
        <div><input type="submit" value="sign up"/></div>
    </form>
</body>
</html>

<!DOCTYPE html>

<head>

</head>

<body>

<div><label>パスワード: <input type="password" name="password"/> </label></div>

</form>

</body>

</html>

Controller

@Autowired
private UserRepository userRepository;
@Autowired
private AuthorityRepository authorityRepository;

@RequestMapping(value = "signup", method = RequestMethod.GET)
public String signup() {
    return "signup";
}

@RequestMapping(value = "signup", method = RequestMethod.POST)
public String signup(@RequestParam String username, @RequestParam String password) {
    User user = new User();
    user.setUsername(username);
    user.setPassword(password);
    user.setEnabled(true);
    userRepository.save(user);
    Authority authority = new Authority();
    authority.setUsername(username);
    authority.setAuthority("ROLE_USER");
    authorityRepository.save(authority);
    return "signup";
}

@Autowired

private UserRepository userRepository;

@Autowired

private AuthorityRepository authorityRepository;

@RequestMapping(value = "signup", method = RequestMethod.GET)

public String signup() {

return "signup";

}

@RequestMapping(value = "signup", method = RequestMethod.POST)

public String signup(@RequestParam String username, @RequestParam String password) {

User user = new User();

user.setUsername(username);

user.setPassword(password);

user.setEnabled(true);

userRepository.save(user);

Authority authority = new Authority();

authority.setUsername(username);

authority.setAuthority("ROLE_USER");

authorityRepository.save(authority);

return "signup";

}

1〜4行目: RepositoryをDIする。
6〜9行目: @RequestParamでmethodを指定するとメソッド毎に処理を分けることができる。GETの場合はviewを指定するだけ。
11〜23行目: POSTの場合は送られてきたパラメータを使ってUserとAuthorityのインスタンスを生成し、データベースにセーブする。

これは最も単純な場合なので、すでに同じユーザ名で登録されていた場合の処理がされていない、パスワードが平文で保存されている等いろいろ修正しなければなりませんが、とりあえずはこれでユーザ情報を登録して認証に使えるようになります。

Lombokの利用

Lombokは所謂「boilerplate」なコードを自動生成することができるライブラリです。IDEでもコード（例えばgetter/setter）を自動生成することができますが、コードの追加・変更・削除に応じて自動生成し直す必要があり、少々面倒です。Lombokを使うことによってboilerplateなコードを書かなくてすむようになります。LombokのメリットについてはJavaでIDEのアクセッサ生成よりlombokを使ったほうがいい理由が参考になります。

IntelliJの設定

Lombok Pluginをインストールします。メニューから[Preferences]→[Plugins]→[Browse repositories]からインストールできます。

プロジェクトの設定では[Compiler]→[Annotation Processors]の[Enable annotation processing]をonにします。

Preferences

build.gradle

Lombokを利用するプロジェクトのbuild.gradleには次の行をdependenciesに追加します。

compile("org.projectlombok:lombok:1.14.8")

1	compile("org.projectlombok:lombok:1.14.8")

これでLombokが使えるようになります。

※上記ではcompileでLombokを利用するようにしていますが、実行時にLombokは必要ないので、本来はmavenにおけるprovidedと同様の動作となるようにするのが適切です。ここでは（手を抜いて）compileで指定しています。mavenのprovidedと同様の動作にするには、例えばWhich is the proper Gradle plugin to support ‘provided’ method?に書かれている方法等があります。

ユーザ認証: 単純なログイン

ユーザ認証を行ってみましょう（参考: Getting Started · Securing a Web Application）。

spring-boot-starter-security

Springにはセキュリティ関係の機能をサポートするSpring Securityがあり、またSpring Bootで利用する場合はspring-boot-starter-securityを使うことができます。build.gradleのdependenciesに追加します。

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

apply plugin: 'java'
apply plugin: 'idea'
apply plugin: 'spring-boot'

sourceCompatibility = 1.8
version = '1.0'

idea {
    module {
        inheritOutputDirs = false
        outputDir = file("$buildDir/classes/main/")
    }
}

repositories {
    mavenCentral()
}

dependencies {
    compile("org.springframework.boot:spring-boot-starter-web") {
        exclude module: "spring-boot-starter-tomcat"
    }
    compile("org.springframework.boot:spring-boot-starter-jetty")
    compile("org.springframework.boot:spring-boot-starter-thymeleaf")
    compile("org.springframework.boot:spring-boot-starter-data-jpa")
    compile("com.h2database:h2:1.4.181")
    compile("org.springframework.boot:spring-boot-starter-security")
    testCompile group: 'junit', name: 'junit', version: '4.11'
}

dependencies {

compile("org.springframework.boot:spring-boot-starter-web") {

exclude module: "spring-boot-starter-tomcat"

}

compile("org.springframework.boot:spring-boot-starter-jetty")

compile("org.springframework.boot:spring-boot-starter-thymeleaf")

compile("org.springframework.boot:spring-boot-starter-data-jpa")

compile("com.h2database:h2:1.4.181")

compile("org.springframework.boot:spring-boot-starter-security")

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

}

ログインフォーム

まずログインフォームを作り、アクセスできるようにしておきます。

テンプレートは、/loginにusernameとpasswordを送るようにします。

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8" />
    <title>login</title>
</head>
<body>
    <div th:if="${param.error}">
        エラー: ユーザ名・パスワードが違います。
    </div>
    <form th:action="@{/login}" method="post">
        <div><label>ユーザ名: <input type="text" name="username"/> </label></div>
        <div><label>パスワード: <input type="password" name="password"/> </label></div>
        <div><input type="submit" value="ログイン"/></div>
    </form>
</body>
</html>

<!DOCTYPE html>

<head>

<title>login</title>

</head>

<body>

エラー: ユーザ名・パスワードが違います。

</div>

<div><label>パスワード: <input type="password" name="password"/> </label></div>

</form>

</body>

</html>

コントローラでは/loginにアクセスがあったときに上記のテンプレートが表示されるようにします。Getting Started · Securing a Web Applicationでは、WebMvcConfigurerAdapterを使ってビューを追加していますが、どちらでも構いません。

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

@RequestMapping("login")

public String login() {

return "login";

}

WebSecurityConfigurerAdapter

WebSecurityConfigurerAdapterを継承した設定用クラスを作り、overrideしたconfigureメソッドで設定を行います。

package net.teachingprogramming.mybootapp.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder;
import org.springframework.security.config.annotation.authentication.configurers.GlobalAuthenticationConfigurerAdapter;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
import org.springframework.security.config.annotation.web.servlet.configuration.EnableWebMvcSecurity;

@Configuration
@EnableWebMvcSecurity
public class WebSecurityConfig extends WebSecurityConfigurerAdapter {

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http.authorizeRequests().antMatchers("/").permitAll().anyRequest().authenticated();
        http.formLogin().loginPage("/login").permitAll().and().logout().permitAll();
    }

    @Configuration
    protected static class AuthenticationConfiguration extends GlobalAuthenticationConfigurerAdapter {
        @Override
        public void init(AuthenticationManagerBuilder auth) throws Exception {
            auth.inMemoryAuthentication().withUser("user1").password("password1").roles("USER");
            auth.inMemoryAuthentication().withUser("user2").password("password2").roles("USER");
        }
    }
}

package net.teachingprogramming.mybootapp.config;

import org.springframework.context.annotation.Configuration;

import org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder;

import org.springframework.security.config.annotation.authentication.configurers.GlobalAuthenticationConfigurerAdapter;

import org.springframework.security.config.annotation.web.builders.HttpSecurity;

import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;

import org.springframework.security.config.annotation.web.servlet.configuration.EnableWebMvcSecurity;

@Configuration

@EnableWebMvcSecurity

public class WebSecurityConfig extends WebSecurityConfigurerAdapter {

@Override

protected void configure(HttpSecurity http) throws Exception {

http.authorizeRequests().antMatchers("/").permitAll().anyRequest().authenticated();

http.formLogin().loginPage("/login").permitAll().and().logout().permitAll();

}

@Configuration

protected static class AuthenticationConfiguration extends GlobalAuthenticationConfigurerAdapter {

@Override

public void init(AuthenticationManagerBuilder auth) throws Exception {

auth.inMemoryAuthentication().withUser("user1").password("password1").roles("USER");

auth.inMemoryAuthentication().withUser("user2").password("password2").roles("USER");

}

10行目: 設定用クラスであることを指定する。
11行目: Spring Securityのウェブ用の機能を利用することを指定する。
14〜18行目: configureメソッドをoverrideし、ここで設定を行う。16行目ではトップページ（/）は認証無しでアクセス可、それ以外は認証が必要なことを設定している。複数のページを認証なしでアクセス可とする場合は「antMatchers(“/”, “/sample”)」のように複数指定することができる。17行目ではログインフォームのURLが/loginで、ここへのアクセスも全てのユーザがアクセス可能としている。
20〜27行目: GlobalAuthenticationConfigurerAdapterを継承したクラスのinitメソッドで認証するユーザとパスワードを設定する。

ログインの確認

トップページ（/）以外のページにアクセスすると/loginにリダイレクトされます。

ユーザ名・パスワードがあっていれば、元のURLに移動します。ユーザ名・パスワードが間違っている場合はエラーメッセージが表示されます。

Spring-Loadedの利用

一般に、Servlet環境での開発は、プログラムを変更したら、再デプロイをして動作を確認します。しかし再デプロイは時間がかかるため開発効率がよくありません。このため再デプロイすることなくプログラムの追加・変更を適用することができる「hot swap」や「hot deploy」と呼ばれる手法が使われることがあります。

Spring-LoadedはSpringアプリケーションのhot deployを実現するライブラリです。Spring-Loadedを利用するにはgradle.buildを次のようにします（参考: 67.6.1 Configuring Spring Loaded for use with Gradle and IntelliJ）。

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

apply plugin: 'java'
apply plugin: 'idea'
apply plugin: 'spring-boot'

sourceCompatibility = 1.8
version = '1.0'

idea {
    module {
        inheritOutputDirs = false
        outputDir = file("$buildDir/classes/main/")
    }
}

repositories {
    mavenCentral()
}

dependencies {
    compile("org.springframework.boot:spring-boot-starter-web") {
        exclude module: "spring-boot-starter-tomcat"
    }
    compile("org.springframework.boot:spring-boot-starter-jetty")
    compile("org.springframework.boot:spring-boot-starter-thymeleaf")
    compile("org.springframework.boot:spring-boot-starter-data-jpa")
    compile("com.h2database:h2:1.4.181")
    testCompile group: 'junit', name: 'junit', version: '4.11'
}

buildscript {

repositories {

mavenCentral()

}

dependencies {

classpath("org.springframework.boot:spring-boot-gradle-plugin:1.1.7.RELEASE")

classpath("org.springframework:springloaded:1.2.0.RELEASE")

}

apply plugin: 'java'

apply plugin: 'idea'

apply plugin: 'spring-boot'

sourceCompatibility = 1.8

version = '1.0'

idea {

module {

inheritOutputDirs = false

outputDir = file("$buildDir/classes/main/")

}

repositories {

mavenCentral()

}

dependencies {

compile("org.springframework.boot:spring-boot-starter-web") {

exclude module: "spring-boot-starter-tomcat"

}

compile("org.springframework.boot:spring-boot-starter-jetty")

compile("org.springframework.boot:spring-boot-starter-thymeleaf")

compile("org.springframework.boot:spring-boot-starter-data-jpa")

compile("com.h2database:h2:1.4.181")

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

}

7行目: Spring-Loadedの利用を指定する。
12行目: gradleのideaプラグインを利用する。
18〜23行目: IDEAによる出力をgradleの出力先に合わせる。

Intellijの設定では、「Make Project Automatically」をonにします。

これによりbootRunで実行中にプログラムを書き直すと起動中のプログラムも修正されます。

Spring Bootの利用

これまで行ってきたように、ウェブアプリケーションの開発では様々なライブラリ/フレームワークを使います。grailsやmaven等のツールを用いることにより様々なライブラリ等が簡単に利用可能となりますが、それでも設定ファイルの作成等、面倒な作業が多く、ミスの元になったりします。

「Spring Boot」は「Spring Frameworkを使ってさらに簡単にウェブアプリケーションを作る仕組み」です。Spring Bootを使うことで標準的な設定がなされたウェブアプリケーションのベースを利用することができます。ただし、これまで紹介してきた設定の知識が不要になる、というわけではありません。自動設定（というか定義済み設定）が利用できるというだけで、自動で設定できない部分はこれまでと同様に設定する必要があります。

具体的には「Starter」を利用することになります。使いたい機能のStarterを加えることでライブラリの導入や設定が行われます。用意されているStarterの一覧は12.4 Starter POMsにまとめられています。

それでは、ここまで（掲示板の作成まで）と同等の環境をSpring Bootで構築してみましょう。

Gradle

プロジェクトはこれまでと同様にGradleを利用して作成し、build.gradleを次のように編集します（参考: 9.1.2 Gradle installation）。

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

apply plugin: 'java'
apply plugin: 'spring-boot'

sourceCompatibility = 1.8
version = '1.0'

repositories {
    mavenCentral()
}

dependencies {
    compile("org.springframework.boot:spring-boot-starter-web") {
        exclude module: "spring-boot-starter-tomcat"
    }
    compile("org.springframework.boot:spring-boot-starter-jetty")
    compile("org.springframework.boot:spring-boot-starter-thymeleaf")
    compile("org.springframework.boot:spring-boot-starter-data-jpa")
    compile("com.h2database:h2:1.4.181")
    testCompile group: 'junit', name: 'junit', version: '4.11'
}

buildscript {

repositories {

mavenCentral()

}

dependencies {

classpath("org.springframework.boot:spring-boot-gradle-plugin:1.1.7.RELEASE")

}

apply plugin: 'java'

apply plugin: 'spring-boot'

sourceCompatibility = 1.8

version = '1.0'

repositories {

mavenCentral()

}

dependencies {

compile("org.springframework.boot:spring-boot-starter-web") {

exclude module: "spring-boot-starter-tomcat"

}

compile("org.springframework.boot:spring-boot-starter-jetty")

compile("org.springframework.boot:spring-boot-starter-thymeleaf")

compile("org.springframework.boot:spring-boot-starter-data-jpa")

compile("com.h2database:h2:1.4.181")

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

}

1〜8, 11行目: Spring Bootのgradleプラグインを利用する。
21〜26行目: 利用するstarterの指定。ここではJetty（Tomcatを使わない）、Thymeleaf、Spring Data JPAを利用するように指定している。
27行目: H2を利用する。

起動用のクラス

Spring Bootはウェブアプリケーションを実行する環境も用意することができます（これまでと同様にwarファイルを生成することももちろんできます）。Gradleの設定ではJettyを利用するように設定しました。Jettyを起動してウェブアプリケーションを実行するクラスを作成します（参考: 13.2 Locating the main application class）。

package net.teachingprogramming.mybootapp;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;

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

package net.teachingprogramming.mybootapp;

import org.springframework.boot.SpringApplication;

import org.springframework.boot.autoconfigure.EnableAutoConfiguration;

import org.springframework.context.annotation.ComponentScan;

import org.springframework.context.annotation.Configuration;

@Configuration

@EnableAutoConfiguration

@ComponentScan

public class Application {

public static void main(String[] args) {

SpringApplication.run(Application.class, args);

}

8行目: このクラスが設定用のクラスであることを指定する。
9行目: 自動設定を有効にする。
10行目: このクラスのパッケージ内のクラスをDIの対象にする。
13行目: ウェブアプリケーションを起動する。

設定ファイル

Spring Bootは設定が自動でされることが特徴ですが、最低限の設定はしなければなりません。またデフォルトの設定を変更したい場合もあります。その設定の方法の1つとして、application.propertiesを使う方法があります（参考: Appendix A. Common application properties）。

resourcesディレクトリにapplication.propertiesを作成します。

spring.datasource.url = jdbc:h2:file:~/tmp/mybootapp
spring.datasource.username = sa
spring.datasource.password = sa
spring.datasource.driverClassName = org.h2.Driver
spring.jpa.hibernate.ddl-auto=create-drop

spring.datasource.url = jdbc:h2:file:~/tmp/mybootapp

spring.datasource.username = sa

spring.datasource.password = sa

spring.datasource.driverClassName = org.h2.Driver

spring.jpa.hibernate.ddl-auto=create-drop

ここでは、データベースファイルの置き場所、ユーザ名、パスワード、ドライバを設定し、HibernateのDDL自動生成は、create-drop（削除して再作成）としている。

ディレクトリ構成

これまではWEB-INFというディレクトリがありましたが、Spring Bootのデフォルトではここは使いません。Thymeleafのテンプレートのデフォルトはresources/templatesに置きます。

Spring Bootのディレクトリ構成

実行

実行は次のようにgrablewから行います（Windowsの場合はgradlew.bat）。事前に「chmod +x grablew」として実行可能としておきます。

./gradlew bootRun

IntelliJのTerminalから実行するのがよいでしょう。

grablew bootRun

Started Applicationと表示されたら、実行中です。終了するにはキーボードからCtrl+Cを押します。

文字化け対策: CharacterEncodingFilterの利用

文字化けは様々な原因が考えられますが、Springの環境ではCharacterEncodingFilterを使うことで文字化けをなくすことができる場合があります。

CharacterEncodingFilterはweb.xmlで設定します。

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://java.sun.com/xml/ns/javaee"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
		  http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
           version="3.0">
    <servlet>
        <servlet-name>mvc-dispatcher</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>mvc-dispatcher</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

    <filter>
        <filter-name>SetCharacterEncodingFilter</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        <init-param>
            <param-name>encoding</param-name>
            <param-value>UTF8</param-value>
        </init-param>
        <init-param>
            <param-name>forceEncoding</param-name>
            <param-value>true</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>SetCharacterEncodingFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

</web-app>

<?xml version="1.0" encoding="UTF-8"?>

<web-app xmlns="http://java.sun.com/xml/ns/javaee"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://java.sun.com/xml/ns/javaee

http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"

version="3.0">

<servlet-name>mvc-dispatcher</servlet-name>

<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>

<load-on-startup>1</load-on-startup>

</servlet>

<servlet-mapping>

<servlet-name>mvc-dispatcher</servlet-name>

<url-pattern>/</url-pattern>

</servlet-mapping>

<filter-name>SetCharacterEncodingFilter</filter-name>

<filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>

<init-param>

<param-name>encoding</param-name>

<param-value>UTF8</param-value>

</init-param>

<init-param>

<param-name>forceEncoding</param-name>

<param-value>true</param-value>

</init-param>

</filter>

<filter-mapping>

<filter-name>SetCharacterEncodingFilter</filter-name>

<url-pattern>/*</url-pattern>

</filter-mapping>

</web-app>

掲示板を作る: Viewの作成

最後にViewを作って完成です。

Controllerの返り値として「bbs/index」を指定しているので、templatesディレクトリの中にbbsフォルダを作ってその中にindex.htmlを作成します。

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8" />
    <title>BBS</title>
</head>
<body>
    <h1>BBS</h1>
    <ol>
        <li th:each="comment:${commentList}"><span th:text="${comment.name}">名前</span>: <span th:text="${comment.text}">テキスト</span></li>
    </ol>
    <form th:action="@{/bbs/}" method="post">
        <input type="text" name="name" />
        <input type="text" name="text" /><input type="submit" />
    </form>
</body>
</html>

<!DOCTYPE html>

<head>

</head>

<body>

<ol>

</ol>

</form>

</body>

</html>

10行目: th:eachを使うとリストから1つずつ取り出して、要素が生成される。この場合commentListから取り出した値はcommentとして参照できる。comment.nameでcomment.getName()が実行される。
12行目: actionの代わりにth:actionを指定すると@{}を使ってURLを記述することができる。@{}を使うと、contextに応じたpathに書き換えてくれる。

実行例

BBS

H2コンソールで確認すると、idが自動的に割り当てられているのがわかります。

H2console2

掲示板を作る: Controllerの作成

掲示板のControllerを作成します。

今回はこれまで作ってきたTopContorollerではなくて、掲示板用のコントローラを作成します。掲示板では、コメントの表示とコメントの投稿の2つの機能が必要ですが、これを1つのページ（URL）で実現してみます。具体的にはたんなる表示の時はGETメソッドを用い、投稿時にはPOSTメソッドを使うようにします。

package net.teachingprogramming.myfirstspringapp.controller;

import net.teachingprogramming.myfirstspringapp.entity.Comment;
import net.teachingprogramming.myfirstspringapp.repository.CommentRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.ui.ModelMap;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;

import java.util.List;

/**
 * BbsController
 */
@Controller
@RequestMapping("/bbs")
public class BbsController {
    @Autowired
    private CommentRepository commentRepository;

    @RequestMapping(value = "/", method = RequestMethod.GET)
    public String indexGet(ModelMap modelMap) {
        List<Comment> commentList = commentRepository.findAll();
        modelMap.addAttribute("commentList", commentList);
        return "bbs/index";
    }

    @RequestMapping(value = "/", method = RequestMethod.POST)
    public String indexPost(ModelMap modelMap, @RequestParam("name") String name, @RequestParam("text") String text) {
        Comment comment = new Comment();
        comment.setName(name);
        comment.setText(text);
        commentRepository.save(comment);
        return indexGet(modelMap);
    }

}

package net.teachingprogramming.myfirstspringapp.controller;

import net.teachingprogramming.myfirstspringapp.entity.Comment;

import net.teachingprogramming.myfirstspringapp.repository.CommentRepository;

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

import org.springframework.stereotype.Controller;

import org.springframework.ui.ModelMap;

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

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

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

import java.util.List;

/**

* BbsController

@Controller

@RequestMapping("/bbs")

public class BbsController {

@Autowired

private CommentRepository commentRepository;

@RequestMapping(value = "/", method = RequestMethod.GET)

public String indexGet(ModelMap modelMap) {

List<Comment> commentList = commentRepository.findAll();

modelMap.addAttribute("commentList", commentList);

return "bbs/index";

}

@RequestMapping(value = "/", method = RequestMethod.POST)

public String indexPost(ModelMap modelMap, @RequestParam("name") String name, @RequestParam("text") String text) {

Comment comment = new Comment();

comment.setName(name);

comment.setText(text);

commentRepository.save(comment);

return indexGet(modelMap);

}

18行目: ベースとなるURLを「/bbs」にする。
20、21行目: @AutowiredアノテーションでCommentRepositoryをDI（dependency injection、依存性の注入）することを表す。これにより、システムがCommentRepositoryをインスタンス化してくれる。
23〜28行目: GETメソッドによるアクセスを処理するメソッド。25行目でデータベースから全てのデータを取得する。26行目で取得したデータをビューに渡す設定をする。
30〜37行目: POSTメソッドによるアクセスを処理するメソッド。32〜34行目で、Commentクラスのインスタンスを生成し受け取ったパラメータをそれぞれセットする。35行目でCommentRepositoryを使ってセーブする。これ以降の操作はGETメソッドの場合と同様なので、indexGetを呼んでそれを返り値とする。