PLSQL编码指南Word文档下载推荐.docx

1、修改内容修改人/日期审批人/日期修改后的版本号实施日期目 录目 录 III1. 编写目的 12. 适用范围 13. 规范内容 13.1 编码风格 2一般风格 2DML风格 2控制语句 4参数声明 5记录类型 6注释 63.2 命名规范 7变量 7参数 7公用函数（过程） 8数据库对象【参考】 83.3 设计规范 9私用函数（过程） 9数据处理函数/过程 9打包 9附件1：样本代码 10附件2：PL/SQL配置参数 12 1. 编写目的 提高代码的可读性； 提高编码可靠性； 提高代码的可管理性。2. 适用范围 以Oracle数据库为后台存储过程的软件开发工作； 推荐工具为：PL/SQL deve

2、loper； 推荐原因：可自动应用编码规范，无须手工操作； 本文以PL/SQL develper的自动化工具为要求和演示； 本规范的代码样本见附件1； 可自动应用于PL/SQL developer的配置见附件2。3. 规范内容3.1 编码风格一般风格DML风格DML命令中的元素排列可视需要选择：1. 每行一个元素（本规范默认）2. 每行固定数量元素控制语句参数声明记录类型注释1. 记录“日期YYYYMMDD”、“程序员ID”、“变更申请单位置”、“基线版本”和“注释内容”，不限制顺序。2. 如果没有 “变更申请单位置”则可省略，否则不能省略。3. “注释内容”通常写修改的原因。可省略。例 -

3、20070415 ZT 4.4.0.1 增加字段例 - 20070415 ZT DEBUG例 - 20061220 GJ V4.2.0 UPL-BASE表日期字段类型变化：DATE-NUMBER（8）4. 解释性注释：-在要解释的语句后跟注释内容即可3.2 命名规范变量1. 用前缀识别变量类型（不区分大小写）类型前缀NUMBERN_VARCHAR2VC_自定义类型TYPE_例 n_count number（1） default 0;2. 和某字段关系密切的变量在定义时和该字段保持一致例 vc_rdmscp MDP_ADJ_README.RDMSCP%TYPE参数1. 输入参数前缀为：i_例 i

4、_vc_group in varchar22. 输出参数前缀为：o_例 o_vc_result out varchar23. 前缀往后请遵守“变量”规范公用函数（过程）1. 从函数（过程）名字面上能识别函数的功能。数据库对象【参考】1. 数据表采用12位长度字符命名：（以下为数据服务设计举例）字符位代表分类含义代码1数据服务系统标识数据服务系统D2数据所属系统标识ODS操作性数据存储系统（快报系统）ODW数据仓库系统W3数据所属层次接口层（Interface）I数据登台区（Staging）S基础数据区（Base Data）B应用产品层（Product）P4间隔符_5客货标识客运货运C客货合并A

5、68模块代码订座BOK运输UPL对内开账IWB空白票ADC调整ADJ912事实表内容代码根据事实表记录的实际内容，使用缩写代码描述UPLI说明：1） 如出现某个事实表不能确定属于某个分类，则由项目组统一调整。2） 9-12位字符对应代码为举例代码，具体表名根据实际情况设定。例 DWB_PUPLUPLI（数据仓库区的国际客运运输基本数据表）2. SEQUENCE命名：加SEQ_前缀例 SEQ_SYS_RUNID暂无3.3 设计规范私用函数（过程）1. 私用函数（过程）指的是仅供特定模块使用的，没有目标表的函数（过程）2. 尽量避免定义私用函数3. 规范同公用函数（过程）数据处理函数/过程1. 目

6、标表有且仅有一个，源表可以有零个或多个。2. 中间表可以有多个，但如果中间表和主要源表之间数据粒度发生了变化，建议把一个函数（过程）拆分为两个函数（过程），中间表作为第一个函数（过程）的目标表，作为第二个函数（过程）的主要源表。3. 从函数（过程）名中可识别一个主要源表和一个目标表，不必识别中间表。如果没有源表，则只须识别目标表。打包1. 用位字符表示1-2识别程序包PK分隔符分类符数据仓库-SMARTRIX5-7模块名称举例：UPL,SLT,NOD例 PK_DSLT样本代码PL/SQL配置参数将以下内容复制与文本文件，后缀为“br”，即可使用Version=1RightMargin=88In

7、dent=3UseTabCharacter=FALSETabCharacterSize=3AlignDeclarationGroups=TRUEAlignAssignmentGroups=TRUEKeywordCase=1IdentifierCase=2UseSpecialCase=FALSEItemList.Format=0ItemList.Align=TRUEItemList.CommaAfter=TRUEItemList.AtLeftMargin=FALSEEmptyLines=1ThenOnNewLine=TRUELoopOnNewLine=TRUEDML.LeftAlignKeywo

8、rds=TRUEDML.LeftAlignItems=TRUEDML.OnOneLineIfPossible=TRUEDML.WhereSplitAndOr=TRUEDML.WhereAndOrAfterExpression=FALSEDML.WhereAndOrUnderWhere=FALSEDML.InsertItemList.Format=2DML.InsertItemList.Align=FALSEDML.InsertItemList.CommaAfter=FALSEDML.InsertItemList.AtLeftMargin=FALSEDML.SelectItemList.Form

9、at=2DML.SelectItemList.Align=TRUEDML.SelectItemList.CommaAfter=FALSEDML.SelectItemList.AtLeftMargin=FALSEDML.UpdateItemList.Format=2DML.UpdateItemList.Align=TRUEDML.UpdateItemList.CommaAfter=FALSEDML.UpdateItemList.AtLeftMargin=FALSEParameterDeclarationList.Format=2ParameterDeclarationList.Align=TRUEParameterDeclarationList.CommaAfter=TRUEParameterDeclarationList.AtLeftMargin=FALSERecordFieldList.Format=1RecordFieldList.Align=TRUERecordFieldList.CommaAfter=FALSERecordFieldList.AtLeftMargin=FALSESplitAndOr=TRUEAndOrAfterExpression=FALSESpecialCase