SpringMVC 获取请求参数

test638
1,698 阅读6分钟

开启掘金成长之旅！这是我参与「掘金日新计划 · 12 月更文挑战」的第26天，点击查看活动详情

获取路径参数

RestFul风格的接口一些参数是在请求路径上的。类似： /user/1 这里的1就是id。

如果我们想获取这种格式的数据可以使用 @PathVariable来实现。

范例一

要求定义个RestFul风格的接口，该接口可以用来根据id查询用户。请求路径要求为 /user ，请求方式要求为GET。

而请求参数id要写在请求路径上，例如 /user/1 这里的1就是id。

我们可以定义如下方法，通过如下方式来获取路径参数：

@Controller
public class UserController {
​
    @RequestMapping(value = "/user/{id}",method = RequestMethod.GET)
    加上@PathVariable("id")注解，和@RequestMapping(value = "/user/{id}"里面的id对应
    public String findUserById( @PathVariable("id")Integer id){
        System.out.println("findUserById");
        System.out.println(id);
        return "/success.jsp";
    }
}

范例二

如果这个接口，想根据id和username查询用户。请求路径要求为 /user ，请求方式要求为GET。

而请求参数id和name要写在请求路径上，例如 /user/1/zs 这里的1就是id，zs是name

我们可以定义如下方法，通过如下方式来获取路径参数：

@Controller
public class UserController {
    @RequestMapping(value = "/user/{id}/{name}",method = RequestMethod.GET)
    public String findUser(@PathVariable("id") Integer id,@PathVariable("name") String name){
        System.out.println("findUser");
        System.out.println(id);
        System.out.println(name);
        return "/success.jsp";
    }
}
​

获取请求体中的Json格式参数

RestFul风格的接口一些比较复杂的参数会转换成Json通过请求体传递过来。这种时候我们可以使用 @RequestBody注解获取请求体中的数据。

配置

SpringMVC可以帮我们把json数据转换成我们需要的类型。但是需要进行一些基本配置。SpringMVC默认会使用jackson来进行json的解析。所以我们需要导入jackson的依赖。

        <!-- jackson，帮助进行json转换-->
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>2.9.0</version>
        </dependency>

然后还要配置注解驱动

    <mvc:annotation-driven>
    </mvc:annotation-driven>

使用

范例一

要求定义个RestFul风格的接口，该接口可以用来新建用户。请求路径要求为 /user ，请求方式要求为POST。

用户数据会转换成json通过请求体传递。 ​ 请求体数据

{"name":"三更","age":15}
1.获取参数封装成实体对象

如果我们想把Json数据获取出来封装User对象,我们可以这样定义方法：

@Controller
public class UserController {
    @RequestMapping(value = "/user",method = RequestMethod.POST)
    public String insertUser(@RequestBody User user){
        System.out.println("insertUser");
        System.out.println(user);
        return "/success.jsp";
    }
}

User实体类如下：

@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
    private Integer id;
    private String name;
    private Integer age;
}
​
2.获取参数封装成Map集合

也可以把该数据获取出来封装成Map集合：

    @RequestMapping(value = "/user",method = RequestMethod.POST)
    public String insertUser(@RequestBody Map map){
        System.out.println("insertUser");
        System.out.println(map);
        return "/success.jsp";
    }
范例二

如果请求体传递过来的数据是一个User集合转换成的json，Json数据可以这样定义：

[{"name":"三更1","age":14},{"name":"三更2","age":15},{"name":"三更3","age":16}]

方法定义：

    @RequestMapping(value = "/users",method = RequestMethod.POST)
    public String insertUsers(@RequestBody List<User> users){
        System.out.println("insertUsers");
        System.out.println(users);
        return "/success.jsp";
    }

注意事项

如果需要使用 @RequestBody来获取请求体中Json并且进行转换，要求请求头 Content-Type 的值要为： application/json 。

获取QueryString格式参数

如果接口的参数是使用QueryString的格式的话，我们也可以使用SpringMVC快速获取参数。

我们可以使用 @RequestParam来获取QueryString格式的参数。

@RequestParam

@RequestParam是将请求参数和控制器方法的形参创建映射关系

一共有三个属性：

  • value：指定为形参赋值的请求参数的参数名
  • required：设置是否必须传输此请求参数，默认值为true
    • 若设置为true，则当前请求必须传输value所指定的请求参数，若没有传输该请求参数，且没有设置defaultValue属性，则页面报错400：Required String parameter'xxx'is not present；
    • 若设置为false，则当前请求不是必须传输value所指定的请求参数，若没有传输，则注解所标识的形参的值为null

  • defaultValue：不管required属性值为true或false，当value所指定的请求参数没有传输或传输的值为空值时，则使用默认值为形参赋值

