DWR是一個框架,簡單的說就是能夠在javascript直接調用java方法,而不必去寫一大堆的javascript代碼。它的實現是基于ajax的,可以實現無刷新效果。
??? 網上有不少DWR的例子,但大都只是某種方法的調用,本文只在使用層面上介紹DWR,并不涉更多的技術與設計,其目的是讓初學者能夠很快的學會各種java方法在javascript中是如何調用的。
??? 本文以DWR 1.1 為基礎,對于DWR 2.0,因為還沒有正式發布版,故不做介紹。
?? 1、最小配置
<servlet>
? <servlet-name>dwr-invoker</servlet-name>
? <servlet-class>uk.ltd.getahead.dwr.DWRServlet</servlet-class>
</servlet>
<servlet-mapping>
? <servlet-name>dwr-invoker</servlet-name>
? <url-pattern>/dwr/*</url-pattern>
</servlet-mapping>
2、當我們想看DWR自動生成的測試頁(Using debug/test mode)時,可在servlet配置中加上
<init-param>
? <param-name>debug</param-name>
? <param-value>true</param-value>
</init-param>
3、多個dwr.xml文件的配置
可能有幾種情況,我們一一列舉。一個servlet,多個dwr.xml配置文件;多個servlet,每個servlet對應一個或多個dwr.xml配置文件。
3.1、一個servlet,多個dwr.xml配置文件
<servlet>
? ? <servlet-name>dwr-invoker</servlet-name>
? ? <servlet-class>uk.ltd.getahead.dwr.DWRServlet</servlet-class>
? ? <init-param>
? ? ? <param-name>config-1</param-name>
? ? ? <param-value>WEB-INF/dwr1.xml</param-value>
? ? </init-param>
? ? <init-param>
? ? ? <param-name>config-2</param-name>
? ? ? <param-value>WEB-INF/dwr2.xml</param-value>
? ? </init-param>
</servlet>
在這種配置下,param-name的值必須以config開頭。param-name可以有>=0個。如果沒有param-name,那么將會讀取WEB-INF/dwr.xml。如果有大于零個param-name,那么WEB-INF/dwr.xml文件將不會被讀取。
3.2、多個servlet,每個servlet對應一個或多個dwr.xml
<servlet>
? ?<servlet-name>dwr-invoker</servlet-name>
? ? <servlet-class>uk.ltd.getahead.dwr.DWRServlet</servlet-class>
</servlet>
<servlet>
? ?<servlet-name>dwr-invoker1</servlet-name>
? ?<servlet-class>uk.ltd.getahead.dwr.DWRServlet</servlet-class>
? ?<init-param>
? ? ?<param-name>config-admin</param-name>
? ? ?<param-value>WEB-INF/dwr1.xml</param-value>
? ?</init-param>
? ?<init-param>
? ? ?<param-name>debug</param-name>
? ? ?<param-value>true</param-value>
? ?</init-param>
</servlet>
<servlet-mapping>
<servlet-name>dwr-invoker</servlet-name>
? ?<url-pattern>/dwr/*</url-pattern>
</servlet-mapping>
<servlet-mapping>
? ?<servlet-name>dwr-invoker1</servlet-name>
? ?<url-pattern>/dwr1/*</url-pattern>
</servlet-mapping>
在這種情況下,我們可以根據J2EE security來控制權限,針對不同url,加不同的角色。
?
?
1、調用沒有返回值和參數的JAVA方法
1.1、dwr.xml的配置
<dwr>
<allow>
<create creator="new" javascript="testClass" >
<param name="class" value="com.dwr.TestClass" />
<include method="testMethod1"/>
</create>
</allow>
</dwr>
<allow>標簽中包括可以暴露給javascript訪問的東西。
<create>標簽中指定javascript中可以訪問的java類,并定義DWR應當如何獲得要進行遠程的類的實例。creator="new"屬性指定java類實例的生成方式,new意味著DWR應當調用類的默認構造函數來獲得實例,其他的還有spring方式,通過與IOC容器Spring進行集成來獲得實例等等。javascript=" testClass "屬性指定javascript代碼訪問對象時使用的名稱。
<param>標簽指定要公開給javascript的java類名。
<include>標簽指定要公開給javascript的方法。不指定的話就公開所有方法。
<exclude>標簽指定要防止被訪問的方法。
1.2、javascript中調用
首先,引入javascript腳本
<script src='dwr/interface/ testClass.js'></script>
<script src='dwr/engine.js'></script>
<script src='dwr/util.js'></script>
其中TestClass.js是dwr根據配置文件自動生成的,engine.js和util.js是dwr自帶的腳本文件。
其次,編寫調用java方法的javascript函數
Function callTestMethod1(){
????? testClass.testMethod1();
}
2、調用有簡單返回值的java方法
2.1、dwr.xml的配置
配置同1.1
<dwr>
<allow>
<create creator="new" javascript="testClass" >
<param name="class" value="com.dwr.TestClass" />
<include method="testMethod2"/>
</create>
</allow>
</dwr>
2.2、javascript中調用
首先,引入javascript腳本
其次,編寫調用java方法的javascript函數和接收返回值的回調函數
Function callTestMethod2(){
????? testClass.testMethod2(callBackFortestMethod2);
}
Function callBackFortestMethod2(data){
???? //其中date接收方法的返回值
???? //可以在這里對返回值進行處理和顯示等等
alert("the return value is " + data);
}
其中callBackFortestMethod2是接收返回值的回調函數
3、調用有簡單參數的java方法
3.1、dwr.xml的配置
配置同1.1
<dwr>
<allow>
<create creator="new" javascript="testClass" >
<param name="class" value="com.dwr.TestClass" />
<include method="testMethod3"/>
</create>
</allow>
</dwr>
3.2、javascript中調用
首先,引入javascript腳本
其次,編寫調用java方法的javascript函數
Function callTestMethod3(){
???????????????? //定義要傳到java方法中的參數
????? var data;
????? //構造參數
????? data = “test String”;
????? testClass.testMethod3(data);
}
4、調用返回JavaBean的java方法
4.1、dwr.xml的配置
<dwr>
<allow>
<create creator="new" javascript="testClass" >
<param name="class" value="com.dwr.TestClass" />
<include method="testMethod4"/>
</create>
<convert converter="bean" match=""com.dwr.TestBean">
?????????? ?????? <param name="include" value="username,password" />
</convert>
</allow>
</dwr>
<creator>標簽負責公開用于Web遠程的類和類的方法,<convertor>標簽則負責這些方法的參數和返回類型。convert元素的作用是告訴DWR在服務器端Java 對象表示和序列化的JavaScript之間如何轉換數據類型。DWR自動地在Java和JavaScript表示之間調整簡單數據類型。這些類型包括Java原生類型和它們各自的封裝類表示,還有String、Date、數組和集合類型。DWR也能把JavaBean轉換成JavaScript 表示,但是出于安全性的原因,要求顯式的配置,<convertor>標簽就是完成此功能的。converter="bean"屬性指定轉換的方式采用JavaBean命名規范,match=""com.dwr.TestBean"屬性指定要轉換的javabean名稱,<param>標簽指定要轉換的JavaBean屬性。
4.2、javascript中調用
首先,引入javascript腳本
其次,編寫調用java方法的javascript函數和接收返回值的回調函數
Function callTestMethod4(){
????? testClass.testMethod4(callBackFortestMethod4);
}
Function callBackFortestMethod4(data){
???? //其中date接收方法的返回值
//對于JavaBean返回值,有兩種方式處理
????? ?????? //不知道屬性名稱時,使用如下方法
?????????? for(var property in data){
????????????? alert("property:"+property);
????????????? alert(property+":"+data[property]);
?????????? }
//知道屬性名稱時,使用如下方法
?????????? alert(data.username);
?????????? alert(data.password);
}
其中callBackFortestMethod4是接收返回值的回調函數
5、調用有JavaBean參數的java方法
5.1、dwr.xml的配置
配置同4.1
<dwr>
<allow>
<create creator="new" javascript="testClass" >
<param name="class" value="com.dwr.TestClass" />
<include method="testMethod5"/>
</create>
<convert converter="bean" match="com.dwr.TestBean">
?????????? ?????? <param name="include" value="username,password" />
</convert>
</allow>
</dwr>
5.2、javascript中調用
首先,引入javascript腳本
其次,編寫調用java方法的javascript函數
Function callTestMethod5(){
????? ?????????? //定義要傳到java方法中的參數
????? var data;
????? //構造參數,date實際上是一個object
????? data = { username:"user", password:"password"?}
????? testClass.testMethod5(data);
}
6、調用返回List、Set或者Map的java方法
6.1、dwr.xml的配置
配置同4.1
<dwr>
<allow>
<create creator="new" javascript="testClass" >
<param name="class" value="com.dwr.TestClass" />
<include method="testMethod6"/>
</create>
<convert converter="bean" match="com.dwr.TestBean">
<param name="include" value="username,password" />
</convert>
</allow>
</dwr>
注意:如果List、Set或者Map中的元素均為簡單類型(包括其封裝類)或String、Date、數組和集合類型,則不需要<convert>標簽。
6.2、javascript中調用(以返回List為例,List的元素為TestBean)
首先,引入javascript腳本
其次,編寫調用java方法的javascript函數和接收返回值的回調函數
Function callTestMethod6(){
????? testClass.testMethod6(callBackFortestMethod6);
}
Function callBackFortestMethod6(data){
???? //其中date接收方法的返回值
//對于JavaBean返回值,有兩種方式處理
????? ?????? //不知道屬性名稱時,使用如下方法
?????????? for(var i=0;i<data.length;i++){
for(var property in data){
????????????? ??? alert("property:"+property);
????????????? ??? alert(property+":"+data[property]);
?????????? ??? }
}
//知道屬性名稱時,使用如下方法
for(var i=0;i<data.length;i++){
?????????? ??? alert(data.username);
?????????? ??? alert(data.password);
}
}
7、調用有List、Set或者Map參數的java方法
7.1、dwr.xml的配置
<dwr>
<allow>
<create creator="new" javascript="testClass" >
<param name="class" value="com.dwr.TestClass" />
<include method="testMethod7"/>
</create>
<convert converter="bean" match="com.dwr.TestBean">
<param name="include" value="username,password" />
</convert>
</allow>
<signatures>
<![CDATA[
import java.util.List;
import com.dwr.TestClass;
import com.dwr.TestBean;
TestClass.testMethod7(List<TestBean>);
]]>
</signatures>
</dwr>
<signatures>標簽是用來聲明java方法中List、Set或者Map參數所包含的確切類,以便java代碼作出判斷。
7.2、javascript中調用(以返回List為例,List的元素為TestBean)
首先,引入javascript腳本
其次,編寫調用java方法的javascript函數
Function callTestMethod7(){
//定義要傳到java方法中的參數
????? var data;
????? //構造參數,date實際上是一個object數組,即數組的每個元素均為object
data = [
????????????????? ??? {
???????????????????? ??? username:"user1",
???????????????????? ??? password:"password2"
????????????????? ??? },
????????????????? ??? {
???????????????????? ??? username:"user2",
???????????????????? ??? password:" password2"
????????????????? ??? }
????????????? ??? ];
????? testClass.testMethod7(data);
}
注意:
1、對于第6種情況,如果java方法的返回值為Map,則在接收該返回值的javascript回調函數中如下處理:
function callBackFortestMethod(data){
?????????? //其中date接收方法的返回值
?????????? for(var property in data){
????????????????? var bean = data[property];
????????????????? alert(bean.username);
????????????????? alert(bean.password);
????????????? }
}
2、對于第7種情況,如果java的方法的參數為Map(假設其key為String,value為TestBean),則在調用該方法的javascript函數中用如下方法構造要傳遞的參數:
function callTestMethod (){
????????????? //定義要傳到java方法中的參數
????????????? var data;
????????????? //構造參數,date實際上是一個object,其屬性名為Map的key,屬性值為Map的value
????????????? data = {
???????????????????????? "key1":{
????????????????? ?????????? username:"user1",
??????????????????????????? password:"password2"
???????????????????????? },
???????????????????????? "key2":{
??????????????????????????? username:"user2",
??????????????????????????? password:" password2"
???????????????????????? }
???????????????????? };
????????????? testClass.testMethod(data);
}
并且在dwr.xml中增加如下的配置段
<signatures>
<![CDATA[
import java.util.List;
import com.dwr.TestClass;
import com.dwr.TestBean;
TestClass.testMethod7(Map<String,TestBean>);
]]>
</signatures>
3、由以上可以發現,對于java方法的返回值為List(Set)的情況,DWR將其轉化為Object數組,傳遞個javascript;對于java方法的返回值為Map的情況,DWR將其轉化為一個Object,其中Object的屬性為原Map的key值,屬性值為原Map相應的value值。
4、如果java方法的參數為List(Set)和Map的情況,javascript中也要根據3種所說,構造相應的javascript數據來傳遞到java中。