springmvc常用注解以及作用

這篇文章主要介紹了springmvc常用注解以及作用，具有一定借鑒價(jià)值，需要的朋友可以參考下。下面就和我一起來(lái)看看springmvc常用注解以及作用吧。

成都創(chuàng)新互聯(lián)作為成都網(wǎng)站建設(shè)公司，專(zhuān)注成都網(wǎng)站建設(shè)公司、網(wǎng)站設(shè)計(jì)，有關(guān)成都定制網(wǎng)頁(yè)設(shè)計(jì)方案、改版、費(fèi)用等問(wèn)題，行業(yè)涉及成都履帶攪拌車(chē)等多個(gè)領(lǐng)域，已為上千家企業(yè)服務(wù)，得到了客戶(hù)的尊重與認(rèn)可。

springmvc常用注解以及作用

SpringMVC 常用注解

1、@Controller

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

@Controller 標(biāo)記在一個(gè)類(lèi)上還不能真正意義上的說(shuō)它就是SpringMVC 的一個(gè)控制器類(lèi)，因?yàn)檫@個(gè)時(shí)候Spring 還不認(rèn)識(shí)它。這個(gè)時(shí)候就需要我們把這個(gè)控制器類(lèi)交給Spring 來(lái)管理。有兩種方式可以管理：

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

此外Controller 不會(huì)直接依賴(lài)于HttpServletRequest 和HttpServletResponse 等HttpServlet 對(duì)象，它們可以通過(guò)Controller 的方法參數(shù)靈活的獲取到。為了先對(duì)Controller 有一個(gè)初步的印象，以下先定義一個(gè)簡(jiǎn)單的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是一個(gè)用來(lái)處理請(qǐng)求地址映射的注解，可用于類(lèi)或方法上。用于類(lèi)上，表示類(lèi)中的所有響應(yīng)請(qǐng)求的方法都是以該地址作為父路徑。

返回值會(huì)通過(guò)視圖解析器解析為實(shí)際的物理視圖，對(duì)于 InternalResourceViewResolver 視圖解析器，會(huì)做如下的解析：

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

<!-- 配置視圖解析器：如何把 handler 方法返回值解析為實(shí)際的物理視圖 -->
     <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
         <property name="prefix" value="/WEB-INF/views/"></property>
         <property name="suffix" value=".jsp"></property>
     </bean>

RequestMapping注解有六個(gè)屬性:

1)、value

value：指定請(qǐng)求的實(shí)際地址；

2)、method；

method：指定請(qǐng)求的method類(lèi)型， 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：指定處理請(qǐng)求的提交內(nèi)容類(lèi)型（Content-Type），例如application/json, text/html;

4)、produces

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

5)、params

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

6)、headers

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

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

● ?：匹配文件名的一個(gè)字符

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

● **：匹配多層路徑

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

@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的注入時(shí)使用，其實(shí)@Resource并不是Spring的注解，它的包是javax.annotation.Resource，需要導(dǎo)入，但是Spring支持該注解的注入。

1)、共同點(diǎn)

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

2)、不同點(diǎn)

（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注解是按照類(lèi)型（byType）裝配依賴(lài)對(duì)象，默認(rèn)情況下它要求依賴(lài)對(duì)象必須存在，如果允許null值，可以設(shè)置它的required屬性為false。如果我們想使用按照名稱(chēng)（byName）來(lái)裝配，可以結(jié)合@Qualifier注解一起使用。如下：

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

（2）@Resource

@Resource默認(rèn)按照ByName自動(dòng)注入，由J2EE提供，需要導(dǎo)入包javax.annotation.Resource。@Resource有兩個(gè)重要的屬性：name和type，而Spring將@Resource注解的name屬性解析為bean的名字，而type屬性則解析為bean的類(lèi)型。所以，如果使用name屬性，則使用byName的自動(dòng)注入策略，而使用type屬性時(shí)則使用byType自動(dòng)注入策略。如果既不制定name也不制定type屬性，這時(shí)將通過(guò)反射機(jī)制使用byName自動(dòng)注入策略。

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

注：最好是將@Resource放在setter方法上，因?yàn)檫@樣更符合面向?qū)ο蟮乃枷?，通過(guò)set、get去操作屬性，而不是直接去操作屬性。

4、@PathVariable

用于將請(qǐng)求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

作用：用來(lái)獲取Cookie中的值；

參數(shù)： value：參數(shù)名稱(chēng) required：是否必須 defaultValue：默認(rèn)值

