SpringMVC 方法三種類型返回值總結,你用過幾種?

SpringMVC 現在算是 Java 領域的一個基礎性框架了,很多人天天用,可是對於 SpringMVC 方法的返回值,你又是否完全清楚呢?今天我就來和大家聊一聊 SpringMVC 中四種不同類型的返回值,看看有沒有 get 到你的知識盲點?

1. ModelAndView

以前前後端不分的情況下,ModelAndView 應該是最最常見的返回值類型了,現在前後端分離後,後端都是以返回 JSON 數據爲主了。後端返回 ModelAndView 這個比較容易理解,開發者可以在 ModelAndView 對象中指定視圖名稱,然後也可以綁定數據,像下面這樣:

  
  
  
  1. @RequestMapping("/book")

  2. public ModelAndView getAllBook() {

  3. ModelAndView mv = new ModelAndView();

  4. List<Book> books = new ArrayList<>();

  5. Book b1 = new Book();

  6. b1.setId(1);

  7. b1.setName("三國演義");

  8. b1.setAuthor("羅貫中");

  9. books.add(b1);

  10. Book b2 = new Book();

  11. b2.setId(2);

  12. b2.setName("紅樓夢");

  13. b2.setAuthor("曹雪芹");

  14. books.add(b2);

  15. //指定數據模型

  16. mv.addObject("bs", books);

  17. mv.setViewName("book");//指定視圖名

  18. return mv;

  19. }

返回 ModelAndView ,最常見的兩個操作就是指定數據模型+指定視圖名 。

2. Void

返回值爲 void 時,可能是你真的沒有值要返回,也可能是你有其他辦法,我將之歸爲如下四類,大夥來看下。

2.1 沒有值

如果確實沒有返回值,那就返回 void ,但是一定要注意,此時,方法上需要添加 @ResponseBody 註解,像下面這樣:

  
  
  
  1. @RequestMapping("/test2")

  2. @ResponseBody

  3. public void test2(){

  4. //你的代碼

  5. }

2.2 重定向

由於 SpringMVC 中的方法默認都具備 HttpServletResponse 參數,因此可以重拾 Servlet/Jsp 中的技能,可以實現重定向,像下面這樣手動設置響應頭:

  
  
  
  1. @RequestMapping("/test1")

  2. @ResponseBody

  3. public void test1(HttpServletResponse resp){

  4. resp.setStatus(302);

  5. resp.addHeader("Location","/aa/index");

  6. }

也可以像下面這樣直接調用重定向的方法:

  
  
  
  1. @RequestMapping("/test1")

  2. @ResponseBody

  3. public void test1(HttpServletResponse resp){

  4. resp.sendRedirect("/aa/index");

  5. }

當然,重定向無論你怎麼寫,都是 Servlet/Jsp 中的知識點,上面兩種寫法都相當於是重回遠古時代。

2.3 服務端跳轉

既然可以重定向,當然也可以服務端跳轉,像下面這樣:

  
  
  
  1. @GetMapping("/test5")

  2. public void test5(HttpServletRequest req,HttpServletResponse resp) {

  3. req.getRequestDispatcher("/WEB-INF/jsp/index.jsp").forward(req,resp);

  4. }

2.4 返回字符串

當然也可以利用 HttpServletResponse 返回其他字符串數據,包括但不侷限於 JSON,像下面這樣:

  
  
  
  1. @RequestMapping("/test2")

  2. @ResponseBody

  3. public void test2(HttpServletResponse resp) throws IOException {

  4. resp.setContentType("application/json;charset=utf-8");

  5. PrintWriter out = resp.getWriter();

  6. List<Book> books = new ArrayList<>();

  7. Book b1 = new Book();

  8. b1.setId(1);

  9. b1.setName("三國演義");

  10. b1.setAuthor("羅貫中");

  11. books.add(b1);

  12. Book b2 = new Book();

  13. b2.setId(2);

  14. b2.setName("紅樓夢");

  15. b2.setAuthor("曹雪芹");

  16. books.add(b2);

  17. String s = new Gson().toJson(books);

  18. out.write(s);

  19. out.flush();

  20. out.close();

  21. }

