PLSQL(Oracle)编程规范

PL/PL/PL/PL/SQLSQLSQLSQL编程编程编程编程规范规范规范规范1目的...........................................................................................................................................22应用范围...................................................................................................................................23PL/SQL变量规范......................................................................................................................24书写规范...................................................................................................................................34.1大小写风格...................................................................................................................34.2缩进风格.......................................................................................................................34.3空格及换行...................................................................................................................64.4创建过程/函数/包.......................................................................................................85注释规范...................................................................................................................................96常用语法.................................................................................................................................126.1变量声明.....................................................................................................................126.2返回值.........................................................................................................................126.3符号.............................................................................................................................136.4包的使用.....................................................................................................................136.5绑定变量.....................................................................................................................136.6异常处理.....................................................................................................................146.7事务控制.....................................................................................................................156.8游标使用.....................................................................................................................157注意事项.................................................................................................................................177.1避免通过DUAL表赋值。...........................................................................................177.2函数，存储过程，包必须有异常处理.....................................................................177.3事务结束必须COMMIT或ROLLBACK..........................................................................187.4禁止随意使用COMMIT和ROLLBACK..........................................................................187.5修改程序需加修改记录.............................................................................................197.6尽可能使用%TYPE.......................................................................................................207.7删除不使用的变量.....................................................................................................207.8避免写超长的PL/SQL代码.......................................................................................201111目的目的目的目的使用统一的OraclePL/SQL编程规范，使Oracle数据库库编程风格标准化，以便于阅读、理解和继承及项目组成员相互交流。本规范的制定主要出于以下几方面的考虑：
效率
可读性
可维护性
规范性规范中未做声明的内容，以满足开发总则为准。2222应用范围应用范围应用范围应用范围本规范适用于公司范围内所有以ORACLE作为后台数据库的应用系统和项目开发工作。3333PL/SQLPL/SQLPL/SQLPL/SQL变量规范变量规范变量规范变量规范使用以下前缀对于避免与关键字和表名列名相冲突：i_输入参数名o_输出参数名io_输入输出参数名v_变量名con_常量名cur_游标名rc_RefCursor名type_名称（用户定义的类型）4444书写规范书写规范书写规范书写规范开发人员要使用统一的开发人员要使用统一的开发人员要使用统一的开发人员要使用统一的beautifierbeautifierbeautifierbeautifier格式规范格式规范格式规范格式规范！！！！4.14.14.14.1大小写风格大小写风格大小写风格大小写风格开发人员要使用统一的开发人员要使用统一的开发人员要使用统一的开发人员要使用统一的beautifierbeautifierbeautifierbeautifier格式规范格式规范格式规范格式规范：：：：OracleOracleOracleOracle保留字大寫保留字大寫保留字大寫保留字大寫,,,,其餘小寫其餘小寫其餘小寫其餘小寫！！！！ORACLE的关键字和保留字请参见视图V$RESERVED_WORDS。4.24.24.24.2缩进风格缩进风格缩进风格缩进风格规则规则规则规则：：：：脚本代码块采用缩进风格书写脚本代码块采用缩进风格书写脚本代码块采用缩进风格书写脚本代码块采用缩进风格书写，，，，保证代码清晰易读保证代码清晰易读保证代码清晰易读保证代码清晰易读，，，，风格一致风格一致风格一致风格一致。。。。缩进格数统一为缩进格数统一为缩进格数统一为缩进格数统一为2个空格个空格个空格个空格，，，，但需要关键字右对齐或者参数但需要关键字右对齐或者参数但需要关键字右对齐或者参数但需要关键字右对齐或者参数/字段向上对齐的时候例外字段向上对齐的时候例外字段向上对齐的时候例外字段向上对齐的时候例外。。。。示例1：IFc_CursorName%ISOPENTHENCLOSEc_CursorName;ENDIF;规则规则规则规则：：：：缩进必须使用空格键缩进必须使用空格键缩进必须使用空格键缩进必须使用空格键，，，，不允许使用不允许使用不允许使用不允许使用TAB键键键键。。。。规则规则规则规则：：：：同一条语句占用多于一行时同一条语句占用多于一行时同一条语句占用多于一行时同一条语句占用多于一行时，，，，每行的第一个关键字应当右对齐每行的第一个关键字应当右对齐每行的第一个关键字应当右对齐每行的第一个关键字应当右对齐，，，，但但但但INSERT...SELECT语句例外语句例外语句例外语句例外。。。。示例1：FETCHc_CursorINTOv_Field1,v_Field2,...↑关键字右对齐规则规则规则规则：：：：在在在在INSERT...SELECT语句中语句中语句中语句中，，，，如果需要换行时如果需要换行时如果需要换行时如果需要换行时，，，，应使应使应使应使INSERTINTO部分的字段与部分的字段与部分的字段与部分的字段与SELECT部分的字段一一对应部分的字段一一对应部分的字段一一对应部分的字段一一对应，，，，以增强可读性以增强可读性以增强可读性以增强可读性。。。。示例：错误的写法：BEGININSERTINTOT_DEST_TABLENAME(DESTFIELDNAME1,DESTFIELDNAME2,DESTFIELDNAME3,DESTFIELDNAME4,DESTFIELDNAME5,DESTFIELD