DWR中文文档v0.9 04

lgf444

浏览: 81015 次
性别:
来自: 长沙

最近访客更多访客>>

博主相关

博客

微博

相册

留言

关于我

文章分类

社区版块

存档分类

博客分类：

AJAX

DWR JavaScript Bean 浏览器应用服务器

第3章. dwr.xml配置
3.1 纵览
dwr.xml是你用来配置DWR的文件，默认是将其放入WEB-INF文件夹。创建一个dwr.xml文件

dwr.xml有如下的结构：

<?xml version="1.0" encoding="UTF-8"?> 
<!DOCTYPE dwr PUBLIC 
"-//GetAhead Limited//DTD Direct Web Remoting 2.0//EN" 
"http://www.getahead.ltd.uk/dwr/dwr20.dtd"> <dwr> 
<!-- 仅当需要扩展DWR时才需要 --> 

<init> 
<creator id="..." class="..." />
 <converter id="..." class="..." /> 
</init> 

<!-- 没有它DWR什么也做不了 --> 
<allow>
 <create creator="..." javascript="..." /> 

<convert converter="..." match="..." />
 </allow> 
<!-- 有必要告诉DWR方法签名 --> 

<signatures>...</signatures>
 </dwr>

3.2 <init>标签
这个初始化部分申明被用来创建远程beans而且这个类能被用来以某种过程转换。大多数例子你

将不需要用它，如果你想去定义一个新的Creator或者Converter，就要在此被申明。在init部

分里有了定义只是告诉DWR这些扩展类的存在，给出了如何使用的信息。这时他们还没有被使用

。这种方式很像Java中的import语句。多数类需要在使用前先import一下，但是只有import语

句并不表明这个类已经被使用了。每一个creator和converter都用id属性，以便后面使用。

3.3 <allow>标签
allow部分定义了DWR能够创建和转换的类。
3.3.1 Creator
每一个在类中被调用的方法需要一个<create …>有若干类型的creator，使用“new”关键字或

者Spring 框架等。 create元素是如下的结构

<allow> 
<create creator="..."  javascript="..." scope="...">
 <param name="..." value="..." /> 
<auth method="..." role="..." />
 <exclude method="..." /> 
<include method="..." /> 
</create> 
... 
</allow>

1. creator属性
1)．new：Java用“new”关键字创造对象是DWR默认的creator，如下所示

<create id="new"class="org.directwebremoting.create.NewCreator"/>

没有必要把它加入dwr.xml，它已经在DWR内部文件了。这个creator将使用默认构造器创建类

的实例，以下是用new创建器的好处
 安全:DWR创造的对象生存的时间越短，多次调用中间的值不一致的错误机会越少。
 内存消耗低：如果你的站点用户量非常大，这个创造器可以减少VM的内存溢出。
2)．none: 它不创建对象，看下面的原因。 (v1.1+) none创建器不创建任何对象，它会假设你

不须要创建对象。有2个使用的原因：
 你可能在使用的scope不是"page"(看上面)，并在在前面已经把这个对象创建到这个scope中

了，这时你就不需要再创建对象了。
 还有一种情况是要调用的方法是静态的，这时也不需要创建对象。DWR会在调用创建器之前

先检查一下这个方法是不是静态的。
对于上诉两种情况，你仍然需要class参数，用来告诉DWR它是在操作的对象类型是什么。

3)． scripted: 通过BSF使用脚本语言创建对象，例如BeanShell或Groovy。
要使用这个创造器，你需要把一些辅助库放到WEB-INF/lib文件夹下：比如BSF的jar包，你要用

的脚本语言的jar包。 new创造器在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通过创造器得到类型。

注意：当一个类是用script创造出来的，并且scope是session或application，如果你的脚本

改变，session中的类和script中的类就不一致了。这样会出现错误。虽然web容器不用重启，

但是用户需要先登出(或以某种方式清空session)，然后再登录。当clazz参数不为空，并且用

来创造新实例，DWR简单的调用 class.newInstance() 方法。这种方法是没问题的，除非脚本

正在用某个参数创建一个类，或者调用某个函数来配置这个类。不幸的是，每次请求都要重新

运行script并造成上面的问题。
4). spring: 通过Spring框架访问Bean。
详情请见DWR与Spring整合 5). jsf: 使用JSF的Bean。 (v1.1+)
详情请见DWR与JSF整合 6). struts: 使用Struts的FormBean。 (v1.1+)
详情请见DWR与Struts整合 7). pageflow: 访问Weblogic或Beehive的PageFlow。 (v1.1+)
详情请见DWR与Weblogic或Beehive的PageFlow整合 8). ejb3:使用EJB3 session bean。