使用

范例一

要求定义个接口，该接口请求路径要求为 /testRequestParam，请求方式无要求。参数为id和name和likes。使用QueryString的格式传递。

1.参数单独的获取

如果我们想把id，name，likes单独获取出来可以使用如下写法：

在方法中定义方法参数，方法参数名要和请求参数名一致，这种情况下我们可以省略 @RequestParam注解。

    @RequestMapping("/testRquestParam")
    public String testRquestParam(Integer id, String name, String[] likes){
        System.out.println("testRquestParam");
        System.out.println(id);
        System.out.println(name);
        System.out.println(Arrays.toString(likes));
        return "/success.jsp";
    }

如果方法参数名和请求参数名不一致，我们可以加上 @RequestParam注解例如：

    @RequestMapping("/testRquestParam")
    public String testRquestParam(@RequestParam("id") Integer uid,@RequestParam("name") String name, @RequestParam("likes")String[] likes){
        System.out.println("testRquestParam");
        System.out.println(uid);
        System.out.println(name);
        System.out.println(Arrays.toString(likes));
        return "/success.jsp";
    }
2.获取参数封装成实体对象

如果我们想把这些参数封装到一个User对象中可以使用如下写法：

    @RequestMapping("/testRquestParam")
    public String testRquestParam(User user){
        System.out.println("testRquestParam");
        System.out.println(user);
        return "/success.jsp";
    }

User类定义如下：

@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
    private Integer id;
    private String name;
    private Integer age;
    private String[] likes;
}

测试时请求url如下：

http://localhost:81/testRquestParam?id=1&name=三更草堂&likes=编程&likes=录课&likes=烫头

注意：实体类中的成员变量要和请求参数名对应上。并且要提供对应的set/get方法。

required属性

代表是否必须，默认值为true也就是必须要有对应的参数。如果没有就会报错。

如果对应的参数可传可不传则可以把去设置为fasle

required默认为true，即要求该请求参数不能为空。因为是默认值，所以添加required="true"与不写required属性是一样的

默认情况下不传对应请求参数时系统的反应是啥样子，只需要在浏览器地址栏删除该请求参数，可以尝试一下

image.png

报错信息：400错误的请求，必须的请求参数'user_name'...不存在

经测试，不论是为 username 传空值还是不传值，都是400错误

如果将required设置为false

例如：

    @RequestMapping("/testRquestParam")
    public String testRquestParam(@RequestParam(value = "id",required = false) Integer uid,@RequestParam("name") String name, @RequestParam("likes")String[] likes){
        System.out.println("testRquestParam");
        System.out.println(uid);
        System.out.println(name);
        System.out.println(Arrays.toString(likes));
        return "/success.jsp";
    }

不会出现400错误

Q：不是说默认是true吗？为什么在没有使用@RequestParam注解时，也能正常访问呢？

A：这个默认值本身就是在使用@RequestParam注解时生效的，如果都没有使用到@RequestParam，就没有相应限制了

defaultValue属性

如果对应的参数没有，我们可以用defaultValue属性设置默认值。

例如：

    @RequestMapping("/testRquestParam")
    public String testRquestParam(@RequestParam(value = "id",required = false,defaultValue = "777") Integer uid,@RequestParam("name") String name, @RequestParam("likes")String[] likes){
        System.out.println("testRquestParam");
        System.out.println(uid);
        System.out.println(name);
        System.out.println(Arrays.toString(likes));
        return "/success.jsp";
    }

@RequestHeader

@RequestHeader是将请求头信息和控制器方法的形参创建映射关系

一共有三个属性：value、required、defaultValue，用法同@RequestParam一样

因为@RequestHeader与@RequestParam别无二致，所以参考上面的@RequestParam

总结

SpringMVC 获取请求参数的注解：@RequestParam、@RequestHeader、

  • 都是作用在控制器方法上的形参的（就是获取请求参数的）
  • 都有三个属性：value/name、required、defaultValue
  • 主要解决形参和请求参数名不同名的问题，其次是必填问题，最后是缺省值的问题

如果请求参数与控制器方法形参同名，就可以不用上述的@RequestParam注解

如果请求参数有多个值，通过字符串类型或字符数组类型都可以获取

如果请求参数与控制器方法形参对象属性同名，同理。即满足同名条件时，SpringMVC 中允许通过实体类接收请求参数

avatar
文章
阅读
粉丝