DWR中文文档

dwr.xml文件的结构如下:
术语
这里是一些必须理解的术语 - 参数会被converted，远程Bean会被created。所以如果你有一个叫A的bean，它有一个方法叫A.blah(B) 那么你需要一个A的creator和一个B的converter。
一：<allow>
allow段落里面定义的试DWR可以创建和转换的类。
二：Creators
dwr.xml文件中的create元素的结构如下：
<allow> <create creator="..." javascript="..." scope="..."> <param name="..." value="..."/> <auth method="..." role="..."/> <exclude method="..."/> <include method="..."/> </create> ...</allow> 这里的多数元素都是可选的 - 你真正必须知道的是指定一个creator和一个javascript名字。
creator属性 是必须的 - 它用来指定使用那种创造器。
默认情况下DWR1.1有8种创造器。它们是：
new: 用Java的new关键字创造对象。
none: 它不创建对象，看下面的原因。 (v1.1+)
scripted: 通过BSF使用脚本语言创建对象，例如BeanShell或Groovy。
spring: 通过Spring框架访问Bean。
jsf: 使用JSF的Bean。 (v1.1+)
struts: 使用Struts的FormBean。 (v1.1+)
pageflow: 访问Beehive或Weblogic的PageFlow。 (v1.1+)
如果你需要写自己的创造器，你必须在init部分注册它。
javascript属性 用于指定浏览器中这个被创造出来的对象的名字。你不能使用Javascript的关键字。
scope属性 非常类似servlet规范中的scope。它允许你指定这个bean在什么生命范围。选项有"application", "session", "request" 和"page"。这些值对于Servlet和JSP开发者来说应该相当熟悉了。
scope属性是可选的。默认是"page"。如果要使用"session"需要cookies。当前的DWR不支持ULR重写。
param元素 被用来指定创造器的其他参数，每种构造器各有不同。例如，"new"创造器需要知道要创建的对象类型是什么。每一个创造器的参数在各自的文档中能找到。请查看上面的链接。
include和exclude元素 允许创造器来限制类中方法的访问。一个创造器必须指定include列表或exclude列表之一。如果是include列表则暗示默认的访问策略是"拒绝"；如果是exclude列表则暗示默认的访问策略是"允许"。
例如要拒绝防范除了setWibble()以外的所有方法，你应该把如下内容添加到dwr.xml中。
<create creator="new" javascript="Fred"> <param name="class" value="com.example.Fred"/> <include method="setWibble"/></create> 对于加入到create元素中的类的所有方法都是默认可见的。
auth元素 允许你指定一个J2EE的角色作为将来的访问控制检查:
<create creator="new" javascript="Fred"> <param name="class" value="com.example.Fred"/> <auth method="setWibble" role="admin"/></create>
--------------------------------------------------------------------------------
new创造器在DWR中已经默认声明了：<creator id="new" class="uk.ltd.getahead.dwr.create.NewCreator"/> 。你不需要在dwr.xml文件中添加这段话，它已经存在于DWR的内部dwr.xml文件中了。
这个创造器通过类默认的够早函数创造对象实例。用new创造器有一些好处：
安全:DWR创造的对象生存的事件越短，多次调用中间的值不一致的错误机会越少。
内存消耗低：如果你的站点用户量非常大，这个创造器可以减少VM的内存溢出。
你可以通过下面的方式使用new创造器来创造远程调用Bean：
<allow> <create creator="new" javascript="Blah"> <param name="class" value="java.util.Date"/> </create> ... </allow> 这些代码把 java.util.Date 映射成Javascript，并且命名为Blah，所以在Javascript中当你调用Blah.toString(reply) 那么一个新的 java.util.Date 就会通过默认的构造函数创造出来， 然后 toString() 方法被调用，然后结果数据返回给reply方法(在这个例子中date是字符串格式)。
none'创造器不创建任何对象 - 它会假设你不需要创建对象。这有可能是对的，有两个原因。
你可能在使用的scope不是"page"(看上面)，并在在前面已经把这个对象创建到这个scope中了，这时你就不需要再创建对象了。
还有一种情况是要调用的方法是静态的，这时也不需要创建对象。DWR会在调用创建器之前先检查一下这个方法是不是静态的。
对于上诉两种情况，你仍然需要class参数，用来告诉DWR它是在操作的对象类型是什么。
scripted创造器在DWR中已经默认声明了：<creator id="script" class="uk.ltd.getahead.dwr.create.ScriptedCreator"/>
这个创造器用BSF来执行脚本得到Bean，例如：
<allow> ... <create creator="script" javascript="EmailValidator"> <param name="language" value="beanshell"/> <param name="script"> import org.apache.commons.validator.EmailValidator; return EmailValidator.getInstance(); </param> </create> ...</allow> script创造器有如下参数：
参数 DWR版本 描述
language 1.0 脚本语言，字符串，例如'beanshell'. (必需)
script 1.0 要执行的脚本。 (必需，除非scriptPath参数存在)
scriptPath 1.1 脚本文件路径。 (必需，除非script参数存在)
reloadable 1.1 是否检测脚本文件的改动，以重新加载 (可选, 默认true)
class 1.0 创造出对象的类型(可选). 如果没有DWR通过创造器得到类型。
需要了解的主题
要使用这个创造器，你需要把一些辅助库放到WEB-INF/lib文件夹下：BSF的jar包，你要用的脚本语言的jar包。
当一个类是用script创造出来的，并且scope是session或application，如果你的脚本改变，session中的类和script中的类就不一致了。这样会出现错误。虽然web容器不用重启，但是用户需要先登出(或以某种方式清空session)，然后再登录。
当clazz参数不为空，并且用来创造新实例，DWR简单的调用 class.newInstance() 方法。这种方法是没问题的，除非脚本正在用某个参数创建一个类，或者调用某个函数来配置这个类。不幸的是，每次请求都要重新运行script并造成上面的问题。
创造器
让DWR和Spring一起工作的步骤
确认你用的是最新版的DWR。Spring创造器已经有了变化，所以你最好检查一下DWR的最新版本。
确认你查看过开始指南中的内容。
确认你的Spring的Bean在DWR外面运行良好。
配置DWR和Spring一起工作。 (看下面)
查看演示页面: http://localhost:8080/[ YOUR-WEBAPP ]/dwr ，检查spring的Bean是否出现。
DWR对于Spring没有运行期依赖，所以如果你不使用Spring那么Spring的支持不会产生任何影响到。
The SpringCreator
这个创造器会查找spring的中配置的Bean，用Spring去创建它们。如果你已经在使用Spring，那么这个创造器会非常有用。
你可以通过下面的方式来创建远程调用的Bean：
<allow> ... <create creator="spring" javascript="Fred"> <param name="beanName" value="Shiela"/> </create> </allow> 寻找你的Spring配置
有三种方式寻找配置文件：
ContextLoaderListener
最简单的方式是使用org.springframework.web.context.ContextLoaderListener。你不必使用所有的Spring-MVC功能，只需要这个Listener就够了，所以这是个不错的方案。你需要在WEB-INF/web.xml中做如下配置：
<context-param> <param-name>contextConfigLocation</param-name> <param-value>/WEB-INF/classes/beans.xml</param-value> </context-param> <listener> <listener-class> org.springframework.web.context.ContextLoaderListener </listener-class> </listener> 我能找到的ContextLoaderListener的最好的文档就是javadoc。如果你知道还有更好的文档，请告知我。
Rob Sanheim 指出还有一个能深入了解ContextLoaderListener的文档。
使用location*参数
如果你要在dwr.xml中指定使用哪些bean，你可以使用location*参数。你可以指定任意多个文件，只要参数以location开始并且唯一即可。例如：location-1, location-2。这些location被用做Spring的ClassPathXmlApplicationContext的参数：
<allow> ... <create creator="spring" javascript="Fred"> <param name="beanName" value="Shiela"/> <param name="location" value="beans.xml"/> </create> </allow> 直接设置BeanFactory
SpringCreator有一个静态方法 setOverrideBeanFactory(BeanFactory) 用来通过编程的方式直接设置BeanFactory。
配置DWR和Spring
Bram Smeets写了一个有意思的blog，教你配置DWR使用beans.xml代替WEB-INF/web.xml。
我也对于如何在beans.xml中指定dwr.xml很感兴趣，尽管这看上去有些Spring传染病的感觉。有人知道如何实现吗？请加入邮件列表并告诉大家。

