SpringMVC（三）请求参数的绑定

迷南。 2021-06-22 15:37 471阅读 0赞

### 目录 ###

*  请求参数的绑定
 *   *  一、绑定的机制
     *  二、支持的数据类型
     *  三、使用要求
     *  四、使用示例
     *   *  1. 基本类型和String类型作为基本参数
         *  2. 实体类类型作为参数
         *  3. 实体类中包含实体类
         *  4. 集合类型封装
     *  五、自定义类型转换器
     *   *  1. 使用场景
         *  2. 使用步骤
         *   *  ① 定义一个类
             *  ② 配置自定义转换器
     *  六、使用ServletAPI对象作为方法参数

![在这里插入图片描述][20200609220407779.png]

# 请求参数的绑定 #

## 一、绑定的机制 ##

我们都知道道，表单中请求参数都是基于 `key=value` 的。  
SpringMVC 绑定请求参数的过程是通过把表单提交请求参数，作为控制器中方法参数进行绑定的。

**例如：**  
请求的超链接：

上面的代码中请求的参数是accountID=10。  
后台代码：

/** * 查询账户 * @return */  
    @RequestMapping("/findAccount")  
    public String findAccount(Integer accountId) { 
    	System.out.println("查询了账户。。。。"+accountId); 
    	return "success";  
    }

只要我们的方法中的参数和请求参数一致，就会自动绑定。

## 二、支持的数据类型 ##

**基本类型参数：** 包括基本类型和 String 类型  
**POJO 类型参数：** 包括实体类，以及关联的实体类  
**数组和集合类型参数：** 包括 List 结构和 Map 结构的集合（包括数组）

SpringMVC 绑定请求参数是自动实现的，但是要想使用，必须遵循使用要求。

## 三、使用要求 ##

1.  **如果是基本类型或者 String类型：**  
    要求我们的参数名称必须和控制器中方法的形参名称保持一致。(严格区分大小写)
2.  **如果是 POJO类型，或者它的关联对象：**  
    要求表单中参数名称和 POJO 类的属性名称保持一致。并且控制器方法的参数类型是 POJO 类型。
3.  **如果是集合类型,有两种方式：**  
    第一种：  
    ① 要求集合类型的请求参数必须在 POJO 中。在表单中请求参数名称要和 POJO 中集合属性名称相同。  
    ② 给 List 集合中的元素赋值，使用下标。  
    ③ 给 Map 集合中的元素赋值，使用键值对。  
    第二种：  
    接收的请求参数是 json 格式数据。需要借助一个注解实现。

**注意：**  
它可以实现一些数据类型的自动转换。内置转换器全都在`org.springframework.core.convert.support` 包下。  
有：

java.lang.Boolean -> java.lang.String : ObjectToStringConverter
    java.lang.Character -> java.lang.Number : CharacterToNumberFactory 
    java.lang.Character -> java.lang.String : ObjectToStringConverter 
    java.lang.Enum -> java.lang.String : EnumToStringConverter 
    java.lang.Number -> java.lang.Character : NumberToCharacterConverter 
    java.lang.Number -> java.lang.Number : NumberToNumberConverterFactory 
    java.lang.Number -> java.lang.String : ObjectToStringConverter 
    java.lang.String -> java.lang.Boolean : StringToBooleanConverter 
    java.lang.String -> java.lang.Character : StringToCharacterConverter 
    java.lang.String -> java.lang.Enum : StringToEnumConverterFactory 
    java.lang.String -> java.lang.Number : StringToNumberConverterFactory 
    java.lang.String -> java.util.Locale : StringToLocaleConverter 
    java.lang.String -> java.util.Properties : StringToPropertiesConverter 
    java.lang.String -> java.util.UUID : StringToUUIDConverter 
    java.util.Locale -> java.lang.String : ObjectToStringConverter 
    java.util.Properties -> java.lang.String : PropertiesToStringConverter 
    java.util.UUID -> java.lang.String : ObjectToStringConverter 
    ......

**如遇特殊类型转换要求，需要我们自己编写自定义类型转换器。**

