SpringMVC 常用注解

1、@Controller

@Controller 用于標(biāo)記在一個類上，使用它標(biāo)記的類就是一個SpringMVC Controller 對象。分發(fā)處理器將會掃描使用了該注解的類的方法，并檢測該方法是否使用了@RequestMapping 注解。@Controller 只是定義了一個控制器類，而使用@RequestMapping 注解的方法才是真正處理請求的處理器。

@Controller 標(biāo)記在一個類上還不能真正意義上的說它就是SpringMVC 的一個控制器類，因為這個時候Spring 還不認識它。這個時候就需要我們把這個控制器類交給Spring 來管理。有兩種方式可以管理：

<!--方式一--> <bean class="com.cqvie.handler.HelloWorld"/> <!--方式二--> < context:component-scan base-package = "com.cqvie" /> <!-- 路徑寫到controller的上一層 -->

此外Controller 不會直接依賴于HttpServletRequest 和HttpServletResponse 等HttpServlet 對象，它們可以通過Controller 的方法參數(shù)靈活的獲取到。為了先對Controller 有一個初步的印象，以下先定義一個簡單的Controller ：

package com.cqvie.handler; import org.springframework.stereotype.Controller; @Controller public class HelloWorld {     @RequestMapping("/helloworld")     public String sayHello() {         System.out.println("Hello World!");         return "success";     }      }

2、@RequestMapping

　　RequestMapping是一個用來處理請求地址映射的注解，可用于類或方法上。用于類上，表示類中的所有響應(yīng)請求的方法都是以該地址作為父路徑。

返回值會通過視圖解析器解析為實際的物理視圖，對于 InternalResourceViewResolver 視圖解析器，會做如下的解析：

　　　　通過 prefix + returnVal + suffix 這樣的方式得到實際的物理視圖，然后做轉(zhuǎn)發(fā)操作；

<!-- 配置視圖解析器：如何把 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

value：指定請求的實際地址；

2)、method；

method： 指定請求的method類型， GET、POST、PUT、DELETE等，下面例子的@PathVariable后面講解：

/**      * Rest 風(fēng)格的 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

consumes： 指定處理請求的提交內(nèi)容類型（Content-Type），例如application/json, text/html;

4)、produces

produces: 指定返回的內(nèi)容類型，僅當(dāng)request請求頭中的(Accept)類型中包含該指定類型才返回；

5)、params

params： 指定request中必須包含某些參數(shù)值是，才讓該方法處理。

6)、headers

headers： 指定request中必須包含某些指定的header值，才能讓該方法處理請求。

@RequestMapping("/helloword/?/aa") 的 Ant 路徑,匹配符：

● ?：匹配文件名的一個字符

● *：匹配文件名的所有字符

● **：匹配多層路徑

@RequestMapping("/testPojo") POJO類用法：

@RequestMapping("/testPojo")     public String testPojo(User user) {         System.out.println("testPojo:" + user);         return "success";     } 　　@RequestMapping("/testPojo") Map用法： 　　@RequestMapping("/testMap")     public String testMap(Map<String, Object> map) {         map.put("names", Arrays.asList("Tomcat", "Eclipse", "JavaEE"));         return "success";     } 　　@RequestMapping("/testPojo") ModelAndView用法： 　　@RequestMapping("/testModelAndView")     public ModelAndView testModelAndView() {         String viewName = SUCCESS;         ModelAndView modelAndView = new ModelAndView(viewName);         modelAndView.addObject("time", new Date());         return modelAndView;     }

3、@Resource和@Autowired

　　@Resource和@Autowired都是做bean的注入時使用，其實@Resource并不是Spring的注解，它的包是javax.annotation.Resource，需要導(dǎo)入，但是Spring支持該注解的注入。

1)、共同點

兩者都可以寫在字段和setter方法上。兩者如果都寫在字段上，那么就不需要再寫setter方法。

2)、不同點

（1）@Autowired

@Autowired為Spring提供的注解，需要導(dǎo)入包org.springframework.beans.factory.annotation.Autowired;只按照byType注入。

public class HelloWorld{     // 下面兩種@Autowired只要使用一種即可     @Autowired     private UserDao userDao; // 用于字段上          @Autowired     public void setUserDao(UserDao userDao) { // 用于屬性的方法上         this.userDao = userDao;     } }

@Autowired注解是按照類型（byType）裝配依賴對象，默認情況下它要求依賴對象必須存在，如果允許null值，可以設(shè)置它的required屬性為false。如果我們想使用按照名稱（byName）來裝配，可以結(jié)合@Qualifier注解一起使用。如下：

public class HelloWorld{  　　@Autowired  　　@Qualifier("userDao")  　　private UserDao userDao;  }

（2）@Resource

@Resource默認按照ByName自動注入，由J2EE提供，需要導(dǎo)入包javax.annotation.Resource。@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方法上，因為這樣更符合面向?qū)ο蟮乃枷?，通過set、get去操作屬性，而不是直接去操作屬性。

4、@PathVariable

用于將請求URL中的模板變量映射到功能處理方法的參數(shù)上，即取出uri模板中的變量作為參數(shù)。如：

@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中的值；

參數(shù)： value：參數(shù)名稱 required：是否必須 defaultValue：默認值

使用案例：

/**      * 獲取 Session      * JSESSIONID=411A032E02A2594698F6E3F4458B9CE4      */     @RequestMapping("/testCookieValue")     public String testCookieValue(@CookieValue("JSESSIONID") String sessionId) {         System.out.println("JSESSIONID = " + sessionId);         return "success";     }

