springMVC常用注解
@RequestMapping
作用:
用于建立请求 URL 和处理请求方法之间的对应关系。
属性:
value:用于指定请求的 URL。它和 path 属性的作用是一样的。
method:用于指定请求的方式。
params:用于指定限制请求参数的条件。它支持简单的表达式。要求请求参数的 key 和 value 必须和配置的一模一样。
headers:用于指定限制请求消息头的条件。
@RequestParam
作用:
把请求中指定名称的参数给控制器中的形参赋值。
属性:
value:请求参数中的名称。
required:请求参数中是否必须提供此参数。默认值:true。表示必须提供,如果不提供将报错。
@RequestBody
作用:
用于获取请求体内容。直接使用得到是 key=value&key=value...结构的数据。
get 请求方式不适用。
属性:
required:是否必须有请求体。默认值是:true。当取值为 true 时,get 请求方式会报错。如果取值为 false,get 请求得到是 null。
@PathVaribale
作用:
用于绑定 url 中的占位符。例如:请求 url 中 /delete/{id},这个{id}就是 url 占位符。
url 支持占位符是 spring3.0 之后加入的。是 springmvc 支持 rest 风格 URL 的一个重要标志。
属性:
value:用于指定 url 中占位符名称。
required:是否必须提供占位符。
@RequestHeader
作用:
用于获取请求消息头。
属性:
value:提供消息头名称
required:是否必须有此消息头
@CookieValue
作用:
用于把指定 cookie 名称的值传入控制器方法参数。
属性:
value:指定 cookie 的名称。
required:是否必须有此 cookie。
@ModelAttribute
作用:
该注解是 SpringMVC4.3 版本以后新加入的。它可以用于修饰方法和参数。出现在方法上,表示当前方法会在控制器的方法执行之前,先执行。它可以修饰没有返回值的方法,也可以修饰有具体返回值的方法。出现在参数上,获取指定的数据给参数赋值。
属性:
value:用于获取数据的 key。key 可以是 POJO 的属性名称,也可以是 map 结构的 key。
应用场景:
当表单提交数据不是完整的实体类数据时,保证没有提交数据的字段使用数据库对象原来的数据。
例如:
我们在编辑一个用户时,用户有一个创建信息字段,该字段的值是不允许被修改的。在提交表单数据是肯定没有此字段的内容,一旦更新会把该字段内容置为 null,此时就可以使用此注解解决问题。
REST 风格 URL:
什么是 rest:
REST(英文:Representational State Transfer,简称 REST)描述了一个架构样式的网络系统,比如 web 应用程序。它首次出现在 2000 年 Roy Fielding 的博士论文中,他是 HTTP 规范的主要编写者之一。在目前主流的三种 Web 服务交互方案中,REST 相比于 SOAP(Simple Object Access protocol,简单对象访问协议)以及 XML-RPC 更加简单明了,无论是对 URL 的处理还是对 Payload 的编码,REST 都倾向于用更加简单轻量的方法设计和实现。值得注意的是 REST 并没有一个明确的标准,而更像是一种设计的风格。它本身并没有什么实用性,其核心价值在于如何设计出符合 REST 风格的网络接口。
restful 的优点:
它结构清晰、符合标准、易于理解、扩展方便,所以正得到越来越多网站的采用。
restful 的特性:
资源(Resources):网络上的一个实体,或者说是网络上的一个具体信息。它可以是一段文本、一张图片、一首歌曲、一种服务,总之就是一个具体的存在。可以用一个 URI(统一资源定位符)指向它,每种资源对应一个特定的 URI 。要获取这个资源,访问它的 URI 就可以,因此 URI 即为每一个资源的独一无二的识别符。表现层(Representation):把资源具体呈现出来的形式,叫做它的表现层 (Representation)。
比如,文本可以用 txt 格式表现,也可以用 HTML 格式、XML 格式、JSON 格式表现,甚至可以采用二进制格式。
状态转化(State Transfer):每 发出一个请求,就代表了客户端和服务器的一次交互过程。HTTP 协议,是一个无状态协议,即所有的状态都保存在服务器端。因此,如果客户端想要操作服务器,必须通过某种手段,让服务器端发生“状态转化”(State Transfer)。而这种转化是建立在表现层之上的,所以就是 “表现层状态转化”。
具体说,就是 HTTP 协议里面,四个表示操作方式的动词:GET 、POST 、PUT、DELETE。
它们分别对应四种基本操作:
GET 用来获取资源,
POST 用来新建资源,
PUT 用来更新资源,
DELETE 用来删除资源。
restful 的示例:
/account/1
HTTP GET :得到 id = 1 的 account
/account/1
HTTP DELETE:删除 id = 1 的 account
/account/1
HTTP PUT:更新 id = 1 的 account
使用案例:
package com.yyj.controller; import com.yyj.domain.User; import org.springframework.stereotype.Controller; import org.springframework.ui.Model; import org.springframework.ui.ModelMap; import org.springframework.web.bind.annotation.*; import org.springframework.web.bind.support.SessionStatus; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import java.io.IOException; import java.util.Date; import java.util.Map; /** * 常用的注解 */ @Controller @RequestMapping("/anno") @SessionAttributes(value = {"msg"}) // 把msg=美美存入到session域对中 public class AnnoController { @RequestMapping("/testRequestParam") public String testRequestParam(@RequestParam(name = "name") String username) { System.out.println("执行了..."); System.out.println(username); return "success"; } /** * 获取到请求体的内容 * * @return */ @RequestMapping("/testRequestBody") public String testRequestBody(@RequestBody String body) { System.out.println("执行了..."); System.out.println(body); return "success"; } /** * PathVariable注解 * * @return */ @RequestMapping(value = "/testPathVariable/{sid}") public String testPathVariable(@PathVariable(name = "sid") String id) { System.out.println("执行了..."); System.out.println(id); return "success"; } /** * 获取请求头的值 * * @param header * @return */ @RequestMapping(value = "/testRequestHeader") public String testRequestHeader(@RequestHeader(value = "Accept") String header, HttpServletRequest request, HttpServletResponse response) throws IOException { System.out.println("执行了..."); System.out.println(header); // return "success"; // response.sendRedirect(request.getContextPath()+"/anno/testCookieValue"); return "redirect:/param.jsp"; } /** * 获取Cookie的值 * * @return */ @RequestMapping(value = "/testCookieValue") public String testCookieValue(@CookieValue(value = "JSESSIONID") String cookieValue) { System.out.println("执行了..."); System.out.println(cookieValue); return "success"; } /** * ModelAttribute注解 * * @return */ @RequestMapping(value = "/testModelAttribute") public String testModelAttribute(@ModelAttribute("abc") User user) { System.out.println("testModelAttribute执行了..."); System.out.println(user); return "success"; } @ModelAttribute public void showUser(String uname, Map<String, User> map) { System.out.println("showUser执行了..."); // 通过用户查询数据库(模拟) User user = new User(); user.setUname(uname); user.setAge(20); user.setDate(new Date()); map.put("abc", user); } /** * 该方法会先执行 @ModelAttribute public User showUser(String uname){ System.out.println("showUser执行了..."); // 通过用户查询数据库(模拟) User user = new User(); user.setUname(uname); user.setAge(20); user.setDate(new Date()); return user; } */ /** * SessionAttributes的注解 * * @return */ @RequestMapping(value = "/testSessionAttributes") public String testSessionAttributes(Model model) { System.out.println("testSessionAttributes..."); // 底层会存储到request域对象中 model.addAttribute("msg", "美美"); return "success"; } /** * 获取值 * * @param modelMap * @return */ @RequestMapping(value = "/getSessionAttributes") public String getSessionAttributes(ModelMap modelMap) { System.out.println("getSessionAttributes..."); String msg = (String) modelMap.get("msg"); System.out.println(msg); return "success"; } /** * 清除 * * @param status * @return */ @RequestMapping(value = "/delSessionAttributes") public String delSessionAttributes(SessionStatus status) { System.out.println("getSessionAttributes..."); status.setComplete(); return "success"; } }