【ナレッジ】SpringBoot入門パラメータを送受信してみる

Java

こんにちは!ワーパパエトウです!

第2回目はパラメータの送受信についてやっていきましょう。

前提として、パラメータの受け渡し方には大きく下記の2パターンがあるので頭に入れておいてください。

用語説明
パスパラメータ例えば「http://localhost:8080/xxxx/yyyy/zzzz」というURLがあった場合、URLの「zzzz」箇所をパラメータとして受け取る。
リクエストパラメータ例えば「http://localhost:8080/xxxx/yyyy?param=hoge」というURLがあった場合、URLの「?」以降の箇所をパラメータとして受け取る。

パスパラメータでパラメータを受け取る

メソッド引数に「@PathVariable」アノテーションを付与します。また、アノテーションにはバインド対象のパスパラメータ名を指定してください。

もし、パスパラメータ名の指定を省略した場合はメソッド引数の変数名でバインドされます。

@RequestMapping("/pathvariable/{pathVariableParam}")
private String pathVariable(@PathVariable("pathVariableParam") String pathVariableParam) {
	return pathVariableParam;
}
@RequestMapping("/pathvariableomit/{pathVariableOmitParam}")
private String pathVariableOmit(@PathVariable String pathVariableOmitParam) {
	return pathVariableOmitParam;
}

HTTPメソッドを指定したい場合は「@RequestMapping」アノテーションの第2引数に指定してください。

@RequestMapping(value = "/pathvariableomitget/{pathVariableOmitGETParam}", method = RequestMethod.GET)
private String pathVariableOmitGET(@PathVariable String pathVariableOmitGETParam) {
	return pathVariableOmitGETParam;
}

リクエストパラメータでパラメータを受け取る

メソッド引数に「@RequestParam」アノテーションを付与します。アノテーションにはバインド対象のリクエストパラメータ名を指定してください。

もし、リクエストパラメータ名の指定を省略した場合はメソッド引数の変数名でバインドされます。

@RequestMapping("/requestparam")
private String requestParam(@RequestParam("requestParamParam") String requestParamParam) {
	return requestParamParam;
}
@RequestMapping("/requestparamomit")
private String requestParamOmit(@RequestParam String requestParamOmitParam) {
	return requestParamOmitParam;
}

HTTPメソッドを指定したい場合は 「@RequestMapping」アノテーションの第2引数に指定してください。

@RequestMapping(value = "/requestparamomitget", method = RequestMethod.GET)
private String requestParamOmitGET(@RequestParam String requestParamOmitGETParam) {
	return requestParamOmitGETParam;
}

JavaBeanを返却する

先程からString文字列ばかり返却しておりましたが、JavaBeanを返却してみましょう。

返却方法としてはそのまま返却したいJavaBeanを返却してあげればOKです。

ちなみにJavaBeanを返却するとJSON形式に自動変換されるようです。

下記のソースコードを実行すると「{“id”:100,”pass”:”test01″}」というJSON文字列が画面に表示されます。

@RequestMapping("topbean")
private TopBean getTopBean() {
	// そのまま返却すればよい
	return new TopBean(100, "test01");
}
/**
 * 返却用のBeanクラス
 */
public class TopBean {
	private int id;
	private String pass;
	
	public TopBean() {}
	
	public TopBean(int id, String pass) {
		this.id = id;
		this.pass = pass;
	}

	
	public int getId() {
		return id;
	}
	public void setId(int id) {
		this.id = id;
	}
	public String getPass() {
		return pass;
	}
	public void setPass(String pass) {
		this.pass = pass;
	}
}

メディアタイプを指定したい場合は「@RequestMapping」アノテーションの第2引数に指定してください。

@RequestMapping(value = "jsonvalue", produces = MediaType.APPLICATION_JSON_VALUE)
private String getJSONValue() {
	return "{\"id\":100,\"pass\":\"test01\"}";
}

さいごにまとめ

今回はパラメータの送受信のやり方について解説しました。

まだSpringBootに入門する準備が出来ていない方は下記の記事を参考にしてください。

【ナレッジ】SpringBoot入門STSのインストールから日本語化まで
SpringBoot入門ってことで、今回はSTSのインストールから日本語化までを解説していきます。 環境構築は初心者が躓きやすい場所でもあるので画像たっぷりで解説しております。

もっと詳細にSpringFWについて知りたいという方には下記の書籍がオススメです。

★実際にモノづくりしながら読み進めたい方はコチラ!!

★設計概念など根本から知りたい方はコチラ!

では今回はここまで、また次回お会いしましょう!

コメント

タイトルとURLをコピーしました