SpringMVC常⽤注解及其作⽤整理
1. @Controller
该注解⽤于标记在⼀个类上，使⽤它标记的类就是⼀个SpringMVC的Controller对象。⽤于分发处理器将会扫描使⽤了该注解的类的⽅法，并检测该⽅法是否使⽤了 @RequestMapping 注解。@Controller 注解只是定义了⼀个控制器类，⽽使⽤ @RequstMapping 注解的⽅法才是真正处理请求的处理器。
@Contoller 标记在⼀个类上还不能真正意义上说它就是SpringMVC的⼀个控制器，还需要将其交给Spring容器来进⾏管理：
<!--⽅式⼀-->
<bean class="com.cqvie.handler.HelloWorld"/>
<!--⽅式⼆-->
< context:component-scan base-package = "com.sztxtech" /> <!-- 路径写到controller的上⼀层 -->
此外，Controller 不会直接依赖于 HttpServletRequest 和 HttpServletResponse 等 HttpServlet 对象，它们可以通过
Controller 的⽅法参数灵活的获取到。
2. @RequestMapping
该注解是⼀个⽤来处理请求地址映射的注解，可⽤于类或⽅法上。⽤于类上，表⽰类中的所有⽅法的请求都是以该地址作为⽗路径的。
返回值会通过视图解析器解析为实际的物理视图，对于 InternalResourceViewResolver 视图解析器，会做如下的解析：通过 prefix + returnVal + suffix 这样的⽅式得到实际的物理视图，然后做转发操作。
<!-- 配置视图解析器：如何把 handler ⽅法返回值解析为实际的物理视图 -->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<property name="prefix" value="/WEB-INF/views/"></property>
<property name="suffix" value=".jsp"></property>
</bean>
RequestMapping 注解有以下属性：
(1) value ：指定请求的实际地址；
(2) method：指定请求的⽅法类型，包括 GET、POST、PUT、DELETE 等；
/**
* Rest 风格的 URL（以 CRUD 为例）：
*        新增：/order POST
*        修改：/order/1 PUT
*        获取：/order/1 GET
*        删除：/order/1 DELETE
* @param id
* @return
*/
@RequestMapping(value = "/testRestPut/{id}", method = RequestMethod.PUT)
public String testRestPut(@PathVariable int id) {
System.out.println("testRestPut:" + id);
return SUCCESS;
}
@RequestMapping(value = "/testRestDelete/{id}", method = RequestMethod.DELETE)
public String testRestDelete(@PathVariable int id) {
System.out.println("testRestDelete:" + id);
return SUCCESS;
}
@RequestMapping(value = "/testRestPost/{id}", method = RequestMethod.POST)
public String testRestPost(@PathVariable int id) {
System.out.println("testRestPost:" + id);
return SUCCESS;
}
@RequestMapping("/testRestGet")
public String testRestGet() {
System.out.println("testRestGet");
return SUCCESS;
}
(3) consumes：指定处理请求的提交内容类型（Content-Type）；例如，application/json,text/html。
(4) produces：指定返回的内容类型，仅当 request 请求头中的（Accept）类型中包含该指定类型才返回；
(5) params：指定 request 中必须包含某些参数值时，才让该⽅法处理此 request 请求；
(6) headers：指定 request 中必须包含某些指定的 header 值，才能让该⽅法处理此 request 请求；
@RequestMapping("/hello/?/xxx") 的 Ant 路径，匹配符：
：匹配⽂件名的⼀个字符；
* ：匹配⽂件名的所有字符；
** ：匹配多层路径；
@RequestMapping("/testPojo") POJO类⽤法：
@RequestMapping("/testPojo")
public String testPojo(User user){
System.out.println("test Pojo : " + user);
return "success";
}
@RequestMapping("/testPojo") Map⽤法：
@RequestMapping("/testMap")
public String testPojo(Map<String, Object map){
map.put("names", Arrays.asList("Jack", "James", "Tom"));
return "success";
}
@RequestMapping("/testPojo") ModelAndView⽤法：
@RequestMapping("/testModelAndView")
public String testModelAndView(){
String viewName = SUCCESS;
ModelAndView modelAndView = new ModelAndView(viewName);
modelAndView.addObject("time", new Date());
return modelAndView;
}
3. @Resource 和 @Autowired
这两个注解都是做 bean 的注⼊时使⽤的，实际上 @Resource 并不是 Spring 的注解，它的包是 javax.annontation.Resource，需要导⼊；但是Spring⽀持该注解的注⼊。
⼆者在使⽤上的异同点⽐较如下：
(1) 相同点： 都可以写在属性和setter()⽅法上。若⼆者都写着属性上，那么就不需要再写 setter() ⽅法了。
(2) 不同点：
@Autowired 是Spring提供的注解，所在包：org.springframework.beans.factory.annotation.Autowired；
public class HelloWorld{
// 下⾯两种@Autowired只要使⽤⼀种即可
@Autowired
private UserDao userDao; // ⽤于字段上
@Autowired
public void setUserDao(UserDao userDao) { // ⽤于属性的⽅法上
this.userDao = userDao;
}
}
@Autowired 注解是按照类型（byType）装配依赖对象的，默认情况下它要求依赖对象必须存在，如果允许 null 值，可以设置它的required 属性为 false。如果想使⽤按照名称（buName）来装配，可以结合 @Qualifier 注解⼀起使⽤。例如：
public class Helloworld{
@Autowired
@Qualifier("userDao")
private UserDao userdao;
}
@Resource 注解默认按照 byName ⾃动注⼊，由J2EE提供，所在包：javax.annotation.Resource；该注解有两个重要的属性：name 和 type；⽽Spring将 @Resource 注解的 name 属性解析为 bean 的名字，⽽ type 属性则被解析为 bean 的类型。所以，如果使⽤ name 属性，则使⽤ byName 的⾃动注⼊策略，⽽使⽤ type 属性时则使⽤ byType ⾃动注⼊策略。如果既不指定 name 也不指定type 属性，这时将通过反射机制使⽤ byName ⾃动注⼊策略。
public class HelloWorld{
// 下⾯两种@Resource只要使⽤⼀种即可
@Resource(name="userDao")
private UserDao userDao; // ⽤于字段上
@Resource(name="userDao")
public void setUserDao(UserDao userDao) { // ⽤于属性的setter⽅法上
this.userDao = userDao;
}
}
备注：最好是将 @Resource 放在 setter() ⽅法上，因为这样更符合⾯向对象的思想，通过set、get 去操作属性，⽽不是直接去操作属性。
4. @PathVariable
该注解⽤于将请求 URL 中的模板变量映射到功能处理⽅法的参数上，即取出 url 模板中的变量作为参数。例如：
@Controller
public class TestController {
@RequestMapping(value="/user/{userId}/roles/{roleId}",method = RequestMethod.GET)
public String getLogin(@PathVariable("userId") String userId,
@PathVariable("roleId") String roleId){
System.out.println("User Id : " + userId);
System.out.println("Role Id : " + roleId);
return "hello";
}
@RequestMapping(value="/product/{productId}",method = RequestMethod.GET)
public String getProduct(@PathVariable("productId") String productId){
System.out.println("Product Id : " + productId);
return "hello";
}
@RequestMapping(value="/javabeat/{regexp1:[a-z-]+}",
method = RequestMethod.GET)
public String getRegExp(@PathVariable("regexp1") String regexp1){
System.out.println("URI Part 1 : " + regexp1);
return "hello";
}
}
5. @CookieValue
该注解⽤于获取Cookie 中的值；该注解有以下属性：value：参数名称；required：是否必须；defaultValue：默认值。
/**
* 获取 Session
* JSESSIONID=411A032E02A2594698F6E3F4458B9CE4
*/
@RequestMapping("/testCookieValue")
public String testCookieValue(@CookieValue("JSESSIONID") String sessionId) {
System.out.println("JSESSIONID = " + sessionId);
return "success";
}
6. @RequestParam
该注解⽤于将请求参数区的数据映射到功能处理⽅法的参数上。例如：
/
**
* @RequestParam("id") 带参映射
* @param id
* @return
*/
@RequestMapping("/testRequestParam")
public String testRequestParam(@RequestParam("id") int id) {
System.out.println("testRequestParam  " + id);
return "success";
}
7. @SessionAttribute
该注解⽤于将值放到 session 作⽤域中，写在 class 上⾯。该注解除了可以通过属性名指定需要放到绘画中的属性外（value属性值），还可以通过模型属性的对象类型指定那些模型属性需要放到会话中（type属性值）；例如：
import java.util.Map;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.SessionAttributes;
import del.User;
@SessionAttributes(value = {"user"}, types = {String.class})
@RequestMapping("/springmvc")
@Controller
public class SessionAttributesTest {
/**
* @SessionAttributes
*        除了可以通过属性名指定需要放到会话中的属性外（value 属性值），
*        还可以通过模型属性的对象类型指定哪些模型属性需要放到会话中（types 属性值）。
* 注意：该注解只能放在类的上⾯，不能放在⽅法上⾯
*
* @return
*/
@RequestMapping("/testSessionAttributes")
public String testSessionAttributes(Map<String, Object> map) {
User user = new User(1, "刘邦", "qwe", "123", "辽宁");
map.put("user", user);
map.put("school", "重庆");
resource和autowired注解的区别
return "success";
}
}
8. @ModelAttribute
该注解表⽰的是：该 Controller 的所有⽅法在调⽤前，先执⾏ @ModelAttribute ⽅法，可⽤于注解和⽅法参数中，可以把这个
@ModelAttribute 特性应⽤在 BaseController 类当中，所有的 Controller 继承 BaseController 类，即可实现在调⽤ Controller 时，先执⾏ @ModelAttribute ⽅法。

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。