欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

AJAX实践DWR篇

程序员文章站 2022-03-14 10:33:37
dwr(direct web remoting)是一个web远程调用框架.利用这个框架可以让ajax开发变得很简单.利用dwr可以在客户端利用javas...
dwr(direct web remoting)是一个web远程调用框架.利用这个框架可以让ajax开发变得很简单.利用dwr可以在客户端利用javascript直接调用服务端的java方法并返回值给javascript就好像直接本地客户端调用一样(dwr根据java类来动态生成javascrip代码).它的最新版本dwr0.6添加许多特性如:支持dom trees的自动配置,支持spring(javascript远程调用spring bean),更好浏览器支持,还支持一个可选的commons-logging日记操作.

以上摘自open-open,看了几天,确实是一个非常优秀的项目,它通过反射,将java翻译成javascript,然后利用回调机制,轻松实现了javascript调用java代码。

其大概开发过程如下:
1.编写业务代码,该代码是和dwr无关的。
2.确认业务代码中哪些类、哪些方法是要由javascript直接访问的。
3.编写dwr组件,对步骤2的方法进行封装。
4.配置dwr组件到dwr.xml文件中,如果有必要,配置convert,进行java和javascript类型互转。
5.通过反射机制,dwr将步骤4的类转换成javascript代码,提供给前台页面调用。
5.编写网页,调用步骤5的javascript中的相关方法(间接调用服务器端的相关类的方法),执行业务逻辑,将执行结果利用回调函数返回。
6.在回调函数中,得到执行结果后,可以继续编写业务逻辑的相关javascript代码。

下面以用户注册的例子,来说明其使用。(注意,本次例子只是用于演示,说明dwr的使用,类设计并不是最优的)。

