DWR(Direct Web Remoting)是在Apache许可下的一个开源项目,他是一个非常专业的Java EE
Ajax框架。通过使用DWR框架,可以将Java组件的方法直接暴露给JavaScript客户端。
DWR还提供了一套JavaScript函数集,可用于简化DOM元素的操作,例如动态修改表格,动态修改列表框、下拉菜单等。
DWR的专业还体现在与其他Java EE框架的整合上——DWR可以与Spring和无缝整合,允许直接调用Spring容器中的Bean。
DWR框架主要包括以下两个部分:
- 客户端的JavaScript,这部分代码使客户端的JavaScript可以直接调用远程服务器的java方法。除此之外,DWR还提供了一些方便的工具函数来简化DOM操作。
- 服务器上运行的Servlet负责处理用户请求,并将用户请求委托到实际java对象进行处理,并负责把处理结果返回客户端。
DWR会根据java类动态的生成JavaScript代码,通过这些动态生成的JavaScript代码将服务器端的java方法直接暴露给客户端的JavaScript,让用户产生一种错觉,通过使用DWR框架的帮助,客户端JavaScript代码能够直接调用远程java方法。实际上DWR依然是依赖XMLHttpRequest对象和服务器进行通信的。其基本原理是:当开发者直接调用远程java方法时,DWR会负责将这种调用转换成对应的Ajax请求,并使用XMLHttpRequest将请求发送到远程服务器端。当服务器处理完成后,DWR负责将处理结果传回给客户端的JavaScript代码。在整个Ajax交互过程中,DWR负责数据的传递和转换。
简单示例:
第一步:导入jar包commons-logging-1.0.4.jar、dwr.jar。
第二步:编写web.xml、dwrDWR.xml(默认和web.xml位置一样)
<?xml version="1.0" encoding="utf-8"?>
<web-app xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd">
<!-- 配置DWR的核心Servlet -->
<servlet>
<!-- 指定DWR核心Servlet的名字 -->
<servlet-name>dwr-invoker</servlet-name>
<!-- 指定DWR核心Servlet的实现类 -->
<servlet-class>org.directwebremoting.servlet.DwrServlet</servlet-class>
<!-- 指定DWR核心Servlet处于调试状态 -->
<init-param>
<param-name>debug</param-name>
<param-value>true</param-value>
</init-param>
</servlet>
<!-- 指定核心Servlet的URL映射 -->
<servlet-mapping>
<servlet-name>dwr-invoker</servlet-name>
<!-- 指定核心Servlet映射的URL -->
<url-pattern>/cyqdwr/*</url-pattern>
</servlet-mapping>
</web-app>
<?xml version="1.0" encoding="GBK"?>
<!-- 指定DWR配置文件的DTD等信息 -->
<!DOCTYPE dwr PUBLIC "-//GetAhead Limited//DTD Direct Web Remoting 3.0//EN"
"http://getahead.org/dwr/dwr30.dtd">
<dwr>
<allow>
<!-- 使用new创建器创建hello JavaScript对象 -->
<create creator="new" javascript="hello">
<param name="class" value="com.bohua.dwr.HelloDwr"/>
</create>
<!-- 对com.bohua.beans.Person类使用Bean转换器 -->
<convert converter="bean" match="com.bohua.beans.Person"/>
<!-- 对com.bohua.beans.Cat 使用Object转换器 -->
<convert converter="object" match="com.bohua.beans.Cat">
<param name="force" value="true"/>
</convert>
</allow>
<!-- 因为sendListNoGeneric方法中list没有指定参数类型,需要借助signatures标签指定其类型 -->
<signatures>
<![CDATA[
import java.util.List;
import com.bohua.dwr.HelloDwr;
import com.bohua.beans.Person;
HelloDwr.sendListNoGeneric(List<Person>);
]]>
</signatures>
</dwr>
第三步:编写dwr处理类以及实体类
package com.bohua.dwr;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import com.bohua.beans.Cat;
import com.bohua.beans.Person;
/**
*/
public class HelloDwr
{
// 第一个简单的hello方法
public String hello(String name)
{
return name + ",您好!您已经开始了DWR的学习之旅,祝您学得开心...";
}
// 使用一个JavaBean作为参数的方法
public String sendObj(Person p )
{
return p.getName() + ",您好!您已经学会了使用JavaBean参数...";
}
// 返回JavaBean实例的方法
public Person getBean (String name)
{
return new Person(name);
}
// 返回一个普通的Java对象,Cat对象为其属性提供setter和getter方法
public Cat getObject(String name)
{
return new Cat("服务器端" + name);
}
// 返回一个集合对象
public List<Person> getPersonList()
{
List<Person> result = new ArrayList<Person>();
result.add(new Person("集合aaaa"));
result.add(new Person("集合bbbb"));
result.add(new Person("集合cccc"));
return result;
}
// 返回一个数组对象
public Person[] getPersonArray()
{
Person[] result = new Person[3];
result[0] = new Person("数组aaaa");
result[1] = new Person("数组bbbb");
result[2] = new Person("数组cccc");
return result;
}
// 返回一个Map对象
public Map<String, Person> getPersonMap()
{
// 创建一个Map对象
Map<String, Person> result = new HashMap<String, Person>();
// 填充Map对象的内容
result.put("first" , new Person("Map aaaa"));
result.put("second" , new Person("Map bbb"));
result.put("third" , new Person("Map cccc"));
// 返回Map
return result;
}
// 远程方法的参数是集合
public String sendList(List<Person> pl)
{
String result = "";
for (Person p : pl)
{
result += p.getName() + "<br />";
}
return result;
}
// 远程方法的参数是不带泛型的集合
public String sendListNoGeneric(List pl)
{
String result = "";
for (Object p : pl)
{
result += ((Person)p).getName() + "<br />";
}
return result;
}
// 远程方法的参数是集合
public String sendMap(Map<String , Person> pmap)
{
String result = "";
for (String key : pmap.keySet())
{
result += "键" + key + " 其值为:" +
pmap.get(key).getName() + "<br />";
}
return result;
}
}
package com.bohua.beans;
/**
*/
public class Cat
{
//Cat类的私有属性
private String name;
//构造器
public Cat(String name)
{
this.name = name;
}
}
package com.bohua.beans;
/**
*/
public class Person
{
// 私有Field
private String name;
public Person(String name)
// 初始化全部成员变量的构造器
{
this.name = name;
}
// name的setter和getter方法
public void setName(String name)
{
this.name = name;
}
public String getName()
{
return this.name;
}
// 无参数的构造器
public Person() {
super();
}
}
第四步:编写js文件 hellodwr.js
// -------------发送简单字符串参数,返回普通字符串--------------
function sendMessage()
{
// 获取页面中name元素的值
var name = document.getElementById("name").value;
// 调用远程方法,cb是回调函数
hello.hello(name , cb)
}
var cb=function (data)
{
document.getElementById("show").innerHTML = data;
}
// -----------发送一个JavaBean对象作为参数,返回普通字符串------------
function sendObject()
{
var nameValue = document.getElementById("name").value;
// 调用远程方法,使用JavaScript对象作为参数
hello.sendObj({name:nameValue} , cb);
}
// ----------------调用返回JavaBean方法-----------------
function getBean()
{
var name = document.getElementById("name").value;
// 调用远程方法,beanCb是回调函数
hello.getBean(name , beanCb)
}
function beanCb(data)
{
// 服务器方法返回JavaBean对象,客户端的data是JavaScript对象
document.getElementById("show").innerHTML =
data.name + ",您好,您已经学会了使用JavaBean返回值";
}
// ----------------调用返回getObject方法---------------
function getObject()
{
var name = document.getElementById("name").value;
// 调用远程方法,objCb是回调函数
hello.getObject(name , objCb)
}
function objCb(data)
{
// 服务器方法返回非JavaBean式的对象,客户端的data是JavaScript对象
document.getElementById("show").innerHTML =
data.name + ",是从服务器返回的猫的名字";
}
// ---------------调用返回集合的方法--------------
function getBeanList()
{
// 调用远程方法,listCb返回回调函数
hello.getPersonList(listCb);
}
// 远程Java方法返回List对象,集合元素是JavaBean式的对象
// 此处的data是JavaScript对象数组
function listCb(data)
{
var result='';
// 遍历每个数组元素
for (var i = 0 ; i < data.length ; i ++)
{
result += data[i].name + "<br />";
}
document.getElementById("show").innerHTML = result;
}
// ---------------调用返回数组的方法--------------
function getBeanArray()
{
hello.getPersonArray(arrayCb);
}
function arrayCb(data)
{
var result = "";
// 下面的data是远程Java方法的返回值,
// data是个数组,遍历数组。
for (var i = 0 ; i < data.length ; i ++)
{
//依次访问数组元素,数组元素是JSON格式的对象,访问其name属性
result += data[i].name + "<br />";
}
document.getElementById("show").innerHTML = result;
}
// ---------------调用返回Map对象的方法-------------
function getBeanMap()
{
hello.getPersonMap(mapCb);
}
// 远程Java方法返回Map对象,集合元素是JavaBean式的对象
// 此处的data是JavaScript对象,且每个属性值都是JavaScript对象
function mapCb(data)
{
var result='';
for (var key in data)
{
result += "键为" + key + ",其值为:" + data[key].name + "<br />";
}
document.getElementById("show").innerHTML = result;
}
// ---------------调用发送集合的方法-------------------
function sendBeanList()
{
// 创建JavaScript数组
var args = [
{name:"客户端aaa"},
{name:"客户端bbb"},
{name:"客户端ccc"}
];
// Java方法需要List参数,以JavaScript数组作为参数调用远程方法
hello.sendList(args , sendListCb);
}
function sendListCb(data)
{
document.getElementById("show").innerHTML = data;
}
// ---------------调用发送无泛型限制的集合--------------------
function sendBeanListNoGeneric()
{
// 创建JavaScript数组
var args = [
{name:"客户端aaa"},
{name:"客户端bbb"},
{name:"客户端ccc"}
];
// Java方法需要List参数,以JavaScript数组作为参数调用远程方法
hello.sendListNoGeneric(args , sendListCb);
}
// ---------------调用发送Map的方法-------------------------
function sendBeanMap()
{
// 创建JavaScript对象
var args = {
first:{name:"客户端aaa"},
second:{name:"客户端bbb"},
third:{name:"客户端ccc"}
};
// Java方法需要Map参数,以JavaScript对象作为参数调用远程方法
hello.sendMap(args , sendMapCb);
}
function sendMapCb(data)
{
document.getElementById("show").innerHTML = data;
}
第五步:编写html文件
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>DWR入门</title>
<!-- 导入DWR引擎的核心JavaScript代码库 -->
<script type='text/javascript' src='/20150627Ajax_Dwr_Test1/cyqdwr/engine.js' charset="utf-8"></script>
<!-- 导入开发者为本应用编写的JavaScript代码库 -->
<script type='text/javascript' src='js/hellodwr.js' charset="utf-8"></script>
<!-- 导入DWR为hello对象动态生成的JavaScript代码库 -->
<script type='text/javascript' src='/20150627Ajax_Dwr_Test1/cyqdwr/interface/hello.js' charset="utf-8"></script>
</head>
<body>
<h3>DWR入门</h3>
请输入您的名字
<input id="name" name="name" type="text" />
<br />
<input type="button" value="发送简单请求" onclick="sendMessage();" />
<input type="button" value="发送对象参数" onclick="sendObject();" />
<input type="button" value="返回JavaBean" onclick="getBean();" />
<br />
<input type="button" value="返回Object" onclick="getObject();" />
<input type="button" value="返回Bean集合" onclick="getBeanList();" />
<input type="button" value="返回Bean数组" onclick="getBeanArray();" />
<br />
<input type="button" value="返回Bean Map" onclick="getBeanMap();" />
<input type="button" value="发送Bean集合" onclick="sendBeanList();" />
<input type="button" value="发送不带泛型限制的Bean集合"
onclick="sendBeanListNoGeneric();" />
<br />
<input type="button" value="发送Bean Map" onclick="sendBeanMap();" />
<hr />
下面是服务器的回应:
<br />
<div id="show"></div>
</body>
</html>