oa项目命与编码规范.doc

Java项目命名与编码规范Three-Group 成都朗沃信息技术有限公司 2014-09-16 编写说明 标题：项目命名与代码编写规范 版本历史： 版本 作者 日期 备注 V1.0.0 汪小辉 2014-09-16  编写目的 作为朗沃进行项目开发的技术规范，是进行软件质量控制的必要规范。 命名 业务模块名 在需求建模阶段按照用例划分来对业务模块进行命名，要求简洁易懂。 包的命名 业务包命名 业务包指与项目所要实现的业务逻辑相关的包。 包的命名由前缀和包的逻辑名组成，其中 前缀：com.lovo.+项目名称 逻辑名：业务模块名+层名，如果项目规模不是很大，直接采用层名，例如： project.action或action project.service或service 业务模块“项目管理”完整的包名示例： com.lovo.cmts.action(web.action) com.lovo.cmts.domain（model） com.lovo.cmts.service 基础包命名 基础包指在项目中供多个业务包共用的包,一般放置到下列包中 mon com.lovo.cmts.utils Java命名 Java命名的时候需要同时兼顾业务和技术，命名要能体现软件的层次结构。 接口命名 命名规范：首字母大写，如果有多个单词，每个单词头字母大写 StudentInfo servlet类命名： Servlet单词结尾 LoginServlet Struts Action类命名： 命名规范：Action的命名以名称来制定，名称Action 例如： 一个名称为Diary，其对应的action为DiaryActionAction中所有对service的引用，变量命名必须以*Service结尾，比如：userService。 Struts Form类命名： 命名规范：的命名以名称来制定，名称 例如： 一个名称为Diary，其对应的为Diary 业务逻辑接口命名: 命名规范：业务逻辑接口的命名以名称来制定， I名称Service例如：一个名称为Diary，其对应的业务逻辑接口为IDiaryService 业务逻辑接口命名: 命名规范：业务逻辑接口的命名以名称来制定， 名称Service例如：一个名称为Diary，其对应的业务逻辑接口为DiaryService Jsp页面命名 命名规范：jsp页面名称要以小写字母开头，如果有多个单词组成，后面的单词以大写字母开头。名称要体现出该页面的意义，最好能够与模块名称联系在一起。 列表页面,project_list.jsp 详细信息页面,project_detail.jsp 项目目录结构 总体目录结构 根据eclipse工具的特征，项目的目录结构为： ??? ----存放java文件? |--config???? --存放WebRoot|--images???? --存放web程序所需的公共图片|--css???????? --存放web程序所需的公共样式表|--js??? --存放web程序所需的公共js文件|--commons?? --存放web程序所需的公共文件|--upload 上传的公共文件，其下可以继续建目录存放不同类别文件|--功能模块文件夹(存放与某个功能模块相关的资源)|--images? --存放与该功能模块相关的图片|--css????? --存放与该模块相关的样式表文件|--js??? --存放与该模块相关的js文件|--jsp或html页面|--upload 上传的文件，其下可以继续建目录存放不同类别文件|--WEB-INF |--classes |--lib --项目中的包 |--tld --tld文件 doc |--rq --需求相关文档 |--plan --项目计划相关文档 |--db --数据库相关文档（包括建表sql，数据初始化sql） 配置文件规范 Spring配置文件： 系统中所有的配置文件统一放到config/下。spring文件配置 Spring配置文件放在config/spring/ 基本配置文件(dao的配置也是这里) 以上是公共部分文件，每个人的struts action在spring中的配置文件命名规则为： spring-ction-模块名-姓名拼音缩写.xml spring-action-sale-zs.xml，表示张三所写的销售的action配置。 spring-action-schedule-ls.xml，表示李四所写的计划的action配置。 struts配置文件放在config/struts/ 基本配置文件(全局出错定义、process