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 干貨!