快速开发J2EE应用方案.doc

快速开发快速开发 J2EE 应用方案应用方案 快速开发 J2EE 应用方案 中科软科技股份有限公司 i 目 录 第一章 概要说明 2 第一节 概要说明 2 第二节 内容 2 第三节 专用语说明 2 第二章 方案 3 1 1技术平台架构及分析 3 1 1 1总体图 3 1 1 2页面设计说明 4 1 2项目搭建说明 6 1 2 1项目说明 6 1 2 2总体说明 6 1 2 3Java源代码目录 D DEMO modules component 7 1 2 4工程搭建说明 7 1 2 5工作区命令说明 7 1 3JAVA编程规范 8 1 3 1程序结构 8 1 3 2命名规范 9 1 3 3注释规范 11 1 3 4声明规范 13 1 3 5语句规范 15 1 3 6空白使用规范 18 1 3 7缩进规范 19 1 4HTML 编程规范 20 1 4 1编写规范 20 1 5业务编程规范 21 1 5 1命名规范 21 快速开发 J2EE 应用方案 中科软科技股份有限公司 ii 1 5 2JavaScript库维护规则 22 1 5 3页面元素命名规范 22 1 5 4词根表维护规则 22 1 5 5注释规范 23 1 5 6书写规范 23 1 5 7程序规范 23 1 6编程步骤 23 1 6 1数据库设计 23 1 6 2搭建工作区 24 1 6 3生成标准代码 24 1 6 4添加BLFacade 主要为声明接口 24 1 6 5重新生成UICommand 24 1 6 6添加BLAction 25 1 6 7完成BLFacade 25 1 6 8编写JSP 25 1 6 9编写其他 25 附录 JTOOLPAD 26 第一章第一章 概要说明概要说明 第一节第一节 概要说明概要说明 快速开发 J2EE 应用 是所有饱受 J2EE 应用开发之苦的程序员和项目经理 的梦想 希望本文能对他们有所帮助 作者是从最基础的 Web 应用程序员一步一步走过来的 开发 J2EE 项目中 的各种痛苦与无奈也都一一体验过 基于 5 年来 J2EE 应用开发的经验和教训的 总结得出本文 以下以 DEMO 项目为例 项目路径为 D DEMO 应用代码 web 应用名 为 demo 快速开发 J2EE 应用方案 中科软科技股份有限公司 第 2 页 第二节第二节 内容内容 本文档包含如下内容 架构描述 命名规范 编码规范 编程步骤 第三节第三节 专用语说明专用语说明 为了便于描述 下面对文档中简略用词统一进行说明 中科软科技股份有限公司 统一简称为 中科软科技 快速开发 J2EE 应用方案 中科软科技股份有限公司 第 3 页 第二章第二章 方案方案 1 1 技术平台架构及分析技术平台架构及分析 1 1 1 总体图总体图 快速开发 J2EE 应用方案 中科软科技股份有限公司 第 4 页 图中蓝色部份表示 JToolpad 可以为程序员生成标准的类模块 1 1 2 页面设计说明页面设计说明 经过分析发现 对于通用功能来说 通常就包括 9 种标准动作 对应 mon Constants 类中定义的 9 个常量 准备查询 即显示查询条件 public static final String PREPAREQUERY prepareQuery 查询 public static final String QUERY query 查询后继续向下翻页 public static final String QUERYCONTINUE queryContinue 察看结果 public static final String VIEW view 准备新增记录 即准备显示新增页面数据 public static final String PREPAREINSERT prepareInsert 新增记录 public static final String INSERT insert 删除记录 public static final String DELETE delete 准备更新 即准备显示更新页面数据 public static final String PREPAREUPDATE prepareUpdate 更新记录 public static final String UPDATE update 对于一个标准功能来说 对应以上 9 个标准动作 为此对应四个 JSP 文件 如表 agTask 对应 EditAgTask jsp 新增 更新 QueryAgTaskOverview jsp 输入查询条件 快速开发 J2EE 应用方案 中科软科技股份有限公司 第 5 页 QueryAgTaskOverviewResult jsp 分页显示查询结果 删除 ViewAgTask jsp 查看 快速开发 J2EE 应用方案 中科软科技股份有限公司 第 6 页 1 2 项目搭建说明项目搭建说明 1 2 1 项目说明项目说明 1 2 2 总体说明总体说明 快速开发 J2EE 应用方案 中科软科技股份有限公司 第 7 页 1 2 3 Java 源代码目录 源代码目录 D DEMO modules component 注 凡是存在 domain 的目录都可以存在 custom Java 源代码中 所有 Base java 都是不允许修改的 它们由 JToolpad 生成 写好 BLFacade 后 即可以利用 JToolpad 生成 UICommand 生成的 UICommand 一般不用修改 如果想自己写 UICommand 类名必须严格按照规则命名 如 BLPrpCmainFacade 的 queryByPolicyNo 方法 对应的 UICommand 为 PrpCmainQueryByPolicyNoCommand 1 2 4 工程搭建说明工程搭建说明 在 D DEMO modules 目录下建立 Eclipse 工程 如果已有则导入即可 快速开发 J2EE 应用方案 中科软科技股份有限公司 第 8 页 1 2 5 工作区命令说明工作区命令说明 在 D DEMO Modules 目录下存在文件 build xml 需要在 Path 路径中加入 ant 所在目录 输入 ant compile 即可编译 它将编译项目所有源代码 并转换所有的 properties 文件 1 3 java 编程规范编程规范 本编程规范建立在标准的 Java 编程规范的基础上 如和标准的 Java 编程规 范有冲突 以本编程规范为准 1 3 1 程序结构程序结构 包名 引入包 类名 类注释 类 常量 常量注释 构造器注释 快速开发 J2EE 应用方案 中科软科技股份有限公司 第 9 页 构造器 构造器注释 构造器 方法注释 方法 方法注释 方法 1 3 2 命名规范命名规范 命名规范使得程序更易理解 可读性更强 并且能够提供函数和标识 符的信息 文件命名规范文件命名规范 java 程序使用如下的文件名后缀 文件类型后缀 Java 源文件 java Java 字节码文件 class 对系统的文件命名方式有待于根据实际业务决定 包命名规范包命名规范 包名应该唯一 它的前缀可以为任何小写的ASCII字符但必须是顶级域 名 目前包括com edu gov mil net org 或者ISO标准3166 1981中两个字符 的国别代码 包名接下来的部分按照公司内部的命名规范 这些规范指出 了某种目录名 主要包括部门 项目 机器 或者登录名 包命名举例 com sinosoft reins out bl facade com sinosoft reins out dto domain 类命名规范类命名规范 类名应该是名词 并且是大小写混合的 首字母要大写 尽量保证类名 快速开发 J2EE 应用方案 中科软科技股份有限公司 第 10 页 简单并且描述性强 避免使用只取单词首字母的简写或者单词的缩写形式 除非缩写形式比单词的完整形式更常用 例如 URL 或者 HTML 类命名举例 class PolicyOverviewDTO class CitemDTOFactory 接口命名规范接口命名规范 接口命名方式与类命名方式相同 接口命名举例 interface PolicyOverview interface PolicyOverviewSessionHome 方法命名规范方法命名规范 方法名应该为动词 并且是大小写混合的 首字母要小写 方法名的第 二个单词的第一个字母大写 方法命名举例 String getNoticeNo Collection findByCondition String 变量命名规范变量命名规范 变量 以及所有的类实例应为首字母小写的大小写混合形式 变量名的 第二个单词的首字母大写 变量名的首字母不能为下划线或者 符 变量名应该尽可能的短小 但要有意义 变量名应该便于记忆 也就是 说变量名应该尽可能的做到见名知意 除了暂时使用的变量外 一般用于 循环变量 应该避免使用只有一个字母的变量名 对于临时变量一般说来 i j k m n 代表整型变量 c d e 代表字符型变量 变量命名举例 String dataType String name int i char c 常量命名规范常量命名规范 快速开发 J2EE 应用方案 中科软科技股份有限公司 第 11 页 声明为类常量的变量或者 ANSI 常量应该全部为大写字母 并且每个单 词间用下划线 隔开 为了便于调试 应避免使用 ANSI 常量 常量命名举例 static final int MIN WIDTH 4 1 3 3 注释规范注释规范 Java 提供了两种类型的注释 程序注释和文档注释 程序注释是由分 隔符 和 隔开的部分 这些注释和 C 中的注释一样 文档注释 即 doc 注释 是 Java 独有的 由分隔符 隔开 使用 javadoc 工 具能够将文档注释抽取出来形成 HTML 文件 程序注释主要是对程序的某 部分具体实现方式的注释 文档注释是对程序的描述性注释 主要是提供 给不需要了解程序具体实现的开发者使用 注释应该是代码的概括性描述 提供不易直接从代码中得到的信息 并且只包含对阅读和理解程序有用的 信息 例如注释中包含相应的包如何编译或者在哪个目录下 而不应该包 括这个包驻留在哪儿的信息 注释中可以描述一些精妙的算法和一些不易 理解的设计思想 但应该避免那些在程序代码中很清楚的表达出来的信息 尽可能的避免过时的信息 错误的注释比没有注释更有害 经常性的注释 有时也反映出代码质量的低下 程序注释程序注释 程序注释有四种格式 块注释格式 单行注释 跟随注释 行尾注释 块注释格式块注释格式 块注释主要用于描述 文件 方法 数据结构和算法 一般在文件或者 方法定义的之前使用 也可以用在方法定义里面 如果块注释放在函数或 者方法定义里 它必须与它所描述的代码具有相同的缩进形式 块注释应该用一个空行开头 以便于代码部分区分开来 块注释举例 Here is a block comment 快速开发 J2EE 应用方案 中科软科技股份有限公司 第 12 页 单行注释单行注释 比较短的注释可以放在一行中 但必须与它所跟随的代码有相同的缩进 如果注释不可以放在一行 那么必须按照块注释的格式来写 单行的注释 会被解释为一空行 单行注释举例 if condition Handle the condition 跟随注释跟随注释 非常短的注释可以和它所描述的代码放在同一行 但要保证代码和注释 之间有足够的间隔 在同一块代码中不止一个这样的注释时它们应该对齐 跟随注释举例 if a 2 return TRUE special case else return isPrime a works only for odd a 行尾注释行尾注释 注释标记 能够注释一行或者该行由 开始直到行尾的部分 行 尾注释不能用在多行文本注释中 但它可以将多行代码注释掉 这三种注 释方法举例如下 if foo 1 Do a double flip else return false Explain why here if bar 1 Do a triple flip 快速开发 J2EE 应用方案 中科软科技股份有限公司 第 13 页 else return false 文档注释文档注释 文档注释描述了 Java 类 接口 构造函数 方法和属性 每个文档注 释放在文档注释符 中 每个类 接口或者成员只在声明的地方之前有一个文档注释 例如 The Example class provides public class Example 注意 最外层的类或者接口的文档注释不用缩进 但它的成员的文档注 释与成员的声明具有相同的缩进格式 文档注释从第二行开始与第一行相比缩进一个字符 即注释的每一行的 星号要对齐 如果关于类 接口 变量或者方法的注释信息不是为文档信息提供的 就应该使用块注释或者单行注释 这两类注释应该使用在声明之后 关于 类实现方法的详细信息应该放在类语句后的块注释中 而不应该放在类的 文档注释中 文档注释方法或者构造函数的定义块内 Java 会将文档注释后的第一个 声明于文档注释关联起来 1 3 4 声明规范声明规范 变量声明变量声明 每行定义变量数目每行定义变量数目 每行定义的变量数目必须有且只有一个 例如 快速开发 J2EE 应用方案 中科软科技股份有限公司 第 14 页 int level indentation level int size size of table 变量初始化变量初始化 在声明局部变量的时候就要初始化变量 变量定义位置变量定义位置 在 for 循环里的循环变量可以在 for 语句里面定义 for int i 0 i maxLoops i 注意 应避免局部变量屏蔽了外层变量的作用范围 也就是说不要在内 部块中声明一个与外部块某个变量同名的变量 例如类似下面的情况应避免 int count myMethod if condition int count 与外部的 count 变量重名 应该避免 类和接口声明类和接口声明 类和接口的声明应该遵循以下规范 1 在方法名和参数列表的圆括号以及括号后的第一个参数间都没有空 格 2 开括号 必须与声明语句放在同一行 3 闭括号 必须与声明语句有相同的缩进格式 4 如果类或者接口实现内容为空 则可以将 放在 后面 5 方法之间要用一个空行隔开 class Sample extends Object int ivar1 int ivar2 快速开发 J2EE 应用方案 中科软科技股份有限公司 第 15 页 Sample int i int j ivar1 i ivar2 j int emptyMethod 1 3 5 语句规范语句规范 简单语句简单语句 每行最多包含一个语句 例如 argv 正确 argc 正确 argv argc 错误 应该避免这样写 组合语句组合语句 组合语句使用大括号括起来的一串语句 1 大括号中的语句比组合语句多一级缩进 2 开括号 应该放在组合语句前的语句末尾 闭括号 应该放 在新的一行并与组合语句开始前的第一个语句有相同的缩进 3 如果语句是控制语句的一部分时 所有的语句都要用大括号围起来 即使只有一个语句也要用括号 例如在 if else 或者 for 语句中 这 样避免在添加语句时忘记添加括号而导致程序产生 bug return 语句语句 return 语句在有返回值时不需要使用圆括号 除非使用圆括号在某些特 定的情况下能够提高代码的可读性 return 语句举例 快速开发 J2EE 应用方案 中科软科技股份有限公司 第 16 页 return return myDisk size return size size defaultSize if 语句语句 if 语句使用格式如下 if condition statements if condition statements else statements if condition statements else if condition statements else statements 注意 在 if 语句中必须使用大括号 避免使用下面的形式 if condition 禁止使用 这种方式忽略了大括号 容易导致错误 statement switch 语句语句 switch 语句使用格式如下 switch condition 快速开发 J2EE 应用方案 中科软科技股份有限公司 第 17 页 case ABC statements 不包括 break 语句 case DEF statements break case XYZ statements break default statements break 1 每一个 case 语句都要包含 break 语句 如果不包含应该说明正常情 况下应在什么时候退出 switch 语句 2 每一个 switch 语句都要包含 default 情况 default 语句后的 break 语 句不是多余的 它能避免在以后添加其他的 case 语句时而可能导致 的错误 3 一般 switch 语句中 condition 的值是整型数 for 语句语句 for 语句使用格式如下 for int i 0 i maxLoops i try catch 语句语句 try catch 语句使用格式如下 try statements 快速开发 J2EE 应用方案 中科软科技股份有限公司 第 18 页 catch ExceptionClass e statements try catch 语句后也可以跟随 finally 无论 try 块内的语句是否成功执行 finally 块内的语句都会执行 使用格式如下 try statements catch ExceptionClass e statements finally statements 如果 catch 块中除 throw 异常外没有任何处理 则不应该写该 try catch 块 1 3 6 空白使用规范空白使用规范 空行使用规范空行使用规范 空行的正确使用能够提高源代码的可读性 使得程序的逻辑关系更清 楚 两行空行的使用两行空行的使用 在下列情况下使用两行空行 1 在一个文件的两部分 section 代码之间 2 在两个类或者接口的定义之间 单行空行的使用单行空行的使用 在下列情况下使用单行空行 1 在两个方法定义之间 2 在一个方法中局部变量的变量定义语句和方法的第一个其他语句之 间 快速开发 J2EE 应用方案 中科软科技股份有限公司 第 19 页 3 在一个语句块或者单行注释之前 4 为了提高程序可读性 在一个方法的两个逻辑段之间 空格使用规范空格使用规范 在下列情况下使用空格 1 关键字后跟随圆括号时要在两者间添加空格 例如 while true 2 函数调用时 函数名和圆括号间要添加括号 注意 在定义方法时的方法名和圆括号之间不加空格 这样便于区 分方法调用和方法定义 3 参数列表中的逗号后面要添加空格 4 除了成员运算符 以外 所有的二元运算符应该用空格和操作数 分开 在一元运算符 如 负数 和操作数之间不用空格 例如 a c d a a b c d while n 10 n print size is foo n 5 for 语句中的表达式要用空格隔开 例如 for expr1 expr2 expr3 6 强制类型转换后面要用空格隔开 例如 myMethod byte aNum Object x myMethod int cp 5 int i 3 1 快速开发 J2EE 应用方案 中科软科技股份有限公司 第 20 页 1 3 7 缩进规范缩进规范 每一级缩进都要再上一级的基础上缩进 4 个字符 1 4 HTML 编程规范编程规范 1 4 1 编写规范编写规范 1 在引用 CSS 时 请先确认所引用的属性名称在 CSS 中是有的 2 在文件中引用了 CSS 就尽量不要再给 TD 或 INPUT 设一个死值 把数值尽量写在 CSS 里 如 如 如果 CSS 中没有设宽度 那在写时也尽量写成百分比形式 如 如 3 注意上下行列数相同 4 在录入 查询 修改 列表等页 TABLE 请写成 这是表格居中 边距 5 间距 1 在录入 查询 修改页中一般表格为 4 列 第 1 列及 3 列 第 2 及 4 列为 在列表页 标题行 TR 内容行 TR 可以在 TD 中设每列的宽度 但只写一行就可以 如 如 快速开发 J2EE 应用方案 中科软科技股份有限公司 第 21 页 5 有链接的文字样式 一般文字链接样式为灰色带下划线 鼠标移到 上方时下划线消失 如果是结果例表页中表格里文字带链接 那么 样式为彩色带下划线 鼠标移到上方时下划线消失 彩色字带下划 线样式引用 格式制定人名称 格式制定人名称 6 书写 HTML 代码时请依次缩进 2 个空格 并对齐代码 以便于修改 1 5 业务编程规范业务编程规范 1 5 1 命名规范命名规范 类文件命名规范类文件命名规范 参见架构设计的通用原则 JSP 文件命名规范文件命名规范 以操作名开头 后接对象名 如果对象名超过 20 位 则按照缩略规则执行 例 编辑 CCL 保单 EditCCLPolicy jsp 通常会有部分文件可以公用 如 EditCCLPolicy jsp 就包含文件 EditCCLCitem jsp EditCCLCmain jsp 等 方法命名规范方法命名规范 采用由大小写英文字母 数字和 组成方式 规则如下 公共方法命名公式 动作 或 动作 对象名 快速开发 J2EE 应用方案 中科软科技股份有限公司 第 22 页 例 保单接口类 Policy java 中的方法 add 保单数据传输对象 PolicyDTO java 中的方法 setCmain 私有方法命名公式 private 动作 对象名 例 private InsertRow 1 5 2 JavaScript 库维护规则库维护规则 JavaScript 库分为通用 JavaScript 库和应用专用 JavaScript 库 其中通用 JavaScript 库分为如下几个部分 Common js 为标准的 JavaScript 库 MulLine js 操作多行输入的 JavaScript Framework CodeSelect js代码输入的 JavaScript Framework Process jsJavaScript 整体框架 通用 JavaScript 库由专人负责 并提供向后兼容性保证 项目组不允许 修改通用 JavaScript 库 应用专用 JavaScript 库为 Application js 由项目组负 责维护 原则上 所有 JavaScript 都应该兼容 IE5 和 NN6 或以上版本 1 5 3 页面元素命名规范页面元素命名规范 通常页面输入域应该命名成与数据库表名字段名一致 同时在 XXXDataDefine js JToolpad 生成 中存在该数据库字段的相关信息 用 域校验数据 如果一个域的校验希望与数据库的信息不同 可在 CustomDataDefine js 加入该域名的数据类型 由框架来做相应处理 1 5 4 词根表维护规则词根表维护规则 词根表分为通用词根表和专用词根表两类 通用词根表只有一份 它的作 快速开发 J2EE 应用方案 中科软科技股份有限公司 第 23 页 用域是所有系统 专用词根表依附于特定的系统 其作用域也仅限于该系统 所有的词根表由专人 词根表管理员 维护 维护流程如下 假设存在系统 A 如果 A 需要的某些单词 W 没有在当前版本的词根表中定 义 则 A 系统的项目经理向标准化小组发出申请 标准化小组负责提供词根 与此同时 如果 W 是一个通用词根 标准化小组负责将新增词根表信息发布 1 5 5 注释规范注释规范 程序文件头的注释说明主要包括该程序文件包含类的功能描述 Description 文件创建作者 author 创建日期 createdate 等信息 例 Policy 的 Custmo Action 类 author zhouxianli version 1 0 1 5 6 书写规范书写规范 参 java 编程规范 1 5 7 程序规范程序规范 参 java 编程规范 1 6 编程步骤编程步骤 我们以演示系统 DEMO 为例 快速开发 J2EE 应用方案 中科软科技股份有限公司 第 24 页 1 6 1 数据库设计数据库设计 首先 我们要设计好数据库 频繁的变更数据库结构是项目设计混乱的 体现 在这里我们要用到工具 Sybase PowerDesigner 9 在平台中心的 FTP 上 有 Beta 版下载 我们用 PowerDesigner 设计数据库 里面包含几个表 保存为 demodb pdm 1 6 2 搭建工作区搭建工作区 我们按照 1 1 2 节所说的方法构建一个工作区 1 6 3 生成标准代码生成标准代码 启动工具 JToolpad 从菜单文件 导入 PDM 选择我们设计好的 数据库文件 demodb pdm 导入 很快就会出现一个窗口 显示出我们的数据 库结构 选择菜单模型 设置应用属性 其中的应用代码就是我们的包名 的一部分 这里我们输入 DEMO Java 源代码目录就是生成出来的文件所 在的位置 我们选用刚才创建的工作区的源代码目录 确定后可以保存一 下 以便以后再用 选择菜单模型 生成所有生成我们所需的所有标准类 1 6 4 添加添加 BLFacade 主要为声明接口 主要为声明接口 这是后台服务提供给 UI 编程人员的编程接口 需要我们自己编写 当 然 我们也可以选择先让 JToolpad 生成主体框架 再来自己编写 如添加 类 BLEissTableFacade java 然后在其中添加一个服务 findPolic