SpringMVC學習(四)--常用註解標籤詳解

1、@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 來管理。有兩種方式：

　　（1）在SpringMVC 的配置文件中定義MyController 的bean 對象。

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

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

2、@RequestMapping

　　RequestMapping是一個用來處理請求地址映射的註解，可用於類或方法上。用於類上，表示類中的所有響應請求的方法都是以該地址作爲父路徑。
　　
　　RequestMapping註解有六個屬性，下面我們把她分成三類進行說明（下面有相應示例）。

1、 value， method；

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

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

2、consumes，produces

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

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

3、params，headers

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

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

3、@Resource和@Autowired

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

1、共同點

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

2、不同點

（1）@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; 
}

（2）@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自動注入。

4、@ModelAttribute和 @SessionAttributes

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

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

具體示例參見下面：使用 @ModelAttribute 和 @SessionAttributes 傳遞和保存數據

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

6、@requestParam

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

7、@ResponseBody

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

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

8、@Component

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

9、@Repository

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

注：
　　1、使用 @RequestMapping 來映射 Request 請求與處理器

　　方式一、通過常見的類路徑和方法路徑結合訪問controller方法

　　方式二、使用uri模板
　　

@Controller
@RequestMapping ( "/test/{variable1}" )
public class MyController {

    @RequestMapping ( "/showView/{variable2}" )
    public ModelAndView showView( @PathVariable String variable1, @PathVariable ( "variable2" ) int variable2) {
       ModelAndView modelAndView = new ModelAndView();
       modelAndView.setViewName( "viewName" );
       modelAndView.addObject( " 需要放到 model 中的屬性名稱 " , " 對應的屬性值，它是一個對象 " );
       return modelAndView;
    }
}

　　URI 模板就是在URI 中給定一個變量，然後在映射的時候動態的給該變量賦值。如URI 模板http://localhost/app/{variable1}/index.html ，這個模板裏面包含一個變量variable1 ，那麼當我們請求http://localhost/app/hello/index.html 的時候，該URL 就跟模板相匹配，只是把模板中的variable1 用hello 來取代。這個變量在SpringMVC 中是使用@PathVariable 來標記的。在SpringMVC 中，我們可以使用@PathVariable 來標記一個Controller 的處理方法參數，表示該參數的值將使用URI 模板中對應的變量的值來賦值。

　　代碼中我們定義了兩個URI 變量，一個是控制器類上的variable1 ，一個是showView 方法上的variable2 ，然後在showView 方法的參數裏面使用@PathVariable 標記使用了這兩個變量。所以當我們使用/test/hello/showView/2.do 來請求的時候就可以訪問到MyController 的showView 方法，這個時候variable1 就被賦予值hello ，variable2 就被賦予值2 ，然後我們在showView 方法參數裏面標註了參數variable1 和variable2 是來自訪問路徑的path 變量，這樣方法參數variable1 和variable2 就被分別賦予hello 和2 。方法參數variable1 是定義爲String 類型，variable2 是定義爲int 類型，像這種簡單類型在進行賦值的時候Spring 是會幫我們自動轉換的。

　　在上面的代碼中我們可以看到在標記variable1 爲path 變量的時候我們使用的是@PathVariable ，而在標記variable2 的時候使用的是@PathVariable(“variable2”) 。這兩者有什麼區別呢？第一種情況就默認去URI 模板中找跟參數名相同的變量，但是這種情況只有在使用debug 模式進行編譯的時候纔可以，而第二種情況是明確規定使用的就是URI 模板中的variable2 變量。當不是使用debug 模式進行編譯，或者是所需要使用的變量名跟參數名不相同的時候，就要使用第二種方式明確指出使用的是URI 模板中的哪個變量。

　　除了在請求路徑中使用URI 模板，定義變量之外，@RequestMapping 中還支持通配符“* ”。如下面的代碼我就可以使用/myTest/whatever/wildcard.do 訪問到Controller 的testWildcard 方法。如：
　　

@Controller
@RequestMapping ( "/myTest" )
public class MyController {
    @RequestMapping ( "*/wildcard" )
    public String testWildcard() {
       System. out .println( "wildcard------------" );
       return "wildcard" ;
    }  
}

當@RequestParam中沒有指定參數名稱時，Spring 在代碼是debug 編譯的情況下會默認取更方法參數同名的參數，如果不是debug 編譯的就會報錯。
2、使用 @RequestMapping 的一些高級用法

（1）params屬性

@RequestMapping (value= "testParams" , params={ "param1=value1" , "param2" , "!param3" })
    public String testParams() {
       System. out .println( "test Params..........." );
       return "testParams" ;
    }

　　用@RequestMapping 的params 屬性指定了三個參數，這些參數都是針對請求參數而言的，它們分別表示參數param1 的值必須等於value1 ，參數param2 必須存在，值無所謂，參數param3 必須不存在，只有當請求/testParams.do 並且滿足指定的三個參數條件的時候才能訪問到該方法。所以當請求/testParams.do?param1=value1&param2=value2 的時候能夠正確訪問到該testParams 方法，當請求/testParams.do?param1=value1&param2=value2&param3=value3 的時候就不能夠正常的訪問到該方法，因爲在@RequestMapping 的params 參數裏面指定了參數param3 是不能存在的。

