DWR 异步交互
导读
「DWR 异步交互」是面试与实战中都会被反复问到的问题,下面从结论讲起。
DWR(Direct Web Remoting)是 Ajax 时代早期的一个"魔法框架":它把服务器端的 Java 方法直接暴露成 JavaScript 函数,前端调用就像调用本地函数一样,返回值通过回调函数拿到。在 OA 项目中,它主要用于授权界面的即时保存、机构树的异步加载等场景。
一、快速上手三步
第 1 步:拷贝 dwr.jar 到 WEB-INF/lib
第 2 步:在 web.xml 中配置 DWR Servlet
<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>
debug=true会开放/dwr/index.html调试页面,可以直接在浏览器里调用暴露的方法做测试。上线时必须关掉。
第 3 步:在 WEB-INF/dwr.xml 中声明要暴露的类
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dwr PUBLIC "-//GetAhead Limited//DTD Direct Web Remoting 2.0//EN"
"http://getahead.org/dwr/dwr20.dtd">
<dwr>
<allow>
<create creator="spring" javascript="aclManager">
<param name="beanName" value="aclManager"/>
</create>
</allow>
</dwr>
| 属性 | 含义 |
|---|---|
creator="spring" |
对象由 Spring 容器提供(也可填 new,由 DWR 自己 new) |
javascript="aclManager" |
前端可用的 JS 对象名 |
param beanName |
Spring 容器中的 Bean id |
这样前端就能直接调用 Spring 管理的业务对象方法了——不需要写任何 Controller 或 Servlet。
二、在 OA 中的用法
<create creator="spring" javascript="aclManager">
<param name="beanName" value="aclManager"/>
</create>
页面引入三个 JS(顺序固定):
<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/aclManager.js"></script>
第三个
dwr/interface/aclManager.js并不是磁盘上的真实文件,而是 DWR Servlet 根据配置动态生成的代理脚本。
调用示例——授权界面勾选复选框时立即保存:
// Java: boolean hasPermission(int userId, String resourceSn, int permission)
aclManager.hasPermission(userId, 'document', 0, function(data) {
if (data) {
document.getElementById('btnAdd').style.display = '';
}
});
授权保存:
// Java: void addOrUpdatePermission(String type, int principalSn, int resourceSn, int permission, boolean yes)
aclManager.addOrUpdatePermission('User', userId, moduleId, 1, true, function() {
alert('授权已保存');
});
三、返回值与参数的各种姿势
DWR 示例工程里有 9 个递进的测试,覆盖了实际开发中会遇到的全部情形:
test1:处理返回值(多种回调写法)
// 写法一:只传回调
Test1.hello(function(data) { alert(data); });
// 写法二:用 call 对象,可指定异常处理
Test1.hello({
callback: function(data) { alert(data); },
errorHandler: function(msg) { alert('出错:' + msg); },
timeout: 3000
});
// 写法三:把回调定义在别处
function show(data) { alert(data); }
Test1.hello(show);
test2:向方法传递参数
// Java: String sayHello(String name)
Test2.sayHello('张三', function(data) { alert(data); });
test3:返回数组
// Java: String[] getArray()
Test3.getArray(function(data) {
for (var i = 0; i < data.length; i++) alert(data[i]);
});
test4:返回集合(List)
// Java: List getList() 元素为 JavaBean
Test4.getList(function(data) {
for (var i = 0; i < data.length; i++) {
alert(data[i].id + ' - ' + data[i].name); // 直接按属性访问
}
});
DWR 会把 JavaBean 自动转成 JS 对象,属性名一一对应。
test5:返回 Map
// Java: Map getMap()
Test5.getMap(function(data) {
for (var key in data) {
alert(key + ' = ' + data[key]);
}
});
test6:返回二维数组
Test6.getArray2(function(data) {
alert(data[0][1]);
});
test7:$("") 获取页面元素的值
dwr/util.js 提供了类似 prototype 的 $():
var name = $("username").value; // 等价于 document.getElementById("username")
Test2.sayHello(name, function(data) { alert(data); });
test8:扩展页面元素的属性
DWRUtil.setValue("msg", data); // 给 id=msg 的元素赋值(支持 input/select/div)
DWRUtil.addOptions("sel", items, "value", "label"); // 动态填充下拉框
DWRUtil.removeAllOptions("sel");
批量填充下拉框在 OA 里非常实用,例如"选择机构 → 联动加载人员列表"。
test9:同步与异步
// DWR 默认是异步的
dwr.engine.setAsync(false); // 改成同步(会阻塞浏览器,慎用)
Test1.hello(function(data) { result = data; });
dwr.engine.setAsync(true); // 用完记得改回来
还可以设置全局超时与错误处理器:
dwr.engine.setTimeout(5000);
dwr.engine.setErrorHandler(function(msg, ex) { alert('请求失败:' + msg); });
四、类型转换与安全
4.1 转换器
dwr.xml 中用 <convert> 声明复杂类型如何序列化:
<allow>
<convert converter="bean" match="com.oa.model.*"/>
<convert converter="hibernate3" match="com.oa.model.Organization">
<param name="include" value="id,name,sn"/>
</convert>
</allow>
Hibernate 的懒加载代理对象不能直接序列化,DWR 提供了专门的
hibernate3转换器,并通过include/exclude精确控制输出字段,既能避免LazyInitializationException,也能防止把敏感字段(如password)暴露到前端。
4.2 安全注意事项
- 不要暴露整个 Manager。示例里直接暴露
aclManager只是为了演示。真实项目应单独写一个门面类,只暴露必要方法。 - 服务端必须再校验权限。JS 调用只是换了入口,绕过它直接发 HTTP 请求同样能调到方法。
- 关闭 debug 模式,否则
/dwr/会把所有类的接口列出来。 - 对输出做字段过滤,避免序列化出整个对象图(尤其是带双向关联的对象)。
五、DWR 在 OA 中的典型场景
| 场景 | 实现方式 |
|---|---|
| 授权界面勾选即保存 | aclManager.addOrUpdatePermission(...) |
| 机构树异步展开 | 点节点时调用 orgManager.findOrgs(parentId) 返回子机构 |
| 选择流程后加载对应表单 | formManager.findForm(workflowId) |
| 用户名重复校验 | userManager.findUserByUsername(name) 返回是否存在 |
| 会议室申请冲突提示 | meetingRoomManager.searchApplies(begin, end) |
六、小结
| 优点 | 局限 |
|---|---|
| 零样板代码,Java 方法直接变 JS 函数 | 前后端强耦合,Java 签名改动会直接影响前端 |
| 自动完成 Java ↔ JS 类型转换 | 调试困难,错误堆栈在服务端 |
| 与 Spring 无缝整合 | 已被 RESTful + JSON + axios/fetch 全面取代 |
今天再看 DWR,它的价值主要在于理解"远程过程调用"的思想;新项目请直接使用 REST 接口返回 JSON。
要点小结
-
- DWR 示例工程里有 9 个递进的测试,覆盖了实际开发中会遇到的全部情形
- | 场景 | 实现方式 | |---|---| | 授权界面勾选即保存 |
aclManager.addOrUpdatePermission(...)| | 机构树异步… - | 优点 | 局限 | |---|---| | 零样板代码,Java 方法直接变 JS 函数 | 前后端强耦合,Java 签名改动会直接影响前端 | | 自动完成 Java …
由站内小编编辑整理