Spring MVC获取控制器参数的几种姿势

处理器是对控制器(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会根据约定的格式把数据转换出来,这样就可以完成转换。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,496评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,407评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,632评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,180评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,198评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,165评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,052评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,910评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,324评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,542评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,711评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,424评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,017评论 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,668评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,823评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,722评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,611评论 2 353

推荐阅读更多精彩内容