1.先介绍下相关的java类

  user: 用户类,
  public class user {
//登陆id,主键唯一
private string id;
//姓名
private string name;
//口令
private string password;
//电子邮件
private string email;

//以下包含getxxx和setxxx方法
.......
  }

  userdao:实现user的数据库访问,这里作为一个演示,编写测试代码
  public class userdao { 
    //存放保存的数据
    private static map datamap = new hashmap();

    //持久用户
    public boolean save(user user) {
      if (datamap.containskey(user.getid()))
        return false;
      system.out.println("下面开始保存用户");
      system.out.println("id:"+user.getid());
      system.out.println("password:"+user.getpassword());
      system.out.println("name:"+user.getname());
      system.out.println("email:"+user.getemail());
      datamap.put(user.getid(), user);
      system.out.println("用户保存结束");
      return true;
    }

    //查找用户
    public user find(string id) {
      return (user)datamap.get(id);
    }
}

  dwruseraccess:dwr组件,提供给javascript访问的。

  public class dwruseraccess {

      userdao userdao = new userdao();

      public boolean save(user user) {
        return userdao.save(user);
      }

      public user find(string id) {
        return userdao.find(id);
      }
  }


  下面说明下程序执行的流程

  1.用户在页面上输入相关注册信息,id、name、password、email,点击“提交”按钮
  2.javascript代码开始执行,根据用户填写相关信息,通过dwr提供的dwruseraccess.js里save的方法,调用服务器端的dwruseraccess类save方法,将注册信息保存。
  3.通过dwruseraccess.jsp里的find方法,调用服务器端dwruseraccess类里的find方法,执行用户信息查找。

  注意,在以上的执行过程中,dwruseraccess是供dwr调用的,是dwr组件,因此需要将dwruseraccess类配置到dwr中。

  接下来讲解本次dwr测试环境的配置。

  1.新建一个webapp,命名为testapp
  2.将dwr.jar拷贝到testapp的web-inf的lib目录下
  3.编译上面的user,userdao,dwruseraccess类,放到classes目录下
  4.在web.xml中配置servlet,适配路径到dwr目录下,如下所示
    <servlet>
    <servlet-name>dwr-invoker</servlet-name>
    <display-name>dwr servlet</display-name>
    <description>direct web remoter servlet</description>
    <servlet-class>uk.ltd.getahead.dwr.dwrservlet</servlet-class>
    <init-param>
      <param-name>debug</param-name>
      <param-value>true</param-value>
    </init-param>
    <init-param>
      <param-name>scriptcompressed</param-name>
      <param-value>false</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
  </servlet>

  <servlet-mapping>
    <servlet-name>dwr-invoker</servlet-name>
    <url-pattern>/dwr/*</url-pattern>
  </servlet-mapping>

  以上的配置可以拦截testapp下所有指向dwr的请求,关于这个拦截器,我们会在后面介绍。

  5.web-inf下新建一个dwr.xml文件,内容如下:
  <?xml version="1.0" encoding="utf-8"?>
<!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="dwruseraccess">
      <param name="class" value="test.dwruseraccess"/>
    </create>
<convert converter="bean" match="test.user"/>
  </allow>
</dwr>

  这里我们把dwruseraccess配置到了dwr中,create元素中,creater="new"表示每调用一次dwruseraccess时,需要new一个这样的类;javascript="dwruseraccess",表示提供给前台页面调用的javascirpt文件是dwruseraccess.js。

  convert元素用于数据类型转换,即java类和javascript之间相互转换,因为和前台交换的是user对象,因此需要对此使用bean转换,我们将在后面介绍这个类。

  4.编写测试的html页面 test.html
   <!doctype html public "-//w3c//dtd html 4.0 transitional//en">
<html>
<head>
<title>dwr测试</title>
<meta http-equiv=content-type content="text/html; charset=gb2312">
<script src="/oblog312/dwr/engine.js"></script>
<script src="/oblog312/dwr/util.js"></script>
<script src="/oblog312/dwr/interface/dwruseraccess.js"></script>
</head>
<body>
<b>用户注册</b><br>
------------------------------------------------
<br>
<form name="regform">
登陆id:<input type="text" name="id"><br>
口  令:<input type="password" name="password"><br>
姓  名:<input type="text" name="name"><br>
电子邮件:<input type="text" name="email"><br>
<input type="button" name="submitbtn" value="提交" onclick="onsave()"><br>
    </form>

<br>
<br><b>用户查询</b><br>
------------------------------------------------
<br>
<form name="queryform">
登陆id:<input type="text" name="id"><br>
<input type="button" name="submitbtn" value="提交" onclick="onfind()"><br>
</form>
<br>
</body>
</html>
<script language="javascript">
<!--
function savefun(data) {
if (data) {
  alert("注册成功!");
} else {
  alert("登陆id已经存在!");
}
}

function onsave() {
var usermap = {};
usermap.id = regform.id.value;
usermap.password = regform.password.value;
usermap.name = regform.name.value;
usermap.email = regform.email.value;
dwruseraccess.save(usermap, savefun); 
}

function findfun(data) {
if (data == null) {
  alert("无法找到用户:"+queryform.id.value);
  return;
}

alert("找到用户,\nid:"+data.id+",\npassword:"+data.password+",\nname:"+data.name+",\nemail:"+data.email);

}

function onfind() {
dwruseraccess.find(queryform.id.value, findfun); 
}
//-->
</script>


以下对页面的javascript进行解释

<script src="/oblog312/dwr/engine.js"></script>
<script src="/oblog312/dwr/util.js"></script>
这两个是dwr提供的,用户可以不必关心,只需要导入即可

<script src="/oblog312/dwr/interface/dwruseraccess.js"></script>
是我们编写的dwruseraccess类,经dwr反射后,生成的javascript代码,它和dwruseraccess.java是对应的,供用户调用,实际上我们就是通过这个js文件去调用服务器端的dwruseraccess类的。

<script language="javascript">
<!--
function savefun(data) {
if (data) {
  alert("注册成功!");
} else {
  alert("用户名已经存在!");
}
}

function onsave() {
var usermap = {};
usermap.id = regform.id.value;
usermap.password = regform.password.value;
usermap.name = regform.name.value;
usermap.email = regform.email.value;
dwruseraccess.save(usermap, savefun); 
}

function findfun(data) {
if (data == null) {
  alert("无法找到用户:"+queryform.id.value);
  return;
}

alert("找到用户,\nid:"+data.id+",\npassword:"+data.password+",\nname:"+data.name+",\nemail:"+data.email);

}

function onfind() {
dwruseraccess.find(queryform.id.value, findfun); 
}
//-->
</script>

这段javascirpt代码,我们来看下onsave函数,首先它构造一个map,将表单数据都设置到map中,然后调用dwruseraccess.save(usermap, savefun),执行save操作。大家可以注意到,服务器端的dwruseraccess中的save方法是这样的:boolean save(user user),其参数是一个user对象,返回一个boolean值;而客户端的方法是这样的:save(usermap,savefun),第一个参数usermap是javascirpt中的map对象,在这里相当于服务器端的user对象(在服务器端执行时,会通过convert转换成user对象),前面我们提到dwr是利用回调函数来返回执行结果的,第二个参数savefun即是一个回调函数。在函数function savefun(data)中,data是执行结果,这里是一个bool值,非常简单的,我们通过判断data是否为真,可以知道用户名是否重复,用户是否注册成功。

看一下onfind查找函数,执行结果在回调函数findfun(data)中,因为服务器端返回的是一个user对象,通过convert,将会转换成javascript的一个map对象,
于是在findfun中,通过data.id、data.name、data.password、data.email我们可以轻松的访问到这个user对象。


好了配置完毕,启动服务器,在目录中打入localhost/testapp/test.html。

1.在“用户注册”表单中,id框中输入admin,password中输入123456,name中输入chenbug,email中输入chenbug@zj.com,点击提交按钮,弹出对话框:“注册成功”,在服务器后台可以看到信息如下:

下面开始保存用户
id:admin
password:123456
name:chenbug
email:chenbug@zj.com
用户保存结束

再次点击提交按钮,弹出对话框“登陆id已经存在”。

2.在“用户查询”对话框中,输入登陆id为admin,点击提交按钮,提示找到用户,并显示相关信息,输入admin123,点击提交按钮,提示无法找到用户。

至此,测试结束。


后续:
1。拦截器 uk.ltd.getahead.dwr.dwrservlet
该类拦截所有指向dwr目录下的请求,并调用processor的handler方法进行处理,在uk.ltd.getahead.dwr.impl.defaultprocessor下,我们可以看到详细的处理过程。
if (pathinfo.length() == 0 ||
            pathinfo.equals(htmlconstants.path_root) ||
            pathinfo.equals(req.getcontextpath()))
        {
            resp.sendredirect(req.getcontextpath() + servletpath + htmlconstants.file_index);
        }
        else if (pathinfo.startswith(htmlconstants.file_index))
        {
            index.handle(req, resp);
        }
        else if (pathinfo.startswith(htmlconstants.path_test))
        {
            test.handle(req, resp);
        }
        else if (pathinfo.startswith(htmlconstants.path_interface))
        {
            iface.handle(req, resp);
        }
        else if (pathinfo.startswith(htmlconstants.path_exec))
        {
            exec.handle(req, resp);
        }
        else if (pathinfo.equalsignorecase(htmlconstants.file_engine))
        {
            file.dofile(req, resp, htmlconstants.file_engine, htmlconstants.mime_js);
        }
        else if (pathinfo.equalsignorecase(htmlconstants.file_util))
        {
            file.dofile(req, resp, htmlconstants.file_util, htmlconstants.mime_js);
        }
        else if (pathinfo.equalsignorecase(htmlconstants.file_deprecated))
        {
            file.dofile(req, resp, htmlconstants.file_deprecated, htmlconstants.mime_js);
        }
        else
        {
            log.warn("page not found (" + pathinfo + "). in debug/test mode try viewing /[web-app]/dwr/"); //$non-nls-1$ //$non-nls-2$
            resp.senderror(httpservletresponse.sc_not_found);
        }

通过判断request请求的servlet路径,进行处理,大家可以自己去参看,这里不详细讨论。


2.bean转换器,<convert converter="bean" match="test.user"/>
将dwr.jar解压缩,在路径uk\ltd\getahead\dwr下可以看到dwr.xml,这里配置了系统默认的一些转换器,
<converter id="bean" class="uk.ltd.getahead.dwr.convert.beanconverter"/>即是刚才用到user类的转换器,进入代码我们来看看它是如何在javascript和java间进行转换的。

打开beanconverter代码,定位到函数

public object convertinbound(class paramtype, inboundvariable iv, inboundcontext inctx) throws conversionexception

即是将javascript对象转换成java对象的,其中
paramtype即class类型,在上面的例子中是test.user,
inboundvariable iv,是传入的值,通过iv.getvalue可以得到传入的javascript值串
inboundcontext inctx,是入口参数上下文,用于保存转换的后java对象。

因为前台传入的是一个javascript的map类型,而map肯定是以{开始和以}结束的,于是在这个函数一开始进行了判断
if (!value.startswith(conversionconstants.inbound_map_start))
        {
            throw new illegalargumentexception(messages.getstring("beanconverter.missingopener", conversionconstants.inbound_map_start)); //$non-nls-1$
        }

        if (!value.endswith(conversionconstants.inbound_map_end))
        {
            throw new illegalargumentexception(messages.getstring("beanconverter.missingcloser", conversionconstants.inbound_map_start)); //$non-nls-1$
        }

javascript中,map里各个项是用逗号连接的,如var usermap = {id:'admin',password:'123456',name:'chenbug',email:'chenbug@zj.com'};而每个项的键值对是用冒号连接的,
在convertinbound函数的接下来的处理中,即是通过分析map字串,通过paramtype构造java实例(即user类),然后通过反射,将这些键值对设置到java实例中,并返回。
这样就完成了javascript到java的转换。


另一个函数
public string convertoutbound(object data, string varname, outboundcontext outctx) throws conversionexception

即是将java对象转换为javascript对象(其实是声明和赋值语句)。
object data ,是待转换的java对象
string varname,是javascript中的该对象的变量名
outboundcontext outctx,传出参数上下文,用于保存转换后的javascript值

stringbuffer buffer = new stringbuffer();
        buffer.append("var "); //$non-nls-1$
        buffer.append(varname);
        buffer.append("={};"); //$non-nls-1$
这里声明了map类型的变量。

即下来来的代码即是通过反射进行变量赋值,如下
  buffer.append(varname);
                    buffer.append('.');
                    buffer.append(name);
                    buffer.append('=');
                    buffer.append(nested.getassigncode());
                    buffer.append(';');
大家可以自己去参看更多的代码。

3.dwr本身提供了一个测试环境,大家在配置完后,可以在ie中输入地址http://localhost/testapp/dwr/index.html,看到配置的各dwr组件,并进行相关测试。