当前位置：文档之家 › PLSQL编码开发规范

PLSQL编码开发规范

  • 格式：doc
  • 大小：70.29 KB
  • 文档页数：9

PLSQL开发规范 Andrew.zhao 日期 作者 版本 变更说明

2013-6-7 Andrew.zhao V1.0 原始版

1. PL/SQL编码规范 1.1. 使用工具 Toad 或PL/SQL Developer 1.2. 使用基表(视图)别名 在SQL语句中为表或视图指定别名。其命名规格以简短为原则，一般为基表或视图名称每一节单词的第一个字母，如mtl_system_items的别名一般指定为msi。

1.3. 例外处理 尽可能多的使用EXCEPTION捕捉各种例外，并返回用户可读懂的信息，如无法确定是否有其它例外，可在每个PL/SQL程序块的例外中加上WHEN OTHERS语句。

例外信息统一风格， 定义统一的例外处理Package 统一返回在哪个Package、Procedure中发生的例外 对日志中的一些调试信息，通过参数设定是否需要输出 语法如下： EXCEPTION WHEN OTHERS THEN FND_FILE.PUT_LINE(FND_FILE.OUTPUT, SQLCODE); FND_FILE.PUT_LINE(FND_FILE.OUTPUT, SQLERRM); END; 1.4. 注释 PL/SQL有两种表示注释的方法，分别为’- -’和’/*… */’,对于多行或整段的注释一般采用后者，对于单行或行尾的注释一般采用前者。以下从几个主要地方注释做个规定，力求统一。

注释风格：注释单独成行、放在语句前面。 应对不易理解的分支条件表达式加注释； 对重要的计算应说明其功能； 过长的函数实现，应将其语句按实现的功能分段加以概括性说明； 常量及变量注释时，应注释被保存值的含义(必须)，合法取值的范围； 可采用单行/多行注释。（-- 或 /* */ 方式） 。  包、过程、函数注释(代码头信息注释规范) /*=============================================================== * Copyright (C) CNC All rights reserved * =============================================================== * Program Name: [Package Name] * Author : $OSUSER * Date : $DATE $TIME * Purpose : [Purpose] * Parameters : * In X --参数X 的简要说明 * Out Y --参数Y 的简要说明 * Called : * Called By : * Description : * * Update History * Version Date Name Description * -------- ---------- --------------- -------------------- * V1.0 $DATE $OSUSER Creation * ===============================================================*/

如增加包中的过程或函数，需在包的注释中的Update History中增加相应的信息。如仅是修改过程或函数，则在过程或函数的注释中的Update History中增加相应的信息。

 注释的基本原则 过程中定义的变量需要注释其含义，过程或函数中关键性语句也要注释其作用，对于较复杂的程序，则对该段程序的流程进行描述，在程序中的关键位置应加入相应的注释，对于非首次作者修改原有的程序，要对所做的修改部分加以标示，并作相应的注释。

注释的格式无特殊要求，一般单行以’- -’注释，多行以/*… */注释。  增加程序 select count(*) from < table_list > where < where_clause1 > and < where_clause2 > --added by xxx 2006-05-28 and < where_clause4 > --end added by xxx 2006-05-28 and < where_clause3 >

蓝色部分为新增加的程序  修改/删除程序 select count(*) from < table_list > where < where_clause1 > and < where_clause2 > --changed by xxx 2006-05-28 --and < where_clause4 > and < where_clause5 > --end changed by xxx 2006-05-28 and < where_clause3 > 蓝色部分为修改的程序，修改为 1.5. 代码语法规范 语法规范主要包括变量规范、包规范、游标规范、事务处理规范等等 1.5.1. 变量规范 1) 变量名全部采用小写，局部变量名使用“v_”开头，输入参数以“i_开头，输出参数以“o_”开头，输入输出参数用io_开头。所有输入参数必须显示声明。

2) 游标的命名，游标统一用“c_” 命名。 3) 使用命名的常量以避免硬编码，使用常量包,常量统一用 cn_ 的前缀命名。 4) 当变量代表列时，使用%TYPE属性，当变量实际上表示数据库表的某列数据时，为避免数据库结构修改对变量的影响，应统一使用%TYPE属性对变量命名。

5) 使用%TYPE以标准化非数据库变量的声明 1.5.2. 包规范 包内的存储过程及函数的命名必须遵循简写规范，常用的操作简称如下： 增加 add 修改 upd 删除 del 查询 qry 检查 chk 1.5.3. 游标规范 1) 外部查询的多行数据返回使用游标进行处理，通过传递游标变量的形式返回数据到外部接口,由外部程序自行FETCH数据。

