DWR

DWR(Direct Web Remoting)是一個用於改善web頁面與Java類交互的遠程服務器端Ajax開源框架,能夠幫助開發人員開發包含AJAX技術的網站。它能夠容許在 瀏覽器裏的代碼使用運行在 WEB服務器上的JAVA函數,就像它就在瀏覽器裏同樣。
中文名
DWR
全    稱
Direct Web Remoting
應用領域
計算機
類    型
網站
 

1原理編輯

它包含兩個主要的部分:容許 JavaScriptWEB服務器上一個遵循了 AJAX原則的 Servlet中獲取數據.另一方面一個JavaScript庫能夠幫助 網站開發人員輕鬆地利用獲取的數據來動態改變網頁的內容.
DWR採起了一個相似AJAX的新方法來動態生成基於JAVA類的JavaScript代碼。這樣WEB開發人員就能夠在JavaScript裏使用Java代碼,就像它們是 瀏覽器本地代碼( 客戶端代碼)同樣;可是Java代碼運行在WEB服務器端並且能夠自由訪問WEB 服務器的資源。出於安全的理由,WEB開發者必須適當地配置哪些Java類能夠安全的被外部使用。[1]  
這個從JAVA到JavaScript的遠程功能方法給DWR的用戶帶來很是像傳統的RPC機制,就像RMI或者SOAP同樣,並且擁有運行在WEB上可是不須要 瀏覽器插件的好處.
DWR不認爲瀏覽器/WEB服務器協議是重要的,而更樂於保證 編程界面的簡單天然.對此最大的挑戰就是把AJAX的異步特性和正常JAVA方法調用的同步特性相結合.在異步模式下,結果數據在開始調用以後的一段時間以後才能夠被異步訪問獲取到.DWR容許WEB開發人員傳遞一個 回調函數,來 異步處理Java 函數調用過程.

2方法介紹編輯

調用方法

1.一、dwr.xml的配置
<dwr>
<allow>
<create creator="new" javascript="testClass" >
<include method="testMethod1"/>
</create>
</allow>
</dwr>
<allow>標籤中包括能夠暴露給javascript訪問的東西。
<create>標籤中指定javascript中能夠訪問的java類名,並定義DWR應當如何得到要進行遠程的類的實例。creator="new"屬性指定java類實例的生成方式,new意味着DWR應當調用類的 默認構造函數來得到實例,其餘的還有spring方式,經過與IOC容器Spring進行集成來得到實例等等。javascript=" testClass "屬性指定javascript代碼訪問對象時使用的名稱。
標籤指定要公開給javascript的java類名。
<include>標籤指定要公開給javascript的方法。不指定的話就公開全部方法。
<exclude>標籤指定要防止被訪問的方法。
注意:include和exclude不能同時存在
1.二、javascript中調用
首先,引入javascript 腳本
<script src='/[WEB-APP]/dwr/interface/ testClass.js'></script>
<script src='/[WEB-APP]/dwr/engine.js'></script>
<script src='/[WEB-APP]/dwr/util.js'></script>
其中TestClass.js是dwr根據配置文件自動生成的,engine.js和util.js是dwr自帶的 腳本文件
其次,編寫調用java方法的javascript函數
Function callTestMethod1(){
testClass.testMethod1();
}

調用返回值

2.一、dwr.xml的配置
配置同1.1
<dwr>
<allow>
<create creator="new" javascript="testClass" >
<include method="testMethod2"/>
</create>
</allow>
</dwr>
2.二、javascript中調用
首先,引入javascript 腳本
其次,編寫調用java方法的javascript函數和接收返回值的 回調函數
Function callTestMethod2(){
testClass.testMethod2(callBackFortestMethod2);
}
Function callBackFortestMethod2(data){
//其中data接收方法的返回值
//能夠在這裏對返回值進行處理和顯示等等
alert("the return value is " + data);
}
其中callBackFortestMethod2是接收返回值的回調函數

調用簡單參數

3.一、dwr.xml的配置
配置同1.1
<dwr>
<allow>
<create creator="new" javascript="testClass" >
<include method="testMethod3"/>
</create>
</allow>
</dwr>
3.二、javascript中調用
首先,引入javascript腳本
其次,編寫調用java方法的javascript函數
Function callTestMethod3(){
//定義要傳到java方法中的參數
var data;
//構造參數
data = 「test String」;
testClass.testMethod3(data);
}

調用返回JavaBean

