存储过程开发规范与技巧.pdf

存储过程开发规范与技巧 开发规范 1.书写规范 1）：程序头书写规范 程序头开始部分应说明程序整体的功能，存储过程名称，编写人，编写日期，修改人，修 改日期，版本号以及过程涉及的表和视图。示例如下： /* 名称及实现功能: 版本: ( 版本号标示：新建 V1.0.0 小的修改变为V1.0.1 大的修改V1.1.0 重构V2.0.0) Create by *** Create Date 2006-06-29 Update by *** update Date 2006-06-30 修改原因: Update by *** update Date 2006-06-31 修改原因: 涉及的表或视图： dump_init 辅助表(DM)：记录存储过程中使用的物化视图日志序号 mlog$_acrcusmrsecindex 源表(ODS)：客户第一索引物化视图日志,使用同义词 ft_gld_customerdata 目标表(DM)：客户事实表 */ CREATE OR REPLACE PROCEDURE ******* 2 ）：代码书写规范 1. 语句中出现的所有表名、字段名全部小写，系统保留字、内置函数名、Sql 保留 字大写。 2. 连接符or、in、and、以及＝、=、=等前后加上一个空格。 3. where 子句书写时，每个条件占一行，语句令起一行时，以保留字或者连接符开 始，连接符右对齐。 4. 查询的WHERE 过滤，原则应使过滤记录数最多的条件放在最前面。 5. 多表连接时，使用表的别名来引用列。 6. 查找数据库表或视图时，只能取出确实需要的那些字段，不要使用*来代替所有 列名。 7. 功能相似的过程和函数，尽量写到同一个包中，加强管理。 示例如下： BEGIN --查询员工及对应的部门名称 SELECT emp.name, dept.name FROM l_dept dept, l_employee emp WHERE emp.dept_id = dept.dept_id; END; 3 ）注释书写规范 为了提高可读性，应该使用一定数量的注释。注释大约占总行数的1/5。 1：注释风格：注释单独成行、放在语句前面。 2 ：应对不易理解的分支条件表达式加注释； 3 ：对重要的计算应说明其功能； 4 ：过长的函数实现，应将其语句按实现的功能分段加以概括性说明； 5：每条SQL 语句均应有注释说明 6：对于程序的整体功能，应在程序开始部分说明，可采用单行/ 多行注释。（-- 或 /* */ 方 式） 2.命名规范 命名对象 规则 样例 1 业务相关以模块代码开头 gld_assist_check_p 2 如果区分全量和增量，在最后加标识 gld_load_to_etl 存储过程、包、方法 gld_load_to_etl_full 3 全局使用，以global 开头 global_procedure_check 变量 以 v 开头 v_updatemode1 游标 以 c 开头 c_tablist 内存表 以 m 开头 m_table1 临时表 以 t 开头