RequestMapping 用法详解

  categories:资料  author:

简介:

@RequestMapping

RequestMapping是一个用来处理请求地址映射的注解,可用于类或方法上。用于类上,表示类中的所有响应请求的方法都是以该地址作为父路径。

RequestMapping注解有六个属性,下面我们把她分成三类进行说明。

value, method

value:     指定请求的实际地址,指定的地址可以是URI Template 模式(后面将会说明);

method:  指定请求的method类型, GET、POST、PUT、DELETE等;

consumes,produces

consumes: 指定处理请求的提交内容类型(Content-Type),例如application/json, text/html;

produces:    指定返回的内容类型,仅当request请求头中的(Accept)类型中包含该指定类型才返回;

params,headers

params: 指定request中必须包含某些参数值是,才让该方法处理。

headers: 指定request中必须包含某些指定的header值,才能让该方法处理请求。

示例:

value  / method 示例

默认RequestMapping(“….str…”)即为value的值;

@Controller  
@RequestMapping("/appointments")  
public class AppointmentsController {  
  
    private AppointmentBook appointmentBook;  
      
    @Autowired  
    public AppointmentsController(AppointmentBook appointmentBook) {  
        this.appointmentBook = appointmentBook;  
    }  
  
    @RequestMapping(method = RequestMethod.GET)  
    public Map<String, Appointment> get() {  
        return appointmentBook.getAppointmentsForToday();  
    }  
  
    @RequestMapping(value="/{day}", method = RequestMethod.GET)  
    public Map<String, Appointment> getForDay(@PathVariable @DateTimeFormat(iso=ISO.DATE) Date day, Model model) {  
        return appointmentBook.getAppointmentsForDay(day);  
    }  
  
    @RequestMapping(value="/new", method = RequestMethod.GET)  
    public AppointmentForm getNewForm() {  
        return new AppointmentForm();  
    }  
  
    @RequestMapping(method = RequestMethod.POST)  
    public String add(@Valid AppointmentForm appointment, BindingResult result) {  
        if (result.hasErrors()) {  
            return "appointments/new";  
        }  
        appointmentBook.addAppointment(appointment);  
        return "redirect:/appointments";  
    }  
}

value的uri值为以下三类:

A) 可以指定为普通的具体值;

B)  可以指定为含有某变量的一类值(URI Template Patterns with Path Variables);

C) 可以指定为含正则表达式的一类值( URI Template Patterns with Regular Expressions);

example B)

@RequestMapping(value="/owners/{ownerId}", method=RequestMethod.GET)  
public String findOwner(@PathVariable String ownerId, Model model) {  
  Owner owner = ownerService.findOwner(ownerId);    
  model.addAttribute("owner", owner);    
  return "displayOwner";   
}

example C)

@RequestMapping("/spring-web/{symbolicName:[a-z-]+}-{version:\d\.\d\.\d}.{extension:\.[a-z]}")  
  public void handle(@PathVariable String version, @PathVariable String extension) {      
    // ...  
  }  
}

consumes、produces 示例

cousumes的样例:

@Controller  
@RequestMapping(value = "/pets", method = RequestMethod.POST, consumes="application/json")  
public void addPet(@RequestBody Pet pet, Model model) {      
    // implementation omitted  
}

方法仅处理request Content-Type为“application/json”类型的请求。produces的样例:

@Controller  
@RequestMapping(value = "/pets/{petId}", method = RequestMethod.GET, produces="application/json")  
@ResponseBody  
public Pet getPet(@PathVariable String petId, Model model) {      
    // implementation omitted  
}

方法仅处理request请求中Accept头中包含了”application/json”的请求,同时暗示了返回的内容类型为application/json;

params、headers 示例

params的样例:

@Controller  
@RequestMapping("/owners/{ownerId}")  
public class RelativePathUriTemplateController {  
  
  @RequestMapping(value = "/pets/{petId}", method = RequestMethod.GET, params="myParam=myValue")  
  public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) {      
    // implementation omitted  
  }  
}

仅处理请求中包含了名为“myParam”,值为“myValue”的请求;

headers的样例:

@Controller  
@RequestMapping("/owners/{ownerId}")  
public class RelativePathUriTemplateController {  
  
@RequestMapping(value = "/pets", method = RequestMethod.GET, headers="Referer=http://www.ifeng.com/")  
  public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) {      
    // implementation omitted  
  }  
}

仅处理request的header中包含了指定“Refer”请求头和对应值为“http://www.ifeng.com/”的请求;

来源: https://www.cnblogs.com/kuoAT/p/7121753.html

二、@RequestParam
@RequestParam String inputStr等价于request.getParameter(“inputStr”)
value属性约定传递过来的值必须为value指定的,否则异常