2) 打开游标前，必须显式检查游标的%ISOPEN属性。 3) 使用FETCH语句后，要立即检查%NOTFOUND属性，以便正常终止游标FETCH循环。 4) 无论PL/SQL程序是正常终止还是出错退出，都要关闭所有已打开的游标。在出错退出时，应该在其异常处理部分管理所有游标，这可以释放一部分的系统资源。

5) 尽可能使用显示游标，避免使用隐式游标。 1.5.4. 数据封装和访问规范 1) 按照业务逻辑实现功能模块的封装，将业务规则逻辑集中在更少量的、良好设计的、易于维护的函数或者过程中，不必在每条SQL语句或者每块PL/SQL程序中重复这些逻辑。

2) 后台数据按照逻辑划分成多个SCHEMA，不同SCHEMA的数据不可互相访问。 3) 需要相互访问的表均存放在INTERFACE的SCHEMA中，通过访问INTERFACE中的接口表实现跨SCHEMA的数据访问。 1.5.5. 日志书写规范 1) 采用公共的API包完成后台日志数据记录。（API完成输出错误信息提示、记录错误信息内容到数据库表、系统级的错误代码及错误信息等）

2) 后台日志的信息记录级别包括DEBUG、INFO、WARN、ERROR、FATAL，其定义以及不同级别日志的采集标准如下：

DEBUG－调试信息，供开发人员调试使用，由开发人员自行确定。 INFO－提示信息，记录重要的系统事件或者业务事件，如开始结算等。 WARN－警告信息，可能导致严重错误的警告信息 ERROR－错误信息，导致系统运行错误的信息。 FATAL－致命信息，导致系统无法继续运行的致命错误信息。 3) 所有表操作的错误处理部分均应记录日志信息。 1.5.6. 错误处理规范 1) 后台中所有出现错误或者异常的地方，都必须调用公共的日志模块记录日志信息。 2) 凡是涉及到表操作(insert,update,select,delete)的sql语句,都必须进行错误捕捉,不能将错误带到后面的语句。

3) 从表中select数据的语句,应严格区分NO_DATA_FOUND 和 TOO_MANY_ROWS的错误,并将相应错误信息填入错误信息。

NO_DATA_FOUND 多数为查询条件问题导致无数据返回（用户级错误）。 TOO_MANY_ROWS 应该是数据表内数据异常导致（系统级错误）。 4) 所有存储过程(函数)的统一出口一律在存储过程的结束部分,不允许中间返回。 5) 在每一个异常处理部分，都要定义WHEN OTHER 子程序，以便捕获所有没有显示处理或其它类型的异常。

6) 所有程序中捕获到的错误,均转换成对应的errcode,errmsg,通过输出参数返回给调用者。

7) 在每个存储过程(函数)的入口处统一先将返回错误代码(errCode)设置为-999,功能处理成功结束后再将错误代码(errCode)设置为0(成功),避免程序过程中因错误未能正确捕获,导致功能未能完成,而程序却成功返回的情况出现。

8) 所有的模块都有错误编码区间,原则上错误编码全局唯一。 9) 错误信息描述应准确，业务相关的错误应将输入数据拼接到错误信息中。如会员密码错误等等。

10) 错误代码根据存储过程（函数）的功能号来确定，具体规则为： 错误代码＝功能号后7位＋XX，（XX 为 00 －99）。 即分配给每个功能点的错误代码为100个，由开发者自己划分错误代码，自行描述错误信息，不做具体规定。

合集下载

26、PLSQL格式化指南

26、PLSQL格式化指南


