《《软件工厂J2EE项目开发指南》.doc

J2EE项目开发指南 编 写： 杨柯 编写日期： 2008-6-5 审 核： 审核日期： 长沙牛耳信息技术有限公司 目 录 软件工厂J2EE项目开发指南 1 1 概要说明 1 1.1 概要说明 1 1.2 内容 1 1.3 专用语说明 1 2 框架体系说明 2 2.1 总体架构图 2 2.2 框架结构说明 3 2.2.1 数据访问层 3 2.2.2 业务控制层 3 2.2.3 用户视图层 3 2.2.4 日志服务组件 3 2.3 框架目录结构及关键文件说明 4 2.3.1 总体说明 4 2.3.2 配置文件存放目录说明 5 2.3.3 框架核心Java代码目录说明 5 2.3.4 系统业务Java代码目录说明 6 2.3.5 系统JSP页面级目录说明 7 3 项目开发指南 9 3.1 总体说明 9 3.1.1 总体开发流程 9 3.1.2 标准开发模式 9 3.1.3 参考实例说明 11 3.2 开发步骤说明 11 3.2.1 总体说明 11 3.2.2 数据库设计 11 3.2.3 编写数据库映射实体类 12 3.2.4 添加数据访问组件 12 3.2.5 添加业务控制组件 12 3.2.6 编写Struts配置信息 13 3.2.7 编写JSP页面 13 3.3 应用框架开发关键要点说明 13 3.3.1 JSP页面开发要点说明 13 3.3.2 Struts及web.xml配置文件编写要点说明 16 3.3.3 Hibernate配置文件编写要点说明 17 3.3.4 Log4j配置文件编写要点说明 17 3.3.5 业务控制组件开发要点说明 18 3.3.6 数据访问组件开发要点说明 18 3.3.7 数据库映射实体类开发要点说明 18 4 开发规范 18 4.1 表现层开发规范 18 4.1.1 目录与文件命名 18 4.1.2 页面元素命名 19 4.1.3 javascript库管理 19 4.2 中间层开发规范 19 4.2.1 目录与文件命名 19 4.2.2 注释规范 20 4.2.3 异常处理规范 20 4.2.4 日志处理规范 21 4.2.5 事务处理规范 21 4.3 Java编程规范 22 4.3.1 程序结构 22 4.3.2 命名规范 22 4.3.3 注释规范 24 4.3.4 构造方法规范 26 4.3.5 修饰符规范 26 4.3.6 声明规范 27 4.3.7 语句规范 28 4.3.8 空白使用规范 30 4.3.9 缩进规范 32 4.3.10 代码长度 32 4.3.11 其它说明 32 4.4 HTML编程规范 32 4.4.1 编写规范 32 附录一：数据访问层AbstractSupportDao基础方法使用手册 32 附录二：业务控制层StrutsAction基础方法使用手册 34 附录三：业务控制层StrutsEntityAction基础方法使用手册 35 附录四：通用服务端工具类使用手册 36 com.newer.core.util.BeanUtils说明 36 com.newer.core.util.ConvertUtil说明 36 com.newer.core.util.DateUtil说明 36 com.newer.core.util.FileOperate说明 38 com.newer.core.util.GenericsUtils说明 38 com.newer.core.util.GenericsUtils说明 38 com.newer.core.util.NumericUtils说明 39 com.newer.core.util.ObjectToXMLUtil说明 39 com.newer.core.util.PropertyReader说明 39 com.newer.core.util.PropertyUtilsExt说明 40 com.newer.core.util.RequestUtil说明 40 com.newer.core.util.UserSession说明 40 com.newer.core.util.WebUtils说明 40 附录五：通用客户端工具类使用手册 41 Components/dwr/validation.js用法 41 Components/dwr/textsuggest.js用法 42 Components/dwr/utilextend.js用法 42 软件工厂J2EE项目开发指南 概要说明 概要说明 软件工厂J2EE项目开发规范是对J2EE项目开发的规范化说明文档，希望通过本文档能够规范J2EE实训项目的开发过程，降低项目开发的出错率，提高学员项目开发效率。 以下以DEMO及SYSTEM业务模块