一、概述
使用基于注解的控制器具有以下2个优点:
- 基于注解的控制类中可以编写多个处理方法,进而可以处理多个请求动作,这就允许将相关的操作编写在同一个控制器类中,从而减少控制类的数量,方便维护。
- 基于注解的控制器不需要在配置文件中部署映射,仅需要使用@RequestMapping注解一个方法进行请求处理即可。
二、@Controller
@Controller用于声明某类的实例是一个控制器。
@Controller
public class IndexController {
//处理请求的方法
}
SpringMVC使用扫描机制找到应用中所有基于注解的控制类,所以,为了让控制器被SpringMVC框架扫描到,需要在配置文件中声明spring-context,并使用context:component-scan元素指定控制器类的基本包(确保所有控制器类都在基本包及其子包下)
在springmvc-servlet.xml中添加如下代码
<context:component-scan base-package="com.jsonliu.controller" />
三、@RequestMapping
一个可告知其内有多个处理请求方法,如UserController中通常有新增、修改、删除用户,根据条件获取用户列表等等。每个方法负责不同的请求处理,而@RequestMapping负责将请求映射到对应的控制器方法上。
@RequestMapping可用于类或者方法上,用于类上,表示类中的所有响应请求的方法都以该地址作为父路径。
3.1、value属性
value属性是@RequestMapping注解的默认属性,因此如果只有value属性时,可以省略该属性名,如果有其他属性,就必须写上value属性名。
@RequestMapping("addUser")
@RequestMapping(value="addUser")
value属性支持通配符,如:@RequestMapping(“addUser/*”)表示:http://localhost:8080/addUser/1; http://localhost:8080/addUser/jkm 都能方法addUser()方法。
3.2、path属性
path属性和value属性都是用来作为映射使用,@RequestMapping(value=“addUser”)和@RequestMapping(path=“addUser”)都能用来访问addUser()方法。
path和value属性一样也支持通配符。
3.3、name属性
name属性相当于方法的注释,使用方法:@RequestMapping(value=“addUser”,name=“添加用户”)
3.4、method属性
method属性用于表示该方法支持哪些HTTP类型请求,省略method属性,表示支持全部的HTTP请求类型。
@RequestMapping(value=“addUser”,method=RequestMethod.GET)表示该方法只支持GET请求。
@RequestMapping(value=“addUser”,method={RequestMethod.GET,RequestMethod.POST}),该方法同时支持GET和POST请求。
3.5、params属性
@RequestMapping(value="addUser",params = "type")
public String addUser(){
return "showUser";
}
@RequestMapping(value="addUser2",params = "type=2")
public String addUser2(){
return "showUser";
}
3.6、header属性
@RequestMapping(value=“addUser”,headers=“Referer=http://www.baidu.com”)表示请求header中必须包含指定的"Referer"请求头,而且值必须是"http://www.baidu.com"才能执行请求。
3.7、consumers属性
consumers属性用于指定处理请求的提交内容类型(Content-Type),例如:application/json、text/html。
3.8、produces属性
用于指定返回内容类型,但会内容类型必须是request请求头Accept中所包含的类型。如:@RequestMapping(value=“addUser”,produces=“application/json”)除此之外,produces属性还可以指定返回值的编码。如:@RequestMapping(value=“addUser”,produces=“application/json,charset=utf-8”)
四、通过请求URL映射
4.1、方法级别注解
@Controller
public class IndexController {
//处理请求的方法
@RequestMapping(value="/index/login")
public String login(){
return "login";
}
@RequestMapping(value="index/register")
public String register(){
return "register";
}
}
注意:在整个web项目中,@RequestMapping映射的请求信息必须保证全局唯一。
4.2、类级别注解
@Controller
@RequestMapping("/index")
public class IndexController {
//处理请求的方法
@RequestMapping(value="/login")
public String login(){
return "login";
}
@RequestMapping(value="/register")
public String register(){
return "register";
}
}
4.3、通过请求参数、方法进行映射
@RequestMapping除了可以使用URL映射请求之外,还可以使用参数、方法来映射请求。
@RequestMapping(value="/success",method= RequestMethod.GET,params="username")
public String success(@RequestParam String username){
return "index";
}
4.4、编写请求处理方法
1、请求处理方法中常出现的参数类型
ServletAPI类型:
@Controller
@RequestMapping("/index")
public class IndexController {
//处理请求的方法
@RequestMapping(value="/login")
public String login(HttpSession session, HttpServletRequest request){
session.setAttribute("skey","session值");
request.setAttribute("rkey","request值");
return "login";
}
}
Model类型:
@RequestMapping(value="/register")
public String register(Model model){
//在视图中可以使用EL表达式${key}取出model中的值
model.addAttribute("key","信息");
return "register";
}
2、请求处理方法常见的返回类型
- ModelAndView
- Model
- 包含模型属性的Map
- View
- 代表逻辑视图名的String
- void
- 其他任意Java类型
五、示例
5.1、web.xml
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
version="4.0">
<display-name>springMVC</display-name>
<!-- 部署 DispatcherServlet -->
<servlet>
<servlet-name>springmvc</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:springmvc-servlet.xml</param-value>
</init-param>
<!-- 表示容器再启动时立即加载servlet -->
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>springmvc</servlet-name>
<!-- 处理所有URL -->
<url-pattern>/</url-pattern>
</servlet-mapping>
</web-app>
5.2、springmvc-servlet.xml
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context
https://www.springframework.org/schema/context/spring-context.xsd
https://www.springframework.org/schema/mvc
https://www.springframework.org/schema/mvc/spring-mvc.xsd">
<context:component-scan base-package="com.jsonliu.controller"/>
<bean id="viewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<property name="prefix" value="/WEB-INF/jsp/" />
<property name="suffix" value=".jsp" />
</bean>
</beans>
5.3、User
public class User {
private String name;
private Integer id;
public User() {
}
public User(String name, Integer id) {
this.name = name;
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public Integer getId() {
return id;
}
public void setId(Integer id) {
this.id = id;
}
}
5.4、UserController
@Controller
@RequestMapping("/user")
public class UserController {
//处理请求的方法
@RequestMapping(value = "/login")
public String getLogin(Model model) {
User user = new User();
user.setName("JSONLiu");
model.addAttribute("user", user);
return "login";
}
@RequestMapping(value = "/register")
public String getRegister() {
return "register";
}
}
5.5、login.jsp
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
登录页面!欢迎您,${user.name}
</body>
</html>
5.6、register.jsp
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
注册页面!
</body>
</html>