(v2.0+) 一个正在实验的创造器，用来访问EJB Session beans。直到进行更多的测试和正式的

维护，否则还不能作为产品被使用。如果你想写自己的creator，你必须在<init>里注册它。
2. javascript属性
在浏览器里给你创建的对象命名。避免使用JavaScript保留字。这个名字将在页面里作为js被

导入，就像第2章节的那个jsp：

dwr.xml

<create creator="new" javascript="service"> 
<param name="class" value="helloWorld.Service" />
 </create>

html / jsp

<html> 
<head> 
… 
<script type='text/javascript' src='dwr/interface/service.js'>
 …

3. scope属性
和定义在servlet的scope一样大的范围，它允许你指定哪个bean是可以获得的。选项可以是：

application, session, request和page。这些值应该已经被开发者们熟悉了。 scope选项是可

选的，默认为page，使用session请求cookies。目前，DWR还不支持URL重写。

4. param元素
被用来指定创造器的其他参数，每种构造器各有不同。例如，"new"创造器需要知道要创建的对

象类型是什么。每一个创造器的参数在各自的文档中能找到。
5. include和exclude元素
允许一个创造器去限制进入类的方法。一个创造器必须指定include列表或exclude列表之一。

如果是include列表则暗示默认的访问策略是"拒绝"，include中的每个方法就是允许访问的方

法；如果是exclude列表则暗示默认的访问策略是"允许"，exclude中的每个方法就是拒绝访问

的方法。比如：

<create creator="new" javascript="Fred">
 <param name="class" value="com.example.Fred" /> 
<include method="setWibble" /> 
</create>

说明你只能在DWR中使用Fred的是setWibble方法。
6. auth元素
允许你指定一个J2EE的角色作为将来的访问控制检查:

<create creator="new" javascript="Fred"> 
<param name="class" value="com.example.Fred" />
 <auth method="setWibble" role="admin" /> 
</create>

7. 使用静态方法
DWR会在调用创建器之前先检查一下这个方法是不是静态的，如果是那么创造器不会被调用。很

显然这个逻辑适用于所有创造器，尽管如此"null"创造器是最容易配置的。
8. 使用单例类
对于单例类的创建，最好适用BeanShell和BSF来实例化对象。请参考scripted创造器。
9. DWR与HttpSessionBindingListeners
DWR1.x中存贮已经创造的Bean的方法需要注意，它在每次请求时都会调用相同的

setAttribute() 方法。就是说，如果一个Bean在dwr.xml中的声明周期设置为session，再每次

调用bean中的方法时，DWR都会执行一次 session.setAttribute(yourBean) 。这看上去没有什

么危害，但是如果你要使用servlet的事件机制的，就是说用了HttpSessionBindingListener接

口，你就会发现valueBound和valueUnbound事件在每次调用时都会发生，而不是你想像的在

bean被创建时以及session过期时。 DWR2 只在第一次创建对象时调用 setAttribute() 。

3.3.2 Converter
我们需要确认所有的参数能被转换。许多JDK提供的类型使你能够使用，但是你如果要转换你自

己的代码，就必须告诉DWR。一般是指JavaBean的参数需要一个<convert…>标签作为入口。你

不需要在dwr.xml中<allow>部分的<convert>中定义。它们默认支持。
 所有主要的类型，boolean, int , double等等。
 包装类，Boolean, Integer等等。
 java.lang.String
 java.util.Date 和 java.sql.Times，java.sql.Timestamp。
 数组(存放以上类型的)
 集合类型 (List, Set, Map, Iterator等等) (存放以上类型的)
 DOM对象(来自于DOM, XOM, JDOM和DOM4J)
1. 日期转换器
如果你有一个String(例如：“2001－02－11”)在Javascript，你想把它转换成Java日期。那

么你有2种选择，一是使用Date.parse()然后使用DataConverter传入服务器端，还有一种选择

是把该String传入，然后用java的SimpleDateFormat(或者其他的)来转换。同样，如果你有个

Java的Date类型并且希望在HTML使用它。你可以先用SimpleDateFormat把它转换成字符串再使

用。也可以直接传Date给Javascript，然后用Javascript格式化。第一种方式简单一些，尽管

浪费了你的转换器，而且这样做也会是浏览器上的显示逻辑受到限制。其实后面的方法更好，