--------------------------------------------------------------------------------
三：Converters
我们必须保证所有的参数都可以被转换。JDK中的多数类型已经有转换器了，但是你需要给DWR转换你的代码的权利。一般来说JavaBean的参数需要一个<convert ...>定义。默认情况下，如下类型不需要定义就可以转换：所有的原生类型 boolean,int,double, 等等
原生类型的对象类型 Boolean,Integer,等等
java.lang.String
java.util.Date 和SQL中的Date
以上类型组成的数组
以上类型的集合类型 (Lists, Sets, Maps, Iterators, 等)
从DOM, XOM, JDOM 和 DOM4J中的DOM对象 (类似 Element 和 Document)
基础的转换器
原生类型，String，像BigDecimal这样的简单对象的转换器已经有了。你不需要在dwr.xml中<allow>部分的<convert>中定义。它们默认支持。
默认支持的类型包括： boolean, byte, short, int, long, float, double, char, java.lang.Boolean, java.lang.Byte, java.lang.Short, java.lang.Integer, java.lang.Long, java.lang.Float, java.lang.Double, java.lang.Character, java.math.BigInteger, java.math.BigDecimal 和 java.lang.String
Date转换器
Date转换器负责在Javascript的Date类型与Java中的Date类型(java.util.Date, java.sql.Date, java.sql.Times or java.sql.Timestamp)之间进行转换。同基础的转换器一样，DateConverter默认是支持的。
如果你有一个Javascript的字符串 (例如"01 Jan 2010") ，你想把它转换成Java的Date类型有两个办法：在javascript中用Date.parse()把它解析成Date类型，然后用DWR的DateConverter传递给服务器；或者把它作为字符串传递给Server,再用Java中的SimpleDateFormat(或者类似的)来解析。
四：<init>
可选的init部分用来声明创造bean的类和转换bean的类。多数情况下你不需要用到他们。如果你需要定义一个新的Creator [JavaDoc] 和 Converter [JavaDoc] ，那么你就需要在这里定义他们。但是建议你现检查一下DWR是不是已经支持了。
在init部分里有了定义只是告诉DWR这些扩展类的存在，给出了如何使用的信息。这时他们还没有被使用。这中方式很像Java中的import语句。多数类需要在使用前先import一下，但是只有import语句并不表明这个类已经被使用了。每一个creator和converter都用id属性，以便后面使用。
五：多个dwr.xml文件
可以有多个dwr.xml文件(详细信息见web.xml文档)。每个文件中的定义会被加在一起。DWR用这个功能来加载基础配置文件。我们可以看看标准被配置文件来了解dwr.xml的内容。



