Spring Bootによるウェブアプリ開発: プロジェクトの作成からページの表示まで


プロジェクトの雛形を作成

  1. ブラウザで「http://start.sprint.io」にアクセスする。
  2. 「Cradle Project」を選択する。
  3. グループIDとして、パッケージ名を入力する。ここでは「ユーザ名.webapp」とする。
  4. アーティファクトIDとしてプロジェクト名を入力する。ここでは「webapp」とする。
  5. 利用する依存ライブラリを入力する。名前の一部を入力すると選択肢が現れるのでクリックして選択する。ここでは「Web」と「Thymeleaf」を選択する。
  6. 選択されたものが表示されているので「Web」と「Thymeleaf」が選択されていることを確認する。
  7. クリックするとプロジェクトのファイル(ZIPファイル)のダウンロードが始まる。

start.spring.ioでプロジェクト作成

NetBeansでインポート

メニューから[ファイル]→[プロジェクトをインポート]→[ZIPから]を選択し、ダウンロードしたファイル(webapp.zip)を指定してインポートする。

インポート直後の構成

Spring Bootアプリケーションの実行

アプリケーションを実行するためのタスクが定義されているため、それを使う。

プロジェクトを右クリックして、[Task]→[boot]→[bootRun]を選択する。

アプリケーションが立ち上がると、出力ウィンドウの最後に「Started WebappApplication」と表示される。

その1行前に「Tomcat started on port(s): 8080 (http)」と出力されているということは、8080番ポートにアクセスすれば何らかの反応があるはずである。http://localhost:8080/にアクセスしてみよう。

サーバが出力したエラーページ

エラーメッセージが表示されたが、これは、まだコンテンツを返すプログラムを作っていないために表示されるもので、正常な動作である。アプリケーションを終了するには、出力ウィンドウの左側にあるStopボタンをクリックする。

Spring Web MVC frameworkの基礎中の基礎

処理の流れ