6、@RequestParam

@RequestParam用于將請求參數(shù)區(qū)數(shù)據(jù)映射到功能處理方法的參數(shù)上，用例：

/**      * @RequestParam("id") 帶參映射      * @param id      * @return      */     @RequestMapping("/testRequestParam")     public String testRequestParam(@RequestParam("id") int id) {         System.out.println("testRequestParam  " + id);         return "success";     }

7、@SessionAttributes

@SessionAttributes即將值放到session作用域中，寫在class上面。　　

@SessionAttributes 除了可以通過屬性名指定需要放到會話中的屬性外（value 屬性值），

還可以通過模型屬性的對象類型指定哪些模型屬性需要放到會話中（types 屬性值）,用例：

package com.cqvie.yjq; import java.util.Map; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.SessionAttributes; import com.cqvie.model.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", "重慶");         return "success";     } }

8、@ModelAttribute

代表的是：該Controller的所有方法在調(diào)用前，先執(zhí)行此@ModelAttribute方法，可用于注解和方法參數(shù)中，可以把這個@ModelAttribute特性，應(yīng)用在BaseController當(dāng)中，所有的Controller繼承BaseController，即可實現(xiàn)在調(diào)用Controller時，先執(zhí)行@ModelAttribute方法。

package com.cqvie.yjq; import java.util.Map; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.ModelAttribute; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestParam; import com.cqvie.model.User; @Controller @RequestMapping("/springmvc") public class ModelAttributeTest {     private static final String SUCCESS = "success";          /**      * 1.有 @ModelAttribute 標(biāo)記的方法，會在每個目標(biāo)方法執(zhí)行之前被 SpringMVC 調(diào)用      * 2.@ModelAttribute注解也可以修飾目標(biāo)方法POJO類形的入?yún)?，其value的屬性值有如下作用：      *     1）SpringMVC會使用value屬性值在implicitModel中查找對應(yīng)的對象，若存在則直接傳入到目標(biāo)方法的入?yún)⒅?     *     2）SpringMVC會以value為key,POJO類型的對象為value，存入的request中      *       * @param id      * @param map      */     @ModelAttribute     public void getUser(@RequestParam(value = "id", required = false) int id,             Map<String, Object> map) {         //模擬數(shù)據(jù)庫中獲取對象         User user = new User(1, "劉邦", "123", "023", "重慶");         System.out.println("從數(shù)據(jù)庫中獲取一個對象：" + user);         map.put("abc", user);     }          /**      * 運行流程：      *         1.執(zhí)行@ModelAttribute注解修飾的方法，從數(shù)據(jù)庫中取出對象，把對象放入Map中，鍵為：user；      *         2.SpringMVC從Map中取出User對象，并把表單的請求參數(shù)賦值給該User對象的對應(yīng)屬性；      *         3.SpringMVC把上述對象傳入目標(biāo)方法的參數(shù)。      *       * 注意：在@ModelAttribute修飾的方法中，放入到Map時的鍵需要和目標(biāo)方法入?yún)㈩愋偷牡谝粋€字母小寫的字符串一致      *       * @param user      * @return      */     @RequestMapping("/testModelAttribute")     public String testModelAttribute(@ModelAttribute("abc") User user) {         System.out.println("修改：" + user);         return SUCCESS;     } }

9、@ResponseBody　

作用： 該注解用于將Controller的方法返回的對象，通過適當(dāng)?shù)腍ttpMessageConverter轉(zhuǎn)換為指定格式后，寫入到Response對象的body數(shù)據(jù)區(qū)。

使用時機：返回的數(shù)據(jù)不是html標(biāo)簽的頁面，而是其他某種格式的數(shù)據(jù)時（如json、xml等）使用；

本文來自php中文網(wǎng)，java教程欄目，歡迎學(xué)習(xí)！