Day73-回顾SpringMVC篇之Controller 的各种细节

最新推荐文章于 2024-05-29 09:54:41 发布

阿杰杰杰のblog

最新推荐文章于 2024-05-29 09:54:41 发布

阅读量140

点赞数

分类专栏： SpringMVC Spring 文章标签： java spring http

本文链接：https://blog.csdn.net/Youmonster/article/details/127198788

版权

Spring 同时被 2 个专栏收录

22 篇文章 0 订阅

订阅专栏

SpringMVC

10 篇文章 0 订阅

订阅专栏

Day73-回顾SpringMVC篇之Controller 的各种细节

1.1@RequestMapping

这个注解用来标记一个接口,该注解是在接口开发中,使用最多的注解之一.

1.1.1 请求URL

标记请求URL只需要在相应的方法上添加该注解即可:

@Controller
public class HelloController{
	@RequesMapping("/hello")
    public ModelAndView hello(){
        return new ModelAndView("hello");
    }
}

这里@RequestMapping(“/hello”)表示当请求地址为/hello的时候,这个方法会被触发.其中,地址可以是多个,就是可以多个地址映射到同一个方法.

@Controller
public class HelloController{
    @RequestMapping({"/hello","/hello2"}){
        return new ModelAndView("hello");
    }
}

这个配置,表示/hello和/hello2 都可以访问到该方法.

1.1.2 请求窄化

在同一个项目中,会存在多个接口,例如订单相关的接口都是/order/xxx格式的,用户相关的接口都是/user/xxx格式的.为了方便处理,这里的前缀可以统一在Controller上面处理.

@Controller
@RequestMapping("/user")
public class HelloController{
    @RequestMapping({"/hello","/hello2"}){
        return new ModelAndView("hello");
    }
}

当类上加了@RequestMapping注解之后,此时,要想访问到hello,地址就应该是/user/hello 或者/user/hello2.

1.1.3 请求方法限定

默认情况下,使用@RequestMapping注解定义好的方法,可以别GET请求访问到,也可以别POST访问到,但是DELETE请求以及PUT请求不可以访问到.

当然我们也可以指定具体的访问方法:

@Controller
@RequestMapping("/user")
public class HelloController{
    @RequestMapping(value="/hello",method=RequestMapping.GET)
    public ModelAndView hello(){
        return new ModelAndView("hello");
    }
}

通过 @RequestMapping 注解，指定了该接口只能被 GET 请求访问到，此时，该接口就不可以被 POST 以及请求请求访问到了。

限定方法也可以有多个:

@Controller
@RequestMapping("/user")
public class HelloController{
    @RequestMapping(value="/hello",method={RequestMethod.GET,RequestMethod.POST,RequestMethod.PUT,RequestMethod.DELETE})
    public ModelAndView hello(){
        return new ModelAndView("hello");
    }
}

此时,这个接口就可以被GET,POST,PUT以及DELETE访问到了.但是由于jsp只支持GET,POST以及HEAD,所以这测试,不能使用jsp作为页面模板.可以将视图换成其他的,或者放回JSON,这里就不影响了.

1.2 Controller方法的返回值

1.2.1 返回ModelAndView

如果前后端不分的开发,大部分情况下,我们返回ModelAndView,即数据模型+视图:

@Controller
@RequestMapping("/user")
public class HelloController{
    @RequestMapping
    public ModelAndView hello(){
        ModelAndView mv = new ModelAndView("hello");
        mv.addObject("username","fushijie");
        return mv;
    }
}

Model中,放我们的数据,然后在ModelAndView中指定视图名称

1.2.2 返回void

没有返回值，并不一定真的没有返回值，只是方法的返回值为 void，我们可以通过其他方式给前端返回。实际上，这种方式也可以理解为 Servlet 中的那一套方案。

注意，由于默认的 Maven 项目没有 Servlet，因此这里需要额外添加一个依赖：

<dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>javax.servlet-api</artifactId>
    <version>4.0.1</version>
