存储过程编写规范V1.doc

《存储过程编写规范V1.doc》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、版本：X.X修改日期：XXXX-XX-XX存储过程编写规范XX有限公司14文档控制文档名称文档代码文档描述版本信息版本号修订日修订者审核者描述V0.12014-10-01V1.02014-12-16备注：1、文档代码是标识文档类型的分类代码，主要用于文档的分类，查询和归档。其编码规则请参阅相关文档。2、文档描述主要用于文档的快速的分类和查询，使用关键字的方式体现文档的主要内容，需要体现主要功能，系统所属的业务部门，使用部门等关键信息。3、版本信息中项目过程文档1.0版本以前不需要每次审核发布，可以统一批次审批发布。4、版本信息中项目文档1.0版本正式发布后，每个版本发布需

2、要审核者签字确认。14目录1.概述41.1目的41.2适用范围41.3术语解释42.存储过程使用原则53.开发规范63.1存储体结构63.2书写规范63.2.1程序头书写规范63.2.2代码书写规范73.2.3注释书写规范83.3命名规范93.3.1存储过程名称93.3.2存储过程的输入输出参数93.3.3程序主体的注释93.3.4变量的命名93.3.1数据字段103.3.2空格及换行103.3.3返回值113.3.4包的使用113.3.5事务控制113.3.6执行成功113.3.7异常处理123.3.8排序操作123.3.9操作日志133.3.10错误处理133.4其它

3、规范143.4.1游标143.4.2其它14141.概述1.1目的本规范用于指导项目编写Oracle数据库存储过程（StoredProcedure）代码，以保证需求按时、安质实现。1.2适用范围本过程定义文档适用于上海通用汽车有限公司所有软件开发项目编码集成活动。1.3术语解释141.存储过程使用原则应用系统的业务逻辑实现，必须严格按照系统架构师的设计方案进行。应用系统的设计、开发必须保持公司应用系统架构的一致性、系统的可移植性、系统的可维护性、系统版本的可控制性。原则上，自开发系统不建议使用存储过程。如果有特殊情况需要使用存储过程，需要在架构师团队中立案说明，得到讨论认

4、可后，方可进行存储过程的设计开发。并且使用存储过程，须符合以下场景。l业务逻辑的处理涉及到多个数据表及大量数据记录，并且逻辑处理结果仅是一个比较小的结果集（一个结果、几条数据记录）。l业务逻辑处理在系统逻辑层实现比较困难，而采用SQL语句实现其功能时，需要大量SQL语句，并且涉及到多个数据表的数据更新的一致性问题，则可使用存储过程来实现。l应用系统的功能实现对系统性能有较大影响，并且经过证明，在存储过程中实现业务逻辑比在应用系统的业务逻辑层实现性能得到较大的提升。l应用系统的使用场景对网络带宽、流量有明显的限制。141.开发规范1.1存储体结构--------------

5、------------------------------------------------------------CREATEORREPLACEPROCEDUREexample（parameters）--过程声明区IS--------------------------------------------------------------------------/*描述存储过程名称，编写人，编写日期，修改人，修改日期，版本号等信息*/------------------------------------------------------------------

6、--------/*声明部分*/--------------------------------------------------------------------------BEGIN/*代码部分*/EXCEPTION/*异常处理部分*/END;--------------------------------------------------------------------------1.2书写规范1.2.1程序头书写规范程序头开始部分应说明程序整体的功能，存储过程名称，编写人，编写日期，修改人，修改日期，版本号以及过程涉及的表和视图。示例如下：-------

7、----------------------------------------------------------------------/*存储过程名称：存储过程功能说明:版本号:(版本号标示：新建V1.0.0小的修改变为V1.0.1大的修改V1.1.0重构V2.0.0)创建日期：YYYY-MM-DD创建人员：***修改日期：YYYY-MM-DD修改人员：***修改原因：修改内容：修改日期：YYYY-MM-DD修改人员：***14修改原因：修改内容：涉及的表或视图：表或视图名称用途XXXX1YYYY1XXXX2YYYY2存