也有一些工具可以帮你，例如：
 The Javascript Toolbox Date formatter
 Web Developers Notes on Date formatting
2. 数组转换器
数组实体不太容易理解。默认情况下DWR能转换所有原生类型的数组，还有所有marshallable对

象的数组。这些marshallable对象包括前面介绍的String和Date类型。match属性看上去很怪。

<convert converter="array" match="[Z"/>
 <convert converter="array" match="[B"/> 
<convert converter="array" match="[S"/>
 <convert converter="array" match="[I"/> 
<convert converter="array" match="[J"/>
 <convert converter="array" match="[F"/> 
<convert converter="array" match="[D"/>
 <convert converter="array" match="[C"/>
 <convert converter="array" match="[L*"/>

上面没有解释 * 的作用 - 它是通配符，表示匹配接下来的所有字符串。这也是DWR可以转换任

意类型的数组的原因。

3. bean和对象转换器
两个没有默认打开的转换器是Bean 和 Object 转换器。Bean转换器可以把POJO转换成

Javascript的接合数组(类似与Java中的Map)，或者反向转换。这个转换器默认情况下是没打开

的，因为DWR要获得你的允许才能动你的代码。 Object转换器很相似，不同的是它直接应用于

对象的成员，而不是通过getter和setter方法。下面的例子都是可以用object来替换bean的来

直接访问对象成员。如果你有一个在 <create ...> 中声明的远程调用Bean。它有个一参数也

是一个bean，并且这个bean有一个setter存在一些安全隐患，那么攻击者就可能利用这一点。

你可以为某一个单独的类打开转换器：

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

如果要允许转换一个包或者子包下面的所有类，可以这样写：

<convert converter="bean" match="your.full.package.*"/>

显而易见，这样写是允许转换所有的JavaBean：

<convert converter="bean" match="*"/>

BeanConverter 和 JavaBeans 规范用于被BeanConverter转换的Bean必须符合JavaBeans的

规范，因为转换器用的是Introspection，而不是Reflection。这就是说属性要符合一下条件：

有getter和setter，setter有一个参数，并且这个参数的类型是getter的返回类型。setter应

该返回void，getter应该没有任何参数。setter没有重载。以上这些属于常识。就在eclipse里

自动为每个属性添加setter，getter那种类型，如果你用的不是JavaBean，那么你应该用

ObjectConverter.
 设置Javascript变量 DWR可以把Javascript对象(又名maps，或联合数组)转换成JavaBean或

者Java对象。例子：

public class Remoted { 
  public void setPerson(Person p) { 
  // ... 
  } 
} 
public class Person { 
  public void setName(String name) {
   ... 
  }
  public void setAge(int age) {
  ... 
  } 
  // ... 
}

如果这个Remoted已经被配置成Creator了，Persion类也定义了BeanConverter，那么你可以通

过下面的方式调用Java代码：

var p = { name:"Fred", age:21 }; 
Remoted.setPerson(p);

限制转换器就像你可以在creator的定义中剔出一些方法一样，converter也有类似的定义

。
限制属性转换仅仅对于Bean有意义，很明显原生类型是不要需要这个功能的，所以只有

BeanConverter及其子类型(HibernateBeanConverter))有这个功能。语法是这样的：

<convert converter="bean" match="com.example.Fred"> 
<param name="exclude" value="property1, property2" /> 
</convert>

这就保证了DWR不会调用 fred.getProperty1() 和fred.getProperty2两个方法。另外如果你喜

欢"白名单"而不是"黑名单"的话：

<convert converter="bean" match="com.example.Fred"> 
<param name="include" value="property1, property2" /> 
</convert>

安全上比较好的设计是使用"白名单"而不是"黑名单"。
 访问对象的私有成员通过'object'转换器的参数的一个名为force的参数，可以让DWR通过

反射来访问对象私有成员。
语法是这样的：

<convert converter="object" match="com.example.Fred"> 
<param name="force" value="true" /> 
</convert>

直到DWR1.1.3,这里有一个bug，public的field反而不能被发现，所以你需要在public成员上设

置force=true。

4. 集合类型转换器
有个两个默认的转换器，针对Map和Collection：

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

一般来说这些转换器可以递归转换它们的内容。但是也有两点不足之处：
 仅仅用反射机制是没有方法明确集合里面是什么类型的。所以这两个转换器不能把集合里面

