springmvc的常见5种注解:1、@RequestMapping,是一个用来处理请求地址映射的注解;2、@RequestParam,用于将请求参数区数据映射到功能处理方法的参数上;3、@PathVariable,用于将请求变量。
@RequestMapping
是一个用来处理请求地址映射的注解
适用于类、方法。用于类上,表示类中的所有响应请求的方法都是以该地址作为父路径。
属性
value
: 指定请求的实际地址,值可以是普通的具体值,可以指定为含有某变量的一类值(URI Template Patterns with Path Variables)
可以指定为含正则表达式的一类值(URI Template Patterns with Regular Expressions)method
: 指定请求的method类型,GET、POST、PUT、DELETE等consumes
: 指定处理请求的提交内容类型(Content-Type),例如application/json, text/htmlproduces
: 指定返回的内容类型,仅当request请求头中的(Accept)类型中包含该指定类型才返回params
: 指定request中必须包含某些参数值是,才让该方法处理headers
: 指定request中必须包含某些指定的header值,才能让该方法处理请求
1.处理get请求: @RequestMapping(value = "index",method = RequestMethod.GET) 2.springboot错误处理(使用app客户端返回json格式,使用浏览器返回html错误页) @RequestMapping(produces = "text/html") 3.方法仅处理request Content-Type为“application/json”类型的请求 @RequestMapping(value = "/pets", consumes="application/json") 4.仅处理请求中包含了名为“myParam”,值为“myValue”的请求 @RequestMapping(value = "/pets/{petId}", params="myParam=myValue") 5.仅处理request的header中包含了指定“Refer”请求头和对应值为“http://www.rxy.com/”的请求 @RequestMapping(value = "/pets", headers="Referer=http://www.rxy.com/")
@RequestParam
用于将请求参数区数据映射到功能处理方法的参数上
适用:方法参数
属性
value/name
: 两个属性都指代参数名字,即入参的请求参数名字(通常表单name属性)required
: 是否必须,默认是true,表示请求中一定要有相应的参数,否则将抛出异常defaultValue
: 默认值,表示如果请求中没有同名参数时的默认值,设置该参数时,自动将required设为false
如果是原子类型,不管加没加注解,都必须有值,否则抛出异常,如果允许空值请使用包装类代替 index(@RequestParam Integer num){} 表示该参数必须传递,值允许为空 表示该参数非必须,如果不传则默认为0 getPageData(@RequestParam(name="pageNum",defaultValue="0") String pageNo, String pageSize)
@PathVariable
用于将请求URL中的模板变量映射到功能处理方法的参数上,即取出uri模板中的变量作为参数
适用:方法参数
属性
value: 指定url模版变量名称,如果名称与方法参数名不一样,则需要指定,否则可省略
@RequestMapping("/index/{id}") public String index(@PathVariable("id") String sdf){ System.out.println(sdf); return "index"; }
@ResponseBody
该注解用于将Controller
的方法返回的对象,通过适当的HttpMessageConverter
转换为指定格式后,写入到Response
对象的body
数据区,默认springmvc
以json
形式返回(使用jackson
转换器)
适用:方法,返回的数据不是html标签的页面,而是其他某种格式的数据时(如json、xml等)使用
对比:@RequestBody
将HTTP请求正文转换为适合的HttpMessageConverter对象
@ResponseBody
将内容或对象作为 HTTP 响应正文返回,并调用适合HttpMessageConverter的Adapter转换对象,写入输出流
@RequestBody
1.该注解用于读取Request请求的body部分数据,使用系统默认配置的HttpMessageConverter进行解析,然后把相应的数据绑定到要返回的对象上
2.再把HttpMessageConverter返回的对象数据绑定到controller中方法的参数上
适用:方法参数,对于request的Content-Type:为application/json, application/xml必须使用该注解
对于application/x-www-form-urlencoded,如果请求方式为put,则为必须,
对于POST/GET方式可选(即非必须,因为@RequestParam,@ModelAttribute也可以处理)
对于multipart/form-data, @RequestBody不能处理这种格式的数据
属性:required: 是否必须,默认是true,表示请求中一定要有相应的参数,否则将抛出异常
示例:通常使用该注解前端都是发送ajax请求,那么请求部分内容如下:
$.ajax({ type: "POST", url:"/role/saveRole", contentType:"application/json", data: JSON.stringify(_self.form)...
注意:contentType不可省略,data必须是通过stringify转换为json字符串的数据
那么对应方法就可以这么写:
@RequestMapping(value = "/saveRole",method = RequestMethod.POST) public String saveRole(@RequestBody People requestJson) {}
如果前端传递的是对象的数组,那么后台也可以直接使用List<Obj>直接接受,这是绑定List数据最实用的方式
@CookieValue
可以把Request header中关于cookie的值绑定到方法的参数上
适用:方法参数
获取cookie中的JSESSIONID public String index(@CookieValue("JSESSIONID") String cookie){}
@RequestHeader
可以把Request请求header部分的值绑定到方法的参数上
适用:方法参数
获取请求中Accept-Encoding值,返回gzip, deflate, br public String index(@RequestHeader("Accept-Encoding") String host){return host;}
@ExceptionHandler
注解在方法上,表示该方法用于处理特定的异常,处理范围是当前类,如果想要全局捕获异常,需要使用@ControllerAdvice
当一个Controller中有多个HandleException注解出现时,那么异常被哪个方法捕捉呢?这就存在一个优先级的问题
ExceptionHandler的优先级是:在异常的体系结构中,哪个异常与目标方法抛出的异常血缘关系越紧密,就会被哪个捕捉到
属性:value: 需要处理的异常类型集合(Class)
在当前Controller有两个处理异常的方法,当访问/index时,页面显示: json data
package com.rxy.controller; @Controller public class HelloController { @ExceptionHandler({ ArithmeticException.class }) @ResponseBody public String handleArithmeticException(Exception e) { e.printStackTrace(); return "json data"; } @ExceptionHandler({ IOException.class }) public String handleIOException(Exception e) { e.printStackTrace(); //返回错误页面 return "error"; } @RequestMapping("/index") public String index(){ int i = 10 / 0; return "index"; } }
以上就是springmvc常用5种注解的使用的详细内容,更多请关注php中文网其它相关文章!