springboot中的controller注意事項說明
關于controller注意事項
spring boot的controller水深無比，經(jīng)過學習，我總結一些tips，以便以后參照，減少錯誤：
1.controller主要有兩個標簽
@Controller和@RestController，兩個標簽無法同時發(fā)揮作用，前者標注的類只能返回靜態(tài)文件，后者標注的類用于返回數(shù)據(jù)類型如json字符串
2.使用@Controller標簽時
templates下的文件并不能被識別（自己試驗過，發(fā)現(xiàn)和網(wǎng)上很多說法都不一樣），只有static文件夾下文件能直接被讀取，具體代碼如下：
@RequestMapping(value="/", method= RequestMethod.GET)
public String home() {
? ? return "views/index.html";
}這里static作為根目錄被訪問。
各種controller的寫法
最近玩SpingBoot，以下是一些Controller的各種寫法
我們將分為四部分
- 1、Controller的類型(傳統(tǒng)的 和 REST）
- 2、路由（Routes）
- 3、如何接收數(shù)據(jù)
- 4、Controller示例
Controller 類型
你也許每天都在使用Spring ，但你知道controller有幾種類型嗎？其實controller是有兩種的，一種就是傳統(tǒng)的web的那種controller，而另外一種就是REST類型的controller。
@Controller 通常是被使用服務于web 頁面的。默認，你的controller方法返回的是一個string 串，是表示要展示哪個模板頁面或者是要跳轉(zhuǎn)到哪里去。
@RestController 就是專門用在編寫API的時候，特別那種返回一個JSON，或者是XML等等。然后方法返回的是可以是一個對象，是一個可以被序列化的對象。
當然了你也可以通過controller來實現(xiàn)返回JSON、XML這些。只是這里為了"REST"，得另立門戶，這樣會更加的清晰明了。
路由（Routes）
這里的路由就是指http method。（GET,POST,PUT,PATCH,DELETE）。
HTTP Methods
在Spring boot中，http method可以被用類似“*Mapping”的格式來表示：
@GetMapping@PostMapping@PutMapping@PatchMapping@DeleteMapping
然后這些注解中可以添加path，像下面這樣：
例子： @GetMapping("/users")
一個比較典型的REST controller 一般是像下面這樣來映射路由的：
@RestController
public class UsersController { ??
?
? ?@GetMapping("/users") ? ?
? ? public List<User> index() {...} ?
??
? ? @GetMapping("/users/{id}") ? ?
? ? public User show(...) {...}
? ??
? ? @PostMapping("/users") ? ?
? ? public User create(...) {...} ?
??
? ? @PutMapping("/users/{id}") ??
? ? public User update(...) {...} ? ?
?
? ? @DeleteMapping("/users/{id}") ? ?
? ? public void delete(...) {...}
}還有一種比較常見的做法是通過在controller類上添加一個@RequestMapping注解。這樣相當于可以把上面的所有的mapping前綴添加到這里。
像下面這樣（基于上面的例子修改）：
@RestController
@RequestMapping("/users")
public class UsersController {
? ??
? ? @GetMapping
? ? public List<User> index() {...}
? ??
? ? @GetMapping("{id}") ? ?
? ? public User show(...) {...} ??
?
? ? @PostMapping
? ? public User create(...) {...}?
? ?
? ? @PutMapping("{id}") ??
? ? public User update(...) {...} ??
?
? ? @DeleteMapping("{id}") ? ?
? ? public void delete(...) {...}
}返回狀態(tài)
Controller的方法可以去指定一個返回狀態(tài)碼。默認的是返回一個200 OK，如果是沒有返回值（void）則返回 204 No Content。
@PostMapping
@ResponseStatus(HttpStatus.CREATED)
public User create(...) {...}路徑變量
你可以通過添加@PathVariable注解來把路徑上的值捕獲下來：
// DELETE /users/123
@DeleteMapping("/users/{id}")
public void delete(@PathVariable long id) {...}默認情況下，參數(shù)名必須要和路徑上的變量名一樣。但你也可以通過下面的方式來修改，就是你通過給@PathVariable賦值為路徑變量名，然后參數(shù)名就可以是不一樣的了：
// GET /users/me@example.com/edit
@GetMapping("/users/{email}/edit"
public String edit(@PathVariable("email") String userEmail) {...}接收數(shù)據(jù)
查詢字符參數(shù)
如果是通過？xxx=xxx&yyy=yyy來傳遞過來的參數(shù)，那么我們可以通過@RequestParam來獲取：
// GET /users?count=10
@GetMapping("/users")
public List<User> index(@RequestParam int count) {...}默認的話，變量名必須要和查詢字符參數(shù)是一樣的。你也可以通過下面的方式來修改：
// GET /users?num_per_page=50
@GetMapping("/users")
public List<User> index(@RequestParam("num_per_page") int numPerPage) {...}提交HTML表單數(shù)據(jù)
如果我們想要創(chuàng)建一個用戶。這時候，我么可能在前端，寫下面這樣一個form：
<form action="/users" method="POST"> ? <input name="name"/> ? <input name="email"/> ? <button type="submit">Create User</button> </form>
現(xiàn)在我們創(chuàng)建一個請求模型，用來匹配我們的前端form結構：
class UserCreateRequest { ? ?
? ?private String name; ? ?
? ?private String email; ? ?
? ?/* Getters & Setters omitted */
}然后我們就可以在controller對應的方法上來捕獲form里的值，我們通過對參數(shù)添加一個@ModelAttribute注解就可以實現(xiàn)了：
@PostMapping("/users")
public User create(@ModelAttribute UserCreateRequest request) {...}提交JSON
就像上面例子那樣，我們創(chuàng)建一個用戶，然后是一個JSON格式：
{ "name": "Som Eone", "email": "someone@example.com"}
然后請求模型還是沿用之前的：
class UserCreateRequest {undefined
private String name;
private String email;?
}然后我們使用@RequestBody來捕獲前端發(fā)送過來的JSON串，然后反序列化到我們的請求模型UserCreateRequest：
@PostMapping
public User create(@RequestBody UserCreateRequest request) {...}Controller 舉例
以下是使用上述所有注解創(chuàng)建Controller的示例。 沒有具體邏輯，只是簡單的展示上面說到的各個注解。
傳統(tǒng)的controller
這類型的controller返回值表示要展示的頁面或要跳轉(zhuǎn)到哪個請求。
@Controller
@RequestMapping("/users")
public class UsersController { ? ?
? ?@GetMapping
? ? public String index() { ? ? ? ?
? ? ? ? return "users/index";
? ? } ? ?
?
? ? @GetMapping("{id}") ? ?
? ? public String show(@PathVariable long id) { ? ? ? ?
? ? ? ? ?return "users/show";
? ? } ?
?
? ? @PostMapping
? ? @ResponseStatus(HttpStatus.CREATED) ? ?
? ? public String create(@ModelAttribute UserCreateRequest request) {
? ? ? return "redirect:/users";
? ? } ? ?
?
? ? @PutMapping("{id}") ? ?
? ? public String update(@PathVariable long id, @RequestBody UserUpdateRequest request) { ? ? ? ?
? ? ? ?return "redirect:/users/" + id;
? ? } ??
?
? ? @DeleteMapping("{id}") ? ?
? ? public String delete(@PathVariable long id) { ? ? ? ?
? ? ? ? return "redirect:/users";
? ? }
}REST controller
這類型的controller返回值是一些對象，這些對象要被序列化成JSON、XML等其他格式，并不是表示要跳轉(zhuǎn)到哪個HTML模板。
@RestController
@RequestMapping("/users")
public class UsersController { ? ?
? ?@GetMapping
? ? public List<User> index() { ? ? ? ?return new ArrayList<User>();
? ? } ??
?
? ? @GetMapping("{id}") ? ?
? ? public User show(@PathVariable long id) { ? ? ? ?return new User();
? ? } ?
?
? ? @PostMapping
? ? @ResponseStatus(HttpStatus.CREATED) ? ?
? ? public User create(@RequestBody UserCreateRequest request) {
? ? ? ?return new User();
? ? } ? ?
?
? ? @PutMapping("{id}") ? ?
? ? public User update(@PathVariable long id, @RequestBody UserUpdateRequest request) { ? ? ? ?
? ? ? ?return new User();
? ? } ? ?
?
? ? @DeleteMapping("{id}") ? ?
? ? public void delete(@PathVariable long id) {}
}以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關文章
下面小編就為大家?guī)硪黄猨ava判定數(shù)組或集合是否存在某個元素的實例。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2017-01-01
Mybatis-Plus條件構造器select方法返回指定字段方式
這篇文章主要介紹了Mybatis-Plus條件構造器select方法返回指定字段方式，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-06-06
區(qū)塊鏈是分布式數(shù)據(jù)存儲、點對點傳輸、共識機制、加密算法等計算機技術的新型應用模式,下面這篇文章主要給大家介紹了基于Java實現(xiàn)區(qū)塊鏈的相關資料,需要的朋友可以參考下2021-08-08
Fluent MyBatis是一個MyBatis的增強工具，沒有對mybatis做任何修改。本篇文章將詳細介紹對Fluent Mybatis中的update語法進行驗證。代碼具有一定價值，感興趣的小伙伴可以學習一下2021-11-11
這篇文章主要介紹了簡單了解Java日志脫敏框架sensitive,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2019-11-11
SpringBoot+MinIO+KKFileView實現(xiàn)文件預覽功能
本文主要介紹了使用SpringBoot、MinIO和KKFileView實現(xiàn)文件上傳和在線預覽功能,通過配置MinIO存儲文件,并使用KKFileView生成預覽鏈接,感興趣的可以了解一下2024-11-11
Java利用Geotools從DEM數(shù)據(jù)中讀取指定位置的高程信息全過程
Geotools作為一款功能強大且開源的地理工具庫,為地理數(shù)據(jù)的處理和分析提供了豐富的類庫和便捷的接口,能夠很好地滿足從DEM數(shù)據(jù)中讀取高程信息這一實戰(zhàn)需求,本文將深入講解如何利用Geotools從獲取DEM數(shù)據(jù)到成功讀取指定位置高程信息的全過程,需要的朋友可以參考下2025-03-03
java底層AQS實現(xiàn)類ReentrantLock鎖的構成及源碼解析
本章我們就要來學習一下第一個?AQS?的實現(xiàn)類：ReentrantLock，看看其底層是如何組合?AQS?，實現(xiàn)了自己的那些功能，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步2022-03-03
Nacos通過RefreshScope實現(xiàn)配置自動更新的方式分享
這篇文章主要給大家介紹了Nacos如何通過RefreshScope實現(xiàn)配置自動更新,文中給了兩種實現(xiàn)方式供大家參考,對大家的學習或工作有一定的幫助,需要的朋友可以參考下2023-09-09
Java多線程之JUC(java.util.concurrent)的常見類(多線程編程常用類)
這篇文章主要給大家介紹了關于Java多線程之JUC(java.util.concurrent)的常見類(多線程編程常用類)的相關資料,Java中的JUC（java.util.concurrent）包提供了一些并發(fā)編程中常用的類,這些類可以幫助我們更方便地實現(xiàn)多線程編程,需要的朋友可以參考下2024-02-02