Bean Converter
<convert converter="bean" match="your.full.package.BeanName"/>

指定属性转换只有针对bean才有效
<convert converter="bean" match="com.example.Fred"/>
  <param name="exclude" value="property1, property2"/>
</convert>

授权访问方式
<convert converter="bean" match="com.example.Fred"/>
  <param name="include" value="property1, property2"/>
</convert>

Maps和Collections converter
<convert converter="collection" match="java.util.Collection"/>
<convert converter="map" match="java.util.Map"/>

creator
Creator    Parameter    User   
new    class    类的全名称(包括包路径)   
scripted    language    BSF框架支持的脚本语言名称(BSF为apache项目)   
scripted    script    返回远程对象的脚本,脚本可以指定一些属性,多数情况下一般只设置param节点配置.属性很少设置.   
spring    Location*    任何以location开头的参数,每个参数都是指定一个spring的配置文件,在参数没有设置的情况下DWR会去读取spring的全局的配置文件.   
spring    beanName    从配置文件中读取的bean的名称   
           
           
           
fan访问权限           
           
如果要设置除了setWibble方法之外的所有方法都不可访问可以采用下面的设置.
<create creator="new" javascript="Fred">
  <param name="class" value="com.example.Fred"/>
  <exclude method="setWibble"/>
</create>
如果采用j2ee访问角色控制的模式
<create creator="new" javascript="Fred">
  <param name="class" value="com.example.Fred"/>
  <auth method="setWibble" role="admin"/>
