目录结构及命名规则介绍

1. 命名规则

1.1 开发目录

  • 项目目录命名规则: "组织名"."应用名"."模块名" 或 "组织名"."公共包名"."子模块"

例如: 目录结构名为"org.vsg.comm.web"
组织名(group id) : org.vsg
公共包名 : comm
子模块名 : web

一般建立项目目录,尽量使用 MAVEN 构建, 主要是包括"jar 和 war " 类型 除了需要建项目管理的方档项目
  • war类型项目
在子模块名级别加后缀"webapps" , 以示区分该目录是 "war工程"
  • build-project类型项目
该类型项目是非程序代码的文件进行管理存放,以便在构建版本时提供足够的资料 ,如导入的 sql , docs 等文档,都可以放置此目录。

1.2 包命名

  • 包命名规则: "组织名"."应用名"."模块名"."...." 或 "组织名"."公共包名"."子模块"."...."。项目与包的命名一致性,有利于开发人员快速查找包的代码应用,也方便将来的组件整合和拆分工作。

例如: 包名为"org.vsg.comm.orm"
组织名(group id) : org.vsg
公共包名(appid) : comm
子模块名 : orm
若下级还有子包,应在下级建立。

建议 : 特定包命名约定含议
domain (model) —— 系统的业务域
persistence —— 持久层
service —— 业务层
web —— web表现层

web目录结构

如图:
web目录结构图

目录结构如下

ROOT
|
|----- js 存放系统公共级的Javascript
|
|----- resources 存放图片,CSS 公共级
|----- css extjs 默认 css
|----- custom-css 自定义应用级的 css
|----- icons extjs 额外使用的目录
|----- icons.css 使用的icons.css
|----- themes 使用主题图片
|
|----- platform 存放应用平台界面及web操作
|----- default 默认登录平台界面
|----- config 存放环境配置操作
|----- apps_* 存放企业级应用止录
| ... 其他应用存放目录(若有可增加)

目录下的几个view
json.jsp —— 支持json 和 jsonp的数据读取
jsonobj.jsp —— 支持直接对像访问
result.jsp —— 文本型的数据访问,支持 ajax 方式
xml.jsp —— xml格式的数据访问 ,支持 ajax 方式




Last edited Feb 9, 2012 at 3:41 AM by vison_ruan, version 11

Comments

No comments yet.