//inputStr必须为hello
@RequestParam(value=”hello”) String inputStr
1
2
三、@Responsebody
1、注释在方法上
在使用@RequestMapping后,返回值通常解析为跳转路径,加上@responsebody后返回结果不会被解析为跳转路径,而是直接写入HTTP response body中

2、@RequestBody
将HTTP请求正文转换为适合的HttpMessageConverter对象

四、@RequestHeader
@RequestHeader 注解,可以把Request请求header部分的值绑定到方法的参数上。

@RequestHeader(“Host”) String host
1
可以获取host值内容
URL:http://localhost:8080/
得到localhost:8080

五、@CookieValue
@CookieValue 可以把Request header中关于cookie的值绑定到方法的参数上

//JSESSIONID=415A4AC178C59DACE0B2C9CA727CDD84
@RequestMapping(“/displayHeaderInfo.do”)
public void displayHeaderInfo(@CookieValue(“JSESSIONID”) String cookie) {

//…

}

六、@ModelAttribute
该注解有两个用法,一个是用于方法上,一个是用于参数上;

用于方法上时: 通常用来在处理@RequestMapping之前,为请求绑定需要从后台查询的model;

用于参数上时: 用来通过名称对应,把相应名称的值绑定到注解的参数bean上;要绑定的值来源于:

A) @SessionAttributes 启用的attribute 对象上;

B) @ModelAttribute 用于方法上时指定的model对象;

C) 上述两种情况都没有时,new一个需要绑定的bean对象,然后把request中按名称对应的方式把值绑定到bean中。

1、用到方法上@ModelAttribute

// Add one attribute
// The return value of the method is added to the model under the name “account”
// You can customize the name via @ModelAttribute(“myAccount”)

@ModelAttribute
public Account addAccount(@RequestParam String number) {
return accountManager.findAccount(number);
}

// Add multiple attributes

@ModelAttribute
public void populateModel(@RequestParam String number, Model model) {
model.addAttribute(accountManager.findAccount(number));
// add more …
}

添加一个属性将该方法的返回值添加到model中名称为account
可以通过@ModelAttribute(“myAccount”)自定义名称

2、用在参数上的@ModelAttribute示例代码:

“`
@RequestMapping(value=”/owners/{ownerId}/pets/{petId}/edit”, method = RequestMethod.POST)
public String processSubmit(@ModelAttribute Pet pet) {

}
“`、
首先查询 @SessionAttributes有无绑定的Pet对象,若没有则查询@ModelAttribute方法层面上是否绑定了Pet对象,若没有则将URI template中的值按对应的名称绑定到Pet对象的各属性上
通过@ModelAttribute(“account”)将model名为account属性存储

七、@SessionAttributes
八、@RequestAttribute
九、@InitBinder
十、@JsonView
十一、拦截器
常见场景
1. 日志记录:记录请求信息的日志,以便进行信息监控、信息统计、计算PV(Page View)等。
2. 权限检查:如登录检测,进入处理器检测检测是否登录,如果没有直接返回到登录页面;
3. 性能监控:有时候系统在某段时间莫名其妙的慢,可以通过拦截器在进入处理器之前记录开始时间,在处理完后记录结束时间,从而得到该请求的处理时间(如果有反向代理,如apache可以自动记录);
4. 通用行为:读取cookie得到用户信息并将用户对象放入请求,从而方便后续流程使用,还有如提取Locale、Theme信息等,只要是多个处理器都需要的即可使用拦截器实现。
5. OpenSessionInView:如Hibernate,在进入处理器打开Session,在完成后关闭Session
servlet配置

<mvc:interceptors>
<mvc:interceptor>
<!–配置拦截目录/**或者不填则为所有controller–>
<mvc:mapping path=”/**”/>
<bean class=”Model.TimeBasedAccessInterceptor”/>
</mvc:interceptor>
</mvc:interceptors>

继承HandlerInterceptorAdapter实现interceptor

public class TimeBasedAccessInterceptor extends HandlerInterceptorAdapter {
private int openingTime;
private int closingTime;

public void setOpeningTime(int openingTime) {
this.openingTime = openingTime;
}

public void setClosingTime(int closingTime) {
this.closingTime = closingTime;
}

/** 执行处理之后调用*/
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
System.out.println(“===========HandlerInterceptor1 postHandle”);
super.postHandle(request, response, handler, modelAndView);
}
/** 完成请求时调用*/
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
System.out.println(“===========HandlerInterceptor1 afterCompletion”);
super.afterCompletion(request, response, handler, ex);
}
/** 执行处理之前调用 返回值为true继续,false终端执行*/
public boolean preHandle(HttpServletRequest request, HttpServletResponse response,
Object handler) throws Exception {
// Calendar cal = Calendar.getInstance();
// int hour = cal.get(HOUR_OF_DAY);
// if (openingTime <= hour && hour < closingTime) {
// System.out.println(openingTime+”开放”);
// return true;
// }
// System.out.println(“完成”);
System.out.println(“===========HandlerInterceptor1 preHandle”);
return true;
}
}