（2）method屬性

@RequestMapping (value= "testMethod" , method={RequestMethod. GET , RequestMethod. DELETE })
    public String testMethod() {
       return "method" ;
    }

　　在上面的代碼中就使用method 參數限制了以GET 或DELETE 方法請求/testMethod 的時候才能訪問到該Controller 的testMethod 方法。

（3）headers屬性

@RequestMapping (value= "testHeaders" , headers={ "host=localhost" , "Accept" })
    public String testHeaders() {
       return "headers" ;
    }

　　headers 屬性的用法和功能與params 屬性相似。在上面的代碼中當請求/testHeaders.do 的時候只有當請求頭包含Accept 信息，且請求的host 爲localhost 的時候才能正確的訪問到testHeaders 方法
3、 @RequestMapping 標記的處理器方法支持的方法參數和返回類型
1. 支持的方法參數類型

     （1 ）HttpServlet 對象，主要包括HttpServletRequest 、HttpServletResponse 和HttpSession 對象。 這些參數Spring 在調用處理器方法的時候會自動給它們賦值，所以當在處理器方法中需要使用到這些對象的時候，可以直接在方法上給定一個方法參數的申明，然後在方法體裏面直接用就可以了。但是有一點需要注意的是在使用HttpSession 對象的時候，如果此時HttpSession 對象還沒有建立起來的話就會有問題。

（2 ）Spring 自己的WebRequest 對象。使用該對象可以訪問到存放在HttpServletRequest 和HttpSession 中的屬性值。

（3 ）InputStream 、OutputStream 、Reader 和Writer 。 InputStream 和Reader 是針對HttpServletRequest 而言的，可以從裏面取數據；OutputStream 和Writer 是針對HttpServletResponse 而言的，可以往裏面寫數據。

（4 ）使用@PathVariable 、@RequestParam 、@CookieValue 和@RequestHeader 標記的參數。

（5 ）使用@ModelAttribute 標記的參數。

（6 ）java.util.Map 、Spring 封裝的Model 和ModelMap 。這些都可以用來封裝模型數據，用來給視圖做展示。

（7 ）實體類。可以用來接收上傳的參數。

（8 ）Spring 封裝的MultipartFile 。用來接收上傳文件的。

（9 ）Spring 封裝的Errors 和BindingResult 對象。這兩個對象參數必須緊接在需要驗證的實體對象參數之後，它裏面包含了實體對象的驗證結果。
2. 支持的返回類型

（1 ）一個包含模型和視圖的ModelAndView 對象。

（2 ）一個模型對象，這主要包括Spring 封裝好的Model 和ModelMap ，以及java.util.Map ，當沒有視圖返回的時候視圖名稱將由RequestToViewNameTranslator 來決定。

（3 ）一個View 對象。這個時候如果在渲染視圖的過程中模型的話就可以給處理器方法定義一個模型參數，然後在方法體裏面往模型中添加值。

（4 ）一個String 字符串。這往往代表的是一個視圖名稱。這個時候如果需要在渲染視圖的過程中需要模型的話就可以給處理器方法一個模型參數，然後在方法體裏面往模型中添加值就可以了。

（5 ）返回值是void 。這種情況一般是我們直接把返回結果寫到HttpServletResponse 中了，如果沒有寫的話，那麼Spring 將會利用RequestToViewNameTranslator 來返回一個對應的視圖名稱。如果視圖中需要模型的話，處理方法與返回字符串的情況相同。

（6 ）如果處理器方法被註解@ResponseBody 標記的話，那麼處理器方法的任何返回類型都會通過HttpMessageConverters 轉換之後寫到HttpServletResponse 中，而不會像上面的那些情況一樣當做視圖或者模型來處理。

（7 ）除以上幾種情況之外的其他任何返回類型都會被當做模型中的一個屬性來處理，而返回的視圖還是由RequestToViewNameTranslator 來決定，添加到模型中的屬性名稱可以在該方法上用@ModelAttribute(“attributeName”) 來定義，否則將使用返回類型的類名稱的首字母小寫形式來表示。使用@ModelAttribute 標記的方法會在@RequestMapping 標記的方法執行之前執行。
4、使用 @ModelAttribute 和 @SessionAttributes 傳遞和保存數據

@Controller
@RequestMapping ( "/myTest" )
public class MyController {

    @ModelAttribute ( "hello" )
    public String getModel() {
       System. out .println( "-------------Hello---------" );
       return "world" ;
    }

    @ModelAttribute ( "intValue" )
    public int getInteger() {
       System. out .println( "-------------intValue---------------" );
       return 10;
    }

    @RequestMapping ( "sayHello" )
    public void sayHello( @ModelAttribute ( "hello" ) String hello, @ModelAttribute ( "intValue" ) int num, @ModelAttribute ( "user2" ) User user, Writer writer, HttpSession session) throws IOException {
       writer.write( "Hello " + hello + " , Hello " + user.getUsername() + num);
       writer.write( "\r" );
       Enumeration enume = session.getAttributeNames();
       while (enume.hasMoreElements())
           writer.write(enume.nextElement() + "\r" );
    }

