SpringMVC@Controller和@RequestMapping注解
Spring 2.5版本新增了Spring MVC注解功能,⽤于替换传统的基于XML的Spring MVC配置.
使⽤基于注解的控制器具有以下2个优点:
1.在基于注解的控制器类中可以编写多个处理⽅法,进⽽可以处理多个请求(动作),这就允许将相关的操作编写在同⼀个控制器类中,从⽽减少控制器类的数量,⽅便以后维护.
2.基于注解的控制器不需要在配置⽂件中部署映射,仅需要使⽤@RequestMapping注解⼀个⽅法进⾏请求处理即可.
下⾯介绍Spring MVC 中最重要的两个注解类型:@Controller和@RequestMapping.
Controller注解
@Controller注解⽤于声明某类的实例是⼀个控制器.例如,在ller包中创建控制器类IndexController,⽰例代码如下
package ller;
importorg.springframework.stereotype.Controller;
@Controller
public class IndexController{
// 处理请求的⽅法
}
Spring MVC使⽤扫描机制到应⽤中所有基于注解的控制器类,所以,为了让控制器类被Spring MVC框架扫描到,需要在配置⽂件中声明spring-context,并使⽤<context:component-scan/>元素指定控制器类的基本包
例如,在springmvcDemo应⽤的配置⽂件l中添加⼀下代码:
<!-- 使⽤扫描机制扫描控制器类,控制器类都在ller包及其⼦包下 -->
<context:component-scan base-package="ller"/>
RequestMapping注解
⼀个控制器内有多个处理请求的⽅法,如UserController⾥通常有增加⽤户,修改⽤户信息,删除指定⽤户,根据条件获取⽤户列表等.每个⽅法负责不同的请求操作,⽽@RequestMapping就负责将请求映射到对应的控制器⽅法上.
在基于注解的控制器类中可以为每个请求编写对应的处理⽅法.使⽤@RequestMapping注解将请求与处理⽅法⼀⼀对应即可.
@RequestMapping注解可⽤于类或⽅法上.⽤于类上,表⽰类中的所有响应请求的⽅法都以该地址作为⽗路径.
@RequestMapping注解常⽤属性如下:
1.value属性
value属性是@RequestMapping注解的默认属性,因此如果只有value属性时,可以省略该属性名,如果有其它属性,则必须写上value属性名称.如下:
@RequestMapping(value = "toUser")
@RequestMapping("toUser")
path属性和value属性都⽤来作为映射使⽤.即@RequestMapping(value = ''toUser")和@RequestMapping(path="toUser")都能访问toUser()⽅法.
3.name属性
name属性相当于⽅法的注释,使⽅法更易理解.如@RequestMaping(value = "toUser",name = "获取⽤户信息").
method属性⽤于表⽰⽅法⽀持哪些HTTP请求.如果省略method属性,则说明该⽅法⽀持全部的HTTP请求
@RequestMapping(value = "toUser",method = "RequestMethod.GET")表⽰该⽅法只⽀持GET请求.也可指定多个HTTP请求,如
@RequestMapping(value = "toUser",method = {RequestMethod.GET,RequestMethod.POST}),说明该⽅法同时⽀持GET和POST请求.
5.params属性
params属性⽤于指定请求中规定的参数,代码如下.
@RequestMapping(value = "toUser",params = "type")
public String toUser(){
return "showUser";
}
@RequestMapping(value = "toUser",params = "type = 1")
public String toUser() {
return "showUser";
}
6.header属性
header属性表⽰请求中必须包含某些指定的header值.
consumer属性⽤于指定处理请求的提交内容类型(Content-Type),例如:application/json,text/html.如@RequestMapping(value = "toUser",consumes = "application/json").
8.produces属性
produces属性⽤于指定返回的内容类型,返回的内容类型必须是request请求头(Accept)中所包含的类型.如@RequestMapping(value = "toUser",produces = "application/json").
除此之外,produces属性还可以指定返回值的编码.如@RequestMapping(value = "toUser",produces = "application/json,charset = utf-8 "),表⽰返回utf-8编码.
使⽤@RequestMapping 来完成映射,具体包括4个⽅⾯的信息项:请求URL,请求参数,请求⽅法和请求头.
通过请求URL进⾏映射
⽅法级别注解的⽰例代码如下.
el表达式获取session中的值package ller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
@Controller
public class IndexController{
@RequestMapping(value="/index/login")
public String login(){
return"login";
}
@RequestMapping(value="/index/register")
public String register(){
return"register";
}
}
上述⽰例中有两个RequestMapping注解语句,它们都作⽤在处理⽅法上.在整个Web项⽬中,@RequestMapping映射的请求信息必须保证全局唯⼀.
⽤户可以使⽤如下URL访问login⽅法(请求处理⽅法),在访问login⽅法之前需要事先在/WEB-INF/jsp/⽬录下创建login.jsp
2)类级别注解
类级别注解代码如下
package ller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
@Controller
@RequestMapping("/index")
public class IndexController{
@RequestMapping("/login")
public String login(){
return"login";
}
@RequestMapping("/register")
public String register(){
return"register";
}
}
在类级别注解的情况下,控制器类中的所有⽅法都将映射为类级别的请求。⽤户可以使⽤如下 URL 访问 login ⽅法。
为了⽅便维护程序,建议开发者采⽤类级别注解,将相关处理放在同⼀个控制器类中。例如,对⽤户的增、删、改、查等处理⽅法都可以放在UserController 控制类中。
通过请求参数、请求⽅法进⾏映射
@RequestMapping 除了可以使⽤请求 URL 映射请求之外,还可以使⽤请求参数、请求⽅法来映射请求,通过多个条件可以让请求映射更加精确。
package ller;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
@Controller
public class IndexController{
@RequestMapping(value="/index/success"method=RequestMethod.GET,Params="username")
public String success(@RequestParamString username){
return"index";
}
上述代码中,@RequestMapping 的 value 表⽰请求的 URL;method 表⽰请求⽅法,此处设置为 GET 请求,若是 POST 请求,则⽆法进⼊success 这个处理⽅法中。params 表⽰请求参数,此处参数名为 username。
编写请求处理⽅法
在控制类中每个请求处理⽅法可以有多个不同类型的参数,以及⼀个多种类型的返回结果.
1)请求处理⽅法中常出现的参数类型
如果需要在请求处理⽅法中使⽤Servlet API类型,那么可以将这些类型作为请求处理⽅法的参数类型.Servlet API参数类型的⽰例代码如下:
package ller;
import javax.servlet.http.HttpSession;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
@Controller
@RequestMapping("/index")
public class IndexController{
@RequestMapping("/login")
public String login(HttpSession session,HttpServletRequest request){
session.setAttribute("skey","session范围的值");
session.setAttribute("rkey","request范围的值");
return"login";
}
}
除了Servlet API参数类型以外,还有输⼊输出流,表单实体类,注解类型,与Spring框架相关的类型等,这些类型在后续章节中使⽤时再详细介绍.
其中特别重要的类型是org.springframework.ui.Model类型,该类型是⼀个包含Map的Spring MVC类型.在每次调⽤请求处理⽅法时 Spring MVC都将创建org.springframework.ui.Model对象.Model参数类型的⽰例代码如下:
ller;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
@Controller
@RequestMapping("/index")
public class IndexController{
@RequestMapping("/register")
public String register(Model model){
/*在视图中可以使⽤EL表达式${success}取出model中的值*/
model.addAttribute("success","注册成功");
return"register";
}
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论