</dependency>

通过HttpServletRequest做服务端跳转

public void hello2(HttpServletRequest req,HttpServeltResponse resp) thorws ServletException,IOException{
	req.getRequestDispatcher("/jsp/hello.jsp").forward(req,resq);//服务端跳转
}

通过HttpServletResponse做重定向

@RequestMapping("/hello3")
public void hello3(HttpServletRequest req,HttpServeltResponse resp) throws IOException{
    resp.sendRedirect("/hello.jsp");
}

也可以自己手动指定响应头去实现重定向:

@RequestMapping("/hello3")
public void hello3(HttpServletRequest req,HttpServeltResponse resp) throws IOException{
 	resp.setStatus(302);
    resp.addHeader("Location","/jsp/hello.jsp");
}

通过HTTPServletResponse给出响应

@RequestMapping("/hello4")
public void hello3(HttpServletRequest req,HttpServeltResponse resp) throws IOException{
 	resp.setContextType("text/html;charset=utf-8");
 	PrintWriter out = resp.getWriter();
 	out.write("hello world");
 	out.flush();
 	out.close();
}

这种方式,既可以返回JSON,也可以返回普通字符串.

1.2.3 返回字符串

返回逻辑视图名

前面的 ModelAndView 可以拆分为两部分，Model 和 View，在 SpringMVC 中，Model 我们可以直接在参数中指定，然后返回值是逻辑视图名：

@RequestMapping("/hello5")
public String hello5(Model model){
    model.addAttribute("username","fushijie");//这是数据模型
    return "hello";//表示去查找一个名为hello的视图
}

服务端跳转

@RequestMapping("/hello5")
public String hello5(){
    return "forward:/jsp/hello.jsp";
}

forward后面跟上跳转的路径.

客户端跳转

@RequestMapping("/hello5")
public String hello5() {
    return "redirect:/user/hello";
}

本质上就是浏览器重定向.

返回一个字符串

上面三个返回的字符串，都是由特殊含义的，如果一定要返回一个字符串，需要额外添加一个注意：@ResponseBody ，这个注解表示当前方法的返回值就是要展示出来返回值，没有特殊含义。

@RequestMapping("/hello5")
@ResponseBody
public String hello5() {
    return "redirect:/user/hello";
}

上面代码表示就是想返回一段内容为 redirect:/user/hello 的字符串，他没有特殊含义。注意，这里如果单纯的返回一个中文字符串，是会乱码的，可以在 @RequestMapping 中添加 produces 属性来解决：

@RequestMapping(value = "/hello5",produces = "text/html;charset=utf-8")
@ResponseBody
public String hello5() {
    return "Java 语言程序设计";
}

1.3 参数绑定

1.3.1 默认支持的参数类型

默认支持的参数类型,就是可以直接写在@RequestMapping所注解的方法中的参数类型,一共有四类:

HttpServletRequest
HttpServletResponse
HttpSession
Model/ModelMap

在请求的方法中，默认的参数就是这几个，如果在方法中，刚好需要这几个参数，那么就可以把这几个参数加入到方法中。

1.3.2 简单参数类型

Integer,Boolean,Double等等简单数据类型也都是支持的.例如添加一本书:

首先,在/jsp目录下创建addbook.jsp作为图书添加页面:

<%--
  Created by IntelliJ IDEA.
  User: FU
  Date: 2022/10/7
  Time: 15:34
  To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>添加图书</title>
</head>
<body>
<form action="/doAdd" method="post">
    <table>
        <tr>
            <td>书名：</td>
            <td><input type="text" name="name"></td>
        </tr>
        <tr>
            <td>作者：</td>
            <td><input type="text" name="author"></td>
        </tr>
        <tr>
            <td>价格：</td>
            <td><input type="text" name="price"></td>
        </tr>
        <tr>
            <td>是否上架：</td>
            <td>
                <input type="radio" value="true" name="ispublic">是
                <input type="radio" value="false" name="ispublic">否
            </td>
        </tr>
        <tr>
            <td colspan="2">
                <input type="submit" value="添加">
            </td>
        </tr>
    </table>
