SpringBoot2 映射与常用注解
扎哇太枣糕 人气:01 请求映射
在SpringBoot中使用@XxxMapping注解完成前端请求与后端方法的一个映射。以前的时候,通常使用url映射命名的方式完成增删改查的操作,比如:/getUser 查找用户/deleteUser 删除用户 /editUser更改用户 /saveUser 添加用户。但是,后来出现了Rest风格的请求方式一直沿用至今。
1.1 Rest风格
Rest风格就是使用HTTP请求方式动词来表示对资源的增删改查等操作,比如:GET查找用户DELETE删除用户PUT更改用户 POST添加用户。具体使用如下:
但是前端form表单的method只有POST、GET两种方法,如何使用PUT、DELETE两种方法呢?这就使用到了HiddenHttpMethodFilter,在源码的WebMvcAutoConfiguration自动配置类中使用OrderedHiddenHttpMethodFilter方法(方法源码在下面),其中返回它同名类对象,该类向上两层的父类HiddenHttpMethodFilter中定义了如何使用PUT、DELETE两种方法(源码见下面图片)
@Bean @ConditionalOnMissingBean({HiddenHttpMethodFilter.class}) // 这里的隐藏方法过滤器默认是不开启的,通过下面的prefix和name即可在配置文件将其配置为true @ConditionalOnProperty( prefix = "spring.mvc.hiddenmethod.filter", name = {"enabled"} ) public OrderedHiddenHttpMethodFilter hiddenHttpMethodFilter() { return new OrderedHiddenHttpMethodFilter(); }
了解源码的规范之后,让我们试着进行编码,总结上述文字得知:若想使用Rest风格的请求,需要进行两步操作①配置文件中开启隐藏方法过滤器(据说高版本的SpringBoot源码中默认是开启的)②form表单的method为POST并加入_method的值为相应的PUT、DELETE
1.2 表单提交Rest的原理
表单在使用Rest风格的请求方式提交的时候,会带上input标签里_method的对应值PUT、DELETE,当请求发送过来的时候将会被HiddenHttpMethodFilter所拦截进行判断(form表单的method是否为POST且无报错),判断通过之后获取_method对应的值。原生request(post)的包装模式xxxWrapper重写了getMethod方法,返回的是_method传入的值。后面的controller方法中url映射的method的值就是经过方法重写之后获得的传入值。
⚠ 像form表单的method只有POST、GET两个值的情况需要将配置文件中的隐藏方法过滤器开启,别的如PostMan直接发送Put、delete等方式请求就无需使用HiddenHttpMethodFilter ⚠ 根据四种配置演变出的四个新注解
⚠ 自定义_method名称的方法:自定义一个webConfig类类中来创建一个HiddenHttpMethodFilter方法,调用它的setMethodFilter方法即可实现定制
1.3请求映射的原理
SpringBoot和SpringMVC一样,前端发送的所有请求都一定会到DispatcherServlet中,而DispatcherServlet本身就是一个servlet继承自HttpServlet。一个servlet必定会重写doGet和doPost方法,于是通过对源码进行分析发现在HttpServlet的子类FrameworkServlet(它同时也是DispatcherServlet的父类)中重写了doGet和doPost方法,并且重写之后的doXxx方法都是调用了本类的processRequest方法,这个方法的底层又调用了本类的doService抽象方法,抽象方法没有方法体,继承该类的子类必须重写该方法,于是乎在它的子类中找到了重写之后的doService方法,这个方法中除了前面一大堆的初始化之外调用本类的doDispatch方法(这个才是最重要的一个方法)
从上文的析得知,SpringMVC的功能都要从DispatcherServlet类的doDispatch方法中分析得出,此方法使用getHandler(processedRequest)有参构造器里的对获取到的所有请求使用for循环逐个匹配下面的handlerMappings,而前两个都是在WebMvcAutoConfiguration自动配置类中配置过的。
⚠ 拓展知识:如果一些特殊场景需要对不同的请求映射不同的代码包,比如普通用户和VIP用户的功能肯定是不一样的,所以在此时我们就可以借助给容器中注册自定义HandlerMapping的方式来完成。
2 请求处理常用注解
以下的注解都可以通过键名获取单个键的值,也可以使用map集合(kv都是必须String)获取所有的参数
2.1 @RequestParam
@RequestParam注解用来获取请求参数的值
2.2 @PathVariable
在Restful请求风格中,通常使用路径的方式进行参数的传递,@PathVariable注解就是用来获取url路径中参数的值
2.3 @RequestHeader
@RequestHeader注解用来获取请求头的值
2.4 @RequestBody
@RequestBody注解用来获取请求体的值
2.5 @RequestAttribute
@RequestAttribute用来获取request域的值,两种获取方式:①直接@RequestAttribute注解 ②HttpServletRequest对象的getAttribute方法。这个注解无法使用map获取所有的值
2.6 @RequestAttribute
使用session.set(k, v)设置的属性值存储在session中,而每个用户都有其唯一对应的jsessionid保存在cookie中,每次发送请求cookie都会携带这个jsessionid,服务器通过jsessionid解析出session对象之后再调用get(k)方法获取对应的属性值。 但是现在有这么一个情况,在页面开发的时候禁用了cookie(相当于session也失效了),这个时候怎么获取属性值?通过url重写使用矩阵变量的方式进行传递。使用该方法需要有以下两步:
第一步: SpringBoot默认禁用矩阵变量,可通过自定义配置类向容器注册WebMvcConfigurer组件替代默认的组件来开启矩阵变量
第二步: 分单矩阵和多矩阵两种用法
3 方法参数小技巧
3.1 复杂参数属性值
方法中有时会传入一些复杂的参数,比如Map、Model、request、response等,其中前三种参数的设置的属性值数据都会存放在request请求域中。接下来使用代码证实一下这个说法:
3.2 自定义参数实现数据绑定
页面提交的请求数据(GET、POST)都可以和自定义对象参数的属性(也就是POJO类的参数)进行绑定
加载全部内容