4.一、dwr.xml的配置
<dwr>
<allow>
<create creator="new" javascript="testClass" >
<include method="testMethod4"/>
</create>
<convert converter="bean" match=""com.dwr.TestBean">
</convert>
</allow>
</dwr>
<create>標籤負責公開用於Web遠程的類和類的方法。
<convert>標籤則負責這些方法的參數和返回類型。
convert元素的做用是告訴DWR在服務器端Java 對象表示和序列化的JavaScript之間如何轉換數據類型。
DWR自動地在Java和JavaScript表示之間調整簡單數據類型。
這些類型包括Java原生類型和它們各自的封裝類表示,還有String、Date、 數組和集合類型。
DWR也能把JavaBean轉換成JavaScript 表示,可是出於安全性的緣由,要求顯式的配置,<convert>標籤就是完成此功能的。
converter="bean"屬性指定轉換的方式採用JavaBean命名規範,match=""com.dwr.TestBean"屬性指定要轉換的javabean名稱,標籤指定要轉換的JavaBean屬性。
4.二、javascript中調用
首先,引入javascript腳本
其次,編寫調用java方法的javascript函數和接收返回值的回調函數
Function callTestMethod4(){
testClass.testMethod4(callBackFortestMethod4);
}
Function callBackFortestMethod4(data){
//其中data接收方法的返回值
//對於JavaBean返回值,有兩種方式處理
//不知道屬性名稱時,使用以下方法
for(var property in data){
alert("property:"+property);
alert(property+":"+data[property]);
}
//知道屬性名稱時,使用以下方法
alert(data.username);
alert(data.password);
}
其中callBackFortestMethod4是接收返回值的回調函數

調用JavaBean參數

5.一、dwr.xml的配置
配置同4.1
<dwr>
<allow>
<create creator="new" javascript="testClass" >
<include method="testMethod5"/>
</create>
<convert converter="bean" match="com.dwr.TestBean">
</convert>
</allow>
</dwr>
5.二、javascript中調用
首先,引入javascript腳本
其次,編寫調用java方法的javascript函數
Function callTestMethod5(){
//定義要傳到java方法中的參數
var data;
//構造參數,data其實是一個object
data = { username:"user", password:"password" }
testClass.testMethod5(data);
}
六、調用返回List、Set或者Map的java方法
6.一、dwr.xml的配置
配置同4.1
<dwr>
<allow>
<create creator="new" javascript="testClass" >
<include method="testMethod6"/>
</create>
<convert converter="bean" match="com.dwr.TestBean">
</convert>
</allow>
</dwr>
注意:若是 List、Set或者Map中的元素均爲簡單類型(包括其封裝類)或String、Date、 數組和集合類型,則不須要<convert>標籤。
6.二、javascript中調用(以返回List爲例,List的元素爲TestBean)
首先,引入javascript腳本
其次,編寫調用java方法的javascript函數和接收返回值的回調函數
Function callTestMethod6(){
testClass.testMethod6(callBackFortestMethod6);
}
Function callBackFortestMethod6(data){
//其中data接收方法的返回值
//對於JavaBean返回值,有兩種方式處理
//不知道屬性名稱時,使用以下方法
for(var i=0;i<data.length;i++){
for(var property in data[i]){
alert("property:"+property);
alert(property+":"+data[i][property]);
}
}
//知道屬性名稱時,使用以下方法
for(var i=0;i<data.length;i++){
alert(data[i].username);
alert(data[i].password);
}
}
七、調用有List、Set或者Map參數的java方法
7.一、dwr.xml的配置
<dwr>
<allow>
<create creator="new" javascript="testClass" >
<include method="testMethod7"/>
</create>
<convert converter="bean" match="com.dwr.TestBean">
</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.二、javascript中調用(以返回List爲例,List的元素爲TestBean)
首先,引入javascript腳本
其次,編寫調用java方法的javascript函數
Function callTestMethod7(){
//定義要傳到java方法中的參數
var data;
//構造參數,data其實是一個object 數組,即數組的每一個元素均爲object
data = [
{
username:"user1",
password:"password2"
},
{
username:"user2",
password:" password2"
}
];
testClass.testMethod7(data);
}
注意:
一、對於第6種狀況,若是java方法的返回值爲Map,則在接收該返回值的javascript 回調函數中以下處理:
function callBackFortestMethod(data){
//其中data接收方法的返回值
for(var property in data){
var bean = data[property];
alert(bean.username);
alert(bean.password);
}
}
二、對於第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>
三、由以上能夠發現,對於java方法的返回值爲List(Set)的狀況,DWR將其轉化爲Object 數組,傳遞個javascript;對於java方法的返回值爲Map的狀況,DWR將其轉化爲一個Object,其中Object的屬性爲原Map的key值,屬性值爲原Map相應的value值。
四、若是java方法的參數爲List(Set)和Map的狀況,javascript中也要根據3種所說,構造相應的javascript數據來傳遞到java中
特別說明:
建立時要先實例化:var obj = new Object(); obj = {key:"value"}; 也能夠obj.key = "value"; 若是沒有初始化,則會轉換出錯。

