Controller是SpringBoot里最基本的組件,他的作用是把用戶提交來的請求通過對URL的匹配,分配個不同的接收器,再進行處理,然后向用戶返回結果。他的重點就在于如何從HTTP請求中獲得信息,提取參數,并分發給不同的處理服務。
基本組成
一個最經典的Controller應該大概長這樣:
1
2
3
4
5
6
7
8
9
10
11
12
13
|
package com.example.demo.controller; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.RequestMapping; /** * Created by myths on 5/16/17. */ @Controller public class IndexController { @RequestMapping (value = { "index" , "/" }) public String index(Model model) { return "index" ; } } |
首先應該在類的開頭,加上@Controller注解,告知Spring這是一個控制器。
然后在對應的處理函數前面加上@RequestMapping,告知這個函數需要相應的URL。
接著這個函數傳入了一個Model類型的參數,這個參數主要是用于向模板傳遞數據。
該函數最后返回了一個叫”index”的字符串,表示將調用名為”index”的模板,具體名稱取決于模板引擎,比如對于jsp他將訪問”index.jsp”這個文件,對于thymeleaf,他將訪問”index.html”這個文件。
上面的是最簡單的用法,實際上有很多細節需要注意,下面就來一一解釋。
ResponseBody
如果我們想返回純字符串而不是渲染后的模板,那我們可以在需要返回字符串的函數前面加上@ResponseBody這個注解;
如果我們像對于整個類都返回字符串,我們也可以在這個類前面加上@ResponseBody注解,或者將@Controller注解換成@RestController,均可。
RequestMapping
基本用法
這個注解是用來告訴Spring,下面的這個函數或者類是用來映射到那個URL的,通常情況下有下面這些選項:
1
2
3
4
5
6
7
8
|
@RequestMapping ( path = { "/test" }, params = { "name" , "userId" }, method = {RequestMethod.GET}, consumes = { "text/plain" , "application/*" }, produces = "text/plain" , headers = "content-type=text/*" ) |
我們可以指定這個路徑,參數,方法,頭信息,來作為一個Controller的入口。當然,通常我們只需要指定path就行了。
作用對象
這個注解可以注解一個函數,也可以注解一個類。當注解一個類時,類中所有的方法都會在這個基礎上再進行過濾:
1
2
3
4
5
6
7
8
9
|
@Controller @RequestMapping ( "/path1" ) public class TestController { @RequestMapping ( "/path2" ) @ResponseBody public String index() { return "ok" ; } } |
這個函數就能匹配”/path1/path1”這個地址。
缺省參數
當RequestMapping的參數是空的時候,他就表示匹配剩余所有的頁面,實際上也就是匹配所有的404頁面。
1
2
3
4
5
6
7
|
@Controller public class IndexController { @RequestMapping public String index(Model model) { return "index" ; } } |
當RequestMapping不指定參數名時,默認就是path參數。
1
2
3
4
5
6
7
|
@Controller public class IndexController { @RequestMapping ( "/index" ) public String index(Model model) { return "index" ; } } |
PathVariable
RequestMapping中的path也可以是一個未定的變量,比如下面的代碼:
1
2
3
4
5
6
7
8
|
@Controller public class TestController { @RequestMapping ( "/{variable}" ) @ResponseBody public String index( @PathVariable ( "variable" )String variable) { return variable; } } |
通過花括號我們就可以指定這個變量,并且通過@PathVariable注解得到這個參數,非常方便。
RequestParam
RequestMapping也可以獲取類似表單傳回的信息形式,比如/index?name=XXX,這個name變量就可以通過RequestParam注解來獲得:
1
2
3
4
5
6
7
8
|
@Controller public class TestController { @RequestMapping ( "/index" ) @ResponseBody public String index( @RequestParam (value = "name" ,required = false ,defaultValue = "233" )String name) { return name; } } |
我們可以控制這個參數的名字,是否必須,以及設置默認值,來更好的進行匹配。
RequestBody
RequestBody用來獲取Post信息的消息體,只要在參數中通過@RequestBody注解就能得到這個參數:
1
2
3
4
5
6
7
8
9
|
@Controller public class TestController { @RequestMapping ( "/index" ) @ResponseBody public String index( @RequestBody String body) { //對body進行解析即可 return "success" ; } } |
總結
上面這些大概就是Controller中最基本的用法了,十分的方便清楚。具體的細節可以參考源碼中的注釋,解釋的也是十分詳盡了。
以上所述是小編給大家介紹的Spring Boot中Controller用法,希望對大家有所幫助,如果大家有任何疑問歡迎給我留言,小編會及時回復大家的,在此也非常感謝大家對服務器之家網站的支持!
原文鏈接:https://blog.mythsman.com/2017/05/13/1/