JSF請(qǐng)求處理過(guò)程詳解
JSF應(yīng)用中,在web.xml里面配置了一個(gè)Servlet,叫做javax.faces.webapp.FacesServlet,于是可以知道,查看、了解一個(gè)請(qǐng)求的處理過(guò)程可以從這里開(kāi)始。從官方網(wǎng)站上下載JSF的源代碼,項(xiàng)目名比較古怪,叫做“mojarra”,我看的版本是1.2_12_b01。里面包含了兩個(gè)子項(xiàng)目,一個(gè)是jsf-api,里面大多是接口以及少量關(guān)鍵類。另外一個(gè)項(xiàng)目叫做jsf-ri,對(duì)著這個(gè)"ri"邪念了半天之后,終于在兄弟提醒之下想明白了是reference implementation的意思。jsf-api是JavaEE標(biāo)準(zhǔn)的一部分,里面的類型包名都是以javax.faces開(kāi)頭的,而jsf-ri項(xiàng)目是sun針對(duì)JSF標(biāo)準(zhǔn)的一個(gè)參考實(shí)現(xiàn),里面的類型的包名都是以com.sun.faces開(kāi)頭的。
FacesServlet初始化(FacesServlet#init)
JSF請(qǐng)求處理過(guò)程中,系統(tǒng)啟動(dòng)的時(shí)候,會(huì)初始化FacesServlet,調(diào)用其中的init方法。里面主要做了兩件事情,一個(gè)是初始化FacesContextFactory,另外一個(gè)是初始化Lifecycle對(duì)象。在jsf-api項(xiàng)目中,F(xiàn)acesServlet類是一個(gè)Servlet接口的實(shí)現(xiàn)類,而FacesContextFactory和Lifecycle都是接口。在jsf-ri項(xiàng)目中有這兩個(gè)接口的實(shí)現(xiàn)類,分別是com.sun.faces.context.FacesContextFactoryImpl和com.sun.faces.lifecycle.LifecycleImpl類。一個(gè)想當(dāng)然的事實(shí):FacesServlet初始化的時(shí)候要根據(jù)一些配置來(lái)判斷具體的FacesContextFactory和Lifecycle實(shí)現(xiàn)類是什么,也就是在這里,“JSF標(biāo)準(zhǔn)”和“JSF實(shí)現(xiàn)”接軌了。想來(lái)MyFaces等等的其他JSF實(shí)現(xiàn)應(yīng)該不外乎兩種方式,一種是改變FacesServlet的init方法中需要用到的配置的值,于是啟用自己的FacesContextFactory實(shí)現(xiàn)和Lifecycle實(shí)現(xiàn),后面的處理過(guò)程就全部走自己的邏輯了。第二種方法笨一點(diǎn),可能性不大,就是把FacesServlet覆蓋替換掉,其中也不需要讀什么配置了,直接使用自己的實(shí)現(xiàn)類即可——不過(guò)這種做法估計(jì)不符合JSF規(guī)范,想來(lái)只有我等蝦米民眾能做的出來(lái)。主要代碼如下:
- 1 facesContextFactory = (FacesContextFactory)FactoryFinder.
getFactory(FactoryFinder.FACES_CONTEXT_FACTORY);- 2
- 3 LifecycleFactory lifecycleFactory = (LifecycleFactory)FactoryFinder.
getFactory(FactoryFinder.LIFECYCLE_FACTORY);
回頭再來(lái)看初始化的結(jié)果,F(xiàn)acesContextFactory很明顯是用來(lái)生產(chǎn)FacesContext這么個(gè)東西的。而FacesContext可以看做是一個(gè)RequestWrapper(注意這個(gè)FaceContext和ServletContext不一樣,ServletContext是一個(gè)Web應(yīng)用只有一個(gè)的全局對(duì)象,對(duì)應(yīng)的是一個(gè)Web application,而一個(gè)FacesContext對(duì)應(yīng)的是一個(gè)request,另外,RequestWrapper這個(gè)說(shuō)法不嚴(yán)格,實(shí)際上FacesContext里面也包裝了ServletContext、Response等)。而LifeCycle可以看做是一個(gè)過(guò)濾器鏈(類似于servlet規(guī)范里面的Filter Chain)。于是,整個(gè)JSF請(qǐng)求處理過(guò)程,實(shí)際上就是包裝成為FaceContext的用戶請(qǐng)求,通過(guò)類似于一個(gè)Filter Chain的LifeCycle的過(guò)程。
這總覽,很明顯是看FacesServlet的service方法。在FacesServlet的初始化過(guò)程中,構(gòu)造出了全局的FacesContextFactory對(duì)象和LifeCycle對(duì)象??梢园袴acesContextFactory看做是一個(gè)“請(qǐng)求包裝工廠”,于是很明顯,每當(dāng)一個(gè)請(qǐng)求到達(dá)FacesServlet的時(shí)候,第一步便是拿著請(qǐng)求,到包裝工廠里面包裝一下,而包裝的結(jié)果就是一個(gè)FacesContext。代碼如下:
FacesContext context = facesContextFactory.getFacesContext(servletConfig.getServletContext(), request, response, lifecycle);
在包裝過(guò)程中,實(shí)際上是創(chuàng)建了一個(gè)com.sun.faces.context.FacesContextImpl對(duì)象,F(xiàn)acesContextImpl類繼承了jsf-api項(xiàng)目中的javax.faces.context.FacesContext。FacesContextImpl的構(gòu)造方法的第一個(gè)參數(shù)是一個(gè)叫做ExternalContext的接口的實(shí)現(xiàn),查看其源代碼,可以看到ExternalContextImpl類耦合了Servlet API,而FacesContextImpl與Servlet API無(wú)關(guān)。實(shí)際上,在這里,做到了JSF可以不僅僅使用在Servlet環(huán)境中,正如ExternalContext接口的注釋中所說(shuō),在Servlet環(huán)境中使用JSF和在Portlet環(huán)境中使用JSF的不同,實(shí)際上就是使用了不同的ExternalContext。在FacesContextFactoryImpl中構(gòu)造FacesContextImpl的代碼如下:
- FacesContext ctx = new FacesContextImpl
- (new ExternalContextImpl((ServletContext) sc,
- (ServletRequest) request,(ServletResponse) response),
- lifecycle);
FacesContextImpl的構(gòu)造方法中,還做了另外一件事情,就是根據(jù)配置確定了RenderKitFactory,顯然不同的RenderKitFactory可以產(chǎn)生不同的RenderKit,而不同RenderKit對(duì)象是針對(duì)不同客戶端的,所以對(duì)于瀏覽器、移動(dòng)設(shè)備等等,會(huì)有不同的RenderKit。FacesContextImpl的構(gòu)造方法中代碼如下:
- this.externalContext = ec;
- setCurrentInstance(this);
- this.rkFactory = (RenderKitFactory)FactoryFinder.getFactory(FactoryFinder.RENDER_KIT_FACTORY);
在代碼中我們經(jīng)常使用FacesContext.getCurrentInstance()這個(gè)靜態(tài)方法來(lái)獲取與當(dāng)前請(qǐng)求對(duì)應(yīng)的FacesContext對(duì)象,實(shí)際上是在FacesContext類里面有一個(gè)靜態(tài)的ThreadLocal對(duì)象用來(lái)存放了當(dāng)前請(qǐng)求線程對(duì)應(yīng)的FacesContext對(duì)象,于是上面的代碼中setCurrentInstance(this)就是把當(dāng)前構(gòu)造出來(lái)的這個(gè)FacesContext對(duì)象放到了ThreadLocal里面。
FacesContext創(chuàng)建出來(lái)以后,正如上面所說(shuō),要讓他經(jīng)過(guò)LifeCycle這個(gè)“Filter Chain”的逐步處理了。那么,F(xiàn)ilter Chain里面放的是一個(gè)一個(gè)Filter,那么LifeCycle這個(gè)Chain里面放的是什么呢?答案是Phases。
FacesServlet讓FaceContext通過(guò)LifeCycle的處理,分成了兩個(gè)部分。一個(gè)部分是調(diào)用LifeCycle的execute方法,執(zhí)行邏輯,第二個(gè)部分是調(diào)用LifeCycle的render方法,呈現(xiàn)響應(yīng)。FacesServlet.service中代碼如下:
- lifecycle.execute(context);
- lifecycle.render(context);
在LifeCycleImpl這個(gè)實(shí)現(xiàn)中,存放了一個(gè)Phase對(duì)象的數(shù)組,存放了7個(gè)Phase。其中第一個(gè)是null,然后依次是視圖重建、應(yīng)用請(qǐng)求值、驗(yàn)證、更新模型值、執(zhí)行應(yīng)用程序、呈現(xiàn)響應(yīng)。在execute方法中,調(diào)用了從視圖重建開(kāi)始到執(zhí)行應(yīng)用程序?yàn)橹沟?個(gè)Phase,而在render方法中,調(diào)用了最后一個(gè)Phase,也就是呈現(xiàn)響應(yīng)。在LifeCycleImpl類中,代碼如下:
- //The Phase instance for the render() method
- private Phase response = new RenderResponsePhase();
- // The set of Phase instances that are executed by the execute() method
- // in order by the ordinal property of each phase
- private Phase[] phases = {
- null, // ANY_PHASE placeholder, not a real Phase
- new RestoreViewPhase(),
- new ApplyRequestValuesPhase(),
- new ProcessValidationsPhase(),
- new UpdateModelValuesPhase(),
- new InvokeApplicationPhase(),
- response
- };
在Servlet Filter中,可以由每一個(gè)Filter來(lái)決定是否要調(diào)用下一個(gè)Filter,從而決定是否讓請(qǐng)求繼續(xù)通過(guò)Filter Chains中的后續(xù)Filter,是鏈?zhǔn)秸{(diào)用的過(guò)程。而在LifeCycle的execute方法中,是用一個(gè)for循環(huán)順序執(zhí)行幾個(gè)Phase。在每一個(gè)Phase執(zhí)行完之后,都會(huì)檢查FaceContext對(duì)象中是否設(shè)置了停止后續(xù)處理直接呈現(xiàn)響應(yīng)的標(biāo)志(renderResponse)或者已經(jīng)完成了響應(yīng)無(wú)需后續(xù)處理也不需要經(jīng)過(guò)呈現(xiàn)響應(yīng)階段了(responseComplete),如果標(biāo)志為true,那么就不再執(zhí)行后續(xù)Phase。
LifeCycleImpl的execute方法主要代碼如下:
- for (int i = 1, len = phases.length -1 ; i < len; i++) { // Skip ANY_PHASE placeholder
- if (context.getRenderResponse() ||
- context.getResponseComplete()) {
- break;
- }
- phases[i].doPhase(context, this, listeners.listIterator());
- }
在LifeCycle的render方法中,也會(huì)檢查FacesContext的responseComplete狀態(tài),如果為true,那么就不再執(zhí)行render Phase。于是我們此刻知道了在我們自己所寫的一些代碼或者JSF庫(kù)里面的一些代碼中,調(diào)用FacesContext的responseComplete方法和renderResponse得作用原理。render方法主要代碼如下:
- if (!context.getResponseComplete()) {
- response.doPhase(context, this,listeners.listIterator());
- }
另外注意,Phase這個(gè)概念、接口,以及幾個(gè)實(shí)現(xiàn),都是jsf-ri項(xiàng)目中的,而在jsf-api中不存在Phase這個(gè)概念。所以,LifeCycle是JSF標(biāo)準(zhǔn)的內(nèi)容,而通過(guò)幾個(gè)Phase來(lái)處理請(qǐng)求這種實(shí)現(xiàn)是sun的參考實(shí)現(xiàn)的做法。
最后,我們?cè)贘SF請(qǐng)求處理過(guò)程中可以看到對(duì)于每一個(gè)phase都調(diào)用了doPhase方法,同時(shí)把LifeCycle和FacesContext當(dāng)做參數(shù)傳入了。值得注意的是,所謂的phaseListener,也傳入了phase的doPhase方法中,由此大約能夠想明白這個(gè)“階段監(jiān)聽(tīng)器”的道理了。
【編輯推薦】