自定义java开发规范.doc

自定义java开发规范 关键字: 自定义java开发规范 2 ?设计规范 2.1 ?系统设计规范 当有需求 变化的时候，开发经理必须遵守一个顺序，第一先修改概要设计、设计设计，数据库设计等接着再修改代码的原则； 对于每一 次修改，都必须编写changelog； 系统的设 计文件需要放到版本控制文件当中，以便对不同的版本进行控制； 2.2 ?数据库设计规范 数据库的 设计必须放到PowerDesinger的Repository当中； 每一个项 目只有系统架构师，开发经理有权限去修改物理数据模型，其他人只有只读取权； 按数据库 脚本的命名规范编写数据库脚本与初始化数据脚本； 数据库的 设计只能由系统架构师，开发经理或由开发经理指定的高级工程师进行修改； 需求变更 需要修改到数据库的时候，必须先修改物理数据模型，再到数据库修改； 任何人没 有经过系统架构师或开发经理的授权，不得私自修改数据库； 对修改内 容需要修改changelog，并编写修改数据库的脚本； 修改数据 库的脚本需要在测试机上做过测试，并提供项目部经理； 3 ?文件命名规范 3.1 ?页面文件命名规范 页面文件 的命名是由小写英文字码，下划线，数字组成；user_list.html；index.jsp；index_cn.jsp；503.jsp等； 页面文件 最好以英文单词组成，以便提高文件的可读性；例如：permission_list.jsp 对于一个 模块的操作页面，以模块名 + 下 划线 + 动词组成，例如：permission_list.jsp 对于有些 模块使用英文单词命名比较麻烦的，在不得已的情况下，可以使用拼音的简写来进行命名，但是，必须在页面文件的最前面加上注释，注释以下所示： %-- ? 用户列表，yflb是用户列表的简写. ? @version $ Date 2005-7-19 $ ? @author gsh XXXXXXXX公司/信息化应用中心/平台产品部 --% 其中 %--的下一行或多行为页面作用描述， @version 后跟日期，以日期作为版 本 @author 公司帐号 XXXXXXX公司/信息化应用中心/所在部门 3.2 ?Java文件命名规范 Java类文件的命名不要超过32个字字符； Java文件的命名规范按照Sun公司的标准进行命名； 取消Java文件以下划线进行分隔的命名方式； 取消命名 当中出现的Map这些命名方式； 3.2.1 ?Action类的命名规范 Action类是以英文单词组成；由模块名 + [其它标试] + Action构成； 同一个模 块的Action类CRUD操作放在同一个Action类当中；比如UserAction；GroupAction； 对于一个 模块的非CRUD操作，由系统架构师或开发经理根据命名规范决定重新定义一个有意 义的Action；比如：UserSearchAction； 不要在类 文件当中加上下划线； 一个Action类文件不要超过500行代码； 3.2.2 ?Service层的命名规范 Service层命名规范将由接口与实现构成； Service层接口的命名由I + 模块名 + Service构成，例如：IUserService.java； Service层实现的命名由?模块名 + ServiceImpl构 成，例如：UserServiceImpl.java DAO层方法的命名：以 操作动词 + ValueObject名 创建前 缀：create，比如：createUser(User user)； 修改前 缀：update，比如：updateUser(User user); 删除前 缀：delete，比如：deleteUser(User user); 列出前 缀：list，比如：listUsers(); 通过UUID查找实体前缀：find + 实体名 + ById，比如：findUserById(String userId); 查询：search，比如：searchUsers(Map searchKey); 统计：count，比如：countUsers(); 3.2.3 ?DAO层的命名规范 DAO层命名规范将由接口与实现构成； DAO层接口的命名由I + 模块名 + DAO构成，例如：IUserDAO； DAO层实现的命名方式需要结构持久层的实现方式，比如，Hibernate的应用的话其命名由：模块名 + DAO + Hibernate构成，例如：UserDAOHibernate；如实持久实现是由JDO方式实现，则命名由：模块名 + DAO + JDO构 成，例如：UserDAOJDO； 所有CRUD在接口当中都必须定义，方法体调用父对象的操作实现； DAO层方法的命名：以