SpringMVC-方法四種型別返回值總結，你用過幾種？

江南一點雨發表於2019-05-06
SpringMVC型別

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

1. ModelAndView

以前前後端不分的情況下，ModelAndView 應該是最最常見的返回值型別了，現在前後端分離後，後端都是以返回 JSON 資料為主了。後端返回 ModelAndView 這個比較容易理解，開發者可以在 ModelAndView 物件中指定檢視名稱，然後也可以繫結資料，像下面這樣：

@RequestMapping("/book")
public ModelAndView getAllBook() {
    ModelAndView mv = new ModelAndView();
    List<Book> books = new ArrayList<>();
    Book b1 = new Book();
    b1.setId(1);
    b1.setName("三國演義");
    b1.setAuthor("羅貫中");
    books.add(b1);
    Book b2 = new Book();
    b2.setId(2);
    b2.setName("紅樓夢");
    b2.setAuthor("曹雪芹");
    books.add(b2);
    //指定資料模型
    mv.addObject("bs", books);
    mv.setViewName("book");//指定檢視名
    return mv;
}
複製程式碼

返回 ModelAndView ，最常見的兩個操作就是指定資料模型+指定檢視名 。

2. Void

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

2.1 沒有值

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

@RequestMapping("/test2")
@ResponseBody
public void test2(){
    //你的程式碼
}
複製程式碼

2.2 重定向

由於 SpringMVC 中的方法預設都具備 HttpServletResponse 引數，因此可以重拾 Servlet/Jsp 中的技能，可以實現重定向，像下面這樣手動設定響應頭：

@RequestMapping("/test1")
@ResponseBody
public void test1(HttpServletResponse resp){
    resp.setStatus(302);
    resp.addHeader("Location","/aa/index");
}
複製程式碼

也可以像下面這樣直接呼叫重定向的方法：

@RequestMapping("/test1")
@ResponseBody
public void test1(HttpServletResponse resp){
    resp.sendRedirect("/aa/index");
}
複製程式碼

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

2.3 服務端跳轉

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

@GetMapping("/test5")
public void test5(HttpServletRequest req,HttpServletResponse resp) {
    req.getRequestDispatcher("/WEB-INF/jsp/index.jsp").forward(req,resp);
}
複製程式碼

2.4 返回字串

當然也可以利用 HttpServletResponse 返回其他字串資料，包括但不侷限於 JSON，像下面這樣：

@RequestMapping("/test2")
@ResponseBody
public void test2(HttpServletResponse resp) throws IOException {
    resp.setContentType("application/json;charset=utf-8");
    PrintWriter out = resp.getWriter();
    List<Book> books = new ArrayList<>();
    Book b1 = new Book();
    b1.setId(1);
    b1.setName("三國演義");
    b1.setAuthor("羅貫中");
    books.add(b1);
    Book b2 = new Book();
    b2.setId(2);
    b2.setName("紅樓夢");
    b2.setAuthor("曹雪芹");
    books.add(b2);
    String s = new Gson().toJson(books);
    out.write(s);
    out.flush();
    out.close();
}
複製程式碼

這是返回值為 void 時候的情況，方法返回值為 void ，不一定就真的不返回了，可能還有其他的方式給前端資料。

3. String

當 SpringMVC 方法的返回值為 String 型別時，也有幾種不同情況。

3.1 邏輯檢視名

返回 String 最常見的是邏輯檢視名，這種時候一般利用預設的引數 Model 來傳遞資料，像下面這樣 ：

@RequestMapping("/hello")
public String aaa(Model model) {
    model.addAttribute("username", "張三");
    return "hello";
}
複製程式碼

此時返回的 hello 就是邏輯檢視名，需要攜帶的資料放在 model 中。

3.2 重定向

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

@RequestMapping("/test4")
public String test4() {
    return "redirect:/aa/index";
}
複製程式碼

3.3 forward 轉發

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

@RequestMapping("/test3")
public String test3() {
    return "forward:/WEB-INF/jsp/order.jsp";
}
複製程式碼

3.4 真的是 String

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

@RestController
public class HelloController {
    @GetMapping("/hello")
    public String hello() {
        return "hello provider!";
    }
}
複製程式碼

也可以像下面這樣 ：

@Controller
public class HelloController {
    @GetMapping("/hello")
    @ResponseBody
    public String hello() {
        return "hello provider!";
    }
}
複製程式碼

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

4. JSON

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

@GetMapping("/user")
@ResponseBody
public User getUser() {
    User user = new User();
    List<String> favorites = new ArrayList<>();
    favorites.add("足球");
    favorites.add("籃球");
    user.setFavorites(favorites);
    user.setUsername("zhagnsan");
    user.setPassword("123");
    return user;
}
@GetMapping("/users")
@ResponseBody
public List<User> getALlUser() {
    List<User> users = new ArrayList<>();
    for (int i = 0; i < 10; i++) {
        User e = new User();
        e.setUsername("zhangsan:" + i);
        e.setPassword("pwd:" + i);
        users.add(e);
    }
    return users;
}
複製程式碼

總結

好了，這是鬆哥為大夥總結的 SpringMVC 方法四種不同型別的返回值，難倒是不難！有問題歡迎大夥留言討論。

關注公眾號牧碼小子，專注於 Spring Boot+微服務，定期視訊教程分享，關注後回覆 Java ，領取鬆哥為你精心準備的 Java 乾貨！

SpringMVC-方法四種型別返回值總結，你用過幾種？

相關文章