SpringMVC中@Controller和@RequestMapping用法
一、簡介
在SpringMVC 中,控制器Controller 負責處理由DispatcherServlet 分發的請求,它把用戶請求的數據經過業務處理層處理之後封裝成一個Model ,然後再把該Model 返回給對應的View 進行展示。在SpringMVC 中提供了一個非常簡便的定義Controller 的方法,你無需繼承特定的類或實現特定的接口,只需使用@Controller 標記一個類是Controller ,然後使用@RequestMapping 和@RequestParam 等一些註解用以定義URL 請求和Controller 方法之間的映射,這樣的Controller 就能被外界訪問到。此外Controller 不會直接依賴於HttpServletRequest 和HttpServletResponse 等HttpServlet 對象,它們可以通過Controller 的方法參數靈活的獲取到。為了先對Controller 有一個初步的印象,以下先定義一個簡單的Controller :
- @Controller
- public class MyController {
- @RequestMapping ( "/showView" )
- public ModelAndView showView() {
- ModelAndView modelAndView = new ModelAndView();
- modelAndView.setViewName( "viewName" );
- modelAndView.addObject( " 需要放到 model 中的屬性名稱 " , " 對應的屬性值,它是一個對象 " );
- return modelAndView;
- }
- }
在上面的示例中,@Controller 是標記在類MyController 上面的,所以類MyController 就是一個SpringMVC Controller 對象了,然後使用@RequestMapping(“/showView”) 標記在Controller 方法上,表示當請求/showView.do 的時候訪問的是MyController 的showView 方法,該方法返回了一個包括Model 和View 的ModelAndView 對象。這些在後續都將會詳細介紹。
二、使用 @Controller 定義一個 Controller 控制器
@Controller 用於標記在一個類上,使用它標記的類就是一個SpringMVC Controller 對象。分發處理器將會掃描使用了該註解的類的方法,並檢測該方法是否使用了@RequestMapping 註解。@Controller 只是定義了一個控制器類,而使用@RequestMapping 註解的方法才是真正處理請求的處理器,這個接下來就會講到。
單單使用@Controller 標記在一個類上還不能真正意義上的說它就是SpringMVC 的一個控制器類,因為這個時候Spring 還不認識它。那麽要如何做Spring 才能認識它呢?這個時候就需要我們把這個控制器類交給Spring 來管理。拿MyController 來舉一個例子
Java代碼
- @Controller
- public class MyController {
- @RequestMapping ( "/showView" )
- public ModelAndView showView() {
- ModelAndView modelAndView = new ModelAndView();
- modelAndView.setViewName( "viewName" );
- modelAndView.addObject( " 需要放到 model 中的屬性名稱 " , " 對應的屬性值,它是一個對象 " );
- return modelAndView;
- }
- }
這個時候有兩種方式可以把MyController 交給Spring 管理,好讓它能夠識別我們標記的@Controller 。
第一種方式是在SpringMVC 的配置文件中定義MyController 的bean 對象。
<bean class="com.host.app.web.controller.MyController"/>
第二種方式是在SpringMVC 的配置文件中告訴Spring 該到哪裏去找標記為@Controller 的Controller 控制器。
Xml代碼- < context:component-scan base-package = "com.host.app.web.controller" >
- < context:exclude-filter type = "annotation"
- expression = "org.springframework.stereotype.Service" />
- </ context:component-scan >
註:
上面 context:exclude-filter 標註的是不掃描 @Service 標註的類
三、使用 @RequestMapping 來映射 Request 請求與處理器
可以使用@RequestMapping 來映射URL 到控制器類,或者是到Controller 控制器的處理方法上。當@RequestMapping 標記在Controller 類上的時候,裏面使用@RequestMapping 標記的方法的請求地址都是相對於類上的@RequestMapping 而言的;當Controller 類上沒有標記@RequestMapping 註解時,方法上的@RequestMapping 都是絕對路徑。這種絕對路徑和相對路徑所組合成的最終路徑都是相對於根路徑“/ ”而言的。
Java代碼
- @Controller
- public class MyController {
- @RequestMapping ( "/showView" )
- public ModelAndView showView() {
- ModelAndView modelAndView = new ModelAndView();
- modelAndView.setViewName( "viewName" );
- modelAndView.addObject( " 需要放到 model 中的屬性名稱 " , " 對應的屬性值,它是一個對象 " );
- return modelAndView;
- }
- }
在這個控制器中,因為MyController 沒有被@RequestMapping 標記,所以當需要訪問到裏面使用了@RequestMapping 標記的showView 方法時,就是使用的絕對路徑/showView.do 請求就可以了。
Java代碼
- @Controller
- @RequestMapping ( "/test" )
- public class MyController {
- @RequestMapping ( "/showView" )
- public ModelAndView showView() {
- ModelAndView modelAndView = new ModelAndView();
- modelAndView.setViewName( "viewName" );
- modelAndView.addObject( " 需要放到 model 中的屬性名稱 " , " 對應的屬性值,它是一個對象 " );
- return modelAndView;
- }
- }
這種情況是在控制器上加了@RequestMapping 註解,所以當需要訪問到裏面使用了@RequestMapping 標記的方法showView() 的時候就需要使用showView 方法上@RequestMapping 相對於控制器MyController上@RequestMapping 的地址,即/test/showView.do 。
以 @RequestMapping 標記的處理器方法支持的返回類型
如果處理器方法被註解@ResponseBody 標記的話,那麽處理器方法的任何返回類型都會通過HttpMessageConverters 轉換之後寫到HttpServletResponse 中,而不會像上面的那些情況一樣當做視圖或者模型來處理
@Responsebody 註解表示該方法的返回的結果直接寫入 HTTP 響應正文(ResponseBody)中,一般在異步獲取數據時使用,通常是在使用 @RequestMapping 後,返回值通常解析為跳轉路徑,加上 @Responsebody 後返回結果不會被解析為跳轉路徑,而是直接寫入HTTP 響應正文中。
作用:
該註解用於將Controller的方法返回的對象,通過適當的HttpMessageConverter轉換為指定格式後,寫入到Response對象的body數據區。
使用時機:
返回的數據不是html標簽的頁面,而是其他某種格式的數據時(如json、xml等)使用;
當頁面發出異步請求:
function login() {
var datas = ‘{"username":"‘ + $(‘#username‘).val() + ‘","userid":"‘ + $(‘#userid‘).val() + ‘","status":"‘ + $(‘#status‘).val() + ‘"}‘;
$.ajax({
type : ‘POST‘,
contentType : ‘application/json‘,
url : "${pageContext.request.contextPath}/user/login",
processData : false,
dataType : ‘json‘,
data : datas,
success : function(data) {
alert("userid: " + data.userid + "username: " + data.username + "status: "+ data.status);
},
error : function(XMLHttpRequest, textStatus, errorThrown) {
alert("出現異常,異常信息:"+textStatus,"error");
}
});
};
例如:
@RequestMapping(value = "user/login")
@ResponseBody
// 將ajax(datas)發出的請求寫入 User 對象中,返回json對象響應回去
public User login(User user) {
User user = new User();
user .setUserid(1);
user .setUsername("MrF");
user .setStatus("1");
return user ;
}
異步獲取 json 數據,加上 @Responsebody 註解後,就會直接返回 json 數據。
@RequestBody
@RequestBody 註解則是將 HTTP 請求正文插入方法中,使用適合的 HttpMessageConverter 將請求體寫入某個對象。
作用:
1) 該註解用於讀取Request請求的body部分數據,使用系統默認配置的HttpMessageConverter進行解析,然後把相應的數據綁定到要返回的對象上;
2) 再把HttpMessageConverter返回的對象數據綁定到 controller中方法的參數上。
使用時機:
A) GET、POST方式提時, 根據request header Content-Type的值來判斷:
application/x-www-form-urlencoded, 可選(即非必須,因為這種情況的數據@RequestParam, @ModelAttribute也可以處理,當然@RequestBody也能處理);
multipart/form-data, 不能處理(即使用@RequestBody不能處理這種格式的數據);
其他格式, 必須(其他格式包括application/json, application/xml等。這些格式的數據,必須使用@RequestBody來處理);
B) PUT方式提交時, 根據request header Content-Type的值來判斷:
application/x-www-form-urlencoded, 必須;multipart/form-data, 不能處理;其他格式, 必須;
說明:request的body部分的數據編碼格式由header部分的Content-Type指定;
例如:
@RequestMapping(value = "user/login")
@ResponseBody
// 將ajax(datas)發出的請求寫入 User 對象中
public User login(@RequestBody User user) {
// 這樣就不會再被解析為跳轉路徑,而是直接將user對象寫入 HTTP 響應正文中
return user;
}
SpringMVC中使用@ResponseBody註解標註業務方法,將業務方法的返回值做成json輸出給頁面
導包:
除了一些spring的包之外,還需要jackson-annotations.jar , jackson-core.jar , jackson-databind.jar 這三個包
開啟@ResponseBody註解:
在 spring-mvc.xml 中通過<mvc:annotation-driven />開啟@ResponseBody註解
使用@ResponseBody標註業務方法
package com.loger.controller; import java.util.ArrayList; import java.util.HashMap; import java.util.List; import java.util.Map; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.ResponseBody; import com.loger.entity.User; /** * ResponseBody 註解,可以將如下類型的數據做成json: * 1)基本數據類型,如 boolean , String , int 等 * 2) Map 類型數據 * 3)集合或數組 * 4)實體對象 * 5)實體對象集合 * */ @Controller @RequestMapping("/test") public class JsonController { @RequestMapping("test1.do") @ResponseBody public boolean test1(){ return true; } @RequestMapping("/test2.do") @ResponseBody public Map<String, Object> test2(){ Map<String , Object> map = new HashMap<String ,Object>(); map.put("id", "s20070"); map.put("name", "鄭城斌"); return map; } @RequestMapping("/test3.do") @ResponseBody public List<String> test3(){ List<String> list = new ArrayList<>(); list.add("aaa"); list.add("bbb"); list.add("ccc"); return list; } @RequestMapping("/test4.do") @ResponseBody public User test4(){ User user = new User(); user.setId("s20068"); user.setName("余清波"); user.setAge(21); return user; } @RequestMapping("/test5.do") @ResponseBody public List<User> test5(){ List<User> list = new ArrayList<>(); User user1 = new User(); user1.setId("s200681"); user1.setName("余清波1"); user1.setAge(21); list.add(user1); User user2 = new User(); user2.setId("s200682"); user2.setName("余清波2"); user2.setAge(21); list.add(user2); User user3 = new User(); user3.setId("s200683"); user3.setName("余清波3"); user3.setAge(21); list.add(user3); return list; } }
SpringMVC中@Controller和@RequestMapping用法