使用案例：

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

6、@RequestParam

@RequestParam用于將請(qǐng)求參數(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作用域中，寫(xiě)在class上面。

@SessionAttributes 除了可以通過(guò)屬性名指定需要放到會(huì)話(huà)中的屬性外（value 屬性值），

還可以通過(guò)模型屬性的對(duì)象類(lèi)型指定哪些模型屬性需要放到會(huì)話(huà)中（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
     *         除了可以通過(guò)屬性名指定需要放到會(huì)話(huà)中的屬性外（value 屬性值），
     *         還可以通過(guò)模型屬性的對(duì)象類(lèi)型指定哪些模型屬性需要放到會(huì)話(huà)中（types 屬性值）。
     * 注意： 該注解只能放在類(lèi)的上面，不能放在方法上面
     * 
     * @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ù)中，可以把這個(gè)@ModelAttribute特性，應(yīng)用在BaseController當(dāng)中，所有的Controller繼承BaseController，即可實(shí)現(xiàn)在調(diào)用Controller時(shí)，先執(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)記的方法，會(huì)在每個(gè)目標(biāo)方法執(zhí)行之前被 SpringMVC 調(diào)用
     * 2.@ModelAttribute注解也可以修飾目標(biāo)方法POJO類(lèi)形的入?yún)?，其value的屬性值有如下作用：
     *     1）SpringMVC會(huì)使用value屬性值在implicitModel中查找對(duì)應(yīng)的對(duì)象，若存在則直接傳入到目標(biāo)方法的入?yún)⒅?
     *     2）SpringMVC會(huì)以value為key,POJO類(lèi)型的對(duì)象為value，存入的request中
     * 
     * @param id
     * @param map
     */
    @ModelAttribute
    public void getUser(@RequestParam(value = "id", required = false) int id,
            Map<String, Object> map) {
        //模擬數(shù)據(jù)庫(kù)中獲取對(duì)象
        User user = new User(1, "劉邦", "123", "023", "重慶");
        System.out.println("從數(shù)據(jù)庫(kù)中獲取一個(gè)對(duì)象：" + user);
        map.put("abc", user);
    }
    
    /**
     * 運(yùn)行流程：
     *         1.執(zhí)行@ModelAttribute注解修飾的方法，從數(shù)據(jù)庫(kù)中取出對(duì)象，把對(duì)象放入Map中，鍵為：user；
     *         2.SpringMVC從Map中取出User對(duì)象，并把表單的請(qǐng)求參數(shù)賦值給該User對(duì)象的對(duì)應(yīng)屬性；
     *         3.SpringMVC把上述對(duì)象傳入目標(biāo)方法的參數(shù)。
     * 
     * 注意：在@ModelAttribute修飾的方法中，放入到Map時(shí)的鍵需要和目標(biāo)方法入?yún)㈩?lèi)型的第一個(gè)字母小寫(xiě)的字符串一致
     * 
     * @param user
     * @return
     */
    @RequestMapping("/testModelAttribute")
    public String testModelAttribute(@ModelAttribute("abc") User user) {
        System.out.println("修改：" + user);
        return SUCCESS;
    }
}

9、@ResponseBody　

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

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

關(guān)于springmvc常用注解以及作用就分享到這里了，當(dāng)然并不止以上和大家分析的辦法，不過(guò)小編可以保證其準(zhǔn)確性是絕對(duì)沒(méi)問(wèn)題的。希望以上內(nèi)容可以對(duì)大家有一定的參考價(jià)值，可以學(xué)以致用。如果喜歡本篇文章，不妨把它分享出去讓更多的人看到。

當(dāng)前名稱(chēng)：springmvc常用注解以及作用
轉(zhuǎn)載來(lái)源：http://bm7419.com/article30/jcscso.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供、移動(dòng)網(wǎng)站建設(shè)、面包屑導(dǎo)航、虛擬主機(jī)、域名注冊(cè)、品牌網(wǎng)站建設(shè)

聲明：本網(wǎng)站發(fā)布的內(nèi)容（圖片、視頻和文字）以用戶(hù)投稿、用戶(hù)轉(zhuǎn)載內(nèi)容為主，如果涉及侵權(quán)請(qǐng)盡快告知，我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng)，如需處理請(qǐng)聯(lián)系客服。電話(huà)：028-86922220；郵箱：631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載，或轉(zhuǎn)載時(shí)需注明來(lái)源：創(chuàng)新互聯(lián)

猜你還喜歡下面的內(nèi)容