命名规范 3-1
• 为防止命名与保留字和列/表名冲突，有必要 使用如下前缀:
– v_variable_name （变量名） – con_constant_name （常量名） – i_in_parameter_name，o_out_parameter_name， io_in_out_parameter_name （过程和函数的参数名） – c_cursor_name或者name_cur （游标名） – rc_reference_cursor_name （引用游标名） – r_record_name或者name_rec （记录名） – FOR r_stud IN c_stud LOOP... （游标FOR循环） – FOR stud_rec IN stud_cur LOOP ...
命名规范 3-2
– type_name , name_type(适用于用户定义类型) – t_table, name_tab(适用于PL/SQL表) – rec_record_name, name_rec(适用于记录变量) – e_exception_name(适用于用户定义异常)
– 包的名称应该是该包中过程和函数所执行动作 较大的上下文的名称
其它建议
• 对于嵌套在PL/SQL中的SQL语句，应该使用 和PL/SQL相同的格式化指南
• 提供注释头来解释语句块的目的，并列出 语句块的创建日期和创建者。同样，还要 说明每次修改，包括修改者的名字、日期 以及对修改内容的描述
代码范例 3-1
代码范例 3-2
代码范例 3-3
注释
• 在PL/ SQL和SQL中，注释都是非常重要的。 使用注释来描述程序段的主要部分以及关 键的重要逻辑步骤 • 最好使用单行注释(--)，避免使用多行注释 (/*)。尽管PL/ SQL支持这两种注释，但是使 用单行注释有利于代码调试，因为你无法 在多行注释中嵌入多行注释。也就是说， 可以注释掉包含单行注释的代码段，但是 不能注释掉包含多行注释的代码段
SQL编写规范和优化讲稿

SQL编写规范和优化讲稿


PPT文档演模板
SQL编写规范和优化讲稿
SQL编写规范--8
v 连接的使用
对于内连接和外连接的使用，要求该使用外连接的 地方都已经使用了外连接，不需要外连接的地方一 定不使用外连接。 表中的字段若是从其它表引用的，要确保该字段在 被引用的表中存在。
PPT文档演模板
SQL编写规范和优化讲稿
SQL编写规范--8
v 缩进和换行
整个的SQL语句最好按照子句进行分行编写， SELECT/ FROM/ WHERE/ UPDATE/ INSERT 等 每个关键字都要另起一行。如：
PPT文档演模板
SQL编写规范和优化讲稿
SQL编写规范--3
v 缩进和换行
PPT文档演模板
SQL编写规范和优化讲稿
SQL编写规范--3
SQL编写规范和优化讲 稿
PPT文档演模板
2020/11/1
SQL编写规范和优化讲稿
SQL编写规范--1
v 原则定义
1、要求代码行清晰、整齐，具有一定的可观赏性； 2、代码编写要充分考虑执行速度最优的原则； 3、代码行整体层次分明、结构化强； 4、代码中应有必要的注释以增强代码的可读性； 5、规范要求非强制性约束代码开发人员的代码编写 行为，在实际应用中在不违反常规要求的前提下允 许存在可理解的偏差。
PPT文档演模板
SQL编写规范和优化讲稿
SQL优化(teradata)
v SQL脚本优化原则
(3) SPOOL空间尽量小原则，即尽可能使中间过程中的SPOOL空间小一些， 这样可以减小I/O以及继续关联的代价；在此原则下可以引申出下面几个 具体原则：
(3.1) 在几个表大小差不多时，过滤性条件较强的先JOIN； (3.2) 在大/大/小三个表内联时，避免先把两个大表JOIN，除非 过滤条件非常强； (3.3) 在大/小/小三个表内联时，尽量先把两个小表JOIN； (3.4) 有时将看似没必要的过滤条件加上，在关联表较多时可能 有效的减小SPOOL；如表A、B、C、D的关联字段均为k，即A.k=B.k AND A.k=C.k AND A.k=D.k，而同时还有条件substr(A.k,1,2)='01'，有时加 上substr(B.k,1,2)='01'、substr(C.k,1,2)='01'、 substr(D.k,1,2)='01‘ 会有好处；
plsql + 的用法

plsql + 的用法

plsql + 的用法==========PlSql，全称为PL/SQL，是Oracle数据库中一种常用的编程语言。

本篇文章将详细介绍PlSql的用法，包括其基本语法、开发环境设置、常用函数和语句等。

一、基本语法-----PlSql的基本语法包括声明、赋值和执行语句。

以下是一个简单的PlSql程序示例：```sqlDECLAREv_name VARCHAR2(50);v_age NUMBER;BEGINv_name := '张三';v_age := 25;DBMS_OUTPUT.PUT_LINE('姓名: ' || v_name || ', 年龄: ' || v_age);END;```上述代码中，我们声明了两个变量v_name和v_age，并分别赋值为字符串和数字类型。

然后使用DBMS_OUTPUT.PUT_LINE语句输出结果。

在PlSql中，可以使用Oracle提供的输出函数来输出变量的值。

二、开发环境设置要编写和运行PlSql程序，需要安装Oracle数据库客户端，并配置开发环境。

具体步骤如下：1. 安装Oracle数据库客户端，并确保数据库服务已启动。

2. 打开Oracle SQL Developer或其他Oracle数据库管理工具。

3. 创建一个数据库连接，并选择要使用的数据库。

4. 在工具中打开一个新的PlSql编辑器窗口或创建一个新的PlSql文件。

三、常用函数和语句---------PlSql提供了许多内置函数和语句，用于处理数据、执行操作和生成结果。

以下是一些常用的函数和语句：* 数据类型转换函数：TO_CHAR、TO_NUMBER等。

* 字符串操作函数：SUBSTR、LENGTH、REPLACE等。

* 日期操作函数：YEAR、MONTH、DAY等。

* 控制语句：BEGIN...END、LOOP、WHILE、CASE等。

* 异常处理语句：EXCEPTION、RAISE等。

SQL数据库设计，编码开发规范（转）

SQL数据库设计，编码开发规范（转）

SQL数据库设计，编码开发规范（转）SQL Server Database Design, Code and DevelopmentStandards1.更改Change Name Date命名原则：表意性原则（增加）　DavidDong Jan/05数据库命名DavidDong Jan/05表命名DavidDong Jan/05Server/Instance命名DavidDong Jan/05JOB,复制命名DavidDong Jan/052.简介数据库设计是指对于⼀个给定的应⽤环境，构造最优的数据库模式，建⽴数据库及其应⽤系统，有效存储数据，满⾜⽤户信息要求和处理要求数据库设计和开发标准是使Newegg Support Center的数据库系统的设计和开发正式化的标准。

通过此标准，来规范数据库设计。

通过⼀致的系统解决⽅案，能给我们的系统带来以下优点：¨开发出⾼可管理性的⾼质量系统¨能够快速的进⾏开发¨减少维护代码的时间Ø ⾮常容易的把代码从⼀个项⽬拷贝⾄另⼀个项⽬Ø 节省把游标，错误处理信息从⼀个项⽬中拷贝到另⼀个项⽬中的时间Ø 使程序逻辑简单化Ø 不⽤花费时间在常规的事情上，⽐如对象名称转换等，并可允许多次设计，编程和对复杂事件的测试⼯作¨在代码出错时⼤⼤节省时间¨只要在第⼀次是有个良好的设计3．开发环境3.1数据库模型CA公司的ERwin/SQL是数据建模的⼀个⾸选⼯具.在开发经常改变的项⽬时，使⽤ERwin来⽣成表（创建/删除）,索引，规则，数据类型等数据库对象的脚本，在对项⽬⽂件进⾏修改之前，请确认已经对这些脚本进⾏过备份.任何数据库的改变，不管是在开发中还是在产品服务器中，都要⽤ERwinDiagram中进⾏相应的修改.如果产品服务器上做出了更改，则⼀定要对主脚本和ERwin diagram进⾏相应更新.3.2 Diagrams使⽤Visio进⾏数据diagram,流程图，服务器拓朴和其它diagrams进⾏设计.⽂档化系统或者处理流程可以⼤⼤有利于团队间的协作.3.3版本控制推荐使⽤Visual SourceSafe（VSS）对NESE数据库对象进⾏管理.在任何项⽬中，都应该有很好的代码更改控制，初始版本⽂件应该放到VSS中并被注释.所有对这些⽂件的后继更改都应该放到VSS中管理.3.4 源码⽬录结构在项⽬刚开始时，找到⼀个所有Team成员都能够访问的共享.按照以下结构初始化VSS⽬录和数据库⼦⽬录：\CMD 包括全系统脚本的脚本⽂件，如果是⼀个多数据库的系统，应该有⼀个可能创建所有数据库的命令⽂件.\DBName 在系统中的每个数据库应该有⾃⼰的⽬录结构，如下：\CMD：⽤来创建此数据库的脚本⽂件，并且来更改数据库构架.\DAT：⽤来刷新此数据库的数据⽂件.\SP：⽤来存储存储过程的脚本\TBL：除了下⾯⼦⽬录，这个⽬录应该包括表的定义脚本，每个表应该有它⾃⼰的脚本，此脚本应该包括经表的删除，创建语句，索引，触发器，完整性参照，Check约束，默认值约束等，每个表创建语句应该包括在不同的脚本中，并被把归类到类似于下⾯的相应的⼦⽬录中.注意：本⽬录中的脚本和以下⼦⽬录的脚本应该命名为它所影响的表名，⽐如：表名.sql：\Check：为每个表创建独⽴的Check约束定义脚本，Check约束应该使⽤alter table add constraint 来创建，并且每个altertable 语句只能包括⼀个contraint。