3配置編輯

安裝配置

1. 安裝 DWR JAR 包
下載 dwr.jar 文件,而後將它放在 web 程序的 WEB-INF/lib 目錄下面,極可能在這個目錄下已經有一些 jar 文件了。
2. 編輯 config 文件
將下面的代碼添加到 WEB-INF/ web.xml 文件中,<servlet>須要放在另外的<servlet>以後,<servlet-mapping>也是如此。
<servlet>
<servlet-name>dwr-invoker</servlet-name>
<display-name>DWR Servlet</display-name>
<servlet-class>uk.ltd.getahead.dwr.DWRServlet</servlet-class>
workjjh
<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>
接下來建立 dwr.xml 文件並將此放在  web.xml 所在的 WEB-INF 目錄下。文件中相似下面的內容:
<!DOCTYPE dwr PUBLIC
」-//GetAhead Limited//DTD Direct Web Remoting 1.0//EN」
」http://www.getahead.ltd點uk/dwr/dwr10.dtd」>
<dwr>
<allow>
<create creator=」new」 javascript=」JDate」>
</create>
<create creator=」new」 javascript=」Demo」>
</create>
</allow>
</dwr>
DWR 配置文件定義了由 DWR 建立和被 Javascript 遠程使用的類。在上面的例子中咱們在遠程建立了2個類,而且給出了在 Javascript 中的類名。
上面使用的 new creator 使用了全部的 JavaBeans 必須含有的公有(public)無參(no-args)的 構造函數。值得一提的是, DWR 還有一些限制:
避免使用 JavaScript  保留字;以保留字命名的方法將自動被排除。大多數 JavaScript 的保留字同時也是 Java 的保留字,所以不管如何你也不能使用一個名爲 「try()」 的方法。可是最經常使用的一個詞 「delete()」,在 JavaScript 中有特殊的含義而在 Java 中沒有。
重載方法(Overloaded methods)將會在調用的時候陷入未知的情況,所以應該避免重載方法。

相關配置

一、拷貝dwr.jar到項目的lib中
二、配置 web.xml,添加:
<servlet>
<servlet-name>dwr-invoker</servlet-name>
<servlet-class>org.directwebremoting.servlet.DwrServlet</servlet-class>
<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>
三、新建dwr.xml,配置容許js調用的class
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dwr PUBLIC "-//GetAhead Limited//DTD Direct Web Remoting 2.0//EN" "http://www.getahead.ltd.(因爲編輯過程當中不能存在網址,因此此解釋是隱藏的)uk/dwr/dwr20.dtd">
<dwr>
<allow>
<create creator="new" javascript="Hello" scope="page">
<param name="class" value="demo.Hello" />
</create>
</allow>
</dwr>
若是有自定義類型能夠考慮添加下面的配置在<allow>中
<convert converter="bean" match="x.y.Bean"/>
你必須讓DWR知道經過XMLHttpRequest對象,什麼對象將會接收請求。這個任務由叫作dwr.xml的配置文件來完成。在配置文件中,定義了DWR容許你從網頁中調用的對象。從設計上講,DWR容許訪問全部公佈類的公共方法,但在咱們的例子中,咱們只容許訪問幾個方法。下面是咱們示例的配置文件:
<dwr>
<allow>
<convert converter="bean" match="com.yd.pojos.Userss"/>
<create creator="new" javascript="userAction" class="com.yd.imp.UserCol">
<include method="getALlUser"/>
</create>
</allow>
</dwr>
上面的文件實現了咱們例子中的兩個目標。首先,<convert>標記告訴DWR將com.yd.pojos.Userss對象的類型轉換爲聯合 數組,由於,出於安全的緣由,DWR默認的不會轉換普通bean。第二,<create>標記讓DWR暴露出com.yd.imp.UserCol類給JavaScript調用;咱們在頁面中使用JavaScript文件被javascript屬性定義。咱們必須注意<include>標記,它指明瞭com.yd.imp.UserCol類的哪些方法可用。
四、頁面添加:
<script type="text/javascript" src="dwr/engine.js"></script>
<script type="text/javascript" src="dwr/util.js"></script>
<script type="text/javascript" src="dwr/interface/Hello.js"></script>
說明:Hello.js 對應dwr.xml <create creator="new" javascript="Hello" scope="page">
五、自行設計調用處理方法
<script type="text/javascript">
function callback(str)
{
alert(str);
}
function test()
{
Hello.sayHelloTo("zhangsan",callback);
}
</script>
相關文章
相關標籤/搜索