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 乾貨！