DWR中各種java方法的調用

DWR是一個框架，簡單的說就是能夠在javascript直接調用java方法，而不必去寫一大堆的javascript代碼。它的實現是基于ajax的，可以實現無刷新效果。

網上有不少DWR的例子，但大都只是某種方法的調用，本文只在使用層面上介紹DWR，并不涉更多的技術與設計，其目的是讓初學者能夠很快的學會各種java方法在javascript中是如何調用的。

本文以DWR 1.1 為基礎，對于DWR 2.0，因為還沒有正式發布版，故不做介紹。

一、dwr配置篇之web.xml 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>這個參數DWR默認是false。如果選擇true，我們可以通過http://localhost:port/app/dwr看到你部署的每個DWR class。并且可以測試java代碼的每個方法是否運行正常。為了安全考慮，在正式環境下你一定把這個參數設為false。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, 加不同的角色。二、dwr使用篇 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='http://www.wxshucaidpc.com/bcjs/dwr/interface/ testClass.js'></script><script src='http://www.wxshucaidpc.com/bcjs/dwr/engine.js'></script><script src='http://www.wxshucaidpc.com/bcjs/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 數組，即數組的每個元素均為 objectdata = [ ;{ ;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 中。