DWR中Java方法的引數及返回值、物件javabean

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='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& gt;標籤指定要轉換的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[i].username);
  alert(data[i].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中。