【SpringBoot入門】第３回「サンプルプログラムを読み解こう！（その１）」

こんにちは。タグボード開発チームのワシヅカです。

昨日は新宿の就職博へブース出展しておりました。弊社のブースへ足を運んでいただいた皆さま。本当にありがとうございました(^^)

さて、早速ですが第３回をはじめましょう！

今回は第２回で扱った、サンプルプログラムを読み解いていきたいと思います。

どんな流れで動いているかを中心に見ていきたいと思います。

１．Spring Tool Suite（STS）で行数を表示する

…とその前に。このままでは読みにくいので、行数を表示しておきましょう。

メニューバーの［ウィンドウ］→［設定］と進んで、以下の画面が表示されたら、

［一般］→［エディタ］→［テキストエディタ］とクリックしていきます。

そして、右側の「行番号の表示」にチェックを入れて「適用して閉じる」をクリックしてください。

これで行番号が表示されるようになります。

２．ブレイクポイントを付ける

次にブレイクポイントを付けましょう。

ブレイクポイントを付けるとデバッグモード時に、処理がその部分を通過した場合、止まってくれます。

STS（Spring Tool Suite）では、行番号の左の部分をダブルクリックすると、ブレイクポイントを付けてくれます。

まずは、以下の画像の３点にブレイクポイントを付けてみましょう！。

●ブレイクポイント１：Application.javaの１０行目付近

SpringApplication.run(Application.class, args);

1	SpringApplication.run(Application.class, args);

●ブレイクポイント２：MainController.javaの２１行目付近

