DWR根据dwr.xml配置文件或注解中的信息来生成和Java代码类似的JavaScript代码。DWR调用Java代码是同步的,但是创建与Java代码匹配的Ajax远程调用接口需要实现Ajax的异步调用特性,所以DWR通过引入回调函数来解决此问题,当结果被返回时,DWR会调用这个函数。
简单的回调函数
首先创建一个Java类,代码如下:
@RemoteProxy
public class SimpleRemote {
@RemoteMethod
public String getXMLData(int index) {
// write code.
}
}
该类可以在JavaScript中这样使用:
/* <script type="text/javascript" src="dwr/engine.js"></script> <script type="text/javascript" src="dwr/interface/SimpleRemote.js"></script> */ var handleGetData = function(str) { alert(str); }; SimpleRemote.getXMLData(1, handleGetData);
其中“1”是Java方法getXMLData()参数,此外也可减缩格式:
SimpleRemote.getXMLData(1, function(str) { alert(str); });
调用元数据对象
通过使用“调用元数据对象”来指定回调函数和其他选项,例如:
SimpleRemote.getXMLData(1, { callback: function(str) { alert(str); }, timeout: 2000, errorHandler: function(msg) { alert("error: " + msg); } });
在回调函数的元数据对象中可以指定超时和错误的处理方式。
查找回调函数
- 如果第一个或最后一个参数是函数,则它就是回调函数,没有元数据对象,并且其他参数都是Java的方法参数;
- 如果最后一个参数是一个对象,这个对象中有一个callback成员,并且它是个函数,则这个对象就是元数据对象,其他的都是Java方法参数;
- 如果第一个参数是null,假设没有回调函数,并且其他的都是Java方法参数。尽管如此,我们会检查最后一个参数是不是null,如果是就发出警告;
- 如果最后一个参数是null,那么就是没有callback函数。
创建与Java对象匹配的JavaScript对象
为了创建一个与Java对象匹配的JavaScript对象,首先需要创建一个供远程调用的类,实现代码如下:
@RemoteProxy
public class GetRemoteUser {
private User user;
@RemoteMethod
public void setUser(User p) {
this.user = p;
}
}
其中User类的代码如下:
@DataTransferObject class User { @RemoteProperty String firstName; @RemoteProperty String lastName; @RemoteProperty Date birthday; }
这样就可以在JavaScript中写成如下形式:
var user = { firstName: 'Bear', lastName: 'Bibeault', birthday: new Date() }; GetRemoteUser.setUser(user);
在JavaScript中没有出现的字段,在Java中就不会被设置。因为setter的返回类型都是void,这样就不需要使用callback函数了。如果需要一个返回void的服务器端方法,也可以添加callback函数,但DWR不会向它传递任何参数。