美文网首页Java 杂谈MyBatis+SpringMVC+SpringBoot
SpringMVC 方法四种类型返回值总结,你用过几种?

SpringMVC 方法四种类型返回值总结,你用过几种?

作者: _江南一点雨 | 来源:发表于2019-05-06 08:49 被阅读1次

    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 的几种情况。

    4. 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 ,领取松哥为你精心准备的Java干货!牧码小子专注于前后端分离,Java微服务等技术分享,都是 松哥原创技术干货!

    相关文章

      网友评论

        本文标题:SpringMVC 方法四种类型返回值总结,你用过几种?

        本文链接:https://www.haomeiwen.com/subject/uzploqtx.html