常用注解
一、RequestParam
1). 使用说明
把请求中指定名称的参数给控制器中的形参赋值。
2). 属性
-
value: 请求参数中的名称 -
required: 请求参数中是否必须提供此参数。默认值：true、表示必须提供，如果不提供将报错。
3). 使用示例
- jsp核心代码
<%-- requestParams注解的使用 --%>
requestParam注解
- 控制器代码
@Controller
@RequestMapping("/springmvc")
public class AnnotationTestController {
/** requestParams注解的使用 */
@RequestMapping("/useRequestParam")
public String useRuquestParam(@RequestParam("name") String username,
@RequestParam(value = "age", required = false) Integer age) {
System.out.println(username);
System.out.println(age);
return "success";
}
}
二、RequestBody
1). 作用
用于获取请求体内容。直接使用得到的是key=value&key=value...结构的数据。
get请求方式不适用
2). 属性
-
required: 是否必须有请求体。默认值是：true。当取值为true时，get请求方式会报错。
如果取值为false,get请求得到的是null,所以 此注解不适合get请求方式
3). 使用示例
- jsp代码
<%-- requestBody注解 --%>
- 控制器代码
@Controller
@RequestMapping("/springmvc")
public class AnnotationTestController {
/** RequestBody注解 */
@RequestMapping("/useRequestBody")
public String useRequestBody(@RequestBody(required = false) String body) {
System.out.println(body);
return "success";
}
}
三、PathVariable
1). 使用说明
用于绑定url中的占位符。例如，请求url中
/delete/{id},这个{id}就是url占位符。url支持占位符是spring3.0之后加入的。是springMVC支持rest风格URL得到一个重要标志。
2). 属性
-
value: 指定url中占位符名称 -
required: 是否必须提供占位符。
3). 使用案例
- jsp代码
<%-- PathVariable注解 --%>
PathVarable注解
- 控制器代码
@Controller
@RequestMapping("/springmvc")
public class AnnotationTestController {
/** PathVariable注解 */
@RequestMapping("/usePathVariable/{id}")
public String usePathVariable(@PathVariable("id") Integer id) {
System.out.println(id);
return "success";
}
}
4). REST风格URL
Representational State Transfer,描述了一个架构样式的网络系统;REST并没有一个明确的标准，而更像是一种设计的风格
1. 优点
结构清晰、符合标准、易于理解、扩展方便，所以正得到越来越多网站的采用
2. 特性
- 资源(Resources): 网络上的一个实体，或者说是网络上的一个具体信息；可以是一段文本、一张图片、一首歌曲、一种服务，总之就是一个具体的存在。可以用一个 URI（统一资源定位符）指向它，每种资源对应一个特定的 URI；获取这个资源，访问它的 URI 就可以，因此URI即为每一个资源的独一无二的识别符
- 表现层(Representation): 把资源具体呈现出来的形式;比如，文本可以用 txt 格式表现，也可以用 HTML 格式、XML 格式、JSON 格式表现，甚至可以采用二进制格式。
- 状态转化(State Transfer): 每发出一个请求，就代表了客户端和服务器的一次交互过程。 HTTP 协议里面，四个表示操作方式的动词： GET、 POST、 PUT、DELETE。它们分别对应四种基本操作： GET 用来获取资源， POST 用来新建资源， PUT 用来更新资源， DELETE 用来删除资源。restfu
3. restful示例
| url | 提交方式 | 含义 |
|---|---|---|
/account/1 |
HTTP GET | 得到id = 1的account |
/account/1 |
HTTP DELETE | 删除id = 1的account |
/account/1 |
HTTP PUT | 更新id = 1的account |
/account |
HTTP POST | 新增account |
5). 基于HiddenHttpMethodFilter的示例【了解】
演示中浏览器可能会错，是应为浏览器暂时不支持这些方法
1. 作用
浏览器form表单只支持GET与POST请求，而 DELETE、PUT 等 method 并不支持，Spring3.0 添加了一个过滤器，可以将浏览器请求改为指定的请求方式，发送给我们的控制器方法，使得支持 GET、POST、PUT与 DELETE 请求
2. 使用步骤
- 在web.xml中配置该过滤器。
- 请求方式必须使用post请求。
- 按照要求提供_method请求参数，该参数的取值就是我们需要的请求方式。
HiddenHttpMethodFilter源码分析.png
3. 配置及其代码
- web.xml
hiddenHttpMethodFilter
org.springframework.web.filter.HiddenHttpMethodFilter
hiddenHttpMethodFilter
/*
- jsp代码
<%-- HiddenHttpMethodFilter --%>
<%-- 更新 --%>
- 控制器代码
@Controller
@RequestMapping("/springmvc")
public class AnnotationTestController {
/** PUT请求:更新 */
@RequestMapping(value = "testRestPUT/{id}", method = RequestMethod.PUT)
public String testRestfulURLPUT(@PathVariable("id")Integer id) {
System.out.println(id);
return "success";
}
/** DELETE请求:删除 */
@RequestMapping(value = "testRestDELETE/{id}", method = RequestMethod.DELETE)
public String testRestfulDELETE(@PathVariable("id") Integer id) {
System.out.println(id);
return "success";
}
}
四、RequestHeader【一般不用】
1). 使用说明
获取请求消息头，实际开发中一般不用。
2). 属性
-
value: 提供消息头名称 -
required: 是否必须有此消息头
3). 使用示例
- jsp核心代码
<%-- RequestHeader注解 --%>
获取请求消息头
- 控制器代码
@Controller
@RequestMapping("/springmvc")
public class AnnotationTestController {
/** RequestHeader注解 */
@RequestMapping("/useRequestHeader")
public String useRequestHeader(@RequestHeader(value = "Accept-Language",
required = false)String requestHeader) {
System.out.println(requestHeader);
return "success";
}
}
五、CookieValue
1). 使用说明
把指定cookie名称的值传入控制器方法参数。
2). 属性
-
value: 指定cookie的名称 -
required: 是否必须有此cookie
3). 使用案例
- jsp代码
<%-- CookieValue注解 --%>
绑定cookie的值
- 控制器核心代码
@Controller
@RequestMapping("/springmvc")
public class AnnotationTestController {
/** CookieValue */
@RequestMapping("/useCookieValue")
public String useCookieValue(
@CookieValue(value="JSESSIONID", required = false)
String cookieValue) {
System.out.println(cookieValue);
return "success";
}
}
六、ModelAttribute
1). 使用说明
该注解是SpringMVC4.3版本以后加入的。可以用来修饰方法和参数。
- 出现在方法上，表示当前方法会在控制器的方法执行前先执行。有无返回值的方法都可以被修饰。
- 出现在参数上，获取指定的数据给参数赋值。
2). 属性
-
value: 用于获取数据的key。key可以是pojo的属性名称，也可以是map结构的key。
3). 应用场景
当表单提交数据不是完整的实体类数据时，保证没有提交数据的字段使用数据库对象原来的数据。例如，我们在编辑一个用户时，用户有一个信息字段，该字段的值是不允许被修改的。在提交表单数据时肯定没有此字段的内容，一旦跟新会把该字段内容置为null,此时就可使用此注解解决问题。
4). 基于POJO的应用场景I：ModelAttribute修饰方法不带返回值
- jsp
<%-- ModelAttribute注解的基本使用 --%>
测试
- 控制器代码
@Controller
@RequestMapping("/springmvc")
public class AnnotationTestController {
/** 被ModelAttribute修饰的方法，在控制器【所有的】执行前执行 */
@ModelAttribute
public void showModel(User user) {
System.out.println("ModelAttribute: " + user.getUsername());
}
/** 接收请求的方法 */
@RequestMapping("/testModelAttribute")
public String testModelAttribute(User user) {
System.out.println("Controller: " + user.getUsername());
return "success";
}
}
5). 基于POJO的应用场景II：ModelAttribute修饰方法带返回值
例如，有个需求，修改用户信息，比如根据用户名修改年龄，但是用户的密码不能被修改；ModelAttribute注解的底层会保留从数据库查询的对应信息，在封装时从请求数据中读取到null,不会覆盖之前查询的字段！控制器中拿到的对应字段就不是null值了。
- jsp
<%-- 修改用户信息 --%>
- 控制器
@Controller
@RequestMapping("/springmvc")
public class AnnotationTestController {
/** 模拟取数据库查询数据 */
private User findUserByName(String username) {
User user = new User();
user.setUsername(username);
user.setAge(19);
user.setPassword("abc123");
return user;
}
/** 查询数据库中的信息 */
@ModelAttribute
public User showModel(String username) {
// 模拟取数据库查询
User abc = findUserByName(username);
System.out.println("执行了ModelAttribute查询: " + abc );
return abc;
}
/** 模拟修改用户的方法 */
@RequestMapping("/updateUser")
public String testModelAttribute(User user) {
System.out.println("控制器中修改了用户，模拟持久化:" + user);
return "success";
}
}
6). 基于Map的应用场景实例I：ModelAttribute修饰方法不带返回值
需求与上一个案例一样
- jsp
<%-- 修改用户信息 --%>
- 控制器代码
@Controller
@RequestMapping("/springmvc")
public class AnnotationTestController {
/** 模拟取数据库查询数据 */
private User findUserByName(String username) {
User user = new User();
user.setUsername(username);
user.setAge(19);
user.setPassword("abc123");
return user;
}
/** 模拟查询数据库中用户的信息 */
@ModelAttribute
public void showModel(String username, Map map) {
// 模拟去数据库查询
User user = findUserByName(username);
System.out.println("ModelAttribute 查询了数据库：" + user);
map.put("abc", user);
}
/** 模拟持久化用户 */
@RequestMapping("/updateUser")
public String testModelAttribute(@ModelAttribute("abc")User user) {
System.out.println("控制器持久化用户：" + user);
return "success";
}
}
七、SessionAttribute
1). 功能
用于多次执行控制器方法间的参数共享，将数据存放到session域中，只能作用类上！
2). 属性
-
value: 用于指定存入的属性名称 -
type: 用于指定存入的数据类型
3). 使用案例
- jsp
<%-- SessionAttribute注解的使用 --%>
存入SessionAttribute
取出SessionAttribute
清除SessionAttribute
- 控制器代码
Model接口的实现类会将数据存放到request域中,而取数据要从ModelMap接口的实现类中取,SessionStatus接口实现类用于清除该session SpringMVC底层是传递的实现类，开发者在开发时使用多态调用接口方法即可； Model是spring提供的一个接口，该接口有一个实现类ExtendModelMap该类继承了ModelMap,而ModelMap就是LikedHashMap的子类。
/** SessionAttribute注解的使用 */
@Controller("sessionAttributeController")
@RequestMapping("/springmvc")
@SessionAttributes(value = {"username", "password"}, types = {Integer.class})
public class AnnotationTestController {
@RequestMapping("/testPut")
public String testPut(Model model) {
/* 跳转之前将数据保存到request域中，
* 由于类上又配置了@SessionAttribute注解，且变量名一样！
* 会将这些数据存入到session域中！ */
model.addAttribute("username", "切斯特尔");
model.addAttribute("password", "abc123");
model.addAttribute("age", 32);
return "success";
}
@RequestMapping("/testGet")
public String testGet(ModelMap model) {
System.out.println(model.get("username"));
System.out.println(model.get("password"));
System.out.println(model.get("age"));
return "success";
}
/** 清除该session */
@RequestMapping("/testClean")
public String complete(SessionStatus sessionStatus) {
/** 清除该session */
sessionStatus.setComplete();
return "success";
}
}