第 1 页 Wabacus 框架开发指南(二) 共 200 页 Copyright (C) 2010-2012 星星<349446658@qq.com> Wabacus 框架开发指南（二） 作者：星星 二○一二年四月十七日 第 2 页 Wabacus 框架开发指南(二) 共 200 页 Copyright (C) 2010-2012 星星<349446658@qq.com> 一、 常用功能配置 1.1 页面拦截器 页面拦截器是对整个页面进行拦截器，可以在页面初始前执行动作，也可以在整个页面显示 完后执行动作，用户可以根据需要在这两个时机加入自己的执行逻辑，完成某些功能，比如常前 的就是授权功能。 1.1.1 页面拦截器分类 页面拦截器根据作用范围及定义位置分为两种：全局拦截器和页面自己的拦截器 全局页面拦截器 全局页面拦截器定义在系统级配置文件 wabacus.cfg.xml 的标签中，每个 全局拦截器定义在此标签的一个子标签中。 标签包括如下属性： class 属性：此全局页面拦截器对庆的实现类的全限定类名； pageid 属性：此全局拦截器需要匹配哪些页面 ID，只有页面 id 值与这里定义的 pageid 匹配的页面才会被此拦截器拦截，否则不会被它拦截，也就是显示此页面前后都不会调 用拦截器的相应接口方法。 pageid 的配置方式有两种，由下面的 matchmode 属性决定，具体请看这个属性的介 绍。 matchmode 属性：指定上面 pageid 属性的匹配模式，包括两种： 如果配置为“regex”，则采用正则表达式匹配页面 ID，此时上面的 pageid 属性配置 为一正则表达式，只有与此正则表达式匹配的页面 ID 才会被这个全局拦截器拦截； 如果没指定此属性或指定为其它任意值，则采用直接匹配，即只有与 pageid 属性完 全相等（通过 equals()比较）的页面 ID 才会被这个全局拦截器拦截，不过此时 pageid 属性支持配置多个页面 ID，用分号分隔，页面 ID 只要与其中任意一个相等就算匹 配，对应的页面在显示时就会被此拦截器拦截。 如果没有配置 pageid 属性，或配置为空，则与所有页面都匹配。 在 wabacus.cfg.xml 的标签中，可以配置任意多个全局拦截器，每个拦截 器都定义在一个独立的标签中，它们的执行顺序后面会介绍到。 例如： 上面依次定义了三个全局页面拦截器，第一个采用普通的匹配方式，只匹配页面 ID 为 page3_0_3 和 page3_0_4 的页面；第二个采用正则表达式匹配，只匹配页面 ID 满足正则表达式 (page3)(\S*?)的页面；第三个没有指定 pageid 属性，则匹配所有页面。 全局拦截器只能用 J AVA 类的方式实现，不能直接用标签配置。 第 3 页 Wabacus 框架开发指南(二) 共 200 页 Copyright (C) 2010-2012 星星<349446658@qq.com> 页面私有拦截器 页面私有拦截器配置在标签的 interceptor 属性中（此时为 J AVA 类实现）或其 子标签中。 一个页面可以同时通过 interceptor 属性和子标签定义拦截器，它们在页面显示 时都将会拦截，并执行各自定义的方法。 interceptor 属性是通过指定拦截器 JAVA 类的全限定类名进行配置，在这里可以配置多个拦 截器，用分号“；”分隔。 子标签只能定义一个拦截器，拦截器的每个方法它都有一个相应的标签进行配 置，在其中可以定义拦截器类的 J AVA 代码。 不管是在的 interceptor 属性中，还是在子标签中定义的拦截器都将只被 这一个页面所有，不会拦截到其它页面。 1.1.2 页面拦截器实现 从上面的介绍中可以看出，页面拦截器有两种实现方式：开发拦截器类和通过拦截器标签进 行配置，其中全局拦截器和通过的 interceptor 属性配置的页面专有拦截器只能用 J AVA 类 的方式实现，而通过的子标签配置的页面专有拦截器则是直接在配置文件中 配置拦截器代码，下面分别进行介绍。 通过JAVA类实现页面拦截器 不管是用作全局拦截器，还是用作某个页面专有拦截器，在用 J AVA 类实现时，方法都完全 一样，也就是说，一个 J AVA 类实现的页面拦截器，即可以把它配置到 wabacus.cfg.xml 中做为全 局拦截器使用，又可以将它配置给某一个页面做为此页面的专有拦截器。 所有 JAVA 类实现的拦截器都必须继承抽象类： com.wabacus.system.intercept.AbsPageInterceptor，然后实现其中的如下两个方法： public abstract void doStart(ReportRequest rrequest); public abstract void doEnd(ReportRequest rrequest); doStart()方法在页面初始化前调用，doEnd()方法在页面显示完后调用。每次刷新页面时，即 使刷新当前页面的某一个部分，比如本次只刷新此页面的一个从报表，也会执行此页面拦截器的 这两个方法，这对有些操作，比如授权非常有用。 下面给出一个 J AVA 类实现的页面拦截器代码： public class Interceptor2 extends AbsPageInterceptor { public void doStart(ReportRequest rrequest) { String pageid=rrequest.getPagebean().getId();//取到当前拦截的 页面id String sql="select * from tbl_permissions where pageid='"+pageid+"'";//取到为此页面类型在tbl_permissions表中定义的所有 权限 Connection conn=rrequest.getConnection(); Statement stmt=null; try { stmt=conn.createStatement(); 第 4 页 Wabacus 框架开发指南(二) 共 200 页 Copyright (C) 2010-2012 星星<349446658@qq.com> ResultSet rs=stmt.executeQuery(sql); while(rs.next()) {//对取到的每个权限定义进行授权 rrequest.authorize(rs.getString("componentid"),rs.getString("part type"),rs.getString("partid"),rs.getString("permissiontype"),rs.g etString("permissionvalue")); } rs.close(); }catch(SQLException e) { e.printStackTrace(); }finally { //关闭stmt，不用关闭conn } } public void doEnd(ReportRequest rrequest) { } } 上面的拦截器只实现了 doStart()方法，没有实现 doEnd()方法。 在配置文件中配置页面拦截器 页面专有拦截器除了可以在的 interceptor 属性配置 J AVA 类，还可以通过其子标签 进行定义，不过这里只能定义一个拦截器。它包括三个子标签： 子标签：导入拦截器前后置动作要用到的外部包； 定义前置动作，对应 J AVA 类实现的 doStart()方法； 定义后置动作，对应 J AVA 类实现的 doEnd()方法。 上面三个子标签的使用与报表拦截器完全相同。 这种方式配置出来的拦截器与用 JAVA 类实现的拦截器完全相同，可以互换实现，不过执行 的顺序略有不同，在下一节将会讨论到。 例如上面用 J AVA 类实现的拦截器可以用配置文件配置如下所示： java.sql.* Connection conn=rrequest.getConnection(); Statement stmt=null; try { stmt=conn.createStatement(); ResultSet rs=stmt.executeQuery(sql); while(rs.next()) {//对取到的每个权限定义进行授权 rrequest.authorize(rs.getString("componentid"),rs.getString("part type"),rs.getString("partid"),rs.getString("permissiontype"),rs.g etString("permissionvalue")); } rs.close(); }catch(SQLException e) { e.printStackTrace(); }finally { //关闭stmt，不用关闭conn } ]]> 因为此拦截器没有提供后置动作，所以没有配置子标签。 1.1.3 页面拦截器执行顺序 上面已经介绍到，一个页面可能会被多个拦截器拦截到，因此理解各拦截器的 doStart()方法 和 doEnd()方法执行顺序非常重要，下面以一个示例来介绍定义在各位置上的拦截器的 doStart() 和 doEnd()方法的执行顺序。 假如在 wabacus.cfg.xml 中依次注册了如下三个全局拦截器： 然后某个页面的拦截器配置如下所示： ............... 第 6 页 Wabacus 框架开发指南(二) 共 200 页 Copyright (C) 2010-2012 星星<349446658@qq.com> 上面页面定义了三个私有拦截器，其中通过 interceptor 属性定义了 D 和 E 两个 J AVA 类实现 的拦截器，通过属性定义了一个拦截器，假设名字为 F 访问此页面时，两个方法的执行顺序如下所示： doStart()方法执行顺序：A―――>B―――>C―――>D―――>E―――>F doEnd()方法的执行顺序为：F―――>E―――>D―――>C―――>B―――>A 1.2 报表继承 1.2.1 概述 为了简化报表的配置，如果新配置的报表与已有的某报表很多地方相似，框架支持通过让 新报表继承已有报表的方式进行配置，然后在新报表中只配置那些与父报表不同的地方，覆盖掉 父报表在这些地方的配置。这样就可以减少冗余配置，提高了报表的配置效率及配置文件的可维 护性。 针对继承的父子报表，有如下四个特点： 1、 子报表可以与父报表配置在同一个报表配置文件中，也可以配置在不同的报表配 置文件中； 2、 子报表可以配置在父报表之前，也可以配置在父报表之后。 3、 报表间的继承层数没有限制。比如 A 报表继承 B 报表，B 报表又是继承 C 报表， C 报表又是继承 D 报表等等。 4、 报表继承关系不能出现循环继承，即不能 A 报表继承 B 报表，B 报表继承 C 报 表，然后 C 报表又继承 A 报表。这样会导致报表加载失败。 1.2.2 配置继承报表步骤 当 A 报表继承 B 报表时，配置 A 报表的步骤包括如下几步： 1、 将 A 报表的标签的 extends 属性配置为 B 报表的页面 id+“.”+B 报表的 报表 id。 2、 A 报表的标签中除 id 之外的其它所有属性，如果想重用 B 报表的配置， 则均不需配置。只有想覆盖掉 B 报表的配置值的配置属性才需在 A 报表的 标签中显式配置。 3、 如果 A 报表的、、、四个标签中的任意一个 标签上的某个配置项（包括其子标签的配置项）与 B 报表对应标签有所不同，则 要在 A 报表中重新配置自己的相应标签。 比如，以标签为例，只有 A 报表的标签下所有配置项（包括 标签上的所有配置属性以及其子标签
的配置数量、顺序以及每个
上 的配置属性）都与 B 报表相同时，才不用配置自己的标签，直接用 B 报表的即 可，否则就必须重新配置自己的标签，覆盖掉 B 报表中关于的配置。 其它三个标签道理也与此相同。 4、 如果 A 报表的拦截器配置与 B 报表保持一致（即都需配置拦截器且拦截器代码完 第 7 页 Wabacus 框架开发指南(二) 共 200 页 Copyright (C) 2010-2012 星星<349446658@qq.com> 全相同或都不需配置拦截器），则不用在 A 报表配置自己的拦截器，否则就需要 在 A 报表配置自己的拦截器。 这里有两个情况需要着重说明： 1）、如 果 B报表配置了拦截器（不管是使用的interceptor属性还是 子标签），同时 A 报表不需要拦截器，则需将 A 报表标签的 interceptor 属性显式 配置为空字符串，即配置为 interceptor=””，覆盖掉 B 报表的拦截器配置。 2）、如果 B 报表是通过的 interceptor 属性配置了拦截器，则如果 A 报表想覆 盖掉 B 报表的拦截器而配置自己的拦截器，则 A 报表的拦截器配置必须也通过 的 interceptor 属性进行配置，而不能通过属性进行配置，否则覆盖不起作用。 1.2.3 示例 假设一个报表配置如下所示：
