处理器是对控制器(Controller)的包装,在处理运行过程中会调度控制器的方法,只是它进入控制器方法之前会对HTTP的参数进行解析,将他们转换为控制器所需的参数。那么控制器获取HTTP请求参数有几种方式呢?我们来总结一下。
1.无注解下获取参数
在没有注解的情况下,Spring MVC可以获取参数,且参数允许为空,唯一的要求是参数名称和HTTP请求参数保持一致,代码清单如下:
@Controller
@RequestMapping("/my")
public class MyController {
/**
* 在无注解下获取参数,要求参数名称和HTTP请求参数名称一致
* @param intVal 整数
* @param longVal 长整型
* @param str 字符串
* @return 响应JSON参数
*/
@GetMapping("/no/annotation")
@ResponseBody
public Map<String, Object> noAnnotation(Integer intVal, Long longVal, String str) {
Map<String, Object> paramMap = new HashMap<>();
paramMap.put("intVal", intVal);
paramMap.put("longVal", longVal);
paramMap.put("str", str);
return paramMap;
}
}
启动Spring Boot应用后,在浏览器中请求URL: http://localhost:8080/my/no/annotation?intVal=10&longVal=100
从代码中可以看出控制器方法参数中还有一个字符串参数str,但因为参数在默认情况下的规则可以为空,多以这个请求并不会报错,因为方法标注了@ResponseBody,所以控制器返回的结果会转化为JSON数据集。
2.使用@RequestParam获取参数
在无需注解的情况下,就要求HTTP参数和控制器方法名称保持一致。然而在前后来分离的趋势下,前端的命名规则可能与后端规则不同,这时需要把前端的参数与后端对应起来。Spring MVC提供了@RequestParam来确定前后端的参数名称的映射关系,代码清单如下:
@Controller
@RequestMapping("/my")
public class MyController {
/**
* @param intVal 整数
* @param longVal 长整型
* @param strVal 字符串
* @return 响应JSON参数
*/
@GetMapping("/annotation")
@ResponseBody
public Map<String, Object> requestParam(
@RequestParam("int_val") Integer intVal,
@RequestParam("long_val") Long longVal,
@RequestParam("str_val") String strVal) {
Map<String, Object> paramMap = new HashMap<>();
paramMap.put("intVal", intVal);
paramMap.put("longVal", longVal);
paramMap.put("str", strVal);
return paramMap;
}
}
在方法参数处使用了@RequestParam,其目的是指定HTTP参数和方法参数的映射关系,这样处理器就会按照其配置的映射关系来得到参数,然后调用控制器的方法。启动Spring Boot应用后,在浏览器地址栏中输入:http://localhost:8080/my/annotation?int_val=10&long_val=100&str_val=str,就能看到请求的结果了。但是如果把三个HTTP参数中的任意一个去掉,就会得到异常信息,因为默认的情况下@RequestParam标注的参数是不能为空的,为了让他能够为空,可以配置其属性required为fasle,例如字符串参数修改为:
@RequestParam(value = "str_val", required = false) String strVal
3.传递数组
在Spring MVC中,除了可以像上面那样传递一些简单的值外,还可以传递数组。Spring MVC内部已经能够支持用逗号分隔的数组参数,代码清单如下:
@Controller
@RequestMapping("/my")
public class MyController {
@GetMapping("/array")
@ResponseBody
public Map<String, Object> array(Integer[] intVal, Long[] longVal, String[] strVal) {
Map<String, Object> paramMap = new HashMap<>();
paramMap.put("intVal", intVal);
paramMap.put("longVal", longVal);
paramMap.put("str", strVal);
return paramMap;
}
}
方法里定义了采用数组,那么前端就需要依照一定规则传递给这个方法,例如,输入http://localhost:8080/my/array?intVal=1,2,3&longVal=4,5,6&strVal=str1,str2,str3,可以看到需要传递数组参数时,每个参数的数组元素只需要通过逗号分隔即可。
4.传递JSON
在当前前后端分离的趋势下,使用JSON已经十分普遍了。对于前端的页面或者手机应用,可以通过请求后端获取JSON数据集,这样他们就能很方便地将数据渲染到试图中。有时前端也需要提交较为复杂的数据到后端,为了更好组织和提高代码的可读性,可以将数据装维JSON数据集,通过HTTP请求体提交给后端,对此Spring MVC也提供了良好的支持。代码清单如下:
@Controller
@RequestMapping("/user")
public class UserController {
@Autowired
private UserService userService;
/**
* 新增用户
*
* @param User
*/
@PostMapping(value = "/insert")
@ResponsetBody
public User insert(@RequestBody User User) {
userService.save(user);
return user;
}
}
这个方法的参数标注为@RequestBody,意味着它将接受前端提交的JSON请求体,而JSON请求体与 User类之间的属性名称是保持一致的,这样Spring MVC就会通过这层映射关系将JSON请求体转换为User对象了。
5.通过URL传递参数
在一些网站中,提供了REST风格,这时参数往往通过URL进行传递。例如获取编号为1的用户,就要写成/user/1,这里1代表的是用户标号(id)。Spring MVC对此也提供了良好的支持,可以通过处理器映射和注解@PathVariable的组和获取URL参数。首先通过处理器映射可以定位参数位置和名称,而@PathVariable则可以通过名称开获取参数。代码清单如下:
@Controller
@RequestMapping("/user")
public class UserController {
@Autowired
private UserService userService;
/**
* 通过Id查询用户
*/
@GetMapping("/{id}")
@ResponsetBody
public User query(@PathVariable("id") Long id) {
return userService.getById(id);
}
}
首先通过@GetMapping指定一个URL,然后用{}来标明参数的位置和名称。这里指定名称为id,这样Spring MVC就能根据请求来匹配这个方法了。@PathVariable配置字符串为id,它对应URL的参数声明,这样Spring MVC就知道如何从URL中获取参数了。请求http://localhost:8080/user/1就能获取参数了。
6.获取格式化参数
在一些应用中往往需要格式化数据,其中最为典型的当属日期和货币了。例如在一些系统中日期格式约定为yyyy-MM-dd,金额约定为货币符号且用逗号隔开。同样的而Spring MVC对此也提供了良好的支持。对日期和数字类型的转换注解进行处理,分别为@DateTimeFormat和@NumberFormat。其中@DateTimeFormat是针对日期进行格式化的,@NumberFormat是针对数字进行格式化的。代码清单如下:
@Controller
@RequestMapping("/my")
public class MyController {
@GetMapping("/format")
@ResponseBody
public Map<String, Object> format(@DateTimeFormat(iso = DateTimeFormat.ISO.DATE) Date date,
@NumberFormat(pattern = "#,###.##") Double number) {
Map<String, Object> paramMap = new HashMap<>();
paramMap.put("intVal", date);
paramMap.put("longVal", number);
return paramMap;
}
}
他们配置了格式化所约定的格式,所以Spring MVC会根据约定的格式把数据转换出来,这样就可以完成转换。