springmvc常用註解有哪些？

SpringMVC 常用註解

1、@Controller

     @Controller 用來標記在一個類別上，使用它標記的類別就是一個SpringMVC Controller 物件。分發處理器將會掃描使用了該註解的類別的方法，並偵測該方法是否使用了@RequestMapping 註解。 @Controller 只是定義了一個控制器類，而使用@RequestMapping 註解的方法才是真正處理請求的處理器。

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

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

 此外Controller 不會直接依賴HttpServletRequest 和HttpServletResponse 等HttpServlet 對象，它們可以透過Controller 的方法參數靈活的取得。為了先對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是一個用來處理請求位址對映的註解，可用於類別或方法上。用於類別上，表示類別中的所有回應請求的方法都是以該位址作為父路徑。

      傳回值會透過視圖解析器解析為實際的物理視圖，對於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

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

# 2)、method;

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

/**
     * 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

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

4)、produces

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

5)、params

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

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，需要導入，但是Spring支援該註解的注入。

1)、共同點

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

2)、不同點

（1）@Autowired

@Autowired為Spring提供的註解，需要導入套件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值，可以設定它的required屬性為false。如果我們想要使用依照名稱（byName）來組裝，可以結合@Qualifier註解一起使用。如下：

public class HelloWorld{ 
　　@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 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中的模板變數對應到功能處理方法的參數上，即取出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";  
     }  
}

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用于将请求参数区数据映射到功能处理方法的参数上，用例：

/**
     * @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的所有方法在调用前，先执行此@ModelAttribute方法，可用于注解和方法参数中，可以把这个@ModelAttribute特性，应用在BaseController当中，所有的Controller继承BaseController，即可实现在调用Controller时，先执行@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 标记的方法，会在每个目标方法执行之前被 SpringMVC 调用
     * 2.@ModelAttribute注解也可以修饰目标方法POJO类形的入参，其value的属性值有如下作用：
     *     1）SpringMVC会使用value属性值在implicitModel中查找对应的对象，若存在则直接传入到目标方法的入参中
     *     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) {
        //模拟数据库中获取对象
        User user = new User(1, "刘邦", "123", "023", "重庆");
        System.out.println("从数据库中获取一个对象：" + user);
        map.put("abc", user);
    }
    
    /**
     * 运行流程：
     *         1.执行@ModelAttribute注解修饰的方法，从数据库中取出对象，把对象放入Map中，键为：user；
     *         2.SpringMVC从Map中取出User对象，并把表单的请求参数赋值给该User对象的对应属性；
     *         3.SpringMVC把上述对象传入目标方法的参数。
     * 
     * 注意：在@ModelAttribute修饰的方法中，放入到Map时的键需要和目标方法入参类型的第一个字母小写的字符串一致
     * 
     * @param user
     * @return
     */
    @RequestMapping("/testModelAttribute")
    public String testModelAttribute(@ModelAttribute("abc") User user) {
        System.out.println("修改：" + user);
        return SUCCESS;
    }
}

9、@ResponseBody　

作用： 该注解用于将Controller的方法返回的对象，通过适当的HttpMessageConverter转换为指定格式后，写入到Response对象的body数据区。

使用时机：返回的数据不是html标签的页面，而是其他某种格式的数据时（如json、xml等）使用；

本文来自php中文网，java教程栏目，欢迎学习！

以上是springmvc常用註解有哪些？的詳細內容。更多資訊請關注PHP中文網其他相關文章！