</body>
</html>

创建控制器，控制器提供两个功能，一个是访问 jsp 页面，另一个是提供添加接口：

package com.fu.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
public class BookController {
    @RequestMapping("/books")
    public String addBook(){
        return "/jsp/addbook";
    }

    @RequestMapping(value = "/doAdd",method = RequestMethod.POST)
    @ResponseBody
    public void doAdd(String name,String author,Double price,Boolean ispublic){
        System.out.println(name);
        System.out.println(author);
        System.out.println(price);
        System.out.println(ispublic);
    }
}

最后，浏览器中输入 http://localhost:8080/books，就可以执行添加操作，服务端会打印出来相应的日志。

在上面的绑定中，有一个要求，表单中字段的 name 属性要和接口中的变量名一一对应，才能映射成功，否则服务端接收不到前端传来的数据。有一些特殊情况，我们的服务端的接口变量名可能和前端不一致，这个时候我们可以通过 @RequestParam 注解来解决。

@RequestParam

这个注解的功能主要有三个方面:

给变量取别名
设置变量是否必填
给变量设置默认值

如下:

  @RequestMapping(value = "/doAdd",method = RequestMethod.POST)
    @ResponseBody
    public void doAdd(@RequestParam("name") String name, String author, Double price, Boolean ispublic){
        System.out.println(name);
        System.out.println(author);
        System.out.println(price);
        System.out.println(ispublic);
    }

注解中的"name"表示给bookname这个变量取的别名,也就是说,bookname将接受前端传来的name这个变量的值.在这个注解中,还可以添加required属性和defaultValue属性,如下:

@RequestMapping(value = "/doAdd",method = RequestMethod.POST)
@ResponseBody
public void doAdd(@RequestParam(value = "name",required = true,defaultValue = "三国演义") String bookname, String author, Double price, Boolean ispublic) {
    System.out.println(bookname);
    System.out.println(author);
    System.out.println(price);
    System.out.println(ispublic);
}

required属性默认为true,即只要添加了@RequestParam注解,这个参数默认就是必填的,如果不填,请求无法提交,会报400错误,如果这个参数不是必填项,可以手动吧required属性设置为false.但是,如果同时设置了defaultValue,这个时候,前端不传该参数到后端,即使required属性为true,它也不会报错.

1.3.3 实体类

参数除了是简单数据类型之外,它也可以是实体类.实际上,在开发中,大部分情况下,都是实体类.

还是上面的例子,我们该用一个Book对象来接收前端传来的数据:

public class Book {
    private String name;
    private String author;
    private Double price;
    private Boolean ispublic;

