springboot 获取控制器参数的几种方式

绝地灬酷狼 2022-05-08 14:46 250阅读 0赞

如题，这里介绍springboot 获取控制器参数有四种方式

1、无注解下获取参数

2、使用@RequestParam获取参数

3、传递数组

4、通过URL传递参数

### 无注解下获取参数 ###

无注解下获取参数，需要控制器层参数与HTTP请求栏参数名称一致，这样后台就可以获取到请求栏的参数。

/**
    	 * 无注解获取参数时，参数名称和HTTP请求参数必须一致
    	 * @param name String 姓名
    	 * @param age int 年龄
    	 * @param score double 分数
    	 * @return 响应json字符-@ResponseBody注解将map转为json
    	 */
    	@RequestMapping("/param/noannotation")
    	@ResponseBody
    	public Map<String, Object> noAnnotation(String name,int age, double score) {
    		Map<String, Object> paramMap = new HashMap<String, Object>();
    		paramMap.put("name", name);
    		paramMap.put("age", age);
    		paramMap.put("score", score);
    		return paramMap;
    	}

方法中，我们接收三个参数，分别为name，age和score

启动springboot后，在浏览器中请求URL：[http://localhost:8080/param/noannotation?name=zhangsan&age=14&score=89.1][http_localhost_8080_param_noannotation_name_zhangsan_age_14_score_89.1]

前端页面会自动得到我们输入的参数的json形式

![70][]

如果我们的请求URL中name不给参数值 [http://localhost:8080/param/noannotation?name=&age=12&score=89.1][http_localhost_8080_param_noannotation_name_age_12_score_89.1]

请求可以正常跳转

![70 1][]

如果我们将int 或 long 参数为空，给URL [http://localhost:8080/param/noannotation?name=lisi&age=12&score=][http_localhost_8080_param_noannotation_name_lisi_age_12_score]

请求会报错

![70 2][]

无法将String型参数转化为需要的double型。

这里可以看出，如果我们不给参数赋值，那么spring会将空着的参数默认按照String型空字符串处理。所以，如果是String型的参数，为空时不报错的；若是非String型参数，则必须非空。

### 使用@RequestParam获取参数 ###

上面的无注解情况下，HTTP参数与控制器参数名称必须一致。若HTTP参数与控制器参数不一致时，我们就需要将前端参数与后端参数对应起来，这里我们使用@RequestParam来确定前后端参数名称的映射关系。

/**
    	 * 使用@RequestParam获取参数
    	 * 这里RequestParam注解会将括号里面的前端参数名称转化为后面的参数名称
    	 * @param name String 姓名，接收前端username参数
    	 * @param age int 年龄，接收前端user_age参数
    	 * @param score double 分数，接收前端score参数
    	 * @return 响应json字符
    	 */
    	@RequestMapping("/param/requestparam")
    	@ResponseBody
    	public Map<String, Object> requestParam(
    			@RequestParam("username") String name,
    			@RequestParam("user_age") int age, 
    			@RequestParam("score") double score) {
    		Map<String, Object> paramMap = new HashMap<String, Object>();
    		paramMap.put("name", name);
    		paramMap.put("age", age);
    		paramMap.put("score", score);
    		return paramMap;
    	}

方法中，我们接收前端的username，user\_age和score，然后使用@RequestParam注解将其转化映射为name，age和age。

启动springboot后，URL栏输入 [http://localhost:8080/param/requestparam?username=lisi&user\_age=12&score=45.6][http_localhost_8080_param_requestparam_username_lisi_user_age_12_score_45.6]

可以正常跳转，并将结果展示在前端

![70 3][]

如果将URL中username后面值置空，页面可以正常跳转，测试URL

[http://localhost:8080/param/requestparam?username=&user\_age=12&score=45.6][http_localhost_8080_param_requestparam_username_user_age_12_score_45.6]

![70 4][]

若我们将user\_age 或 score值置空，则页面会报错

![70 5][]

与上面无注解时错误相同，这里不做解释了。

如果我们删除掉URL栏里面username参数项，URL为 [http://localhost:8080/param/requestparam?user\_age=12&score=45.6][http_localhost_8080_param_requestparam_user_age_12_score_45.6]

页面无法正常跳转，报错如下

![70 6][]

那如果实际中，我们确实有前端可传可不传的参数时，怎么办？@RequestParam注解给了一个required属性，标注该参数项是否必须有，其默认值为true，即必须传值；若该值可能为空，则将required置为false。注意，此时，@RequestParam后面的数据类型必须为包装类型，不可以是简单类型，若为简单类型，依然会报错。包装类型时，可以接收null对象；若为简单类型，则系统依然会将空字符串与对应的简单类型进行强转，转换失败的，则抛异常出来。

我们将上面方法参数做部分修改，修改如下，由于篇幅关系，这里不再整体贴整个方法

@RequestMapping("/param/requestparam")
    	@ResponseBody
    	public Map<String, Object> requestParam(
    			@RequestParam("username") String name,
    			@RequestParam(value = "user_age", required = false) Integer age, 
    			@RequestParam(value = "score", required = false) double score) {

上面，我们将age对应的类型修改为Integer包装类型，required设置为false；score，只是设置required设置为false

启动springboot做测试，[http://localhost:8080/param/requestparam?username=zhangsan&user\_age=&score=89][http_localhost_8080_param_requestparam_username_zhangsan_user_age_score_89]

这里我们将user\_age后面的参数值设置为空，请求可以正常跳转

![70 7][]

我们再修改一下URL参数项，[http://localhost:8080/param/requestparam?username=zhangsan&user\_age=&score=][http_localhost_8080_param_requestparam_username_zhangsan_user_age_score]

系统会报400错误，提示score是空字符串，如果将数据类型double修改为Double，就会返回null了，这个这里就不测试了

![70 8][]

### 接收前端传递的数组 ###

springMVC中，前端往后端除了可以传递一些单值外，也可以传递数组。传递数据部分没有太多规则可言，在后台控制器部分，定义数组形式接收数据，前端传递时，将一组数据用英文的逗号“,”隔开就可以了。

@RequestMapping("/param/requestarray")
    	@ResponseBody
    	public Map<String, Object> requestArray(String[] names, int[] ages, double[] scores) {
    		Map<String, Object> paramMap = new HashMap<String, Object>();
    		paramMap.put("name", names);
    		paramMap.put("age", ages);
    		paramMap.put("score", scores);
    		return paramMap;
    	}

启动springboot，URL为

[http://localhost:8080/param/requestarray?names=zhangsan,lisi,wangwu&ages=12,14,15&scores=78.9,98,67][http_localhost_8080_param_requestarray_names_zhangsan_lisi_wangwu_ages_12_14_15_scores_78.9_98_67]

我们使用names接收所有的name，多个name值“zhangsan”、“lisi”和“wangwu”之间用“,”隔开

页面可以正常跳转

![70 9][]

**通过URL传递参数**

这里通过URL传递参数与上面的URL不同，上面的URL中均需写明参数名和对应参数值，这里的URL传递参数，仅需要在地址栏输入参数值，然后后台自动匹配到对应的参数名。springMVC通过使用处理器映射和@PathVariable注解的组合来获取URL参数。首先通过处理器映射可以定位参数的位置和名称，而@PathVariable则可以通过名称来获取参数。

/**
    	 * 使用URL传参
    	 * URL传参时，方法请求URL后使用{}包含参数名称，多个参数之间使用/分隔
    	 * @param name 姓名
    	 * @param age 年龄
    	 * @param score 成绩
    	 * @return 响应的json数据
    	 */
    	@RequestMapping("/param/geturl/{name}/{age}/{score}")
    	@ResponseBody
    	public Map<String, Object> getUrlParam(
    			@PathVariable("name") String name,
    			@PathVariable("age") Integer age,
    			@PathVariable("score") Double score) {
    		Map<String, Object> paramMap = new HashMap<String, Object>();
    		paramMap.put("name", name);
    		paramMap.put("age", age);
    		paramMap.put("score", score);
    		return paramMap;
    	}

方法中，我们使用了3个\{ \}，分别代表变量name、age和score，方法变量中使用@PathVariable来接收变量，并映射为方法的变量

启动springboot测试，URL为  [http://localhost:8080/param/geturl/zhangsan/12/89][http_localhost_8080_param_geturl_zhangsan_12_89]

正常跳转

![70 10][]

如果中间某个参数可能为空呢，查了下@PathVariable注解有required属性，但是经测试，发现这个属性无法单独使用。

如果中间某个参数为空，还得借用@RequestMapping 支持多URL的属性进行处理

假如，age属性可能为空，那么修改代码为

@RequestMapping(value = {"/param/geturl/{name}/{age}/{score}", 
    			"/param/geturl/{name}/{score}"})
    	@ResponseBody
    	public Map<String, Object> getUrlParam(
    			@PathVariable("name") String name,
    			@PathVariable(value = "age", required = false) Integer age,
    			@PathVariable("score") Double score) {

其中，后面的URL中没有了age参数，这里，视有无age的请求为不同的请求

使用URL [http://localhost:8080/param/geturl/zhangsan//89][http_localhost_8080_param_geturl_zhangsan_89] 做测试，可以正常跳转

![70 11][]

上面就是这篇博文要介绍的四种获取前端参数的四种方式，内容均为本人学习整理所得，若其中有不严谨之处，欢迎批评斧正。关于获取前端参数，不止上面四种方式，就了解到的还有获取json和格式化参数两种形式，由于涉及页面内容，本篇博文暂时不做介绍，后面单独整理。谢谢。

[http_localhost_8080_param_noannotation_name_zhangsan_age_14_score_89.1]: http://localhost:8080/param/noannotation?name=zhangsan&age=14&score=89.1
[70]: /images/20220506/1dc019c2d174432aaaf568a436801efa.png
[http_localhost_8080_param_noannotation_name_age_12_score_89.1]: http://localhost:8080/param/noannotation?name=&age=12&score=89.1
[70 1]: /images/20220506/1fdbd5a34235411db3939c8a62e5c77a.png
[http_localhost_8080_param_noannotation_name_lisi_age_12_score]: http://localhost:8080/param/noannotation?name=lisi&age=12&score=
[70 2]: /images/20220506/1200c87fde2e4d49ac222112339169b0.png
[http_localhost_8080_param_requestparam_username_lisi_user_age_12_score_45.6]: http://localhost:8080/param/requestparam?username=lisi&user_age=12&score=45.6
[70 3]: /images/20220506/77701e2b98494b2f872a086ff595211a.png
[http_localhost_8080_param_requestparam_username_user_age_12_score_45.6]: http://localhost:8080/param/requestparam?username=&user_age=12&score=45.6
[70 4]: /images/20220506/1d366e7572b943189a1b3ac1f7e4cb5a.png
[70 5]: /images/20220506/972d61e7bee34488b73dd3247046fe90.png
[http_localhost_8080_param_requestparam_user_age_12_score_45.6]: http://localhost:8080/param/requestparam?user_age=12&score=45.6
[70 6]: /images/20220506/9eb4555a4dc34393aa40d55da4e87c1b.png
[http_localhost_8080_param_requestparam_username_zhangsan_user_age_score_89]: http://localhost:8080/param/requestparam?username=zhangsan&user_age=&score=89
[70 7]: /images/20220506/bc38e5d13cc543b197c20d3e240951b3.png
[http_localhost_8080_param_requestparam_username_zhangsan_user_age_score]: http://localhost:8080/param/requestparam?username=zhangsan&user_age=&score=
[70 8]: /images/20220506/030f65b6fa464afd9cb3426440fd2aed.png
[http_localhost_8080_param_requestarray_names_zhangsan_lisi_wangwu_ages_12_14_15_scores_78.9_98_67]: http://localhost:8080/param/requestarray?names=zhangsan,lisi,wangwu&ages=12,14,15&scores=78.9,98,67
[70 9]: /images/20220506/fb73e9b08f4947d79e27e91bcc8f0455.png
[http_localhost_8080_param_geturl_zhangsan_12_89]: http://localhost:8080/param/geturl/zhangsan/12/89
[70 10]: /images/20220506/1da46340f0e74ec1bb130cdd56bee676.png
[http_localhost_8080_param_geturl_zhangsan_89]: http://localhost:8080/param/geturl/zhangsan//89
[70 11]: /images/20220506/3983489316324517985961aa02c99d8c.png