DWR是一個框架,簡單的說就是能夠在javascript直接呼叫java方法,而不必去寫一大堆的javascript程式碼。它的實作是基於ajax的,可以實現無刷新效果。
網上有不少DWR的例子,但大都只是某種方法的調用,本文只在使用層面上介紹DWR,並不涉更多的技術與設計,其目的是讓初學者能夠很快的學會各種java方法在javascript中是如何被呼叫的。
一、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>
標籤中包括可以暴露給javascript存取的東西。
標籤中指定javascript中可以存取的java類,並定義DWR應如何取得要進行遠端的類別的實例。 creator="new"屬性指定java類別實例的產生方式,new意味著DWR應呼叫類別的預設建構子來取得實例,其他的還有spring方式,透過與IOC容器Spring進行整合來取得實例等等。 javascript=" testClass "屬性指定javascript程式碼存取物件時使用的名稱。
標籤指定要公開給javascript的java類別名稱。
標籤指定要公開給javascript的方法。不指定的話就公開所有方法。
標籤指定要防止被存取的方法。
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 c match=""com.dwr.TestBean"> <param name="include" value="username,password" /> </convert> </allow> </dwr>
标签负责公开用于Web远程的类和类的方法,标签则负责这些方法的参数和返回类型。convert元素的作用是告诉DWR在服务器端Java 对象表示和序列化的JavaScript之间如何转换数据类型。DWR自动地在Java和JavaScript表示之间调整简单数据类型。这些类型包括Java原生类型和它们各自的封装类表示,还有String、Date、数组和集合类型。DWR也能把JavaBean转换成JavaScript 表示,但是出于安全性的原因,要求显式的配置,标签就是完成此功能的。c属性指定转换的方式采用JavaBean命名规范,match=""com.dwr.TestBean"属性指定要转换的javabean名称,标签指定要转换的JavaBean属性。
4.2、javascript中调用
首先,引入javascript脚本
其次,编写调用java方法的javascript函数和接收返回值的回调函数
其中callBackFortestMethod4是接收返回值的回调函数
5、调用有JavaBean参数的java方法
5.1、dwr.xml的配置
<dwr> <allow> <create creator="new" javascript="testClass" > <param name="class" value="com.dwr.TestClass" /> <include method="testMethod5"/> </create> <convert c 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); }
并且在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中。