javascript
SpringMVC _Controller认识(1)
一、簡(jiǎn)介
???????? 在SpringMVC中,控制器Controller負(fù)責(zé)處理由DispatcherServlet分發(fā)的請(qǐng)求,它把用戶(hù)請(qǐng)求的數(shù)據(jù)經(jīng)過(guò)業(yè)務(wù)處理層處理之后封裝成一個(gè)Model,然后再把該Model返回給對(duì)應(yīng)的View進(jìn)行展示。在SpringMVC中提供了一個(gè)非常簡(jiǎn)便的定義Controller的方法,你無(wú)需繼承特定的類(lèi)或?qū)崿F(xiàn)特定的接口,只需使用@Controller標(biāo)記一個(gè)類(lèi)是Controller,然后使用@RequestMapping和@RequestParam等一些注解用以定義URL請(qǐng)求和Controller方法之間的映射,這樣的Controller就能被外界訪問(wèn)到。此外Controller不會(huì)直接依賴(lài)于HttpServletRequest和HttpServletResponse等HttpServlet對(duì)象,它們可以通過(guò)Controller的方法參數(shù)靈活的獲取到。為了先對(duì)Controller有一個(gè)初步的印象,以下先定義一個(gè)簡(jiǎn)單的Controller:
@Controller public?class?MyController?{@RequestMapping?(?"/showView"?)public?ModelAndView?showView()?{ModelAndView?modelAndView?=?new?ModelAndView();modelAndView.setViewName(?"viewName"?);modelAndView.addObject(?"?需要放到?model?中的屬性名稱(chēng)?"?,?"?對(duì)應(yīng)的屬性值,它是一個(gè)對(duì)象?"?);return?modelAndView;}}在上面的示例中,@Controller是標(biāo)記在類(lèi)MyController上面的,所以類(lèi)MyController就是一個(gè)SpringMVC Controller對(duì)象了,然后使用@RequestMapping(“/showView”)標(biāo)記在Controller方法上,表示當(dāng)請(qǐng)求/showView.do的時(shí)候訪問(wèn)的是MyController的showView方法,該方法返回了一個(gè)包括Model和View的ModelAndView對(duì)象。這些在后續(xù)都將會(huì)詳細(xì)介紹。
二、使用@Controller定義一個(gè)Controller控制器
???????? @Controller用于標(biāo)記在一個(gè)類(lèi)上,使用它標(biāo)記的類(lèi)就是一個(gè)SpringMVCController對(duì)象。分發(fā)處理器將會(huì)掃描使用了該注解的類(lèi)的方法,并檢測(cè)該方法是否使用了@RequestMapping注解。@Controller只是定義了一個(gè)控制器類(lèi),而使用@RequestMapping注解的方法才是真正處理請(qǐng)求的處理器,這個(gè)接下來(lái)就會(huì)講到。
?? 單單使用@Controller標(biāo)記在一個(gè)類(lèi)上還不能真正意義上的說(shuō)它就是SpringMVC的一個(gè)控制器類(lèi),因?yàn)檫@個(gè)時(shí)候Spring還不認(rèn)識(shí)它。那么要如何做Spring才能認(rèn)識(shí)它呢?這個(gè)時(shí)候就需要我們把這個(gè)控制器類(lèi)交給Spring來(lái)管理。拿MyController來(lái)舉一個(gè)例子
?
@Controller public?class?MyController?{@RequestMapping?(?"/showView"?)public?ModelAndView?showView()?{ModelAndView?modelAndView?=?new?ModelAndView();modelAndView.setViewName(?"viewName"?);modelAndView.addObject(?"?需要放到?model?中的屬性名稱(chēng)?"?,?"?對(duì)應(yīng)的屬性值,它是一個(gè)對(duì)象?"?);return?modelAndView;}}這個(gè)時(shí)候有兩種方式可以把MyController交給Spring管理,好讓它能夠識(shí)別我們標(biāo)記的@Controller。
?? 第一種方式是在SpringMVC的配置文件中定義MyController的bean對(duì)象。
<beanclass="com.host.app.web.controller.MyController"/>
?? 第二種方式是在SpringMVC的配置文件中告訴Spring該到哪里去找標(biāo)記為@Controller的Controller控制器。
????<?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標(biāo)注的是不掃描@Service標(biāo)注的類(lèi)
三、使用@RequestMapping來(lái)映射Request請(qǐng)求與處理器
???????? 可以使用@RequestMapping來(lái)映射URL到控制器類(lèi),或者是到Controller控制器的處理方法上。當(dāng)@RequestMapping標(biāo)記在Controller類(lèi)上的時(shí)候,里面使用@RequestMapping標(biāo)記的方法的請(qǐng)求地址都是相對(duì)于類(lèi)上的@RequestMapping而言的;當(dāng)Controller類(lèi)上沒(méi)有標(biāo)記@RequestMapping注解時(shí),方法上的@RequestMapping都是絕對(duì)路徑。這種絕對(duì)路徑和相對(duì)路徑所組合成的最終路徑都是相對(duì)于根路徑“/”而言的。
@Controller public?class?MyController?{@RequestMapping?(?"/showView"?)public?ModelAndView?showView()?{ModelAndView?modelAndView?=?new?ModelAndView();modelAndView.setViewName(?"viewName"?);modelAndView.addObject(?"?需要放到?model?中的屬性名稱(chēng)?"?,?"?對(duì)應(yīng)的屬性值,它是一個(gè)對(duì)象?"?);return?modelAndView;}}在這個(gè)控制器中,因?yàn)镸yController沒(méi)有被@RequestMapping標(biāo)記,所以當(dāng)需要訪問(wèn)到里面使用了@RequestMapping標(biāo)記的showView方法時(shí),就是使用的絕對(duì)路徑/showView.do請(qǐng)求就可以了。
@Controller @RequestMapping?(?"/test"?) public?class?MyController?{@RequestMapping?(?"/showView"?)public?ModelAndView?showView()?{ModelAndView?modelAndView?=?new?ModelAndView();modelAndView.setViewName(?"viewName"?);modelAndView.addObject(?"?需要放到?model?中的屬性名稱(chēng)?"?,?"?對(duì)應(yīng)的屬性值,它是一個(gè)對(duì)象?"?);return?modelAndView;}}?
?? 這種情況是在控制器上加了@RequestMapping注解,所以當(dāng)需要訪問(wèn)到里面使用了@RequestMapping標(biāo)記的方法showView()的時(shí)候就需要使用showView方法上@RequestMapping相對(duì)于控制器MyController上@RequestMapping的地址,即/test/showView.do。
(一)使用URI模板
?? URI模板就是在URI中給定一個(gè)變量,然后在映射的時(shí)候動(dòng)態(tài)的給該變量賦值。如URI模板http://localhost/app/{variable1}/index.html,這個(gè)模板里面包含一個(gè)變量variable1,那么當(dāng)我們請(qǐng)求http://localhost/app/hello/index.html的時(shí)候,該URL就跟模板相匹配,只是把模板中的variable1用hello來(lái)取代。在SpringMVC中,這種取代模板中定義的變量的值也可以給處理器方法使用,這樣我們就可以非常方便的實(shí)現(xiàn)URL的RestFul風(fēng)格。這個(gè)變量在SpringMVC中是使用@PathVariable來(lái)標(biāo)記的。
?? 在SpringMVC中,我們可以使用@PathVariable來(lái)標(biāo)記一個(gè)Controller的處理方法參數(shù),表示該參數(shù)的值將使用URI模板中對(duì)應(yīng)的變量的值來(lái)賦值。
?
@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?中的屬性名稱(chēng)?"?,?"?對(duì)應(yīng)的屬性值,它是一個(gè)對(duì)象?"?);return?modelAndView;} }?? 在上面的代碼中我們定義了兩個(gè)URI變量,一個(gè)是控制器類(lèi)上的variable1,一個(gè)是showView方法上的variable2,然后在showView方法的參數(shù)里面使用@PathVariable標(biāo)記使用了這兩個(gè)變量。所以當(dāng)我們使用/test/hello/showView/2.do來(lái)請(qǐng)求的時(shí)候就可以訪問(wèn)到MyController的showView方法,這個(gè)時(shí)候variable1就被賦予值hello,variable2就被賦予值2,然后我們?cè)趕howView方法參數(shù)里面標(biāo)注了參數(shù)variable1和variable2是來(lái)自訪問(wèn)路徑的path變量,這樣方法參數(shù)variable1和variable2就被分別賦予hello和2。方法參數(shù)variable1是定義為String類(lèi)型,variable2是定義為int類(lèi)型,像這種簡(jiǎn)單類(lèi)型在進(jìn)行賦值的時(shí)候Spring是會(huì)幫我們自動(dòng)轉(zhuǎn)換的,關(guān)于復(fù)雜類(lèi)型該如何來(lái)轉(zhuǎn)換在后續(xù)內(nèi)容中將會(huì)講到。
?? 在上面的代碼中我們可以看到在標(biāo)記variable1為path變量的時(shí)候我們使用的是@PathVariable,而在標(biāo)記variable2的時(shí)候使用的是@PathVariable(“variable2”)。這兩者有什么區(qū)別呢?第一種情況就默認(rèn)去URI模板中找跟參數(shù)名相同的變量,但是這種情況只有在使用debug模式進(jìn)行編譯的時(shí)候才可以,而第二種情況是明確規(guī)定使用的就是URI模板中的variable2變量。當(dāng)不是使用debug模式進(jìn)行編譯,或者是所需要使用的變量名跟參數(shù)名不相同的時(shí)候,就要使用第二種方式明確指出使用的是URI模板中的哪個(gè)變量。
?? 除了在請(qǐng)求路徑中使用URI模板,定義變量之外,@RequestMapping中還支持通配符“*”。如下面的代碼我就可以使用/myTest/whatever/wildcard.do訪問(wèn)到Controller的testWildcard方法。
?
@Controller @RequestMapping?(?"/myTest"?) public?class?MyController?{@RequestMapping?(?"*/wildcard"?)public?String?testWildcard()?{System.?out?.println(?"wildcard------------"?);return?"wildcard"?;}?? }(二)使用@RequestParam綁定HttpServletRequest請(qǐng)求參數(shù)到控制器方法參數(shù)
????@RequestMapping?(?"requestParam"?)public?String?testRequestParam(?@RequestParam(required=false)?String?name,?@RequestParam?(?"age"?)?int?age)?{return?"requestParam"?;}在上面代碼中利用@RequestParam從HttpServletRequest中綁定了參數(shù)name到控制器方法參數(shù)name,綁定了參數(shù)age到控制器方法參數(shù)age。值得注意的是和@PathVariable一樣,當(dāng)你沒(méi)有明確指定從request中取哪個(gè)參數(shù)時(shí),Spring在代碼是debug編譯的情況下會(huì)默認(rèn)取更方法參數(shù)同名的參數(shù),如果不是debug編譯的就會(huì)報(bào)錯(cuò)。此外,當(dāng)需要從request中綁定的參數(shù)和方法的參數(shù)名不相同的時(shí)候,也需要在@RequestParam中明確指出是要綁定哪個(gè)參數(shù)。在上面的代碼中如果我訪問(wèn)/requestParam.do?name=hello&age=1則Spring將會(huì)把request請(qǐng)求參數(shù)name的值hello賦給對(duì)應(yīng)的處理方法參數(shù)name,把參數(shù)age的值1賦給對(duì)應(yīng)的處理方法參數(shù)age。
在@RequestParam中除了指定綁定哪個(gè)參數(shù)的屬性value之外,還有一個(gè)屬性required,它表示所指定的參數(shù)是否必須在request屬性中存在,默認(rèn)是true,表示必須存在,當(dāng)不存在時(shí)就會(huì)報(bào)錯(cuò)。在上面代碼中我們指定了參數(shù)name的required的屬性為false,而沒(méi)有指定age的required屬性,這時(shí)候如果我們?cè)L問(wèn)/requestParam.do而沒(méi)有傳遞參數(shù)的時(shí)候,系統(tǒng)就會(huì)拋出異常,因?yàn)閍ge參數(shù)是必須存在的,而我們沒(méi)有指定。而如果我們?cè)L問(wèn)/requestParam.do?age=1的時(shí)候就可以正常訪問(wèn),因?yàn)槲覀儌鬟f了必須的參數(shù)age,而參數(shù)name是非必須的,不傳遞也可以。
(三)使用@CookieValue綁定cookie的值到Controller方法參數(shù)
????@RequestMapping?(?"cookieValue"?)public?String?testCookieValue(?@CookieValue?(?"hello"?)?String?cookieValue,?@CookieValue?String?hello)?{System.?out?.println(cookieValue?+?"-----------"?+?hello);return?"cookieValue"?;}?? 在上面的代碼中我們使用@CookieValue綁定了cookie的值到方法參數(shù)上。上面一共綁定了兩個(gè)參數(shù),一個(gè)是明確指定要綁定的是名稱(chēng)為hello的cookie的值,一個(gè)是沒(méi)有指定。使用沒(méi)有指定的形式的規(guī)則和@PathVariable、@RequestParam的規(guī)則是一樣的,即在debug編譯模式下將自動(dòng)獲取跟方法參數(shù)名同名的cookie值。
(四)使用@RequestHeader注解綁定HttpServletRequest頭信息到Controller方法參數(shù)
@RequestMapping?(?"testRequestHeader"?) public?String?testRequestHeader(?@RequestHeader?(?"Host"?)?String?hostAddr,?@RequestHeader?String?Host,?@RequestHeader?String?host?)?{System.?out?.println(hostAddr?+?"-----"?+?Host?+?"-----"?+?host?);return?"requestHeader"?; }???????? 在上面的代碼中我們使用了@RequestHeader綁定了HttpServletRequest請(qǐng)求頭host到Controller的方法參數(shù)。上面方法的三個(gè)參數(shù)都將會(huì)賦予同一個(gè)值,由此我們可以知道在綁定請(qǐng)求頭參數(shù)到方法參數(shù)的時(shí)候規(guī)則和@PathVariable、@RequestParam以及@CookieValue是一樣的,即沒(méi)有指定綁定哪個(gè)參數(shù)到方法參數(shù)的時(shí)候,在debug編譯模式下將使用方法參數(shù)名作為需要綁定的參數(shù)。但是有一點(diǎn)@RequestHeader跟另外三種綁定方式是不一樣的,那就是在使用@RequestHeader的時(shí)候是大小寫(xiě)不敏感的,即@RequestHeader(“Host”)和@RequestHeader(“host”)綁定的都是Host頭信息。記住在@PathVariable、@RequestParam和@CookieValue中都是大小寫(xiě)敏感的。
(五)@RequestMapping的一些高級(jí)應(yīng)用
???????? 在RequestMapping中除了指定請(qǐng)求路徑value屬性外,還有其他的屬性可以指定,如params、method和headers。這樣屬性都可以用于縮小請(qǐng)求的映射范圍。
?
1.params屬性
?
?? params屬性用于指定請(qǐng)求參數(shù)的,先看以下代碼。
????@RequestMapping?(value=?"testParams"?,?params={?"param1=value1"?,?"param2"?,?"!param3"?})public?String?testParams()?{System.?out?.println(?"test?Params..........."?);return?"testParams"?;}?? 在上面的代碼中我們用@RequestMapping的params屬性指定了三個(gè)參數(shù),這些參數(shù)都是針對(duì)請(qǐng)求參數(shù)而言的,它們分別表示參數(shù)param1的值必須等于value1,參數(shù)param2必須存在,值無(wú)所謂,參數(shù)param3必須不存在,只有當(dāng)請(qǐng)求/testParams.do并且滿(mǎn)足指定的三個(gè)參數(shù)條件的時(shí)候才能訪問(wèn)到該方法。所以當(dāng)請(qǐng)求/testParams.do?param1=value1¶m2=value2的時(shí)候能夠正確訪問(wèn)到該testParams方法,當(dāng)請(qǐng)求/testParams.do?param1=value1¶m2=value2¶m3=value3的時(shí)候就不能夠正常的訪問(wèn)到該方法,因?yàn)樵?#64;RequestMapping的params參數(shù)里面指定了參數(shù)param3是不能存在的。
?
2.method屬性
?
?? method屬性主要是用于限制能夠訪問(wèn)的方法類(lèi)型的。
?
????@RequestMapping?(value=?"testMethod"?,?method={RequestMethod.?GET?,?RequestMethod.?DELETE?})public?String?testMethod()?{return?"method"?;}在上面的代碼中就使用method參數(shù)限制了以GET或DELETE方法請(qǐng)求/testMethod.do的時(shí)候才能訪問(wèn)到該Controller的testMethod方法。
?
3.headers屬性
?
???????? 使用headers屬性可以通過(guò)請(qǐng)求頭信息來(lái)縮小@RequestMapping的映射范圍。
????@RequestMapping?(value=?"testHeaders"?,?headers={?"host=localhost"?,?"Accept"?})public?String?testHeaders()?{return?"headers"?;}?
?? headers屬性的用法和功能與params屬性相似。在上面的代碼中當(dāng)請(qǐng)求/testHeaders.do的時(shí)候只有當(dāng)請(qǐng)求頭包含Accept信息,且請(qǐng)求的host為localhost的時(shí)候才能正確的訪問(wèn)到testHeaders方法。
(六)以@RequestMapping標(biāo)記的處理器方法支持的方法參數(shù)和返回類(lèi)型
1.支持的方法參數(shù)類(lèi)型
???????? (1)HttpServlet對(duì)象,主要包括HttpServletRequest、HttpServletResponse和HttpSession對(duì)象。這些參數(shù)Spring在調(diào)用處理器方法的時(shí)候會(huì)自動(dòng)給它們賦值,所以當(dāng)在處理器方法中需要使用到這些對(duì)象的時(shí)候,可以直接在方法上給定一個(gè)方法參數(shù)的申明,然后在方法體里面直接用就可以了。但是有一點(diǎn)需要注意的是在使用HttpSession對(duì)象的時(shí)候,如果此時(shí)HttpSession對(duì)象還沒(méi)有建立起來(lái)的話(huà)就會(huì)有問(wèn)題。
?? (2)Spring自己的WebRequest對(duì)象。使用該對(duì)象可以訪問(wèn)到存放在HttpServletRequest和HttpSession中的屬性值。
?? (3)InputStream、OutputStream、Reader和Writer。InputStream和Reader是針對(duì)HttpServletRequest而言的,可以從里面取數(shù)據(jù);OutputStream和Writer是針對(duì)HttpServletResponse而言的,可以往里面寫(xiě)數(shù)據(jù)。
?? (4)使用@PathVariable、@RequestParam、@CookieValue和@RequestHeader標(biāo)記的參數(shù)。
?? (5)使用@ModelAttribute標(biāo)記的參數(shù)。
?? (6)java.util.Map、Spring封裝的Model和ModelMap。這些都可以用來(lái)封裝模型數(shù)據(jù),用來(lái)給視圖做展示。
?? (7)實(shí)體類(lèi)。可以用來(lái)接收上傳的參數(shù)。
?? (8)Spring封裝的MultipartFile。用來(lái)接收上傳文件的。
?? (9)Spring封裝的Errors和BindingResult對(duì)象。這兩個(gè)對(duì)象參數(shù)必須緊接在需要驗(yàn)證的實(shí)體對(duì)象參數(shù)之后,它里面包含了實(shí)體對(duì)象的驗(yàn)證結(jié)果。
2.支持的返回類(lèi)型
???????? (1)一個(gè)包含模型和視圖的ModelAndView對(duì)象。
?? (2)一個(gè)模型對(duì)象,這主要包括Spring封裝好的Model和ModelMap,以及java.util.Map,當(dāng)沒(méi)有視圖返回的時(shí)候視圖名稱(chēng)將由RequestToViewNameTranslator來(lái)決定。
?? (3)一個(gè)View對(duì)象。這個(gè)時(shí)候如果在渲染視圖的過(guò)程中模型的話(huà)就可以給處理器方法定義一個(gè)模型參數(shù),然后在方法體里面往模型中添加值。
?? (4)一個(gè)String字符串。這往往代表的是一個(gè)視圖名稱(chēng)。這個(gè)時(shí)候如果需要在渲染視圖的過(guò)程中需要模型的話(huà)就可以給處理器方法一個(gè)模型參數(shù),然后在方法體里面往模型中添加值就可以了。
?? (5)返回值是void。這種情況一般是我們直接把返回結(jié)果寫(xiě)到HttpServletResponse中了,如果沒(méi)有寫(xiě)的話(huà),那么Spring將會(huì)利用RequestToViewNameTranslator來(lái)返回一個(gè)對(duì)應(yīng)的視圖名稱(chēng)。如果視圖中需要模型的話(huà),處理方法與返回字符串的情況相同。
?? (6)如果處理器方法被注解@ResponseBody標(biāo)記的話(huà),那么處理器方法的任何返回類(lèi)型都會(huì)通過(guò)HttpMessageConverters轉(zhuǎn)換之后寫(xiě)到HttpServletResponse中,而不會(huì)像上面的那些情況一樣當(dāng)做視圖或者模型來(lái)處理。
?? (7)除以上幾種情況之外的其他任何返回類(lèi)型都會(huì)被當(dāng)做模型中的一個(gè)屬性來(lái)處理,而返回的視圖還是由RequestToViewNameTranslator來(lái)決定,添加到模型中的屬性名稱(chēng)可以在該方法上用@ModelAttribute(“attributeName”)來(lái)定義,否則將使用返回類(lèi)型的類(lèi)名稱(chēng)的首字母小寫(xiě)形式來(lái)表示。使用@ModelAttribute標(biāo)記的方法會(huì)在@RequestMapping標(biāo)記的方法執(zhí)行之前執(zhí)行。
(七)使用@ModelAttribute和@SessionAttributes傳遞和保存數(shù)據(jù)
?????? SpringMVC支持使用@ModelAttribute和@SessionAttributes在不同的模型和控制器之間共享數(shù)據(jù)。@ModelAttribute主要有兩種使用方式,一種是標(biāo)注在方法上,一種是標(biāo)注在Controller方法參數(shù)上。
當(dāng)@ModelAttribute標(biāo)記在方法上的時(shí)候,該方法將在處理器方法執(zhí)行之前執(zhí)行,然后把返回的對(duì)象存放在session或模型屬性中,屬性名稱(chēng)可以使用@ModelAttribute(“attributeName”)在標(biāo)記方法的時(shí)候指定,若未指定,則使用返回類(lèi)型的類(lèi)名稱(chēng)(首字母小寫(xiě))作為屬性名稱(chēng)。關(guān)于@ModelAttribute標(biāo)記在方法上時(shí)對(duì)應(yīng)的屬性是存放在session中還是存放在模型中,我們來(lái)做一個(gè)實(shí)驗(yàn),看下面一段代碼。
@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"?);} }當(dāng)我們請(qǐng)求/myTest/sayHello.do的時(shí)候使用@ModelAttribute標(biāo)記的方法會(huì)先執(zhí)行,然后把它們返回的對(duì)象存放到模型中。最終訪問(wèn)到sayHello方法的時(shí)候,使用@ModelAttribute標(biāo)記的方法參數(shù)都能被正確的注入值。執(zhí)行結(jié)果如下圖所示:
?????? 由執(zhí)行結(jié)果我們可以看出來(lái),此時(shí)session中沒(méi)有包含任何屬性,也就是說(shuō)上面的那些對(duì)象都是存放在模型屬性中,而不是存放在session屬性中。那要如何才能存放在session屬性中呢?這個(gè)時(shí)候我們先引入一個(gè)新的概念@SessionAttributes,它的用法會(huì)在講完@ModelAttribute之后介紹,這里我們就先拿來(lái)用一下。我們?cè)?span style="font-size:19px;">MyController類(lèi)上加上@SessionAttributes屬性標(biāo)記哪些是需要存放到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或者類(lèi)型為User的都會(huì)放到Session中,利用上面的代碼當(dāng)我們?cè)L問(wèn)/myTest/sayHello.do的時(shí)候,結(jié)果如下:
?????? 仍然沒(méi)有打印出任何session屬性,這是怎么回事呢?怎么定義了把模型中屬性名為intValue的對(duì)象和類(lèi)型為User的對(duì)象存到session中,而實(shí)際上沒(méi)有加進(jìn)去呢?難道我們錯(cuò)啦?我們當(dāng)然沒(méi)有錯(cuò),只是在第一次訪問(wèn)/myTest/sayHello.do的時(shí)候@SessionAttributes定義了需要存放到session中的屬性,而且這個(gè)模型中也有對(duì)應(yīng)的屬性,但是這個(gè)時(shí)候還沒(méi)有加到session中,所以session中不會(huì)有任何屬性,等處理器方法執(zhí)行完成后Spring才會(huì)把模型中對(duì)應(yīng)的屬性添加到session中。所以當(dāng)請(qǐng)求第二次的時(shí)候就會(huì)出現(xiàn)如下結(jié)果:
當(dāng)@ModelAttribute標(biāo)記在處理器方法參數(shù)上的時(shí)候,表示該參數(shù)的值將從模型或者Session中取對(duì)應(yīng)名稱(chēng)的屬性值,該名稱(chēng)可以通過(guò)@ModelAttribute(“attributeName”)來(lái)指定,若未指定,則使用參數(shù)類(lèi)型的類(lèi)名稱(chēng)(首字母小寫(xiě))作為屬性名稱(chēng)。
@Controller @RequestMapping?(?"/myTest"?) public?class?MyController?{@ModelAttribute?(?"hello"?)public?String?getModel()?{return?"world"?;}@RequestMapping?(?"sayHello"?)public?void?sayHello(?@ModelAttribute?(?"hello"?)?String?hello,?Writer?writer)?throws?IOException?{writer.write(?"Hello?"?+?hello);}??? }在上面代碼中,當(dāng)我們請(qǐng)求/myTest/sayHello.do的時(shí)候,由于MyController中的方法getModel使用了注解@ModelAttribute進(jìn)行標(biāo)記,所以在執(zhí)行請(qǐng)求方法sayHello之前會(huì)先執(zhí)行g(shù)etModel方法,這個(gè)時(shí)候getModel方法返回一個(gè)字符串world并把它以屬性名hello保存在模型中,接下來(lái)訪問(wèn)請(qǐng)求方法sayHello的時(shí)候,該方法的hello參數(shù)使用@ModelAttribute(“hello”)進(jìn)行標(biāo)記,這意味著將從session或者模型中取屬性名稱(chēng)為hello的屬性值賦給hello參數(shù),所以這里hello參數(shù)將被賦予值world,所以請(qǐng)求完成后將會(huì)在頁(yè)面上看到Hello world字符串。
@SessionAttributes用于標(biāo)記需要在Session中使用到的數(shù)據(jù),包括從Session中取數(shù)據(jù)和存數(shù)據(jù)。@SessionAttributes一般是標(biāo)記在Controller類(lèi)上的,可以通過(guò)名稱(chēng)、類(lèi)型或者名稱(chēng)加類(lèi)型的形式來(lái)指定哪些屬性是需要存放在session中的。
@Controller @RequestMapping?(?"/myTest"?) @SessionAttributes?(value={?"user1"?,?"blog1"?},?types={User.?class?,?Blog.?class?}) public?class?MyController?{@RequestMapping?(?"setSessionAttribute"?)public?void?setSessionAttribute(Map<String,?Object>?map,?Writer?writer)?throws?IOException?{User?user?=?new?User(1,?"user"?);User?user1?=?new?User(2,?"user1"?);Blog?blog?=?new?Blog(1,?"blog"?);Blog?blog1?=?new?Blog(2,?"blog1"?);map.put(?"user"?,?user);map.put(?"user1"?,?user1);map.put(?"blog"?,?blog);map.put(?"blog1"?,?blog1);writer.write(?"over."?);}@RequestMapping?(?"useSessionAttribute"?)public?void?useSessionAttribute(Writer?writer,?@ModelAttribute?(?"user1"?)?User?user1,?@ModelAttribute?(?"blog1"?)?Blog?blog1)?throws?IOException?{writer.write(user1.getId()?+?"--------"?+?user1.getUsername());writer.write(?"\r"?);writer.write(blog1.getId()?+?"--------"?+?blog1.getTitle());}@RequestMapping?(?"useSessionAttribute2"?)public?void?useSessionAttribute(Writer?writer,?@ModelAttribute?(?"user1"?)?User?user1,?@ModelAttribute?(?"blog1"?)?Blog?blog1,?@ModelAttribute?User?user,?HttpSession?session)?throws?IOException?{writer.write(user1.getId()?+?"--------"?+?user1.getUsername());writer.write(?"\r"?);writer.write(blog1.getId()?+?"--------"?+?blog1.getTitle());writer.write(?"\r"?);writer.write(user.getId()?+?"---------"?+?user.getUsername());writer.write(?"\r"?);Enumeration?enume?=?session.getAttributeNames();while?(enume.hasMoreElements())writer.write(enume.nextElement()?+?"?\r"?);}@RequestMapping?(?"useSessionAttribute3"?)public?void?useSessionAttribute(?@ModelAttribute?(?"user2"?)?User?user)?{} }?
?? 在上面代碼中我們可以看到在MyController上面使用了@SessionAttributes標(biāo)記了需要使用到的Session屬性。可以通過(guò)名稱(chēng)和類(lèi)型指定需要存放到Session中的屬性,對(duì)應(yīng)@SessionAttributes注解的value和types屬性。當(dāng)使用的是types屬性的時(shí)候,那么使用的Session屬性名稱(chēng)將會(huì)是對(duì)應(yīng)類(lèi)型的名稱(chēng)(首字母小寫(xiě))。當(dāng)value和types兩個(gè)屬性都使用到了的時(shí)候,這時(shí)候取的是它們的并集,而不是交集,所以上面代碼中指定要存放在Session中的屬性有名稱(chēng)為user1或blog1的對(duì)象,或類(lèi)型為User或Blog的對(duì)象。在上面代碼中我們首先訪問(wèn)/myTest/setSessionAttribute.do,該請(qǐng)求將會(huì)請(qǐng)求到MyController的setSessionAttribute方法,在該方法中,我們往模型里面添加了user、user1、blog和blog1四個(gè)屬性,因?yàn)樗鼈兓蚋?lèi)上的@SessionAttributes定義的需要存到session中的屬性名稱(chēng)相同或類(lèi)型相同,所以在請(qǐng)求完成后這四個(gè)屬性都將添加到session屬性中。接下來(lái)訪問(wèn)/myTest/useSessionAttribute.do,該請(qǐng)求將會(huì)請(qǐng)求MyController的useSessionAttribute(Writerwriter, @ModelAttribute(“user1”) User user1, @ModelAttribute(“blog1”) Blog blog)方法,該方法參數(shù)中用@ModelAttribute指定了參數(shù)user1和參數(shù)blog1是需要從session或模型中綁定的,恰好這個(gè)時(shí)候session中已經(jīng)有了這兩個(gè)屬性,所以這個(gè)時(shí)候在方法執(zhí)行之前會(huì)先綁定這兩個(gè)參數(shù)。執(zhí)行結(jié)果如下圖所示:
?? 接下來(lái)訪問(wèn)/myTest/useSessionAttribute2.do,這個(gè)時(shí)候請(qǐng)求的是上面代碼中對(duì)應(yīng)的第二個(gè)useSessionAttribute方法,方法參數(shù)user、user1和blog1用@ModelAttribute聲明了需要session或模型屬性注入,我們知道在請(qǐng)求/myTest/setSessionAttribute.do的時(shí)候這些屬性都已經(jīng)添加到了session中,所以該請(qǐng)求的結(jié)果會(huì)如下圖所示:
?? 接下來(lái)訪問(wèn)/myTest/useSessionAttribute3.do,這個(gè)時(shí)候請(qǐng)求的是上面代碼中對(duì)應(yīng)的第三個(gè)useSessionAttribute方法,我們可以看到該方法的方法參數(shù)user使用了@ModelAttribute(“user2”)進(jìn)行標(biāo)記,表示user需要session中的user2屬性來(lái)注入,但是這個(gè)時(shí)候我們知道session中是不存在user2屬性的,所以這個(gè)時(shí)候就會(huì)報(bào)錯(cuò)了。執(zhí)行結(jié)果如圖所示:
(八)定制自己的類(lèi)型轉(zhuǎn)換器
???????? 在通過(guò)處理器方法參數(shù)接收request請(qǐng)求參數(shù)綁定數(shù)據(jù)的時(shí)候,對(duì)于一些簡(jiǎn)單的數(shù)據(jù)類(lèi)型Spring會(huì)幫我們自動(dòng)進(jìn)行類(lèi)型轉(zhuǎn)換,而對(duì)于一些復(fù)雜的類(lèi)型由于Spring沒(méi)法識(shí)別,所以也就不能幫助我們進(jìn)行自動(dòng)轉(zhuǎn)換了,這個(gè)時(shí)候如果我們需要Spring來(lái)幫我們自動(dòng)轉(zhuǎn)換的話(huà)就需要我們給Spring注冊(cè)一個(gè)對(duì)特定類(lèi)型的識(shí)別轉(zhuǎn)換器。Spring允許我們提供兩種類(lèi)型的識(shí)別轉(zhuǎn)換器,一種是注冊(cè)在Controller中的,一種是注冊(cè)在SpringMVC的配置文件中。聰明的讀者看到這里應(yīng)該可以想到它們的區(qū)別了,定義在Controller中的是局部的,只在當(dāng)前Controller中有效,而放在SpringMVC配置文件中的是全局的,所有Controller都可以拿來(lái)使用。
1.在@InitBinder標(biāo)記的方法中定義局部的類(lèi)型轉(zhuǎn)換器
???????? 我們可以使用@InitBinder注解標(biāo)注在Controller方法上,然后在方法體里面注冊(cè)數(shù)據(jù)綁定的轉(zhuǎn)換器,這主要是通過(guò)WebDataBinder進(jìn)行的。我們可以給需要注冊(cè)數(shù)據(jù)綁定的轉(zhuǎn)換器的方法一個(gè)WebDataBinder參數(shù),然后給該方法加上@InitBinder注解,這樣當(dāng)該Controller中在處理請(qǐng)求方法時(shí)如果發(fā)現(xiàn)有不能解析的對(duì)象的時(shí)候,就會(huì)看該類(lèi)中是否有使用@InitBinder標(biāo)記的方法,如果有就會(huì)執(zhí)行該方法,然后看里面定義的類(lèi)型轉(zhuǎn)換器是否與當(dāng)前需要的類(lèi)型匹配。
@Controller @RequestMapping?(?"/myTest"?) public?class?MyController?{@InitBinderpublic?void?dataBinder(WebDataBinder?binder)?{DateFormat?dateFormat?=?new?SimpleDateFormat(?"yyyyMMdd"?);PropertyEditor?propertyEditor?=?new?CustomDateEditor(dateFormat,?true?);?//?第二個(gè)參數(shù)表示是否允許為空binder.registerCustomEditor(Date.?class?,?propertyEditor);}@RequestMapping?(?"dataBinder/{date}"?)public?void?testDate(?@PathVariable?Date?date,?Writer?writer)?throws?IOException?{writer.write(String.valueOf?(date.getTime()));}}?????? 在上面的代碼中當(dāng)我們請(qǐng)求/myTest/dataBinder/20121212.do的時(shí)候,Spring就會(huì)利用@InitBinder標(biāo)記的方法里面定義的類(lèi)型轉(zhuǎn)換器把字符串20121212轉(zhuǎn)換為一個(gè)Date對(duì)象。這樣定義的類(lèi)型轉(zhuǎn)換器是局部的類(lèi)型轉(zhuǎn)換器,一旦出了這個(gè)Controller就不會(huì)再起作用。類(lèi)型轉(zhuǎn)換器是通過(guò)WebDataBinder對(duì)象的registerCustomEditor方法來(lái)注冊(cè)的,要實(shí)現(xiàn)自己的類(lèi)型轉(zhuǎn)換器就要實(shí)現(xiàn)自己的PropertyEditor對(duì)象。Spring已經(jīng)給我們提供了一些常用的屬性編輯器,如CustomDateEditor、CustomBooleanEditor等。
?????? PropertyEditor是一個(gè)接口,要實(shí)現(xiàn)自己的PropertyEditor類(lèi)我們可以實(shí)現(xiàn)這個(gè)接口,然后實(shí)現(xiàn)里面的方法。但是PropertyEditor里面定義的方法太多了,這樣做比較麻煩。在java中有一個(gè)封裝類(lèi)是實(shí)現(xiàn)了PropertyEditor接口的,它是PropertyEditorSupport類(lèi)。所以如果需要實(shí)現(xiàn)自己的PropertyEditor的時(shí)候只需要繼承PropertyEditorSupport類(lèi),然后重寫(xiě)其中的一些方法。一般就是重寫(xiě)setAsText和getAsText方法就可以了,setAsText方法是用于把字符串類(lèi)型的值轉(zhuǎn)換為對(duì)應(yīng)的對(duì)象的,而getAsText方法是用于把對(duì)象當(dāng)做字符串來(lái)返回的。在setAsText中我們一般先把字符串類(lèi)型的對(duì)象轉(zhuǎn)為特定的對(duì)象,然后利用PropertyEditor的setValue方法設(shè)定轉(zhuǎn)換后的值。在getAsText方法中一般先使用getValue方法取代當(dāng)前的對(duì)象,然后把它轉(zhuǎn)換為字符串后再返回給getAsText方法。下面是一個(gè)示例:
????@InitBinderpublic?void?dataBinder(WebDataBinder?binder)?{//?定義一個(gè)?User?屬性編輯器PropertyEditor?userEditor?=?new?PropertyEditorSupport()?{@Overridepublic?String?getAsText()?{//?TODO?Auto-generated?method?stubUser?user?=?(User)?getValue();return?user.getUsername();}@Overridepublic?void?setAsText(String?userStr)?throws?IllegalArgumentException?{//?TODO?Auto-generated?method?stubUser?user?=?new?User(1,?userStr);setValue(user);}};//?使用?WebDataBinder?注冊(cè)?User?類(lèi)型的屬性編輯器binder.registerCustomEditor(User.?class?,?userEditor);}??
2.實(shí)現(xiàn)WebBindingInitializer接口定義全局的類(lèi)型轉(zhuǎn)換器
?????? 如果需要定義全局的類(lèi)型轉(zhuǎn)換器就需要實(shí)現(xiàn)自己的WebBindingInitializer對(duì)象,然后把該對(duì)象注入到AnnotationMethodHandlerAdapter中,這樣Spring在遇到自己不能解析的對(duì)象的時(shí)候就會(huì)到全局的WebBindingInitializer的initBinder方法中去找,每次遇到不認(rèn)識(shí)的對(duì)象時(shí),initBinder方法都會(huì)被執(zhí)行一遍。
public?class?MyWebBindingInitializer?implements?WebBindingInitializer?{@Overridepublic?void?initBinder(WebDataBinder?binder,?WebRequest?request)?{//?TODO?Auto-generated?method?stubDateFormat?dateFormat?=?new?SimpleDateFormat(?"yyyyMMdd"?);PropertyEditor?propertyEditor?=?new?CustomDateEditor(dateFormat,?true?);binder.registerCustomEditor(Date.?class?,?propertyEditor);}}定義了這么一個(gè)WebBindingInitializer對(duì)象之后Spring還是不能識(shí)別其中指定的對(duì)象,這是因?yàn)槲覀冎皇嵌x了WebBindingInitializer對(duì)象,還沒(méi)有把它交給Spring,Spring不知道該去×××解析器。要讓Spring能夠識(shí)別還需要我們?cè)?span style="font-size:19px;">SpringMVC的配置文件中定義一個(gè)AnnotationMethodHandlerAdapter類(lèi)型的bean對(duì)象,然后利用自己定義的WebBindingInitializer覆蓋它的默認(rèn)屬性webBindingInitializer。
?
????<?bean?class?=?"org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter"?><?property?name?=?"webBindingInitializer"?><?bean?class?=?"com.host.app.web.util.MyWebBindingInitializer"?/></?property?></?bean?>?
3.觸發(fā)數(shù)據(jù)綁定方法的時(shí)間
當(dāng)Controller處理器方法參數(shù)使用@RequestParam、 @PathVariable、@RequestHeader、@CookieValue和@ModelAttribute標(biāo)記的時(shí)候都會(huì)觸發(fā) initBinder方法的執(zhí)行,這包括使用WebBindingInitializer定義的全局方法和在Controller中使用 @InitBinder標(biāo)記的局部方法。而且每個(gè)使用了這幾個(gè)注解標(biāo)記的參數(shù)都會(huì)觸發(fā)一次initBinder方法的執(zhí)行,這也意味著有幾個(gè)參數(shù)使用了上 述注解就會(huì)觸發(fā)幾次initBinder方法的執(zhí)行。
?
轉(zhuǎn)載于:https://blog.51cto.com/wuwen2011/1567879
總結(jié)
以上是生活随笔為你收集整理的SpringMVC _Controller认识(1)的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問(wèn)題。
- 上一篇: Lucene工具箱之OpenBitSet
- 下一篇: Reveal使用步骤和 破解Reveal