詳解Spring Boot中Controller用法
Controller
Controller是SpringBoot里最基本的組件,他的作用是把用戶提交來的請求通過對URL的匹配,分配個不同的接收器,再進(jìn)行處理,然后向用戶返回結(jié)果。他的重點(diǎn)就在于如何從HTTP請求中獲得信息,提取參數(shù),并分發(fā)給不同的處理服務(wù)。
基本組成
一個最經(jīng)典的Controller應(yīng)該大概長這樣:
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"; } }
首先應(yīng)該在類的開頭,加上@Controller注解,告知Spring這是一個控制器。
然后在對應(yīng)的處理函數(shù)前面加上@RequestMapping,告知這個函數(shù)需要相應(yīng)的URL。
接著這個函數(shù)傳入了一個Model類型的參數(shù),這個參數(shù)主要是用于向模板傳遞數(shù)據(jù)。
該函數(shù)最后返回了一個叫”index”的字符串,表示將調(diào)用名為”index”的模板,具體名稱取決于模板引擎,比如對于jsp他將訪問”index.jsp”這個文件,對于thymeleaf,他將訪問”index.html”這個文件。
上面的是最簡單的用法,實(shí)際上有很多細(xì)節(jié)需要注意,下面就來一一解釋。
ResponseBody
如果我們想返回純字符串而不是渲染后的模板,那我們可以在需要返回字符串的函數(shù)前面加上@ResponseBody這個注解;
如果我們像對于整個類都返回字符串,我們也可以在這個類前面加上@ResponseBody注解,或者將@Controller注解換成@RestController,均可。
RequestMapping
基本用法
這個注解是用來告訴Spring,下面的這個函數(shù)或者類是用來映射到那個URL的,通常情況下有下面這些選項(xiàng):
@RequestMapping( path = {"/test"}, params = {"name","userId"}, method = {RequestMethod.GET}, consumes = {"text/plain", "application/*"}, produces = "text/plain", headers = "content-type=text/*" )
我們可以指定這個路徑,參數(shù),方法,頭信息,來作為一個Controller的入口。當(dāng)然,通常我們只需要指定path就行了。
作用對象
這個注解可以注解一個函數(shù),也可以注解一個類。當(dāng)注解一個類時,類中所有的方法都會在這個基礎(chǔ)上再進(jìn)行過濾:
@Controller @RequestMapping("/path1") public class TestController { @RequestMapping("/path2") @ResponseBody public String index() { return "ok"; } }
這個函數(shù)就能匹配”/path1/path1”這個地址。
缺省參數(shù)
當(dāng)RequestMapping的參數(shù)是空的時候,他就表示匹配剩余所有的頁面,實(shí)際上也就是匹配所有的404頁面。
@Controller public class IndexController { @RequestMapping public String index(Model model) { return "index"; } }
當(dāng)RequestMapping不指定參數(shù)名時,默認(rèn)就是path參數(shù)。
@Controller public class IndexController { @RequestMapping("/index") public String index(Model model) { return "index"; } }
PathVariable
RequestMapping中的path也可以是一個未定的變量,比如下面的代碼:
@Controller public class TestController { @RequestMapping("/{variable}") @ResponseBody public String index(@PathVariable("variable")String variable) { return variable; } }
通過花括號我們就可以指定這個變量,并且通過@PathVariable注解得到這個參數(shù),非常方便。
RequestParam
RequestMapping也可以獲取類似表單傳回的信息形式,比如/index?name=XXX,這個name變量就可以通過RequestParam注解來獲得:
@Controller public class TestController { @RequestMapping("/index") @ResponseBody public String index(@RequestParam(value = "name",required = false,defaultValue = "233")String name) { return name; } }
我們可以控制這個參數(shù)的名字,是否必須,以及設(shè)置默認(rèn)值,來更好的進(jìn)行匹配。
RequestBody
RequestBody用來獲取Post信息的消息體,只要在參數(shù)中通過@RequestBody注解就能得到這個參數(shù):
@Controller public class TestController { @RequestMapping("/index") @ResponseBody public String index(@RequestBody String body) { //對body進(jìn)行解析即可 return "success"; } }
總結(jié)
上面這些大概就是Controller中最基本的用法了,十分的方便清楚。具體的細(xì)節(jié)可以參考源碼中的注釋,解釋的也是十分詳盡了。
以上所述是小編給大家介紹的Spring Boot中Controller用法,希望對大家有所幫助,如果大家有任何疑問歡迎給我留言,小編會及時回復(fù)大家的,在此也非常感謝大家對腳本之家網(wǎng)站的支持!
相關(guān)文章
Java多線程中的ThreadLocal應(yīng)用場景及問題解讀
這篇文章主要介紹了Java多線程中的ThreadLocal應(yīng)用場景及問題解讀,ThreadLocal這個類在多線程并發(fā)中主要的使用場景是什么呢,我們都知道多線程并發(fā)問題實(shí)際就是多個線程對公共資源訪問和修改問題,需要的朋友可以參考下2023-12-12Spring Date jpa 獲取最新一條數(shù)據(jù)的實(shí)例代碼
這篇文章主要介紹了Spring Date jpa 獲取最新一條數(shù)據(jù)的實(shí)例代碼,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2020-10-10SpringBoot環(huán)境Druid數(shù)據(jù)源使用及特點(diǎn)
Druid 是目前比較流行的高性能的,分布式列存儲的OLAP框架(具體來說是MOLAP)。本文給大家分享SpringBoot環(huán)境Druid數(shù)據(jù)源使用及特點(diǎn)介紹,感興趣的朋友跟隨小編一起看看吧2021-07-07json-lib將json格式的字符串,轉(zhuǎn)化為java對象的實(shí)例
下面小編就為大家?guī)硪黄猨son-lib將json格式的字符串,轉(zhuǎn)化為java對象的實(shí)例。小編覺得挺不錯的,現(xiàn)在就分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2017-03-03