dwr.xml是DWR的配置文件。默認(rèn)情況下,應(yīng)該把它放到WEB-INF目錄(web.xml的目錄)下
創(chuàng)建dwr.xml文件
dwr.xml文件的結(jié)構(gòu)如下:
<!DOCTYPE dwr PUBLIC "-//GetAhead Limited//DTD Direct Web Remoting 1.0//EN" "http://www.getahead.ltd.uk/dwr/dwr10.dtd"><dwr> <!-- init is only needed if you are extending DWR --> <init> <creator id="..." class="..."/> <converter id="..." class="..."/> </init> <!-- without allow, DWR isn't allowed to do anything --> <allow> <create creator="..." javascript="..."/> <convert converter="..." match="..."/> </allow> <!-- you may need to tell DWR about method signatures --> <signatures> ... </signatures></dwr>
術(shù)語(yǔ)
這里是一些必須理解的術(shù)語(yǔ) - 參數(shù)會(huì)被converted,遠(yuǎn)程Bean會(huì)被created。所以如果你有一個(gè)叫A的bean,它有一個(gè)方法叫A.blah(B) 那么你需要一個(gè)A的creator和一個(gè)B的converter。
一:<allow>
allow段落里面定義的試DWR可以創(chuàng)建和轉(zhuǎn)換的類(lèi)。
二:Creators
dwr.xml文件中的create元素的結(jié)構(gòu)如下:
<allow> <create creator="..." javascript="..." scope="..."> <param name="..." value="..."/> <auth method="..." role="..."/> <exclude method="..."/> <include method="..."/> </create> ...</allow>
這里的多數(shù)元素都是可選的 - 你真正必須知道的是指定一個(gè)creator和一個(gè)javascript名字。
creator屬性 是必須的 - 它用來(lái)指定使用那種創(chuàng)造器。
默認(rèn)情況下DWR1.1有8種創(chuàng)造器。它們是:
- new: 用Java的new關(guān)鍵字創(chuàng)造對(duì)象。
- none: 它不創(chuàng)建對(duì)象,看下面的原因。 (v1.1+)
- scripted: 通過(guò)BSF使用腳本語(yǔ)言創(chuàng)建對(duì)象,例如BeanShell或Groovy。
- spring: 通過(guò)Spring框架訪(fǎng)問(wèn)Bean。
- jsf: 使用JSF的Bean。 (v1.1+)
- struts: 使用Struts的FormBean。 (v1.1+)
- pageflow: 訪(fǎng)問(wèn)Beehive或Weblogic的PageFlow。 (v1.1+)
如果你需要寫(xiě)自己的創(chuàng)造器,你必須在init部分注冊(cè)它。
javascript屬性 用于指定瀏覽器中這個(gè)被創(chuàng)造出來(lái)的對(duì)象的名字。你不能使用Javascript的關(guān)鍵字。
scope屬性 非常類(lèi)似servlet規(guī)范中的scope。 它允許你指定這個(gè)bean在什么生命范圍。選項(xiàng)有"application", "session", "request" 和"page"。這些值對(duì)于Servlet和JSP開(kāi)發(fā)者來(lái)說(shuō)應(yīng)該相當(dāng)熟悉了。
scope屬性是可選的。默認(rèn)是"page"。如果要使用"session"需要cookies。當(dāng)前的DWR不支持ULR重寫(xiě)。
param元素 被用來(lái)指定創(chuàng)造器的其他參數(shù),每種構(gòu)造器各有不同。例如,"new"創(chuàng)造器需要知道要?jiǎng)?chuàng)建的對(duì)象類(lèi)型是什么。每一個(gè)創(chuàng)造器的參數(shù)在各自的文檔中能找到。請(qǐng)查看上面的鏈接。
include和exclude元素 允許創(chuàng)造器來(lái)限制類(lèi)中方法的訪(fǎng)問(wèn)。一個(gè)創(chuàng)造器必須指定include列表或exclude列表之一。如果是include列表則暗示默認(rèn)的訪(fǎng)問(wèn)策略是"拒絕";如果是exclude列表則暗示默認(rèn)的訪(fǎng)問(wèn)策略是"允許"。
例如要拒絕防范除了setWibble()以外的所有方法,你應(yīng)該把如下內(nèi)容添加到dwr.xml中。
<create creator="new" javascript="Fred"> <param name="class" value="com.example.Fred"/> <include method="setWibble"/></create>
對(duì)于加入到create元素中的類(lèi)的所有方法都是默認(rèn)可見(jiàn)的。
auth元素 允許你指定一個(gè)J2EE的角色作為將來(lái)的訪(fǎng)問(wèn)控制檢查:
<create creator="new" javascript="Fred"> <param name="class" value="com.example.Fred"/> <auth method="setWibble" role="admin"/></create>
new創(chuàng)造器在DWR中已經(jīng)默認(rèn)聲明了:<creator id="new" class="uk.ltd.getahead.dwr.create.NewCreator"/> 。你不需要在dwr.xml文件中添加這段話(huà),它已經(jīng)存在于DWR的內(nèi)部dwr.xml文件中了。
這個(gè)創(chuàng)造器通過(guò)類(lèi)默認(rèn)的夠早函數(shù)創(chuàng)造對(duì)象實(shí)例。用new創(chuàng)造器有一些好處:
- 安全:DWR創(chuàng)造的對(duì)象生存的事件越短,多次調(diào)用中間的值不一致的錯(cuò)誤機(jī)會(huì)越少。
- 內(nèi)存消耗低: 如果你的站點(diǎn)用戶(hù)量非常大,這個(gè)創(chuàng)造器可以減少VM的內(nèi)存溢出。
你可以通過(guò)下面的方式使用new創(chuàng)造器來(lái)創(chuàng)造遠(yuǎn)程調(diào)用Bean:
<allow> <create creator="new" javascript="Blah"> <param name="class" value="java.util.Date"/> </create> ... </allow>
這些代碼把 java.util.Date 映射成Javascript,并且命名為Blah,所以在Javascript中當(dāng)你調(diào)用Blah.toString(reply) 那么一個(gè)新的 java.util.Date 就會(huì)通過(guò)默認(rèn)的構(gòu)造函數(shù)創(chuàng)造出來(lái), 然后 toString() 方法被調(diào)用, 然后結(jié)果數(shù)據(jù)返回給reply方法(在這個(gè)例子中date是字符串格式)。
none'創(chuàng)造器不創(chuàng)建任何對(duì)象 - 它會(huì)假設(shè)你不需要?jiǎng)?chuàng)建對(duì)象。這有可能是對(duì)的,有兩個(gè)原因。
你可能在使用的scope不是"page"(看上面),并在在前面已經(jīng)把這個(gè)對(duì)象創(chuàng)建到這個(gè)scope中了,這時(shí)你就不需要再創(chuàng)建對(duì)象了。
還有一種情況是要調(diào)用的方法是靜態(tài)的,這時(shí)也不需要?jiǎng)?chuàng)建對(duì)象。DWR會(huì)在調(diào)用創(chuàng)建器之前先檢查一下這個(gè)方法是不是靜態(tài)的。
對(duì)于上訴兩種情況,你仍然需要class參數(shù),用來(lái)告訴DWR它是在操作的對(duì)象類(lèi)型是什么。
scripted創(chuàng)造器在DWR中已經(jīng)默認(rèn)聲明了:<creator id="script" class="uk.ltd.getahead.dwr.create.ScriptedCreator"/>
這個(gè)創(chuàng)造器用BSF來(lái)執(zhí)行腳本得到Bean,例如:
<allow> ... <create creator="script" javascript="EmailValidator"> <param name="language" value="beanshell"/> <param name="script"> import org.apache.commons.validator.EmailValidator; return EmailValidator.getInstance(); </param> </create> ...</allow>
script創(chuàng)造器有如下參數(shù):
參數(shù) | DWR版本 | 描述 |
language |
1.0 |
腳本語(yǔ)言,字符串,例如'beanshell'. (必需) |
script |
1.0 |
要執(zhí)行的腳本。 (必需,除非scriptPath參數(shù)存在) |
scriptPath |
1.1 |
腳本文件路徑。 (必需,除非script參數(shù)存在) |
reloadable |
1.1 |
是否檢測(cè)腳本文件的改動(dòng),以重新加載 (可選, 默認(rèn)true) |
class |
1.0 |
創(chuàng)造出對(duì)象的類(lèi)型(可選). 如果沒(méi)有DWR通過(guò)創(chuàng)造器得到類(lèi)型。 |
需要了解的主題
要使用這個(gè)創(chuàng)造器,你需要把一些輔助庫(kù)放到WEB-INF/lib文件夾下:BSF的jar包
,你要用的腳本語(yǔ)言的jar包
。
當(dāng)
一個(gè)類(lèi)是用script創(chuàng)造出來(lái)的,并且scope是session或application,如果你的腳本改變,session中的類(lèi)和script中
的類(lèi)就不一致了。這樣會(huì)出現(xiàn)錯(cuò)誤。雖然web容器不用重啟,但是用戶(hù)需要先登出(或以某種方式清空session),然后再登錄。
當(dāng)clazz參數(shù)不為空,并且用來(lái)創(chuàng)造新實(shí)例,DWR簡(jiǎn)單的調(diào)用 class.newInstance() 方法。這種方法是沒(méi)問(wèn)題的,除非腳本正在用某個(gè)參數(shù)創(chuàng)建一個(gè)類(lèi),或者調(diào)用某個(gè)函數(shù)來(lái)配置這個(gè)類(lèi)。 不幸的是,每次請(qǐng)求都要重新運(yùn)行script并造成上面的問(wèn)題。
創(chuàng)造器
讓DWR和Spring一起工作的步驟
- 確認(rèn)你用的是最新版的DWR。Spring創(chuàng)造器已經(jīng)有了變化,所以你最好檢查一下DWR的最新版本
。
- 確認(rèn)你查看過(guò)開(kāi)始指南
中的內(nèi)容。
- 確認(rèn)你的Spring的Bean在DWR外面運(yùn)行良好。
- 配置DWR和Spring一起工作。 (看下面)
- 查看演示頁(yè)面: http://localhost:8080/[ YOUR-WEBAPP ]/dwr ,檢查spring的Bean是否出現(xiàn)。
DWR對(duì)于Spring沒(méi)有運(yùn)行期依賴(lài),所以如果你不使用Spring那么Spring的支持不會(huì)產(chǎn)生任何影響到。
The SpringCreator
這個(gè)創(chuàng)造器會(huì)查找spring的中配置的Bean,用Spring去創(chuàng)建它們。如果你已經(jīng)在使用Spring,那么這個(gè)創(chuàng)造器會(huì)非常有用。
你可以通過(guò)下面的方式來(lái)創(chuàng)建遠(yuǎn)程調(diào)用的Bean:
<allow> ... <create creator="spring" javascript="Fred"> <param name="beanName" value="Shiela"/> </create> </allow>
尋找你的Spring配置
有三種方式尋找配置文件:
ContextLoaderListener
最
簡(jiǎn)單的方式是使用org.springframework.web.context.ContextLoaderListener。你不必使用所有的
Spring-MVC功能,只需要這個(gè)Listener就夠了,所以這是個(gè)不錯(cuò)的方案。你需要在WEB-INF/web.xml中做如下配置:
<context-param> <param-name>contextConfigLocation</param-name> <param-value>/WEB-INF/classes/beans.xml</param-value> </context-param> <listener> <listener-class> org.springframework.web.context.ContextLoaderListener </listener-class> </listener>
我能找到的ContextLoaderListener的最好的文檔就是javadoc
。如果你知道還有更好的文檔,請(qǐng)告知我。
Rob Sanheim 指出還有一個(gè)能深入了解ContextLoaderListener
的文檔。
使用location*參數(shù)
如
果你要在dwr.xml中指定使用哪些bean,你可以使用location*參數(shù)。你可以指定任意多個(gè)文件,只要參數(shù)以location開(kāi)始并且唯一即
可。例如:location-1,
location-2。這些location被用做Spring的ClassPathXmlApplicationContext的參數(shù):
<allow> ... <create creator="spring" javascript="Fred"> <param name="beanName" value="Shiela"/> <param name="location" value="beans.xml"/> </create> </allow>
直接設(shè)置BeanFactory
SpringCreator有一個(gè)靜態(tài)方法 setOverrideBeanFactory(BeanFactory) 用來(lái)通過(guò)編程的方式直接設(shè)置BeanFactory。
配置DWR和Spring
Bram Smeets寫(xiě)了一個(gè)有意思的blog
,教你配置DWR使用beans.xml代替WEB-INF/web.xml。
我也對(duì)于如何在beans.xml中指定dwr.xml很感興趣,盡管這看上去有些Spring傳染病的感覺(jué)。有人知道如何實(shí)現(xiàn)嗎?請(qǐng)加入郵件列表并告訴大家。
整合
DWR包括兩個(gè)JSF的擴(kuò)展點(diǎn),一個(gè)創(chuàng)造器和一個(gè)ServletFilter。
'jsf'創(chuàng)造器
DWR1.1中有一個(gè)體驗(yàn)版的JsfCreator。你可以哉dwr.xml中這樣使用:
<allow> ... <create creator="jsf" javascript="ScriptName"> <param name="managedBeanName" value="beanName"/> <param name="class" value="your.class"/> </create> ...</allow>
這將允許你通過(guò)DWR調(diào)用ManagedBean。
The Servlet Filter
DWR/Faces 過(guò)濾器允許你不在JSF的生命周期里調(diào)用FacesContext中的Bean。
要使用JsfCreator,你應(yīng)該把DWR/Faces過(guò)濾器加到web.xml中。
<filter> <filter-name>DwrFacesFilter</filter-name> <filter-class>uk.ltd.getahead.dwr.servlet.FacesExtensionFilter</filter-class></filter><filter-mapping> <filter-name>DwrFacesFilter</filter-name> <url-pattern>/dwr/*</url-pattern></filter-mapping>
這兩個(gè)需要放在web.xml中與其他的filter和filter-mapping放在一起。
pageflow 創(chuàng)造器
DWR中有一個(gè)創(chuàng)造器可以和Weblogic或者Beehive中的PageFlow一起工作。
The 'pageflow' Creator
DWR1.1中加入了一個(gè)PageFlowCreator。你可以這樣使用:
<allow> ... <create creator="pageflow" javascript="ScriptName"/> ...</allow>
使用靜態(tài)方法
DWR會(huì)在調(diào)用創(chuàng)建器之前先檢查一下這個(gè)方法是不是靜態(tài)的,如果是那么創(chuàng)造器不會(huì)被調(diào)用。很顯然這個(gè)邏輯適用于所有創(chuàng)造器,盡管如此"null"創(chuàng)造器是最容易配置的。
適用單例類(lèi)
對(duì)于單例類(lèi)的創(chuàng)建,最好適用BeanShell和BSF來(lái)實(shí)例化對(duì)象。詳細(xì)信息參見(jiàn)
其他創(chuàng)造器
我么偶爾也需要一些新的創(chuàng)造器,最常見(jiàn)的是一個(gè)EjbCreator。討論新的創(chuàng)造器的好地方是在郵件列表
。
DWR和HttpSessionBindingListeners
DWR1.x中存貯已經(jīng)創(chuàng)造的Bean的方法需要注意,它在每次請(qǐng)求時(shí)都會(huì)調(diào)用相同的 setAttribute() 方法。就是說(shuō),如果一個(gè)Bean在dwr.xml中的聲明周期設(shè)置為session,再每次調(diào)用bean中的方法時(shí),DWR都會(huì)執(zhí)行一次 session.setAttribute(yourBean) 。這看上去沒(méi)有什么危害,但是如果你要使用servlet的事件機(jī)制的,就是說(shuō)用了HttpSessionBindingListener接口,你就會(huì)發(fā)現(xiàn)valueBound和valueUnbound事件在每次調(diào)用時(shí)都會(huì)發(fā)生,而不是你想像的在bean被創(chuàng)建時(shí)以及session過(guò)期時(shí)。
DWR2 只在第一次創(chuàng)建對(duì)象時(shí)調(diào)用 setAttribute() 。
三:Converters
我們必須保證所有的參數(shù)都可以被轉(zhuǎn)換。JDK中的多數(shù)類(lèi)型已經(jīng)有轉(zhuǎn)換器了,但是你需要給DWR轉(zhuǎn)換你的代碼的權(quán)利。一般來(lái)說(shuō)JavaBean的參數(shù)需要一個(gè)<convert ...>定義。
默認(rèn)情況下,如下類(lèi)型不需要定義就可以轉(zhuǎn)換:
- 所有的原生類(lèi)型 boolean,int,double, 等等
- 原生類(lèi)型的對(duì)象類(lèi)型 Boolean,Integer,等等
- java.lang.String
- java.util.Date 和SQL中的Date
- 以上類(lèi)型組成的數(shù)組
- 以上類(lèi)型的集合類(lèi)型 (Lists, Sets, Maps, Iterators, 等)
- 從DOM, XOM, JDOM 和 DOM4J中的DOM對(duì)象 (類(lèi)似 Element 和 Document)
下面這些轉(zhuǎn)換器有單獨(dú)章節(jié)介紹
基礎(chǔ)的轉(zhuǎn)換器
原生類(lèi)型,String,像BigDecimal這樣的簡(jiǎn)單對(duì)象的轉(zhuǎn)換器已經(jīng)有了。你不需要在dwr.xml中<allow>部分的<convert>中定義。它們默認(rèn)支持。
默
認(rèn)支持的類(lèi)型包括: boolean, byte, short, int, long, float, double, char,
java.lang.Boolean, java.lang.Byte, java.lang.Short, java.lang.Integer,
java.lang.Long, java.lang.Float, java.lang.Double, java.lang.Character,
java.math.BigInteger, java.math.BigDecimal 和 java.lang.String
Date轉(zhuǎn)換器
Date
轉(zhuǎn)換器負(fù)責(zé)在Javascript的Date類(lèi)型與Java中的Date類(lèi)型(java.util.Date, java.sql.Date,
java.sql.Times or
java.sql.Timestamp)之間進(jìn)行轉(zhuǎn)換。同基礎(chǔ)的轉(zhuǎn)換器一樣,DateConverter默認(rèn)是支持的。
如果你有一個(gè)
Javascript的字符串 (例如"01 Jan 2010")
,你想把它轉(zhuǎn)換成Java的Date類(lèi)型有兩個(gè)辦法:在javascript中用Date.parse()把它解析成Date類(lèi)型,然后用DWR的
DateConverter傳遞給服務(wù)器;或者把它作為字符串傳遞給Server,再用Java中的SimpleDateFormat(或者類(lèi)似的)來(lái)解
析。
同樣,如果你有個(gè)Java的Date類(lèi)型并且希望在HTML使用它。你可以先用SimpleDateFormat把它轉(zhuǎn)換成字符串再使
用。也可以直接傳Date給Javascript,然后用Javascript格式化。第一種方式簡(jiǎn)單一些,盡管浪費(fèi)了你的轉(zhuǎn)換器,而且這樣做也會(huì)是瀏覽
器上的顯示邏輯受到限制。其實(shí)后面的方法更好,也有一些工具可以幫你,例如:
其他對(duì)象
其實(shí)創(chuàng)建自己的轉(zhuǎn)換器也很簡(jiǎn)單。Converter接口的Javadoc包含了信息。其實(shí)這種需要很少出現(xiàn)。在你寫(xiě)自己的Converter之前先看看BeanConverter,它有可能就是你要的。
四:<init>
可選的init部分用來(lái)聲明創(chuàng)造bean的類(lèi)和轉(zhuǎn)換bean的類(lèi)。多數(shù)情況下你不需要用到他們。如果你需要定義一個(gè)新的Creator [JavaDoc
] 和 Converter [JavaDoc
] , 那么你就需要在這里定義他們。但是建議你現(xiàn)檢查一下DWR是不是已經(jīng)支持了。
在init
部分里有了定義只是告訴DWR這些擴(kuò)展類(lèi)的存在,給出了如何使用的信息。這時(shí)他們還沒(méi)有被使用。這中方式很像Java中的import語(yǔ)句。多數(shù)類(lèi)需要在
使用前先import一下,但是只有import語(yǔ)句并不表明這個(gè)類(lèi)已經(jīng)被使用了。每一個(gè)creator和converter都用id屬性,以便后面使
用。
五:<signatures>
DWR使用反射來(lái)找出在轉(zhuǎn)換時(shí)應(yīng)該用那種類(lèi)型。有時(shí)類(lèi)型信息并不明確,這時(shí)你可以在這里寫(xiě)下方法的簽名來(lái)明確類(lèi)型。
signatures段使DWR能確定集合中存放的數(shù)據(jù)類(lèi)型。例如下面的定義中我們無(wú)法知道list中存放的是什么類(lèi)型。
public class Check{ public void setLotteryResults(List nos) { ... }}
signatures段允許我們暗示DWR應(yīng)該用什么類(lèi)型去處理。格式對(duì)以了解JDK5的泛型的人來(lái)說(shuō)很容易理解。
<signatures> <![CDATA[ import java.util.List; import com.example.Check; Check.setLotteryResults(List<Integer> nos); ]]></signatures>
DWR中又一個(gè)解析器專(zhuān)門(mén)來(lái)做這件事,所以即便你的環(huán)境時(shí)JDK1.3 DWR也能正常工作。
解析規(guī)則基本上會(huì)和你預(yù)想規(guī)則的一樣(有兩個(gè)例外),所以java.lang下面的類(lèi)型會(huì)被默認(rèn)import。
第一個(gè)是DWR1.0中解析器的bug,某些環(huán)境下不能返回正確類(lèi)型。所以你也不用管它了。
第二個(gè)是這個(gè)解析器時(shí)"陽(yáng)光(sunny day)"解析器。就是說(shuō)它非常寬松,不想編譯器那樣嚴(yán)格的保證你一定正確。所以有時(shí)它也會(huì)允許你丟失import:
<signatures> <![CDATA[ import java.util.List; Check.setLotteryResults(List<Integer>); ]]></signatures>
將來(lái)的DWR版本會(huì)使用一個(gè)更正式的解析器,這個(gè)編譯器會(huì)基于官方Java定義,所以你最好不要使用太多這個(gè)不嚴(yán)格的東西。
signatures段只是用來(lái)確定泛型參數(shù)中的類(lèi)型參數(shù)。DWR會(huì)自己使用反射機(jī)制或者運(yùn)行時(shí)類(lèi)型確定類(lèi)型,或者假設(shè)它是一個(gè)String類(lèi)型。所以:
不需要signatures - 沒(méi)有泛型參數(shù):
public void method(String p);public void method(String[] p);
需要signatures - DWR不能通過(guò)反射確定:
public void method(List<Date> p);public void method(Map<String, WibbleBean> p);
不需要signatures - DWR能正確的猜出:
public void method(List<String> p);public void method(Map<String, String> p);
不需要signatures - DWR可以通過(guò)運(yùn)行時(shí)類(lèi)型確定:
public List<Date> method(String p);
沒(méi)
有必要讓Javascript中的所有對(duì)象的key都是String類(lèi)型 -
你可以使用其他類(lèi)型作為key。但是他們?cè)谑褂弥皶?huì)被轉(zhuǎn)換成String類(lèi)型。DWR1.x用Javascript的特性把key轉(zhuǎn)換成String。
DWR2.0可能會(huì)用toString()方法,在服務(wù)段進(jìn)行這一轉(zhuǎn)換。
六:多個(gè)dwr.xml文件
可以有多個(gè)dwr.xml文件(詳細(xì)信息見(jiàn)web.xml文檔)。每個(gè)文件中的定義會(huì)被加在一起。DWR用這個(gè)功能來(lái)加載基礎(chǔ)配置文件。我們可以看看標(biāo)準(zhǔn)被配置文件來(lái)了解dwr.xml的內(nèi)容。
以上資源來(lái)自http://wiki.javascud.org/display/dwrcn/