数据库开发规范 v-1.0.docxVIP

数据库开发规范 1.前言 良好的系统运行性能取决于硬件、网络、应用、数据库设计、SQL等多个方面，本文着重于探讨在SQL开发上怎样做取得尽可能好的性能(其它诸方面也对性能有决定性作用，因本文目标人员为SQL开发人员，所以着重于SQL)；通过规范SQL编写从而达到 增强程序可读性、降低程序BUG概率、实现程序一致性、增强程序可维护性、提升程序性能的目标 2.命名及编码规范 大小写规则。 数据库对象名称全部采用小写。单词之间用短下划线“_”分割。 关键字/系统函数名全部采用大写。 2.1.变量/类型的命名规范 变量命名字符集 变量/类型的声明必须以字符（a-z/A-Z）开始，并且名称中只能包含（a-z、A-Z、0-9）。 每个有意义的单词的前一个字母大写，其余的都小写。变量/类型名称中禁止使用短下划线“_”美元号“$”或“#”号，这个主要是为了区分表和字段名称。 2.1.1.变量命名规则 规则：变量一律以小写字母v开始，采用驼峰式的命名规则。比如： vCustomerName、vCustomerID、vCustomerType 2.1.2.自定义类型命名 类型 规则 举例 自定义类型 类型名称Typ CustomerTyp 上面2中自定义类型命名都是合法的，具体使用哪种，在特定的DBMS再做明确的规定。 2.1.3.异常变量命名 规则：用户自定义异常变量命名：以小写的“e”开头。 类型 规则 举例 用户定义异常 e异常名称 eInvalidateCustomer 2.1.4.游标命名 规则：以小写的字符“c”开头。 类型 规则 举例 游标声明 c游标名称 cCustomerList、cOrderInfo 2.2.代码注释 2.2.1.注释内容规范 注释增强了可读性，使得脚本更加易于理解、方便使用和维护。 注释从功能上分为2部分，代码内部注释（维护性注释）和代码外部注释（使用注释/头注释）。 外部注释（使用注释/头注释）包含内容： 内容 说明 功能描述 描述该过程/函数完成的实际业务功能 必须 作者 完成该过程代码设计/编写的人员名称 必须 创建时间 代码完成时间 必须 版本 当前版本 修改说明 对代码做过修改的说明，必须包含修改人、修改时间、修改原因、修改概要说明。 如果有修改，修改人必须添加修改说明 使用例子 对使用方法进行描述 建议 代码内部注释（维护性注释）必须包含内容。 内容 说明 参数 对重要参数进行简要说明 必须 变量 对便利进行简要说明 建议 条件 对判断条件进行必要的说明 必须 代码块 对复杂代码块进行算法/功能描述 必须 2.2.2.注释风格规范 具体注释风格参考具体的DBMS规范部分。 2.3.SQL书写规范 1、SQL关键字（谓词）独占一行。 2、每个列表项各占一行，逗号写在列表项的前面。 3、关键字对齐。不同的操作对齐请参考下面提供的例子。 2.3.1.Select SELECT depno AS department_number ,dname AS departmen_name ,loc AS department_location FROM dept ,emp WHERE emp.empno = p_empno AND dept.deptno = emp.deptno; 说明： 1、每个字段独占一行。逗号写在字段前面。 2、from谓词后如果有多个表，则每个表名占一行，逗号写在表名称前面。 3、where 条件中，如过有多个and / or 条件，则每个条件占一行，并且and/or在行首 4、等号”=”左右保留一个空格。 4、关键字select、from 、where、and 等右对齐（以selecct为基准），对齐基准参考下图红线部分。 2.3.2.Insert --insert into INSERT INTO dept (deptno ,dname ,loc) VALUES (10 ,Accounting ,New York); ---把括号分开 INSERT INTO dept ( deptno ,dname ,loc ) VALUES ( 10 ,Accounting ,New York ); 说明： 1、每个字段占一行，逗号写在字段名前面。 SQL关键字左对齐，字段和值对应关键字缩格统一2个或者4个。 2.3.3.Update -- Update UPDATE dept SET dname = Accounting ,loc = New York WHER