SISAL编程规范.doc

泉州商行项目 核心系统SISAL编程规范 ( V1.0 ) 拟制： 郭盈华 日期： 2008年月日 修 订 记 录 修订日期 版 本 修 订 内 容 作 者 2008/4/21 V1.00 完成第一稿 郭盈华 目 录 1. 引言 2 2. 命名规范 3 2.1 配置文件命名规则 3 2.2 应用程序命名规则 3 2.3 变量命名 4 3. 代码风格 4 3.1 JAVA编程风格 4 3.2 SISAL代码规范 4 3.3 常量定义规范 5 4. 代码注释规则 6 4.1 注释方法 6 5. 界面布局 6 5.1 规则 6 引言 本规范主要针对前台SISAL系统编写。 预期读者： 前台开发人员 文件命名规范 目前sisal开发主要涉及两个工程，SISAL和sisalclient。SISAL主要是xml配置文件以及各类jar包。Sisalclient为应用程序，我们主要在此工程中进行代码的开发。 配置文件命名规则 画面文件都放在WebContent\tellerClient\views目录下，并且按业务分目录放置，画面文件名为：View+四位外部交易码+[in/out]+.xml，首字母大写，如现金存款交易ckyw\View0303.xml，in/out为可选项，对于有些交易分为输入界面和输出界面时，可在画面名称后加上in或out用以区分。 交易流程文件放在WebContent\tellerClient\operations目录下，按业务分目录放置，文件名为：4位外部交易码+CltOp+.xml。如现金存款交易命名为ckyw\0303CltOp.xml。 前台标准数据以xml文件的形式存放在WebContent\tellerClient\stddata目录下，文件名为efip中的表名+xml后缀，如柜员角色控制表rolectls.xml。（先将efip前台数据库unload出来，然后在unload文件首行增加字段名，用竖线分隔，再通过sisalclient/com.easycon.easypub/TabelToXml.java，将文件转换成xml文件。执行TabelToXml时，需给TabelToXml.java设置运行参数，或直接在代码中将tableName变量修改为表名，并将fileDir修改为文件存放目录。Xml文件生成后，拷贝到stddata目录下） 应用程序命名规则 在应用程序工程sisalclient中，按照代码类型，分置不同的包，各包含义如下： com.easycon.viewController包：界面控制文件，命名为：ViewController+4位外部交易码 com.easycon.function包：联动交易中用到的功能函数。 com.easycon.pattern包：画面组件格式定义，类名以Pattern结尾，如ParValuePattern.java。 com.easycon.easypub包：交易中用到的公共类或方法。类名按照java的命名规则，首字母大写，若类名由几个单词构成，那么把它们紧靠到一起，每个嵌入单词的首字母都采用大写形式。 com.easycon.step包：交易步骤类。类名以Step结尾，如打印文件PrintFileStep.java。 com.easycon.field包：新增组件类型。 com.easycon.deviceManage包：外设管理。 com.easycon.platform.device包：外设处理。 变量命名 组件对象名：组件名+变量名，如： EText textJyje ECombo comboHbh 代码风格 JAVA编程风格 所有代码的书写风格需首先遵守java编写规范，即： 类名首字母大写。 若类名由多个单词构成，那么将他们紧靠到一起，不要用下划线分隔，每个嵌入单词的首字母都采用大写形式。 方法、字段（成员变量）以及对象句柄名称，样式与类名相似，只是标识符的第一个字母采用小写。 SISAL代码规范 在sisal应用程序开发过程中，主要涉及到的代码种类有ViewController，其次还可能涉及到step，pattern，function以及其他公共方法。下面主要介绍这画面控制器的书写规范： ViewController编写规范 所有ViewController子类都需要继承ViewController父类，并实现ViewListener监听，代码模板如下： public class ViewController3501 extends ViewController implements ViewListener{ pu