## 四、使用示例 ##

### 1. 基本类型和String类型作为基本参数 ###

**jsp代码：**

<html>
        <head>
            <title>请求参数的绑定</title>
        </head>
        <body>
            <a href="param/testParam?username=veeja&userId=10001">请求参数的绑定</a>
        </body>
    </html>

**控制器代码：**

/** * 请求参数绑定的入门 * * @return */
    @RequestMapping("/testParam")
    public String testParam(String username, int userId) { 
        System.out.println("执行了！");
        System.out.println("username=" + username);
        System.out.println("userId=" + userId);
        return "success";
    }

**控制台输出：**  
![在这里插入图片描述][20200613223805631.png]

### 2. 实体类类型作为参数 ###

**实体类对象代码：**

package com.veeja.domain;
    
    import java.io.Serializable;
    
    /** * @Author veeja * 2020/6/14 14:48 */
    public class Account implements Serializable { 
        private String username;
        private String password;
        private double money;
    
        public String getUsername() { 
            return username;
        }
    
        public void setUsername(String username) { 
            this.username = username;
        }
    
        public String getPassword() { 
            return password;
        }
    
        public void setPassword(String password) { 
            this.password = password;
        }
    
        public double getMoney() { 
            return money;
        }
    
        public void setMoney(double money) { 
            this.money = money;
        }
    
        @Override
        public String toString() { 
            return "Account{" +
                    "username='" + username + '\'' +
                    ", password='" + password + '\'' +
                    ", money=" + money +
                    '}';
        }
    }

**JSP代码：**

**控制器代码：**

/** * 请求参数的绑定，把数据封装到JavaBean的类中 * * @return */
    @RequestMapping("/saveAccount")
    public String saveAccount(Account account) { 
        System.out.println("savaAccount()...");
        System.out.println(account);
        return "success";
    }

**后台输出：**  
![在这里插入图片描述][20200614151843712.png]

### 3. 实体类中包含实体类 ###

例如上面的Account如果包含了一个User类：  
**Account实体类代码：**

package com.veeja.domain;
    
    import java.io.Serializable;
    
    /** * @Author veeja * 2020/6/14 14:48 */
    public class Account implements Serializable { 
        private String username;
        private String password;
        private double money;
    
        private User user;
    
        public User getUser() { 
            return user;
        }
    
        public void setUser(User user) { 
            this.user = user;
        }
    
        public String getUsername() { 
            return username;
        }
    
        public void setUsername(String username) { 
            this.username = username;
        }
    
        public String getPassword() { 
            return password;
        }
    
        public void setPassword(String password) { 
            this.password = password;
        }
    
        public double getMoney() { 
            return money;
        }
    
        public void setMoney(double money) { 
            this.money = money;
        }
    
        @Override
        public String toString() { 
            return "Account{" +
                    "username='" + username + '\'' +
                    ", password='" + password + '\'' +
                    ", money=" + money +
                    ", user=" + user +
                    '}';
        }
    }

**User实体类代码：**

package com.veeja.domain;
    
    import java.io.Serializable;
    
    /** * @Author veeja * 2020/6/14 15:20 */
    public class User implements Serializable { 
    
        private String uName;
        private Integer age;
    
        public String getuName() { 
            return uName;
        }
    
        public void setuName(String uName) { 
            this.uName = uName;
        }
    
        public Integer getAge() { 
            return age;
        }
    
        public void setAge(Integer age) { 
            this.age = age;
        }
    
        @Override
        public String toString() { 
            return "User{" +
                    "uName='" + uName + '\'' +
                    ", age=" + age +
                    '}';
        }
    }

**JSP页面代码：**

<form action="param/saveAccount" method="post">
        姓名：<input type="text" name="username"/><br>
        密码：<input type="password" name="password"/><br>
        金额：<input type="text" name="money"/><br>
        uName:<input type="text" name="user.uName"/><br>
        money:<input type="text" name="user.age"/><br>
        <input type="submit" value="提交"/><br>
    </form>