public @ResponseBody String addNewUser (@RequestParam String name, @RequestParam String email)[

1	public @ResponseBody String addNewUser (@RequestParam String name, @RequestParam String email)[

●ブレイクポイント３：MainController.javaの３４行目付近

public @ResponseBody Iterable<User> getAllUsers(){

1	public @ResponseBody Iterable<User> getAllUsers(){

３．デバッグモードで起動する

それでは、デバッグモードで起動してみましょう。

下の画像の赤枠で囲んだ中に、緑の虫のようなアイコンがあると思いますが、そのボタンをクリックします。

※下の画像のように、虫の隣の「▼」をクリックすると、どの設定でデバッグ起動するか選択できます。

万が一エラーが発生した場合は、２重起動している可能性もありますので、■ボタンを押して、アプリケーションをを停止してもう一度試してください。

４．ブレイクした地点を確認する

デバッグ起動した途端、ブレークしました。

public static void main(String[] args)

1	public static void main(String[] args)

の見慣れたmainメソッドです。ここから処理は起動され、次のSpringApplication#runによりWebアプリケーションが立ち上がります。ブレイクポイントから先に進む場合はF8キーを押してください。

Applicationクラスに@SpringBootApplicationというアノテーションが着いていますが、頭の片隅に「起動時にSpringBootの機能設定を自動でやってくれる」アノテーションなんだ程度に留めておきましょう。

５．URLとのマッピングを確認する

起動が一通り終わったら、次にブラウザを起動して、http://localhost:8080/demo/allへ遷移してみましょう。

３６行目のポイントでブレークしたようです。このメソッドが呼び出される秘密は青枠で囲った「@RequestMapping」、「@GetMapping」がポイントとなります。

@ResponseBody Iterable<User> getAllUsers(){

1	@ResponseBody Iterable<User> getAllUsers(){

改めてアプリケーションを起動したときのコンソールを覗いて見てください。

このようなログが出力されていると思います。

[           main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/demo/add],methods=[GET]}" onto public java.lang.String hello.MainController.addNewUser(java.lang.String,java.lang.String)
[           main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/demo/all],methods=[GET]}" onto public java.lang.Iterable<hello.User> hello.MainController.getAllUsers()

[ main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/demo/add],methods=[GET]}" onto public java.lang.String hello.MainController.addNewUser(java.lang.String,java.lang.String)

[ main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/demo/all],methods=[GET]}" onto public java.lang.Iterable<hello.User> hello.MainController.getAllUsers()

「/demo/all」を「MainController.getAllUsers()」、「/demo/add」を「MainController.addNewUser()」

へマッピングしたよとログに出力されています。今回の場合、MainControllerクラスに”/demo”がマッピングされ、そのMainControllerクラスのgetAllUsersメソッドに”/all”がマッピングされており、合わせ技で”/demo/all”、”/demo/add”へのマッピングとなっています。

クラスやメソッドの上に@RequestMapping(path=”…”)や@GetMapping(path=”…”)と書くことで起動時にURLとHTTPリクエストメソッドがマッピングされるのです。以前StrutsのようなフレームワークではこうしたマッピングはXMLで管理していましたが、このようにアノテーションを書くだけで簡単に実現できてしまいます。

６．URLとのマッピングを追加する

それでは試しに新しいURLとHTTPリクエストメソッドのマッピングを追加してみましょう。MainControllerクラスの中に、以下のコードを追加してみてください。Userテーブルの件数を返却するプログラムです。

	/***
	 * テーブル件数を返却する
	 * @return
	 */
	@GetMapping(path="/count")
	public @ResponseBody long getCount() {
		return userRepository.count();
	}

/***

* テーブル件数を返却する

* @return

@GetMapping(path="/count")

public @ResponseBody long getCount() {

return userRepository.count();

}

さて、実際にブレークポイントを張って、ブラウザからアクセスしてみましょう。

見事に新しく追加したgetCountメソッドの中で止まりました。F8キーを押して先に進みましょう。

件数が画面に表示されました。

０と表示されてしまった方は、データを追加して試してみてください。

前回同様、以下のURLでデータ追加可能です。

http://localhost:8080/demo/add?name=user01&email=email01

７．起動時にテーブルが生成されないようにする

前回少しお話しましたが、データを追加したのに０件と表示されてしまった場合、アプリケーション起動時にテーブルが生成されるような設定になっています。起動の度にテーブルが生成されるため、テーブルがリセットされてしまっています。追加したデータを残しておきたい場合は、下の画像ように「none」と設定してください。

８．POSTリクエストにも対応する

さて、@GetMapping(“…”)は、Getメソッドに対応するアノテーションですが、POSTメソッドでもアクセスしたい場合はどうすればよいでしょうか。

試しにMainControllerクラスのaddNewUserメソッドのアノテーションを以下のように修正してみましょう。

@RequestMapping(path="/add" , method = { RequestMethod.GET, RequestMethod.POST })

1	@RequestMapping(path="/add" , method = { RequestMethod.GET, RequestMethod.POST })

RequestMethodは、新たに「org.springframework.web.bind.annotation.RequestMethod」のインポートが必要ですので、エラーのアイコンをダブルクリックしてウィザードを呼出し、importしておきましょう。

９．POSTリクエストでアクセスしてみる。

修正が終わったら、chromeのアドオンツールである「Advanced REST client」というツールを使ってPOSTリクエストして確認してみましょう。

「Advanced REST client」の詳細な使用方法は割愛しますが、以下のような内容で送信します。下の画面を参考に設定してみてください。設定が終わったら右上の「SEND」ボタンをクリックします。もちろん、STSはデバッグ状態で起動したままですよ。

Method	POST
Body Content type	application/x-www-form-urlencoded
name	hogehoge
email	piyopiyo

ブレークポイントに止まりました。見事にPOSTリクエストでもアクセスできるようになりました！送信されたパラメータも受信できています。

少々業業しいコード書きましたが、実は、@RequestMapping(path=”/all”)と書くだけでもアクセス可能です。

ただ、そのように書くとHEADリクエストや、DELETEリクエストでもアクセス可能になってしまいますので、セキュリティーとユーザーの利便性を考慮した上で、HTTPリクエストメソッドは最小限に設計しておいたほうが良いかと思います。

１０．GETメソッドにしかマッピングされていない場合

参考までに、GETリクエストにしかマッピングされていないメソッドにPOSTリクエストでアクセスしてみると、

４０５HTTPエラーが返却されます。

１１．まとめ

URLとクラス・メソッドの紐付け（マッピング）は、アノテーションを使用する
アノテーションには@RequestMapping(path=”…”)、@GetMapping(path=”…”）、@PutMapping(path=”…”）がある。（あまり使わないと思いますが、@DeleteMappingもあります。）
GET/POSTどちらにも対応したい場合、@RequestMapping(path=”/add” , method = { RequestMethod.GET, RequestMethod.POST })のように記述が可能
マッピングしていないリクエストメソッドでアクセスすると４０５エラーとなる

少し長くなりましたので、今回はこの辺で終わりたいと思います。次回は、同じサンプルプロジェクトを使ってDBアクセスまわりを見ていきたいと思います。

以上、タグボード開発チームのワシヅカでした。