的东西转换成有意义的Javascript对象。
 不能明确是那种类型的集合。虽然我们不能让他们自动的起作用，我们可以在dwr.xml中用

signatures语法声明它们类型，使之正确转换。
5. 枚举类型转换器
枚举类型转换器默认是没有打开的。它在Java5中的Enum和Javascript的String之间进行转换。

这个转换器默认关闭是因为DWR要在转换你的代码之前得到你的同意。枚举类型转换器是DWR

1.1版以后才支持的。你可以这样设置来打开这个转换器：

<convert converter="enum" match="your.full.package.EnumName"/>

设置Javascript，一个简单的例子。假设你有下面的Java代码：

public class Remoted { 
   public void setStatus(Status p) { 
     // ... 
   } 
} 
enum Status { 
 PASS, FAIL, 
}

如果Remoted类已经配置好Creator，并且Status枚举类型已经设置了EnumConverter。那么你就

可以在javascript中这样调用：

Remoted.setStatus("PASS");

6. DOM 对象
DWR可以自动转换来之DOM,DOM4J,JDOM和XOM的DOM树。你可以简单得用上面这些类库返回一个

Document、Element或者Node，DWR会把他们自动转换成浏览器的DOM对象。在程序启动的时候

会有一个常见的关于JDOM转换器的警告，你可以放心的忽略它，除非你要用JDOM：

INFO: Missing classdef for converter 'jdom'. Failed to load 
uk.ltd.getahead.dwr.convert.JDOMConverter. Cause: org/jdom/Document

因为DWR没有办法知道你是否想用JDOM，所以这个信息设在INFO级别的。如果你曾经尝试过使

用JDOM，你会意识到在这种情况下这个转换器不可用的 - 这也是我们显示这个信息的原因。

exist-db.org，我相信DWR能同exist-db很好的工作，因为它是建立在W3C DOM之上的，而DWR也

支持这个。
3.4 <signatures>标签
DWR使用反射机制在转换过程中找到它应该使用的类型。有时候类型的信息无法获得，在这种情

况下你要在此处用方法签名给予暗示。 signatures段使DWR能确定集合中存放的数据类型。例

如下面的定义中我们无法知道list中存放的是什么类型。

public class Check {
    public void setLotteryResults(List nos) {
     ... 
   } 
}

signatures段允许我们暗示DWR应该用什么类型去处理。格式对以了解JDK5的泛型的人来说很容

易理解。

<signatures>
 <![CDATA[ 
import java.util.List; 
import com.example.Check; 
Check.setLotteryResults(List<Integer> nos); 
]]> 
</signatures>

DWR中又一个解析器专门来做这件事，所以即便你的环境时JDK1.3 DWR也能正常工作。解析规

则基本上会和你预想规则的一样(有两个例外)，所以java.lang下面的类型会被默认import。

第一个是DWR1.0中解析器的bug，某些环境下不能返回正确类型。所以你也不用管它了。第二

个是这个解析器时"阳光(sunny day)"解析器。就是说它非常宽松，不想编译器那样严格的保证

你一定正确。所以有时它也会允许你丢失import：

<signatures> 
<![CDATA[ 
import java.util.List; 
Check.setLotteryResults(List<Integer>); 
]]>
 </signatures>

将来的DWR版本会使用一个更正式的解析器，这个编译器会基于官方Java定义，所以你最好不要

使用太多这个不严格的东西。 signatures段只是用来确定泛型参数中的类型参数。DWR会自己

使用反射机制或者运行时类型确定类型，或者假设它是一个String类型。所以：不需要

signatures - 没有泛型参数：

public void method(String p);
 public void method(String[] p);

需要signatures - DWR不能通过反射确定：

public void method(List<Date> p);
 public void method(Map<String, WibbleBean> p);

不需要signatures - DWR能正确的猜出:

public void method(List<String> p); 
public void method(Map<String, String> p);

不需要signatures - DWR可以通过运行时类型确定：

public List<Date> method(String p);

没有必要让Javascript中的所有对象的key都是String类型 - 你可以使用其他类型作为key。但

是他们在使用之前会被转换成String类型。DWR1.x用Javascript的特性把key转换成String。

DWR2.0可能会用toString()方法，在服务段进行这一转换。

分享到：

DWR中文文档v0.9 05 | DWR中文文档v0.9 03

2008-05-06 13:23
浏览 3515
评论(0)
查看更多

发表评论

您还没有登录,请您登录后再发表评论

最近访客更多访客>>

博主相关

文章分类

社区版块

存档分类

最新评论