**输出：**  
![在这里插入图片描述][20200614203108373.png]  
上面的代码有一个问题就是在输入中文的时候就会出现乱码，这个问题我们可以通过配置一个过滤器来解决问题：  
**web.xml中添加过滤器配置信息：**

<filter>
        <filter-name>characterEncodingFilter</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        <init-param>
            <param-name>encoding</param-name>
            <param-value>UTF-8</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>characterEncodingFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

### 4. 集合类型封装 ###

**Account实体类代码：**

package com.veeja.domain;
    
    import java.io.Serializable;
    import java.util.List;
    import java.util.Map;
    
    /** * @Author veeja * 2020/6/14 14:48 */
    public class Account implements Serializable { 
        private String username;
        private String password;
        private double money;
    
        private List<User> list;
        private Map<String, User> map;
    
        public String getUsername() { 
            return username;
        }
    
        public void setUsername(String username) { 
            this.username = username;
        }
    
        public String getPassword() { 
            return password;
        }
    
        public void setPassword(String password) { 
            this.password = password;
        }
    
        public double getMoney() { 
            return money;
        }
    
        public void setMoney(double money) { 
            this.money = money;
        }
    
        public List<User> getList() { 
            return list;
        }
    
        public void setList(List<User> list) { 
            this.list = list;
        }
    
        public Map<String, User> getMap() { 
            return map;
        }
    
        public void setMap(Map<String, User> map) { 
            this.map = map;
        }
    
        @Override
        public String toString() { 
            return "Account{" +
                    "username='" + username + '\'' +
                    ", password='" + password + '\'' +
                    ", money=" + money +
                    ", list=" + list +
                    ", map=" + map +
                    '}';
        }
    }

**jsp代码：**

<h1>类中存在集合类型</h1>
    <form action="param/saveAccount" method="post">
        姓名：<input type="text" name="username"/><br>
        密码：<input type="password" name="password"/><br>
        金额：<input type="text" name="money"/><br>
    
        uName:<input type="text" name="list[0].uName"/><br>
        money:<input type="text" name="list[0].age"/><br>
    
        uName:<input type="text" name="map['one'].uName"/><br>
        money:<input type="text" name="map['one'].age"/><br>
    
        <input type="submit" value="提交"/><br>
    </form>

**输出结果：**  
![在这里插入图片描述][20200614205239452.png]

## 五、自定义类型转换器 ##

### 1. 使用场景 ###

我们来做一个演示：

**User实体类代码：**

public class User implements Serializable { 
    
        private String uName;
        private Date date;
    
        public String getuName() { 
            return uName;
        }
    
        public void setuName(String uName) { 
            this.uName = uName;
        }
    
        public Date getDate() { 
            return date;
        }
    
        public void setDate(Date date) { 
            this.date = date;
        }
    
        @Override
        public String toString() { 
            return "User{" +
                    "uName='" + uName + '\'' +
                    ", date=" + date +
                    '}';
        }
    }

**jsp页面代码：**

**控制器代码：**

/** * 请求参数的绑定，把数据封装到JavaBean的类中 * * @return */
    @RequestMapping("/saveUser")
    public String saveUser(User user) { 
        System.out.println("savaUser()...");
        System.out.println(user);
        return "success";
    }

**我们在网页中输入信息：**  
![在这里插入图片描述][20200614211635742.png]  
**后台显示：**  
![在这里插入图片描述][20200614211703549.png]  
**我们在网页中输入信息：**  
![在这里插入图片描述][20200614211513897.png]  
**结果网页报错了：**  
![在这里插入图片描述][2020061421154574.png]  
也就是数据在类型自动转换的时候遇到了问题，所以这个时候我们就需要自定义类型转换器来帮助我们正确的转换数据类型。

### 2. 使用步骤 ###

#### ① 定义一个类 ####

首先我们先定义一个类，实现Converter接口，改该接口有两个泛型。

**Converter接口：**

public interface Converter<S, T> { 
        @Nullable
        T convert(S var1);
    }

其中S表示接受的类型，T表示目标类型。