</create>

DWR的引擎文件，他承担着把后台自动生成的javascript接口与前台调用之间的衔接责任
<script type='text/javascript'
    src='/[YOUR-WEB-APP]/dwr/engine.js'>
</script>

Java组件的编写和发布以及客户端引用
Java组件必须是一个具体类(因为接口、抽象类反射机制无法实例化)
实体类必须遵循Java Bean规范即实现Getter和Setter
配置文件中Allow部分的Create元素的JavaScript属性的值要唯一
如果存在Java Bean需要转换则要配置Allow部分的Convert元素
客户端引用业务组件要以dwr/interface/xxx.js的路径引用JS文件

DWR前台引擎(Engine.js)的主要职责:
截取每个后台组件的请求实现客户端的统一入口
将用于组件调用的JS参数对象重新包装组合
检测客户端浏览器的环境并选择最佳的数据提交方案
处理后台执行结果并通过执行回调函数通知客户

后台控制器(DWRServet)的主要职责
装载Servlet时初始化DWR配置参数
实现后台业务组件调用的服务器端统一入口
分发各种不同类型的请求 JS文件请求 业务调用请求等
输出组件执行结果(JavaScript语句)到客户端浏览器

业务组件执行器的主要职责
根据配置文件的参数确定后台组件的访问规则和生命周期
拆包前台传入的参数 包装组件执行结果
按参数类型匹配数据类型转换器
采用反射机制执行业务组件方法处理客户端请求
处理与其他系统的接口和协作 如：Spring Hibernate等

dwr.xml的业务组件发布和调用规则配置部分Allow
Create配置元素详细说明:
属性：
Creator 
配置业务组件的创建类型。主要有四种:Spring、New、 none 、Scripts。
JavaScript
前台页面javascript引用此组件的名称。名称需要唯一。
scope
组件的作用范围或则叫做生命周期。这个和Servlet的生命周期的作用是 一样的。共Session、request、application、page四个选项。
子节点：
Param 
配置业务组件的创建参数。Name属性设置名称,value属性设置业务组件的具体路径(类全名称)。
Include
授权方式保护业务组件方法的可见性。属性method可以访问的方法名称。如果没有配置则默认为所有方法都可以访问。
exclude
排除方式保护业务组件方法的可见性。属性method设置不可以访问的方法名称。除此之外的都可以访问。如果有需要控制业务组件方法的访问权限时建议采用这种方式。
Auth
采用EJB的角色访问控制方式。Method属性设置可以访问的方法名称，role属性设置访问角色。

Convert配置元素详细说明:
属性：
converter 
配置数据类型的转换器。一般是设置bean转换器，因为基本类型的转换器DWR默认设置。
match
设置要使用此转换器的java实体对象。如:
<convert converter="bean" match="demo.entity.*"/>
子节点:
Param对象属性的转换规则,name属性设置规则有include和exclude选项，作用和组件方法控制的一样。Value属性设置实体对象的属性。默认是所有属性都进行转换。

dwr.xml的业务组件方法签名配置部分Signatures
Signatures是用来配置Java Bean数据类型转换时遇到不能确定转换类型的情况。如:
Bean.setList(List a)方法，DWR设置集合a的时候就无法确定a这个集合里需要填充哪种数据类型。所以针对有输入集合对象的情况就需额外设置Signatures配置节点来设置。这个节点的配置如下:
<signatures>
  <![CDATA[
    import java.util.List;
    import demo.entity.*;
    import demo.busi.*;
   
    Customer.setAccounts(List<Account> accounts);
    DemoBusinessObject.getListSet(List<Contact> inList);
   ]]>
</signatures>

Signatures主要有两个部分:

Import部分 和java文件的作用一样

另一部分对方法的签名进行范型的设定。返回结果的集合元素类型不需要设置，因为可以在运行时确定。

JS开发注意事项
1、要注意DWR异步机制带来的数据可能不同步问题
2、返回结果只能是一个值所以要详细设计返回结果类型
3、要注意Java引用传递和JavaScript值传递的差异
4、连续多次后台请求尽量采用批量调用
5、尽量将JavaScript的逻辑处理代码抽取成一个独立的文件