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

原文地址:https://blog.51cto.com/9806927/2389555

时间: 2024-09-30 19:41:40

SpringMVC-方法四种类型返回值总结,你用过几种?的相关文章

Overload和Override的区别。Overloaded的方法是否可以改变返回值的类型?

Overload是重载的意思,Override是覆盖的意思,也就是重写. 重载Overload表示同一个类中可以有多个名称相同的方法,但这些方法的参数列表各不相同(即参数个数或类型不同). 重写Override表示子类中的方法可以与父类中的某个方法的名称和参数完全相同,通过子类创建的实例对象调用这个方法时,将调用子类中的定义方法,这相当于把父类中定义的那个完全相同的方法给覆盖了,这也是面向对象编程的多态性的一种表现.子类覆盖父类的方法时,只能比父类抛出更少的异常,或者是抛出父类抛出的异常的子异常

SpringMVC中使用@ResponseBody注解返回值,Ajax取得中文乱码解决方法

Spring使用AnnotationMethodHandlerAdapter的handleResponseBody方法, AnnotationMethodHandlerAdapter使用request header中"Accept"的值和messageConverter支持的MediaType进行匹配,然后会用"Accept"的第一个值写入 response的"Content-Type".一般的请求都是通过浏览器进行的,request heade

Override和Overload区别,Overloaded的方法是否可以改变返回值的类型?

Overload是重载的意思, Override是覆盖的意思,也就是重写. 重载Overload表示同一个类中可以有多个名称相同的方法,但这些方法的参数列表各不相同(即参数个数或类型不同). 重写Override表示子类中的方法可以与父类中的某个方法的名称和参数完全相同,通过子类创建的实例对象调用这个方法时,将调用子类中的定义方法,这相当于把父类中定义的那个完全相同的方法给覆盖了,这也是面向对象编程的多态性的一种表现. 子类覆盖父类的方法时,只能比父类抛出更少的异常,或者是抛出父类抛出的异常的子

方法的重写与重载的区别(Override与Overload)。重载的方法是否可以改变返回值的类型

方法的重写(Override)与重载(Overload)的区别.重载的方法是否可以改变返回值的类型?[基础] 解释: 方法的重写overriding和重载Overloading是Java多态性的不同表现. 1.重写overriding是父类与子类之间多态性的一种表现,重载Overloading是一个类中多态性的一种表现. 2.如果在子类中定义某方法与其父类有相同的名称和参数,我们说该方法被重写(Overriding). 子类的对象使用这个方法时,将调用子类中的定义,对它而言,父类中的定义如同被"

Java常见面试题02-方法重写和方法重载的区别?方法重载能改变返回值类型吗?

方法重写和方法重载的区别?方法重载能改变返回值类型吗?       A:Override方法重写和Overload方法重载的区别? Overload是否可以改变返回值类型?可以 方法重写 •  子类中出现了和父类中一模一样的方法声明,也被称为方法覆盖,方法复写. •  使用特点: •   如果方法名不同,就调用对应的方法 •   如果方法名相同,最终使用的是子类自己的 父类方法重写格式:super.父类成员方法名 •  方法重写的注意事项   父类中私有方法不能被重写   子类重写父类方法时,访

java处理方法的多个返回值

我第一次接触到元组是在java编程思想这本书中,当时我正为方法的多个返回值苦恼.因为我之前处理多个返回值方法的时候,要不建一个新的实体类,要不在接收的方法中建立一个对象,返回值之前给其赋值,要不通过异常机制向上抛出,不管哪一种都很繁琐.但是元组不一样,我们只要建立好元组类 和工具类就可以在任何地方使用,而且简单,明了. /*** * 功能描述:登录 * @author 程三发 2016-5-26 下午03:21:30 * @param loginName 用户名 * @param appType

sring mvc 返回值至jsp界面的几种方式

Spring 通过Controller 向 View 传值的方法有以下四种 HttpServletRequest ModelAndView Map<String, Object> map Model model 第一种 需要参数HttpServletRequest 返回值是jsp页面 @RequestMapping("/query1.do") public String queryUser1(HttpServletRequest request){ String name

Overload和Override的区别,Overload 的方法是否可以改变返回值类型?

Overload:重载,发生在同一个类中,各个方法名相同,方法参数的个数.顺序或类型不同:返回值类型不同或形参名称不同,不构成方法重载: Override:重写,发生继承关系中,子类所重写的方法与父类方法 方法名相同,参数个数.顺序和类型相同:返回值类型相同或者是 父类中的返回值类型的子类.子类不能重写父类的private(私有).static和final方法,子类中重写的方法不能抛出比父类更大的异常.构造方法不能被重写. 原文地址:https://www.cnblogs.com/remta/p

C++ 成员函数返回引用,三种获取返回值的效果

这个实验需要以下的代码: class Test { public: Test(){cout << "Test" << endl;} ~Test(){cout << "~Test" << endl;} Test(const Test &right) { cout << "Test(const)" << endl; this->a = right.a; } Test