**自定义类型转换器：**

/** * 字符串转换成日期 * * @Author veeja * 2020/6/14 22:06 */
    public class StringToDateConverter implements Converter<String, Date> { 
    
        /** * @param s 传进来的字符串 * @return */
        @Override
        public Date convert(String s) { 
            // 判断
            if (s == null) { 
                throw new RuntimeException("请您传入参数数据！");
            }
            DateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");
            try { 
                // 把字符串转换成日期
                return dateFormat.parse(s);
            } catch (ParseException e) { 
                throw new RuntimeException("数据类型转换错误！");
            }
        }
    }

#### ② 配置自定义转换器 ####

**springmvc.xml：**

<bean id="conversionService" class="org.springframework.context.support.ConversionServiceFactoryBean">
        <property name="converters">
            <set>
                <bean class="com.veeja.utils.StringToDateConverter"></bean>
            </set>
        </property>
    </bean>
    
    
    <mvc:annotation-driven conversion-service="conversionService"/>

这样就可以了。  
**我们再试一下：**  
![在这里插入图片描述][20200615093626405.png]  
**结果：**  
![在这里插入图片描述][20200615093719836.png]

## 六、使用ServletAPI对象作为方法参数 ##

**SpringMVC 还支持使用原始 ServletAPI 对象作为控制器方法的参数。支持原始 ServletAPI 对象有：**  
`HttpServletRequest`  
`HttpServletResponse`  
`HttpSession`  
`java.security.Principal`  
`Locale`  
`InputStream`  
`OutputStream`  
`Reader`  
`Writer`  
**我们可以把上述对象，直接写在控制的方法参数中使用。**

**jsp页面代码：**

<hr>
    <h1>原生的ServletAPI</h1>
    <a href="param/testServletAPI">获取Servlet原生API作为参数</a>

**控制器代码：**

/** * 测试原生的API * * @return */
    @RequestMapping("/testServletAPI")
    public String testServletAPI(HttpServletRequest request, HttpServletResponse response) { 
        System.out.println("testServletAPI()...");
        System.out.println(request);
        System.out.println(response);
        
        HttpSession session = request.getSession();
        System.out.println(session);
        
        ServletContext servletContext = session.getServletContext();
        System.out.println(servletContext);
        
        return "success";
    }

**输出结果：**  
![在这里插入图片描述][20200615165104878.png]  
![在这里插入图片描述][2020061516531294.png]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ1NjUxMjc_size_16_color_FFFFFF_t_70]

[20200609220407779.png]: /images/20210615/0bb2427ba1e346bca3daa01ea9efdc84.png
[20200613223805631.png]: /images/20210615/a8a66dc6cad945e49f7224b4c6fecb47.png
[20200614151843712.png]: /images/20210615/3f19dd2eaf6741bf8646c2b5232d7b42.png
[20200614203108373.png]: /images/20210615/8b03b083fab3444ebde1e8fc56ecf720.png
[20200614205239452.png]: /images/20210615/92ba95374a914e3783f6eca3ffa8ed31.png
[20200614211635742.png]: /images/20210615/3a2e80da2d30466a88e68e5386206d86.png
[20200614211703549.png]: /images/20210615/b67918a89e9645c2afc31f1626470ea7.png
[20200614211513897.png]: /images/20210615/a9087e29e7af453e946f5b5007d82125.png
[2020061421154574.png]: /images/20210615/2077e6c36ba4442fa2c81a3af76abd9f.png
[20200615093626405.png]: /images/20210615/520fa999997e4cb1a315b1e976a3011a.png
[20200615093719836.png]: /images/20210615/6f5c40f2bf354a71bdd0bbafda9c14e4.png
[20200615165104878.png]: /images/20210615/217ff0ba992e42608079a07a10632cab.png
[2020061516531294.png]: /images/20210615/b8abc354f92c427da12f967ccd72e1e1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTQ1NjUxMjc_size_16_color_FFFFFF_t_70]: /images/20210615/8f55d28dd6d2469ca2671c59703c986a.png