spring mvc常用註解標籤

貼個廣告

樓主的博客已全部搬遷至自己的博客，感興趣的小夥伴請移步haifeiWu與他朋友們的博客專欄

@Controller

在SpringMVC 中，控制器Controller 負責處理由DispatcherServlet 分發的請求，它把用戶請求的數據經過業務處理層處理之後封裝成一個Model ，然後再把該Model 返回給對應的View 進行展示。

在SpringMVC 中提供了一個非常簡便的定義Controller的方法，你無需繼承特定的類或實現特定的接口，只需使用@Controller 標記一個類是Controller ，然後使用@RequestMapping 和@RequestParam 等一些註解用以定義URL 請求和Controller 方法之間的映射，這樣的Controller 就能被外界訪問到。

此外Controller 不會直接依賴於HttpServletRequest 和HttpServletResponse 等HttpServlet 對象，它們可以通過Controller 的方法參數靈活的獲取到。

@Controller 用於標記在一個類上，使用它標記的類就是一個SpringMVC Controller對象。分發處理器將會掃描使用了該註解的類的方法，並檢測該方法是否使用了@RequestMapping 註解。

@Controller只是定義了一個控制器類，而使用@RequestMapping註解的方法纔是真正處理請求的處理器。單單使用@Controller標記在一個類上還不能真正意義上的說它就是SpringMVC 的一個控制器類，因爲這個時候Spring還不認識它。

那麼要如何做Spring才能認識它呢？這個時候就需要我們把這個控制器類交給Spring 來管理。有兩種方式：

• 在SpringMVC 的配置文件中定義MyController 的bean 對象。

• 在SpringMVC 的配置文件中告訴Spring 該到哪裏去找標記爲@Controller 的Controller 控制器。

<!--方式一-->
<bean class="com.host.app.web.controller.MyController"/>
<!--方式二-->
< context:component-scan base-package = "com.host.app.web" /><!--路徑寫到controller的上一層(掃描包詳解見下面淺析)-->

@RequestMapping

RequestMapping是一個用來處理請求地址映射的註解，可用於類或方法上。用於類上，表示類中的所有響應請求的方法都是以該地址作爲父路徑。

RequestMapping註解有六個屬性，下面我們把她分成三類進行說明（下面有相應示例）。

value， method；

value： 指定請求的實際地址，指定的地址可以是URI Template 模式（後面將會說明）；

method： 指定請求的method類型， GET、POST、PUT、DELETE等；

consumes，produces

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

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

params，headers

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

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

@Resource和@Autowired

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

共同點

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

不同點

• @Autowired

@Autowired爲Spring提供的註解，需要導入包org.springframework.beans.factory.annotation.Autowired;只按照byType注入。

public class TestServiceImpl {
    // 下面兩種@Autowired只要使用一種即可
    @Autowired
    private UserDao userDao; // 用於字段上

    @Autowired
    public void setUserDao(UserDao userDao) { // 用於屬性的方法上
        this.userDao = userDao;
    }
}

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

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

• @Resource

@Resource默認按照ByName自動注入，由J2EE提供，需要導入包javax.annotation.Resource。@Resource有兩個重要的屬性：name和type，而Spring將@Resource註解的name屬性解析爲bean的名字，而type屬性則解析爲bean的類型。所以，如果使用name屬性，則使用byName的自動注入策略，而使用type屬性時則使用byType自動注入策略。如果既不制定name也不制定type屬性，這時將通過反射機制使用byName自動注入策略。

public class TestServiceImpl {
    // 下面兩種@Resource只要使用一種即可
    @Resource(name="userDao")
    private UserDao userDao; // 用於字段上

    @Resource(name="userDao")
    public void setUserDao(UserDao userDao) { // 用於屬性的setter方法上
        this.userDao = userDao;
    }
}

注： 最好是將@Resource放在setter方法上，因爲這樣更符合面向對象的思想，通過set、get去操作屬性，而不是直接去操作屬性。

@Resource裝配順序：

① 如果同時指定了name和type，則從Spring上下文中找到唯一匹配的bean進行裝配，找不到則拋出異常。

② 如果指定了name，則從上下文中查找名稱（id）匹配的bean進行裝配，找不到則拋出異常。

③ 如果指定了type，則從上下文中找到類似匹配的唯一bean進行裝配，找不到或是找到多個，都會拋出異常。

④ 如果既沒有指定name，又沒有指定type，則自動按照byName方式進行裝配；如果沒有匹配，則回退爲一個原始類型進行匹配，如果匹配則自動裝配。

@Resource的作用相當於@Autowired，只不過@Autowired按照byType自動注入。

@ModelAttribute和 @SessionAttributes

@ModelAttribute： 該Controller的所有方法在調用前，先執行此@ModelAttribute方法，可用於註解和方法參數中，可以把這個@ModelAttribute特性，應用在BaseController當中，所有的Controller繼承BaseController，即可實現在調用Controller時，先執行@ModelAttribute方法。

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

@PathVariable

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

@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";  
     }  
}

@requestParam

@requestParam主要用於在SpringMVC後臺控制層獲取參數，類似一種是request.getParameter(“name”)，它有三個常用參數：defaultValue = “0”, required = false, value = “isApp”；defaultValue 表示設置默認值，required 銅過boolean設置是否是必須要傳入的參數，value 值表示接受的傳入的參數類型。

@ResponseBody

作用： 該註解用於將Controller的方法返回的對象，通過適當的HttpMessageConverter轉換爲指定格式後，寫入到Response對象的body數據區。

使用時機：返回的數據不是html標籤的頁面，而是其他某種格式的數據時（如json、xml等）使用；

@Component

相當於通用的註解，當不知道一些類歸到哪個層時使用，但是不建議。

@Repository

用於註解dao層，在daoImpl類上面註解。