    @Override
    public String toString() {
        return "Book{" +
                "name='" + name + '\'' +
                ", author='" + author + '\'' +
                ", price=" + price +
                ", ispublic=" + ispublic +
                '}';
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getAuthor() {
        return author;
    }

    public void setAuthor(String author) {
        this.author = author;
    }

    public Double getPrice() {
        return price;
    }

    public void setPrice(Double price) {
        this.price = price;
    }

    public Boolean getIspublic() {
        return ispublic;
    }

    public void setIspublic(Boolean ispublic) {
        this.ispublic = ispublic;
    }

服务端接收数据方式如下:

   @RequestMapping(value = "/doAdd",method = RequestMethod.POST)
    public void add(Book book){
        System.out.println(book);
    }

前端页面传值的时候和上面的一样,只需要写属性名就可以了,不需要写book对象名.

当然,对象中可能还有对象,例如如下对象:

public class Book {
    private String name;
    private Double price;
    private Boolean ispublic;
    private Author author;

    public void setAuthor(Author author) {
        this.author = author;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    @Override
    public String toString() {
        return "Book{" +
                "name='" + name + '\'' +
                ", price=" + price +
                ", ispublic=" + ispublic +
                ", author=" + author +
                '}';
    }

    public Double getPrice() {
        return price;
    }

    public void setPrice(Double price) {
        this.price = price;
    }

    public Boolean getIspublic() {
        return ispublic;
    }

    public void setIspublic(Boolean ispublic) {
        this.ispublic = ispublic;
    }
}
public class Author {
    private String name;
    private Integer age;

    @Override
    public String toString() {
        return "Author{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

Book 对象中，有一个 Author 属性，如何给 Author 属性传值呢？前端写法如下：

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
<form action="/doAdd" method="post">
    <table>
        <tr>
            <td>书名：</td>
            <td><input type="text" name="name"></td>
        </tr>
        <tr>
            <td>作者姓名：</td>
            <td><input type="text" name="author.name"></td>
        </tr>
        <tr>
            <td>作者年龄：</td>
            <td><input type="text" name="author.age"></td>
        </tr>
        <tr>
            <td>价格：</td>
            <td><input type="text" name="price"></td>
        </tr>
        <tr>
            <td>是否上架：</td>
            <td>
                <input type="radio" value="true" name="ispublic">是
                <input type="radio" value="false" name="ispublic">否
            </td>
        </tr>
        <tr>
           <td colspan="2">
               <input type="submit" value="添加">
           </td>
        </tr>
    </table>
</form>
</body>
</html>

这样在后端直接用 Book 对象就可以接收到所有数据了。

1.3.4 自定义参数绑定

前面的转换,都是系统自动转换的,这种转换仅限于基本数据类型.特殊的数据类型,系统无法自动转换,例如日期.例如前端传一个日期到后端,后端不是用字符串接收,而是使用一个Date对象接收,这个时候就会出现参数类型转换失败.这个时候,需要我们手动定义参数类型转换器,将日期字符串手动转换为一个Date对象.

@Component
public class DateConverter implements Converter<String, Date> {
    SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd");
    @Override
    public Date convert(String s) {
        try {
            return sdf.parse(s);
        } catch (ParseException e) {
            e.printStackTrace();
        }
        return null;
    }

在自定义的参数类型转换器中，将一个 String 转为 Date 对象，同时，将这个转换器注册为一个 Bean。

接下来，在 SpringMVC 的配置文件中，配置该 Bean，使之生效。

    <mvc:annotation-driven conversion-service="conversionService"/>
    <bean class="org.springframework.format.support.FormattingConversionServiceFactoryBean" id="conversionService">
        <property name="converters">
            <set>
                <ref bean="dateConverter"/>
            </set>
        </property>
    </bean>

配置完成后，在服务端就可以接收前端传来的日期参数了。

1.3.5 集合类的参数

String 数组

String 数组可以直接用数组去接收，前端传递的时候，数组的传递其实就多相同的 key，这种一般用在 checkbox 中较多。

例如前端增加兴趣爱好一项：

<form action="/doAdd" method="post">
    <table>
        <tr>
            <td>书名：</td>
            <td><input type="text" name="name"></td>
        </tr>
        <tr>
            <td>作者姓名：</td>
            <td><input type="text" name="author.name"></td>
        </tr>
        <tr>
            <td>作者年龄：</td>
            <td><input type="text" name="author.age"></td>
        </tr>
        <tr>
            <td>出生日期：</td>
            <td><input type="date" name="author.birthday"></td>
        </tr>
        <tr>
            <td>兴趣爱好：</td>
            <td>
                <input type="checkbox" name="favorites" value="足球">足球
                <input type="checkbox" name="favorites" value="篮球">篮球
                <input type="checkbox" name="favorites" value="乒乓球">乒乓球
            </td>
        </tr>
        <tr>
            <td>价格：</td>
            <td><input type="text" name="price"></td>
        </tr>
        <tr>
            <td>是否上架：</td>
            <td>
                <input type="radio" value="true" name="ispublic">是
                <input type="radio" value="false" name="ispublic">否
            </td>
        </tr>
        <tr>
           <td colspan="2">
               <input type="submit" value="添加">
           </td>
        </tr>
    </table>
</form>

在服务端用一个数组去接收 favorites 对象：

@RequestMapping(value = "/doAdd",method = RequestMethod.POST)
@ResponseBody
public void doAdd(Book book,String[] favorites) {
    System.out.println(Arrays.toString(favorites));
    System.out.println(book);
}

注意，前端传来的数组对象，服务端不可以使用 List 集合去接收。

List 集合

如果需要使用 List 集合接收前端传来的数据，List 集合本身需要放在一个封装对象中，这个时候，List 中，可以是基本数据类型，也可以是对象。例如有一个班级类，班级里边有学生，学生有多个：

public class MyClass {
    private Integer id;
    private List<Student> students;

    @Override
    public String toString() {
        return "MyClass{" +
                "id=" + id +
                ", students=" + students +
                '}';
    }

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public List<Student> getStudents() {
        return students;
    }

    public void setStudents(List<Student> students) {
        this.students = students;
    }
}
public class Student {
    private Integer id;
    private String name;

    @Override
    public String toString() {
        return "Student{" +
                "id=" + id +
                ", name='" + name + '\'' +
                '}';
    }

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

添加班级的时候，可以传递多个 Student，前端页面写法如下：

<form action="/addclass" method="post">
    <table>
        <tr>
            <td>班级编号：</td>
            <td><input type="text" name="id"></td>
        </tr>
        <tr>
            <td>学生编号：</td>
            <td><input type="text" name="students[0].id"></td>
        </tr>
        <tr>
            <td>学生姓名：</td>
            <td><input type="text" name="students[0].name"></td>
        </tr>
        <tr>
            <td>学生编号：</td>
            <td><input type="text" name="students[1].id"></td>
        </tr>
        <tr>
            <td>学生姓名：</td>
            <td><input type="text" name="students[1].name"></td>
        </tr>
        <tr>
            <td colspan="2">
                <input type="submit" value="提交">
            </td>
        </tr>
    </table>
</form>

服务端直接接收数据即可：

@RequestMapping("/addclass")
@ResponseBody
public void addClass(MyClass myClass) {
    System.out.println(myClass);
}

相对于实体类而言，Map 是一种比较灵活的方案，但是，Map 可维护性比较差，因此一般不推荐使用。

例如给上面的班级类添加其他属性信息：

public class MyClass {
    private Integer id;
    private List<Student> students;
    private Map<String, Object> info;

    @Override
    public String toString() {
        return "MyClass{" +
                "id=" + id +
                ", students=" + students +
                ", info=" + info +
                '}';
    }

    public Map<String, Object> getInfo() {
        return info;
    }

    public void setInfo(Map<String, Object> info) {
        this.info = info;
    }

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public List<Student> getStudents() {
        return students;
    }

    public void setStudents(List<Student> students) {
        this.students = students;
    }
}

在前端，通过如下方式给 info 这个 Map 赋值。

<form action="/addclass" method="post">
    <table>
        <tr>
            <td>班级编号：</td>
            <td><input type="text" name="id"></td>
        </tr>
        <tr>
            <td>班级名称：</td>
            <td><input type="text" name="info['name']"></td>
        </tr>
        <tr>
            <td>班级位置：</td>
            <td><input type="text" name="info['pos']"></td>
        </tr>
        <tr>
            <td>学生编号：</td>
            <td><input type="text" name="students[0].id"></td>
        </tr>
        <tr>
            <td>学生姓名：</td>
            <td><input type="text" name="students[0].name"></td>
        </tr>
        <tr>
            <td>学生编号：</td>
            <td><input type="text" name="students[1].id"></td>
        </tr>
        <tr>
            <td>学生姓名：</td>
            <td><input type="text" name="students[1].name"></td>
        </tr>
        <tr>
            <td colspan="2">
                <input type="submit" value="提交">
            </td>
        </tr>
    </table>