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
函数调用过程.
另外 .dwr还是
文件的一种格式: 比如以Dreamweaver
软件里有查找和替换,经常用的查找和替换
内容可以保存,保存的
文件就是以 .dwr结尾的
文件。这种
文件用
记事本打开后可以看到它的
内容。
1.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的
方法。不指定的话就公开所有
方法。
1.2、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>
Function callTestMethod1(){
testClass.testMethod1();
}
2.1、dwr.xml的配置
配置同1.1
<dwr>
<allow>
<create creator="new" javascript="testClass" >
<include method="testMethod2"/>
</create>
</allow>
</dwr>
Function callTestMethod2(){
testClass.testMethod2(callBackFortestMethod2);
}
Function callBackFortestMethod2(data){
alert("the return value is " + data);
}
其中callBackFortestMethod2是接收返回值的回调
函数
3.1、dwr.xml的配置
配置同1.1
<dwr>
<allow>
<create creator="new" javascript="testClass" >
<include method="testMethod3"/>
</create>
</allow>
</dwr>
首先,引入javascript脚本
Function callTestMethod3(){
var data;
//构造参数
data = “test String”;
testClass.testMethod3(data);
}
4.1、dwr.xml的配置
<dwr>
<allow>
<create creator="new" javascript="testClass" >
<include method="testMethod4"/>
</create>
<convert converter="bean" match=""com.dwr.TestBean">
</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
名称,
标签指定要转换的JavaBean
属性。
首先,引入javascript脚本
Function callTestMethod4(){
testClass.testMethod4(callBackFortestMethod4);
}
Function callBackFortestMethod4(data){
//对于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" >
<include method="testMethod5"/>
</create>
<convert converter="bean" match="com.dwr.TestBean">
</convert>
</allow>
</dwr>
首先,引入javascript脚本
Function callTestMethod5(){
var data;
//构造参数,data实际上是一个object
data = { username:"user",password:"password" }
testClass.testMethod5(data);
}
6.1、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.2、javascript中
调用(以返回List为例,List的元素为TestBean)
首先,引入javascript脚本
Function callTestMethod6(){
testClass.testMethod6(callBackFortestMethod6);
}
Function callBackFortestMethod6(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);
}
}
7、
调用有List、Set或者Map参数的java
方法
7.1、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.2、javascript中
调用(以返回List为例,List的元素为TestBean)
首先,引入javascript脚本
Function callTestMethod7(){
var data;
//构造参数,data实际上是一个object
数组,即数组的每个元素均为object
data = [
{
username:"user1",
password:"password2"
},
{
username:"user2",
password:" password2"
}
];
testClass.testMethod7(data);
}
注意:
1、对于第6种情况,如果java
方法的返回值为Map,则在接收该返回值的javascript
回调函数中如下处理:
function callBackFortestMethod(data){
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 (){
var data;
//构造参数,date实际上是一个object,其
属性名为Map的key,
属性值为Map的value
data = {
"key1":{
username:"user1",
"key2":{
username:"user2",
password:" password2"
}
};
testClass.testMethod(data);
}
<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中
特别说明:
创建时要先实例化:var obj = new Object(); obj = {key:"value"}; 也可以obj.key = "value"; 如果没有初始化,则会转换出错。
1. 安装 DWR JAR 包
下载 dwr.jar
文件,然后将它放在 web 程序的 WEB-INF/lib 目录下面,很可能在这个目录下已经有一些 jar
文件了。
将下面的
代码添加到 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>
<init-param>
debug</param-name>
true</param-value>
</init-param>
</servlet>
<servlet-mapping>
<servlet-name>dwr-invoker</servlet-name>
<url-pattern>/dwr/*</url-pattern>
</servlet-mapping>
<!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)将会在
调用的时候陷入未知的状况,因此应该避免重载
方法。
3. 访问下面的地址
http://localhost:8080/[YOUR-WEBAPP]/dwr/
你应该会看到一个
页面,上面
显示了刚才你在第二步所创建的类。进入一个
链接之后你会看到所有等待
调用方法的列表。这些动态产生的例子你也能通过 DWR 来实现。
亲自尝试和体会下吧。
怎样应用到你的 Web 程序中?
在
侧边栏有很多例子演示了怎样改变网页中的文本、更新列表、操作
表单和动态
修改表格。每一个例子都有详细的说明。
进入 http://localhost:8080/[YOUR-WEBAPP]/dwr/ 然后点击你创建的类;
将这些文本粘贴到你 Web 程序的一个 HTML 或 JSP
页面中;
<script src=’/[YOUR-WEBAPP]/dwr/interface/[YOUR-SCRIPT].js’></script>
<script src=’/[YOUR-WEBAPP]/dwr/engine.js’></script>
你可以根据实际情况
修改 /[YOUR-WEBAPP]/ 部分。
1、拷贝dwr.jar到项目的lib中
<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>
3、新建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.Use
RSS"/>
<create creator="new" javascript="userAction" class="com.yd.imp.UserCol">
<include method="getALlUser"/>
</create>
</allow>
</dwr>
上面的
文件实现了我们例子中的两个目标。首先,<convert>
标记告诉DWR将com.yd.pojos.Use
RSS对象的类型转换为联合
数组,因为,出于安全的原因,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>
DWR搭建以及使用教程
DWR(Direct Web Remoting)是一个Ajax的开源框架,用于改善web
页面与Java类交互的远程服务器端的交互体验,可以帮助开发人员开发包含AJAX技术的网站。它可以允许在浏览器里的
代码使用运行在WEB服务器上的JAVA
函数,就像它就在浏览器里一样。
从DWR官网下载最新版本的jar包,地址:http://directwebremoting.org/dwr/downloads/index.html
将jar包放入WEB-INF的lib文件夹下。同时,dwr依赖于commons-logging.jar这个包,所以必须将这个jar包也放入到WEB-INF的lib文件夹相爱。
首先是配置dwr的环境:
1. web.xml文件:
02 |
< servlet-name >dwr-invoker</ servlet-name > |
03 |
< servlet-class >uk.ltd.getahead.dwr.DWRServlet</ servlet-class > |
05 |
< param-name >debug</ param-name > |
06 |
< param-value >true</ param-value > |
11 |
< servlet-name >dwr-invoker</ servlet-name > |
12 |
< url-pattern >/dwr/*</ url-pattern > |
2. 从官网的jar.war文件中利用winRAR等软件提取出dwr.xml文件,并将其放入到WEB-INF文件夹下。
dwr.xml是dwr的核心配置文件,主要的标签有:<converter>、<convert>、<create>这三个标签。
<converter>标签是dwr中内置的转换器。我们也可以使用自己写的转换器,不过dwr提供的转换器已经足够了,所以这个标签,一般不会自己去写。
<convert>标签是将converter中定义的转换器映射到的具体类型,如:
1 |
< converter id = "date" class = "org.directwebremoting.convert.DateConverter" /> |
3 |
< convert converter = "date" match = "java.util.Date" /> |
<create>标签是dwr中重要的标签,用来描述 java(服务器端) 与 javascript (客户端)的交互方式。其基本格式如下:
2 |
< create creator = "..." javascript = "..." scope = "..." > |
3 |
< param name = "..." value = "..." /> |
4 |
< auth method = "..." role = "..." /> |
5 |
< exclude method = "..." /> |
6 |
< include method = "..." /> |
其中,creator和javascript是必须属性,其他可以忽略。creator包含有以下几个值:
new:Java用“new”关键字创造对象
none:它不创建对象 (v1.1+)
scripted:通过BSF使用脚本语言创建对象,例如BeanShell或Groovy
spring:通过Spring框架访问Bean
struts:使用Struts的FormBean (v1.1+)
jsf:使用JSF的Bean (v1.1+)
pageflow:访问Weblogic或Beehive的PageFlow (v1.1+)
ejb3:使用EJB3 session bean (v2.0+)
关于这几个属性如何使用,这里就不在详细阐述了。我只列出一个与spring整合的例子:
01 |
< create creator = "spring" javascript = "backUpDocumentService" > |
02 |
< param name = "beanName" value = "testDWR1" /> |
03 |
< include method = "modifyBackUpFiles" ></ include > |
04 |
< include method = "isSafeCodeRight" ></ include > |
08 |
< create creator = "spring" javascript = "testDWR2" > |
09 |
< param name = "beanName" value = "testDWR2" /> |
spring配置文件
1 |
< bean id = "testDWR1" class = "com.test.testDWR1" ></ bean > |
2 |
< bean id = "testDWR2" class = "com.test.testDWR2" ></ bean > |
3. 页面配置
在jsp页面添加三个 js 文件,分别是
1 |
< script type = 'text/javascript' src = 'js/util.js' ></ script > |
2 |
< script type = 'text/javascript' src = 'js/engine.js' ></ script > |
3 |
< script type = 'text/javascript' src = 'dwr/interface/testDWR1.js' > |
其中engine.js必须要,如果需要用到dwr提供的一些方便的工具要引用util.js,然后是dwr自动生成的js文件,名字必须和dwr.xml中create标签的javascript属性值一样,且是dwr/interface开头的目录
4. 接下来就可以分别写javascript和java代码了。
javascript代码:
3 |
testDWR1.testFun(name,returnFun); |
4 |
} function returnFun(data) { |
java代码:
3 |
public class testDWR1 { |
4 |
public String test(String str) { |
5. 其他
dwr可以设置是否采用异步方式访问java代码,其代码为:
1 |
dwr.engine.setAsync( false ); |
以及dwr对于异常的处理,这里我只列出个简单的全局性异常捕获,具体到针对某个方法的异常捕获,大家可以自己上网找找。
1 |
dwr.engine.setErrorHandler(errh); |
2 |
function errh(errorString,exception) { |
dwr同样支持参数为对象的方法,这需要在dwr.xml中配置下<convert>标签:
1 |
< convert converter = "bean" match = "com.example.Person" /> |
那么关于dwr我也只介绍到这里了,这基本就是dwr的基本内容了,可以满足普通的项目需求了。
想进一步对于dwr的深入可以查询下相关文章或查看api,这里我就不再说的那么详细了。