数据中心产品开发规范
XXXX公司 XX业务部 XXXX年XX月
开发规范（JAVA部分）
文档说明
本文档所涉及到的文字、图表等，仅限于内部使用，未经双方书面许可，请勿扩散到第三方。 文档属性
属性 客户名称： 项目名称： 文档主题： 文档编号： 文档版本： 版本日期： 文档状态： 作者： 文档变更
版本 修订日期 修订人 描述 内容 文档送呈 单位
姓名 目的 审阅 参阅 本文档仅限内部使用，未经双方许可，请勿扩散到第三方。
第 1 页 共 40 页
开发规范（JAVA部分）
目 录
1
概述.......................................................................................................................................... 5 1.1 2
最根本原则 .............................................................................................................. 5
Java技术规范 ........................................................................................................................ 6 2.1
平台使用的相关技术 .............................................................................................. 6 2.1.1 2.1.2 2.2
基本核心框架包 .............................................................................................. 6 其他框架包 ...................................................................................................... 6
程序设计标准 .......................................................................................................... 7 2.2.1 2.2.2 2.2.3 2.2.4
命名约定 .......................................................................................................... 8 包名，类名，方法名，属性名，常量名命名约定 ...................................... 9 注释约定 ........................................................................................................ 10 快速浏览JavaDoc ......................................................................................... 11
2.3 开发规范 ................................................................................................................ 12 2.3.1 2.3.2 2.3.3 2.3.4 2.3.5
项目结构说明 ................................................................................................ 12 整体包结构说 ................................................................................................ 12 项目模块包结构及命名 ................................................................................ 13 各子项目模块功能包结构 ............................................................................ 14 配置文件包结构 ............................................................................................ 14
2.4 命名规则 ................................................................................................................ 15 2.4.1 2.4.2 2.4.3 2.4.4 2.4.5 2.4.6 2.4.7 2.4.8 2.4.9
共用类 ............................................................................................................ 15 业务层 ............................................................................................................ 15 展现层 ............................................................................................................ 15 模型层 ............................................................................................................ 16 持久层 ............................................................................................................ 16 XML配置 ...................................................................................................... 16 资源文件 ........................................................................................................ 19 JSP文件 ........................................................................................................ 20 事务命名约束 ................................................................................................ 20
本文档仅限内部使用，未经双方许可，请勿扩散到第三方。
第 2 页 共 40 页
开发规范（JAVA部分）
2.4.10
3
JS命名约束 .......................................................................................... 21
数据库技术规范 .................................................................................................................... 22 3.1 3.2 3.3
概述 ........................................................................................................................ 22 命名基本规则 ........................................................................................................ 22 数据库表空间 ........................................................................................................ 22 3.3.1 3.4 3.5 3.6 3.7 3.8 3.9 3.10
命名基本规则 ................................................................................................ 22
默认用户方案 ........................................................................................................ 22 表的命名规则、约定 ............................................................................................ 22 视图的命名规则、约定 ........................................................................................ 23 字段命名规则、约定 ............................................................................................ 23 存储过程的命名规则、约定 ................................................................................ 23 序列对象的命名规则、约定 ................................................................................ 24 触发器命名规则、约定 ........................................................................................ 24
4 5
HIVE技术规范 ..................................................................................................................... 25 HBase设计规范 .................................................................................................................... 26 5.1 5.2
Namespace命名空间设计 .................................................................................... 26 1.2. Table表设计 ................................................................................................... 27 5.2.1 5.2.2 5.2.3 5.2.4 5.2.5 5.2.6 5.2.7 5.2.8 5.2.9 5.2.10 5.2.11 5.3
理想HBase表 ............................................................................................... 27 预创建分区 .................................................................................................... 28 列族数量 ........................................................................................................ 28 可配置的数据块大小 .................................................................................... 29 数据块缓存 .................................................................................................... 29 激进缓存 ........................................................................................................ 29 布隆过滤器（Bloom filters） ....................................................................... 30 生存时间（TTL） ........................................................................................ 31 数据压缩 ........................................................................................................ 32 数据分割 ........................................................................................................ 33 单元时间版本 ................................................................................................ 34
ColumnFamily列族设计 ....................................................................................... 35
本文档仅限内部使用，未经双方许可，请勿扩散到第三方。
第 3 页 共 40 页
开发规范（JAVA部分）
5.4 5.5 5.6
Qualifier列设计 .................................................................................................... 36 版本设计 ................................................................................................................ 37 HBase命名规范 .................................................................................................... 37
本文档仅限内部使用，未经双方许可，请勿扩散到第三方。
第 4 页 共 40 页