これから作るウェブアプリケーションはSpringのWeb MVCフレームワークを利用している。このフレームワークにおける処理の流れを次の図に示す(http://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsingle/#mvc-servletより引用)。

Mvc

フロントコントローラがリクエストを適切なコントローラに渡し、コントローラが出力するデータをビュー(テンプレート)が表示するという仕組み。このうち、自分で作るのは、「コントローラ」と「ビューテンプレート」である。

まずは、単純に「こんにちは」と表示するようにコントローラとテンプレートを作ってみよう。

テンプレートを作る

テンプレートとは雛形のことであり、そこに流し込まれるデータとともに使うことが一般的な使い方であるが、まずはデータの流し込みを想定しないテンプレートを作成してみよう。

まず、テンプレートを格納するディレクトリを作成しよう。Resourcesのtemplatesにlecture03というディレクトリ(パッケージ)を作る。NetBeansのパッケージの表示の仕方によっては、作業が難しい。プロジェクトウィンドウの背景部分を右クリックし、「Javaパッケージの表示方法」を「ツリー」にすると階層構造がわかりやすい。

パッケージをツリーで表示

lecture03を右クリックして新規から「HTMLファイル」を選択する。ファイル名を「hello」と入力する。拡張子は自動でつくので入力しない。作成したら、次のように書き換えよう。

今の所、次の2点が注意する点で、これ以外は普通のHTMLファイルである。

  • 2行目: xmlns属性はXML名前空間の宣言である。テンプレートエンジンであるThymeleafはHTMLへの埋め込みをXMLによって行うことが大きな特徴である。名前宣言によってThymeleafによる操作をthというプレフィックスで行うことができる。
  • 4行目: 単独で使われるタグ(brやhr等)は後ろに/をつける(XMLのルール)。

コントローラを作る

コントローラは、リクエストに対してどのテンプレートを使うか(そしてテンプレートにどのような値を埋め込むか)ということを決定するためのものである。

具体的には@Controllerアノテーションをつけたクラスで、リクエストに対応してメソッドを定義する。メソッドの返り値としてテンプレートを指定する。

  • 12行目: コントローラを表すアノテーション
  • 13行目: このコントローラが、「/lecture03」のURLを担当することを表す。
  • 16〜19行目: /hello(つまりhttp://localhost:8080/lecture03/hello)に対応するメソッド
    • 16行目: /helloに対応すること表す
    • 17行目: 戻り値の型はStringにする。メソッド名はなんでも良い。
    • 18行目: テンプレートのルート(resources/templates)から利用するテンプレートの相対パス(拡張子は除く)

20行目以降は次節以降で解説する。

動作を確認

http://localhost:8080/lecture03/helloにブラウザでアクセスしよう。

テンプレートに値を渡す

  • メソッドにModelMap型の引数を加える。
  • そのaddAttributeメソッドで名前と値を登録する。
  • テンプレートでth:text属性を使う。

例1: サイコロ

アクセスするたびに表示される数が変化する。乱数については教科書P.108を参照。

例2: 挨拶

現在時刻によって表示されれる挨拶が変化する。時刻の扱いについては、教科書P.257を参照。

再評価のための復習: インスタンス


インスタンス化

  • クラスは「型の設計図」のこと。
  • クラス(設計図)からインスタンス(実体)を作ることができる。
  • インスタンス化: インスタンスを作ること。
  • インスタンス化はnew演算子を使う。
  • コンストラクタはインスタンス化の時に使われるメソッド(今後解説する)で、その時に使われる引数を記述する。下の例は引数なし。

インスタンス化

1行でまとめて書くこともできる。

エラーになる例

person3がインスタンス化されていない(注: 厳密には「初期化されていない」)ためコンパイルエラー(コンパイル時にエラーになってコンパイルできない)になる。

コンパイルできる(person4はnullで初期化されている)が、実行時にエラーになる(ランタイムエラー)。person4がインスタンス化されてない(実態がない)のに使おうとしたため。

基本型(プリミティブ型)は?

  • インスタンス化が必要なのは参照型(クラス型)
  • newは使わない。
  • 初期化は必要

次はOK。

1行で書くのもOK。

初期化がないのはNG(コンパイルエラー)。

基本型でnullは扱えないのでNG(コンパイルエラー)。

Gradleの利用


ビルドとは

ソフトウェアのビルド(英: build)は、ソースコードファイルを独立したソフトウェア生成物に変換するコンピュータ上で実行されるプロセス、またはその結果を指す。ビルドにおいて最も重要なのはコンパイルプロセスであり、ソースコードファイルを実行ファイルに変換する。

ビルド (ソフトウェア) – Wikipedia

要するに「コードを書いた後に実行できるようするまでにする作業」のこと。これまでは、NetBeansで行ってきた(「ファイルの実行」をクリックすることで、コンパイルが行われ実行された)。

Javaを用いた開発に使われるビルドツール

  • Ant
  • Maven
  • Gradle
  • etc…

Android用の開発環境であるAndroid StudioではGradleが採用されている。

NetBeansでGradleを使う

プラグイン

Gradle Supportプラグインをインストールすることで、Gradleベースのプロジェクトを作成・管理することができる。

プラグインを確認

インストール済みにあることを確認する。

プロジェクトの作成

Single Gradle Projectを選択。

プロジェクトを選択

プロジェクト名とメインクラス(メインメソッドを作るクラス)を指定する。メインクラスは完全修飾クラス名(パッケージ名を頭につける)で指定する。

プロジェクト名とメインクラス

プロジェクトには、メインクラス(Main.java)とビルドスクリプト(build.gradleとsettings.gradle)が作成される。

プロジェクトの構造

実行する

Main.javaに書き加える。

プロジェクトを右クリックして、Runをクリック。

runタスクの実行

出力ウィンドウに出力される。

出力ウィンドウ

外部のライブラリを使う

これまで、JDKに含まれるライブラリ(クラス)を使ってきたが、世の中には様々なライブラリが公開されている。ライブラリをプロジェクトに取り込んで使ってみよう。

GradleはMavenのリポジトリ(ライブラリが保管されているサーバ)からライブラリをダウンロードする機能があるので、Mavenのリポジトリから利用するライブラリを探すのが簡単だ。

今回は、HTMLパーサ(HTMLを解釈してあれこれするためのソフト)のJsoupを使ってみよう。MavenのリポジトリのJsoup 1.10.2のページにある、Gradle用の記述をコピーし、build.gradleのdependenciesにペーストする。

Mavenレポジトリからコピー

プロジェクトを右クリックして、Reload Projectをクリックすると、依存ライブラリがダウンロードされ、プロジェクトに追加される。

Dependenciesに追加される

Jsoupの利用例

ニュースのサイトからニュースのタイトル一覧を取得しよう。

注意: ブラウザで人間が操作するのではなく、機械的にページを取得する行為は一般に「ウェブスクレイピング(Web scraping)」というが、スクレイピングが想定されていない場合が多い(あるいは明示的に禁止されている)。ウェブから情報を取得するときには、まず専用のAPIがあるかどうか確認しよう。またスクレイピングによって情報を取得する場合も、その頻度を調整するなど、迷惑をかけないようにしよう(提供する側の立場としては、そもそもスクレイピングして欲しくない場合が多い)。

例外処理

教科書[P.65]を参照。

ポイント:

  • 例外(exception、エラーのこと)が発生したらcatch節に飛ぶ。
  • 例外の種類
    • チェック例外: 必ずtryでチェックしなければならない。
    • 非チェック例外: チェックしなくて良い。例えば、0で除算など。

再評価のための復習: クラスの概要


クラスとは

  • クラスとは型の設計図のこと。注: ここではわかりやすさのため設計図に例えるが、設計図の比喩が適切でない場合もあるので注意すること。「適切でない場合」については今後解説する。
  • クラスから作られるものをインスタンス(実体)という。
  • 基本的に、1クラス1ファイルで定義する。ファイル名は「クラス名.java」とする。
  • クラスにはメンバーによって構成される(クラスの中にかけるのはメンバーだけ)。
  • メンバーの種類にはフィールドとメソッドがある(フィールドとメソッド以外のものはない)。
  • [慣例] クラス名は大文字ではじめる。
  • [慣例] フィールド名とメソッド名は小文字ではじめる。

クラスの構造

カウンターアプリを作る


JavaFXでWindowを表示する

  • JavaFXのアプリケーションはjavafx.application.Applicationを継承して作る。
  • ちなみにjavafx.application.Applicationは抽象クラス(アブストラクトクラス)。
  • startメソッドをオーバーライドして、そこで各種設定(部品配置等)を行う。startメソッドはJavaFXにおけるコンストラクタのような役割。
  • アプリケーションの起動は「Application.launch(アプリケーションのクラス名.class);」で行う。

ボタンなどを配置する

イベントハンドラー(オブザーバー)

  • ボタンクラスはイベント(ボタンがクリックされた等)が発生した時に、何か処理をすること(させること)ができる。
  • 「イベントが発生した時の処理」を担当するクラスを「イベントハンドラー(event handler)」という。
  • もっと詳しく知りたい人へ: Observerパターン
  • (JavaFxの場合)ButtonのイベントハンドラーはEventHandlerインターフェースを実装する。
  • ボタンに関するイベントが発生すると、ボタンに登録したイベントハンドラーのhandleメソッドが実行される。

ExampleHandlerをきちんと動作させる(カウントボタンでラベルに表示されるカウンターを増やし、リセットボタンで0にする)には次の2つができるようにすればいいが、煩雑なコードになる。

  • labelのsetTextメソッドを呼べるようにする
  • countButtonとresetButtonのどちらからイベントが発生したか区別できるようにする

カウンターの機能をうまく実現するには、CounterAppがイベントを処理するようにするのが簡潔になる。

JavaFXについて知る

インターフェース(復習)


  • クラスと同様で、型を定義できる。
  • クラスと違って、単体では使えない(インスタンスを作ることができない)。クラスに実装(implements)する。
  • インターフェースで記述できるメソッドは抽象メソッド(本体がない)。したがってクラスでそのメソッドをオーバーライドして実装しなければ(本体を書かなければ)ならない。

例えると:

  • クラス: 設計図(どのような機能があるのか、その機能をどのような処理で実現するのかが書いてある)。
  • インスタンス: 製品・生産物・実体(設計図に基づいて作られるもの)。
  • インターフェース: 規格(設計の時点で持つべき機能が定義されている。どのように実現するのかは書いていない)。

設計図が違っても、同じ規格に準拠していれば、それらの設計図から作られた実体は同じように扱うことができる(その規格の範囲内では)。

例えばスマホ内蔵のバッテリーは特に標準規格がないので、あるスマホバッテリーを他のスマホで使うことはできない。
乾電池は形・サイズ・電圧の規格(単一、単二等)が合っていれば(インターフェースが合っていれば)、メーカや電池系(マンガン、アルカリ等)が違っても(処理の実装が違っても)入れ替えて使うことができる(注: 厳密には、電池系についても規格があるのでマンガンとアルカリで入れ替えてはダメな場合等もある)。

インターフェース


キャッシュレジスターをプログラムする。

レジで会計する(税込の合計金額を計算してレシートを印刷する)ときに必要なのは、商品の値段と商品名だ。だから、Bookクラスに「値段を取得するメソッド」と「商品名を取得するメソッド」があればOK。

では、Bookで表現できないものをレジで会計するには、どのようにすればいいのか?

  • Book以外も受け付けるようにレジを改良する(クラスごとに保存、計算するプログラムが必要になる)。
  • Bookより上位のクラス(例えば商品クラス)を定義し、それを継承するように書き直す(Java言語は単一継承のためうまく実現できない場合も)。
  • getPriceメソッドをなんとかして呼ぶ(リフレクションを使う)。ちなみに、ダック・タイピングをサポートする言語ならば簡単だが、Java言語はそうでは無い。
  • 商品を表すインターフェースを定義し、レジで扱いたいクラスはそれを実装(implements)する。
  • etc…

インターフェースとは

クラスに特定のメンバー(メソッドとフィールド、主にメソッド)が存在することを保証する仕組み。クラスと同様に型として扱うことができる。

  • インターフェースには「クラスが持っていてほしいメンバー」を定義する。ただしメソッドの本体(実際に実行される部分)は無い(抽象メソッドという)。
  • インターフェースをimplementsしたクラスは、そのインターフェースに定義されているメンバー全体を実装する(メソッドの本体も書く)。

まずはBookだけを計算できるレジ

商品を表すProduct

  • クラスと同様にメンバー(フィールド、メソッド)を持つ。
  • ただし、メソッドは本体がない(抽象メソッド)。

Productを実装(implements)

Product対応レジ

getterとsetter


getter/setterとは

  • getterはフィールドを取得(ゲット)するためのメソッド。メソッド名は「getフィールド名」とする。フィールド名の最初を大文字に変える。対応するフィールドをreturnする。 
  • setterはフィールドに設定(セット)するためにメソッド。メソッド名は「setフィールド名」とする。フィールド名の最初を大文字に変える。引数をフィールドにセットする。

getter/setterでフィールドにアクセスする利点(例)

  • フィールドをprivateとしてgetterだけ用意すれば読み出し専用のフィールドとなる。
  • セッターでセットする値をチェックすることができる。
  • etc…

Bookの改良

Bookのpriceを後から書き換えられないようにしよう。

継承: Objectクラス


(Objectクラスを除く)全てのクラスはObjectクラスを継承している

  • extendsを書かない場合は、自動的にObjectクラスを継承する(「extends Object」と同じ)。
  • Objectのメソッドをオーバーライドして動作を変えることができる。

UMLによる継承の関係の図示

Diagram

toStringメソッド

System.out.printlnで表示しようしたり、文字列(Stringクラスのインスタンス)を+演算子で繋げようとすると、ObjectクラスにあるtoStringメソッドが呼ばれて、そのインスタンスを表す文字列型が取り出される。

例えば、

とすると、

lesson11.d00000.Comic@5e481248

等と表示される。これは、ObjectのtoStringが

と定義されているから(例えば、JDK6のソースコードhttp://hg.openjdk.java.net/jdk6/jdk6/jdk/file/48e891c51be5/src/share/classes/java/lang/Object.java#l235)。

オーバーライドして、インスタンスの情報を見やすく表示するようにしてみよう。Bookクラスに

を加えることで、

の表示が変わる(Bookを継承しているComicの場合も)。

継承: スーパークラスとサブクラス


書籍を表すBookクラスを継承して、漫画本(巻という概念がある)を表すクラスを作ろう。

ソースコード

mainメソッドで、それぞれ使ってみよう。

実行結果:

Javaの絵本, アンク, 1580円
ドラえもん, 藤子不二雄, 500円

Comicのコンストラクタ

  • 継承したクラス(サブクラス)のコンストラクタでは、スーパークラスのコンストラクタを最初に呼ばなければならない。
  • スーパークラスのコンストラクタはsuper(引数)で呼ぶことができる。
  • スーパークラスに引数なしのコンストラクタ(デフォルトコンストラクタを含む)がある場合、「super();」という記述を省略することができる(つまり書かなくても呼ばれる)。

オーバーライド

  • スーパークラスと同じメソッドを定義するとそのメソッドを上書きすることができる。
  • スーパークラスのメソッドは super.メソッド名(引数)で呼び出すことができる。
  • @Overrideはなくてもいいが、つけておくとオーバーライドできているかチェックしてくれる(アノテーション)。

実行結果:

Javaの絵本, アンク, 1580円
ドラえもん, 藤子不二雄, 500円, 1巻

合計金額を計算する(1)

代入記号の意味

プリミティブ型(基本型)は「箱」のイメージ。代入によって、値がコピーされて箱に格納される。

Assignment1

クラス型(参照型)は「タグ」のイメージ。
代入によって、同じインスタンスに結びつく。

Assignment2

もっと色々知りたい人のために:

  • タグが1つも付いていないインスタンスはどうなるのか?→GC(ガベージコレクション、ゴミ集め)によってメモリから消えて無くなる。[教科書P.82]
  • Null Pointer(ヌルポ)とは、タグの先にインスタンスがない状態のこと。
  • クラス型のインスタンスをコピーするのはどうするのか?→自分で実装する。大抵はcloneメソッドをオーバーライドする。
  • インスタンスをコピーするコードを書いたけど、思った通りにコピーされてない。→シャローコピー(shallow copy)とディープコピー(deep copy)について調べよう。

サブクラスのインスタンスをスーパークラスのインスタンスとして扱う

Comicクラスのインスタンスは、Bookクラスのインスタンスとして扱うことができる。なぜならComicクラスはBookクラスを受け継いでいるから(継承しているから)。

多態性[教科書P.108]

  • comic2で呼び出すときは、Comicとして扱うので、volumeフィールドにアクセスできる。
  • book2で呼び出すときは、Bookとして扱うので、volumeフィールドにアクセスできない。
  • book2.getInfo()は上書きした方(ComicのgetInfo)が呼び出される(Bookとして扱う場合であっても、実体はComicクラスのインスタンスだから)。

合計金額を計算する(2)