詳解Spring Boot中Controller用法
Controller
Controller是SpringBoot里最基本的組件,他的作用是把用戶提交來的請(qǐng)求通過對(duì)URL的匹配,分配個(gè)不同的接收器,再進(jìn)行處理,然后向用戶返回結(jié)果。他的重點(diǎn)就在于如何從HTTP請(qǐng)求中獲得信息,提取參數(shù),并分發(fā)給不同的處理服務(wù)。
基本組成
一個(gè)最經(jīng)典的Controller應(yīng)該大概長(zhǎ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這是一個(gè)控制器。
然后在對(duì)應(yīng)的處理函數(shù)前面加上@RequestMapping,告知這個(gè)函數(shù)需要相應(yīng)的URL。
接著這個(gè)函數(shù)傳入了一個(gè)Model類型的參數(shù),這個(gè)參數(shù)主要是用于向模板傳遞數(shù)據(jù)。
該函數(shù)最后返回了一個(gè)叫”index”的字符串,表示將調(diào)用名為”index”的模板,具體名稱取決于模板引擎,比如對(duì)于jsp他將訪問”index.jsp”這個(gè)文件,對(duì)于thymeleaf,他將訪問”index.html”這個(gè)文件。
上面的是最簡(jiǎn)單的用法,實(shí)際上有很多細(xì)節(jié)需要注意,下面就來一一解釋。
ResponseBody
如果我們想返回純字符串而不是渲染后的模板,那我們可以在需要返回字符串的函數(shù)前面加上@ResponseBody這個(gè)注解;
如果我們像對(duì)于整個(gè)類都返回字符串,我們也可以在這個(gè)類前面加上@ResponseBody注解,或者將@Controller注解換成@RestController,均可。
RequestMapping
基本用法
這個(gè)注解是用來告訴Spring,下面的這個(gè)函數(shù)或者類是用來映射到那個(gè)URL的,通常情況下有下面這些選項(xiàng):
@RequestMapping(
path = {"/test"},
params = {"name","userId"},
method = {RequestMethod.GET},
consumes = {"text/plain", "application/*"},
produces = "text/plain",
headers = "content-type=text/*"
)
我們可以指定這個(gè)路徑,參數(shù),方法,頭信息,來作為一個(gè)Controller的入口。當(dāng)然,通常我們只需要指定path就行了。
作用對(duì)象
這個(gè)注解可以注解一個(gè)函數(shù),也可以注解一個(gè)類。當(dāng)注解一個(gè)類時(shí),類中所有的方法都會(huì)在這個(gè)基礎(chǔ)上再進(jìn)行過濾:
@Controller
@RequestMapping("/path1")
public class TestController {
@RequestMapping("/path2")
@ResponseBody
public String index() {
return "ok";
}
}
這個(gè)函數(shù)就能匹配”/path1/path1”這個(gè)地址。
缺省參數(shù)
當(dāng)RequestMapping的參數(shù)是空的時(shí)候,他就表示匹配剩余所有的頁(yè)面,實(shí)際上也就是匹配所有的404頁(yè)面。
@Controller
public class IndexController {
@RequestMapping
public String index(Model model) {
return "index";
}
}
當(dāng)RequestMapping不指定參數(shù)名時(shí),默認(rèn)就是path參數(shù)。
@Controller
public class IndexController {
@RequestMapping("/index")
public String index(Model model) {
return "index";
}
}
PathVariable
RequestMapping中的path也可以是一個(gè)未定的變量,比如下面的代碼:
@Controller
public class TestController {
@RequestMapping("/{variable}")
@ResponseBody
public String index(@PathVariable("variable")String variable) {
return variable;
}
}
通過花括號(hào)我們就可以指定這個(gè)變量,并且通過@PathVariable注解得到這個(gè)參數(shù),非常方便。
RequestParam
RequestMapping也可以獲取類似表單傳回的信息形式,比如/index?name=XXX,這個(gè)name變量就可以通過RequestParam注解來獲得:
@Controller
public class TestController {
@RequestMapping("/index")
@ResponseBody
public String index(@RequestParam(value = "name",required = false,defaultValue = "233")String name) {
return name;
}
}
我們可以控制這個(gè)參數(shù)的名字,是否必須,以及設(shè)置默認(rèn)值,來更好的進(jìn)行匹配。
RequestBody
RequestBody用來獲取Post信息的消息體,只要在參數(shù)中通過@RequestBody注解就能得到這個(gè)參數(shù):
@Controller
public class TestController {
@RequestMapping("/index")
@ResponseBody
public String index(@RequestBody String body) {
//對(duì)body進(jìn)行解析即可
return "success";
}
}
總結(jié)
上面這些大概就是Controller中最基本的用法了,十分的方便清楚。具體的細(xì)節(jié)可以參考源碼中的注釋,解釋的也是十分詳盡了。
以上所述是小編給大家介紹的Spring Boot中Controller用法,希望對(duì)大家有所幫助,如果大家有任何疑問歡迎給我留言,小編會(huì)及時(shí)回復(fù)大家的,在此也非常感謝大家對(duì)腳本之家網(wǎng)站的支持!
相關(guān)文章
詳談ServiceLoader實(shí)現(xiàn)原理
下面小編就為大家?guī)硪黄斦凷erviceLoader實(shí)現(xiàn)原理。小編覺得挺不錯(cuò)的,現(xiàn)在就分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧2017-02-02
Springboot實(shí)現(xiàn)發(fā)送郵件及注冊(cè)激活步驟
為了方便郵件發(fā)送功能的使用,我們用郵件發(fā)送功能實(shí)現(xiàn)用戶注冊(cè),實(shí)現(xiàn)步驟大概就是進(jìn)行用戶注冊(cè)同時(shí)發(fā)送一封激活郵件,郵件里附帶激活鏈接,關(guān)于Springboot發(fā)送郵件注冊(cè)激活功能的實(shí)現(xiàn)參考下本文吧2021-06-06
Spring中的之啟動(dòng)過程obtainFreshBeanFactory詳解
這篇文章主要介紹了Spring中的之啟動(dòng)過程obtainFreshBeanFactory詳解,在refresh時(shí),prepareRefresh后,馬上就調(diào)用了obtainFreshBeanFactory創(chuàng)建beanFactory以及掃描bean信息(beanDefinition),并通過BeanDefinitionRegistry注冊(cè)到容器中,需要的朋友可以參考下2024-02-02
怎樣將一個(gè)JAR包添加到Java應(yīng)用程序的Boot?Classpath中
本文文章給大家介紹如何將一個(gè)JAR包添加到Java應(yīng)用程序的Boot?Classpath中,本文通過實(shí)例代碼給大家介紹的非常詳細(xì),需要的的朋友參考下吧2023-11-11
elasticsearch如何根據(jù)條件刪除數(shù)據(jù)
Elasticsearch是一個(gè)基于Apache Lucene?的開源搜索引擎,無論在開源還是專有領(lǐng)域,Lucene 可以被認(rèn)為是迄今為止最先進(jìn)、性能最好的、功能最全的搜索引擎庫(kù),這篇文章主要介紹了elasticsearch如何根據(jù)條件刪除數(shù)據(jù),需要的朋友可以參考下2023-03-03
使用SkyWalking監(jiān)控Java服務(wù)的過程
這篇文章主要介紹了使用SkyWalking監(jiān)控Java服務(wù),介紹一個(gè)對(duì)源碼0入侵的Java服務(wù)監(jiān)控方式,SkyWalking Agent,只需要啟動(dòng)Java程序的時(shí)候加幾個(gè)參數(shù),就能對(duì)Java服務(wù)進(jìn)行可視化監(jiān)控,需要的朋友可以參考下2023-08-08
Java使用JDBC驅(qū)動(dòng)連接MySQL數(shù)據(jù)庫(kù)
這篇文章主要為大家詳細(xì)介紹了Java使用JDBC驅(qū)動(dòng)連接MySQL數(shù)據(jù)庫(kù)的具體步驟,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2016-12-12