    @ModelAttribute ( "user2" )
    public User getUser(){
       System. out .println( "---------getUser-------------" );
       return new User(3, "user2" );
    }
}

　　當我們請求 /myTest/sayHello.do 的時候使用 @ModelAttribute 標記的方法會先執行，然後把它們返回的對象存放到模型中。最終訪問到 sayHello 方法的時候，使用 @ModelAttribute 標記的方法參數都能被正確的注入值。執行結果如下所示：

Hello world,Hello user210
　　由執行結果我們可以看出來，此時 session 中沒有包含任何屬性，也就是說上面的那些對象都是存放在模型屬性中，而不是存放在 session 屬性中。那要如何才能存放在 session 屬性中呢？這個時候我們先引入一個新的概念 @SessionAttributes ，它的用法會在講完 @ModelAttribute 之後介紹，這裏我們就先拿來用一下。我們在 MyController 類上加上 @SessionAttributes 屬性標記哪些是需要存放到 session 中的。看下面的代碼：
　　

@Controller
@RequestMapping ( "/myTest" )
@SessionAttributes (value={ "intValue" , "stringValue" }, types={User. class })
public class MyController {

    @ModelAttribute ( "hello" )
    public String getModel() {
       System. out .println( "-------------Hello---------" );
       return "world" ;
    }

    @ModelAttribute ( "intValue" )
    public int getInteger() {
       System. out .println( "-------------intValue---------------" );
       return 10;
    }

    @RequestMapping ( "sayHello" )
    public void sayHello(Map<String, Object> map, @ModelAttribute ( "hello" ) String hello, @ModelAttribute ( "intValue" ) int num, @ModelAttribute ( "user2" ) User user, Writer writer, HttpServletRequest request) throws IOException {
       map.put( "stringValue" , "String" );
       writer.write( "Hello " + hello + " , Hello " + user.getUsername() + num);
       writer.write( "\r" );
       HttpSession session = request.getSession();
       Enumeration enume = session.getAttributeNames();
       while (enume.hasMoreElements())
           writer.write(enume.nextElement() + "\r" );
       System. out .println(session);
    }

    @ModelAttribute ( "user2" )
    public User getUser() {
       System. out .println( "---------getUser-------------" );
       return new User(3, "user2" );
    }
}

在上面代碼中我們指定了屬性爲 intValue 或 stringValue 或者類型爲 User 的都會放到 Session中，利用上面的代碼當我們訪問 /myTest/sayHello.do 的時候，結果如下：

Hello world,Hello user210

仍然沒有打印出任何 session 屬性，這是怎麼回事呢？怎麼定義了把模型中屬性名爲 intValue 的對象和類型爲 User 的對象存到 session 中，而實際上沒有加進去呢？難道我們錯啦？我們當然沒有錯，只是在第一次訪問 /myTest/sayHello.do 的時候 @SessionAttributes 定義了需要存放到 session 中的屬性，而且這個模型中也有對應的屬性，但是這個時候還沒有加到 session 中，所以 session 中不會有任何屬性，等處理器方法執行完成後 Spring 纔會把模型中對應的屬性添加到 session 中。所以當請求第二次的時候就會出現如下結果：

Hello world,Hello user210

user2

intValue

stringValue

當 @ModelAttribute 標記在處理器方法參數上的時候，表示該參數的值將從模型或者 Session 中取對應名稱的屬性值，該名稱可以通過 @ModelAttribute(“attributeName”) 來指定，若未指定，則使用參數類型的類名稱（首字母小寫）作爲屬性名稱。
5、@PathVariable和@RequestParam的區別
請求路徑上有個id的變量值，可以通過@PathVariable來獲取 @RequestMapping(value = “/page/{id}”, method = RequestMethod.GET)
@RequestParam用來獲得靜態的URL請求入參 spring註解時action裏用到。
簡介：

handler method 參數綁定常用的註解,我們根據他們處理的Request的不同內容部分分爲四類：（主要講解常用類型）

A、處理requet uri 部分（這裏指uri template中variable，不含queryString部分）的註解： @PathVariable;

B、處理request header部分的註解： @RequestHeader, @CookieValue;

C、處理request body部分的註解：@RequestParam, @RequestBody;

D、處理attribute類型是註解： @SessionAttributes, @ModelAttribute;

SpringMVC學習(四)--常用註解標籤詳解

1、@Controller

2、@RequestMapping

3、@Resource和@Autowired

4、@ModelAttribute和 @SessionAttributes

5、@PathVariable

6、@requestParam

7、@ResponseBody

8、@Component

9、@Repository

SpringMVC學習(四)--常用註解標籤詳解

SpringMVC學習(二)--實現簡單用戶登錄

this,super關鍵字(二)

SpringMVC學習(三)--跳轉路徑問題

this,super關鍵字區別

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結