這是返回值爲 void 時候的情況,方法返回值爲 void ,不一定就真的不返回了,可能還有其他的方式給前端數據。

3. String

當 SpringMVC 方法的返回值爲 String 類型時,也有幾種不同情況。

3.1 邏輯視圖名

返回 String 最常見的是邏輯視圖名,這種時候一般利用默認的參數 Model 來傳遞數據,像下面這樣 :

  
  
  
  1. @RequestMapping("/hello")

  2. public String aaa(Model model) {

  3. model.addAttribute("username", "張三");

  4. return "hello";

  5. }

此時返回的 hello 就是邏輯視圖名,需要攜帶的數據放在 model 中。

3.2 重定向

也可以重定向,事實上,如果在 SpringMVC 中有重定向的需求,一般採用這種方式:

  
  
  
  1. @RequestMapping("/test4")

  2. public String test4() {

  3. return "redirect:/aa/index";

  4. }

3.3 forward 轉發

也可以 forward 轉發,事實上,如果在 SpringMVC 中有 forward 轉發的需求,一般採用這種方式:

  
  
  
  1. @RequestMapping("/test3")

  2. public String test3() {

  3. return "forward:/WEB-INF/jsp/order.jsp";

  4. }

3.4 真的是 String

當然,也有一種情況,就是你真的想返回一個 String ,此時,只要在方法上加上 @ResponseBody 註解即可,或者 Controller 上本身添加的是組合註解 @RestController,像下面這樣:

  
  
  
  1. @RestController

  2. public class HelloController {

  3. @GetMapping("/hello")

  4. public String hello() {

  5. return "hello provider!";

  6. }

  7. }

也可以像下面這樣 :

  
  
  
  1. @Controller

  2. public class HelloController {

  3. @GetMapping("/hello")

  4. @ResponseBody

  5. public String hello() {

  6. return "hello provider!";

  7. }

  8. }

這是返回值爲 String 的幾種情況。

JSON

返回 JSON 算是最最常見的了,現在前後端分離的趨勢下,大部分後端只需要返回 JSON 即可,那麼常見的 List 集合、Map,實體類等都可以返回,這些數據由 HttpMessageConverter 自動轉爲 JSON ,如果大家用了 Jackson 或者  Gson ,不需要額外配置就可以自動返回 JSON 了,因爲框架幫我們提供了對應的 HttpMessageConverter ,如果大家使用了 Alibaba 的 Fastjson 的話,則需要自己手動提供一個相應的 HttpMessageConverter 的實例,方法的返回值像下面這樣:

  
  
  
  1. @GetMapping("/user")

  2. @ResponseBody

  3. public User getUser() {

  4. User user = new User();

  5. List<String> favorites = new ArrayList<>();

  6. favorites.add("足球");

  7. favorites.add("籃球");

  8. user.setFavorites(favorites);

  9. user.setUsername("zhagnsan");

  10. user.setPassword("123");

  11. return user;

  12. }

  13. @GetMapping("/users")

  14. @ResponseBody

  15. public List<User> getALlUser() {

  16. List<User> users = new ArrayList<>();

  17. for (int i = 0; i < 10; i++) {

  18. User e = new User();

  19. e.setUsername("zhangsan:" + i);

  20. e.setPassword("pwd:" + i);

  21. users.add(e);

  22. }

  23. return users;

  24. }

總結

好了,這是我爲大夥總結的 SpringMVC 方法四種不同類型的返回值,難倒是不難!

關注我,你不會失望的!!


本文分享自微信公衆號 - JAVA開發大本營(gh_42999193133a)。
如有侵權,請聯繫 [email protected] 刪除。
本文參與“OSC源創計劃”,歡迎正在閱讀的你也加入,一起分享。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章