———————

springMVC中的注解@RequestParam与@PathVariable的区别
@PathVariable绑定URI模板变量值

@PathVariable是用来获得请求url中的动态参数的

@PathVariable用于将请求URL中的模板变量映射到功能处理方法的参数上。//配置url和方法的一个关系@RequestMapping(“item/{itemId}”)

/* @RequestMapping 来映射请求,也就是通过它来指定控制器可以处理哪些URL请求,类似于struts的action请求
* @responsebody表示该方法的返回结果直接写入HTTP response body中
*一般在异步获取数据时使用,在使用@RequestMapping后,返回值通常解析为跳转路径,加上@responsebody后返回结果不会被解析为跳转路径,而是直接写入HTTP response *body中。
*比如异步获取json数据,加上@responsebody后,会直接返回json数据。*
*@Pathvariable注解绑定它传过来的值到方法的参数上
*用于将请求URL中的模板变量映射到功能处理方法的参数上,即取出uri模板中的变量作为参数
*/
@ResponseBody
public TbItem getItemById(@PathVariable Long itemId){
@RequestMapping(“/zyh/{type}”)
public String zyh(@PathVariable(value = “type”) int type) throws UnsupportedEncodingException {
String url = “http://wx.diyfintech.com/zyhMain/” + type;
if (type != 1 && type != 2) {
throw new IllegalArgumentException(“参数错误”);
}
String encodeUrl = URLEncoder.encode(url, “utf-8″);
String redirectUrl = MessageFormat.format(OAUTH_URL, WxConfig.zyhAppId, encodeUrl, “snsapi_userinfo”, UUID.randomUUID().toString().replace(“-“, “”));
return “redirect:” + redirectUrl;
}

在SpringMVC后台控制层获取参数的方式主要有两种:

一种是request.getParameter(“name”),另外一种是用注解@RequestParam直接获取

这里主要讲这个注解 @RequestParam

接下来我们看一下@RequestParam注解主要有哪些参数:

value:参数名字,即入参的请求参数名字,如username表示请求的参数区中的名字为username的参数的值将传入;

required:是否必须,默认是true,表示请求中一定要有相应的参数,否则将报404错误码;

defaultValue:默认值,表示如果请求中没有同名参数时的默认值,例如:

public List<EasyUITreeNode> getItemTreeNode(@RequestParam(value=”id”,defaultValue=”0″)long parentId)
@Controller
@RequestMapping(“/wx”)
public class WxController {

@Autowired
private WxService wxService;
private static final Log log= LogFactory.getLog(WxController.class);

@RequestMapping(value = “/service”,method = RequestMethod.GET)
public void acceptWxValid(@RequestParam String signature, @RequestParam String timestamp, @RequestParam String nonce,
@RequestParam String echostr, HttpServletResponse response) throws IOException {
PrintWriter out = response.getWriter();
if (SignUtil.checkSignature(signature, timestamp, nonce)) {
out.print(echostr);
}else
out.print(“fail”);
out.flush();
out.close();
}

@RequestMapping(“/”)
public String Demo1(@RequestParam String lid){

System.out.println(“—-“+lid);
return null;
}
前台页面

<input type=”text” name=”lid” /> <!– 这时输出为10 –>

Console输出界面

—-10

springmvc会自动根据参数名字来注入,所以要名字一致,不然不会注入

参数名字不一致
@RequestMapping(“/”)
public String Demo1(@RequestParam(name=”lid”) String id){

System.out.println(“—-“+id);
return null;
}
前台页面

<input type=”text” name=”lid” /> <!– 这时输出为10 –>

Console输出界面

—-10

参数名字不一致的话,需要在@RequestParam后面指定参数名字,才能为后面的参数进行赋值。

设置默认值
@RequestMapping(“/”)
public String Demo1(@RequestParam(name=”lid”,defaultValue=”ste”) String id){

System.out.println(“—-“+id);
return null;
}
前台页面

Console输出界面

—-ste

注意事项
@RequestMapping(“/”)
public String Demo1(@RequestParam(name=”lid”) int id){

System.out.println(“—-“+id);
return null;
}
前台页面

<input type=”text” name=”lid” /> <!– 这时输出为10 –>

Console输出界面

—-10

如果要@RequestParam为一个int型的数据传值,假如前端并未输入,那么将会为int型的数据赋值为null。显然,这是不允许的,直接报错。
可以通过required=false或者true来要求@RequestParam配置的前端参数是否一定要传

// required=true,则参数必须要传
@RequestMapping(“/”)
public String Demo1(@RequestParam(name=”lid”,required=true) int id){

System.out.println(“—-“+id);
return null;
}`

如果required为false,那么默认为参数赋值为null

 



快乐成长 每天进步一点点      京ICP备18032580号-1