GDCCMS项目J2EE开发规范

"J2EE开发规范通用版" 本文档详细介绍了J2EE开发的一系列规范，旨在提高软件开发质量，降低开发周期，并确保代码的可重用性和易读性，便于维护和团队间的交流协作。该规范适用于GDCCMS项目的所有相关人员。 ### 第一章 概述 1.1 目的 制定本规范是为了规范GDCCMS项目的开发流程，提高开发效率和软件质量，同时也便于团队成员之间的协同工作。 2.1 面向范围 此规范适用于参与GDCCMS项目开发、实施的所有人员。 3.1 准备开发环境 开发环境包括Eclipse作为集成开发环境，使用SVN进行源代码控制，数据库选择Oracle 10G，文档编辑工具为Word和Visio，测试跟踪工具为Jira，技术栈包含EXT、Spring、Ibatis，应用服务器和操作系统不限于Windows和Linux。 ### 第二章 Java常用约束 1.1 核心原则 遵循软件工程化原则，使用面向对象的设计，保持代码简洁，避免复杂性，并强调团队合作。 2.1 Java命名约定 - 类名、接口名和非初始单词首字母大写，如`UserManagerCommand`。 - 使用完整英文描述符，采用领域相关的术语。 - 尽量避免使用缩写，若使用，需一致且有意义。 - 类文件命名不超过32个字符，避免名字相似或仅通过大小写区分。 ### 第三章 JSP规范 1.1 JSP文件名命名规则 定义了JSP文件的命名规则，以确保文件名的清晰性和一致性。 2.1 JSP头格式 规定了JSP文件头部的标准格式，以促进代码的规范化。 3.1 其他规范 包括但不限于HTML元素的排列，JSP指令的使用，以及脚本元素的组织。 ### 第四章 数据库规范 1.1 命名规则 定义了数据库表、字段等的命名标准，包括基本规则和常用名称。 2.1 数据类型 规定了数据类型的选用规则，包括基本规则和常见类型。 3.1 SQL语句 明确了SQL语句的编写规范，以提高代码的可读性和可维护性。 4.1 保存全量脚本 强调了保存完整数据库脚本的重要性，以便于版本控制和回溯。 ### 第五章 版本控制规范 详细阐述了使用版本控制系统（如SVN）进行代码管理的方法和最佳实践。 ### 第六章 单元测试 1.1 基本原则 单元测试的基本要求，如测试覆盖率、独立性等。 2.1 测试方法 提供了编写和执行单元测试的指导，以确保代码质量。 以上规范覆盖了从开发环境的配置到代码编写、数据库设计、版本控制以及测试的各个层面，旨在为GDCCMS项目的成功实施提供全面的指导。遵循这些规范，可以显著提升开发效率和软件质量。