XMTD-数据库开发规范及经验技巧(V1.0).docxVIP

XMTD-数据库开发规范及经验技巧（版本号 V1.00）朗新科技（中国）有限公司二〇一二年三月更改履历版本号修改编号更改时间更改的图表和章节号更改简要描述更改人批准人V1.002012-4-6初稿吴志伟注：更改人除形成初稿，以后每次修改在未批准确认前均需采用修订的方式进行修改。概述本文描述了厦门开发中心在数据库程序开发的开发规范及经验技巧。为了使代码可读性好，可维护性高，使不同的开发人员维护相同的代码，保持代码的一致性，所有的代码和文档应遵循下面的规则和约定。有些项是强制的，而其他项是可选的。希望所有开发成员都能遵循这些标准，特别是新的代码或需要大幅修改的代码。本文并非最终文档，随着技术的发展应随时进行更新。编写目的规范数据库程序的开发者和维护人员，共同遵循这些标准。约定此文档适用于公司各产品系统原型开发及测试环境。使用范围厦门开发中心数据库开发员、工程实施人员、系统维护人员参考文献PM-数据库开发规范PM-SQL开发数据库开发规范数据库程序开发规范数据库程序开发在本文档中主要指存贮包、过程、函数、触发器和自定义类等数据库对象的设计开发。开发工具数据库开发工具使用比较通用的PL/SQL DEVELOPER，版本7.0以上，此工具便于应用统一的美化器对程序代码实现统一的格式化；便于使用数据库程序模版创建统一格式的数据程序对象。1)安装PL/SQL DEVELOPER。从“VSS/06.质量/开发规范”目录下载plsql_model.rar后并解压到D区（或者其它区），安装完成。2)安装模版如果按照第一步进行绿色安装，此步忽略。其它安装方式则按第一步下载plsql_model.rar后并解压其中的Template目录并覆盖当前目录。3)安装美化器如果按照第一步进行绿色安装，此步忽略。否则按第一步下载plsql_model.rar后并解压其中主目录中的SGPM.BR文件到PL/SQL DEVELOPER安装主目录下。4)应用美化器程序对象及参数、变量、常量、游标、自定义类等命名规范参考《数据库对象命名规范》注释编写规范每个数据库程序对象（包、包内过程及函数、触发器、自定义类等）、变量及常量必须使用注释，数据库程序中的说明性注释必须与模板中的注释格式一致。程序对象注释形式一律在对象紧贴上方使用：/**/除存贮包外的对象注释格式如下：/********************************中文名： 对象名称（功能简述）作者：XXX时间：2012-01-01 09:00:00说明： 功能详细说明修改记录： （修改时间 修改人 修改原因及内容）输入参数：in_para1参数说明 (格式或取值范围说明)输出参数：out_code 返回代码out_msg 返回信息************************************/存贮包的对象注释格式如下：/********************************中文名： 对象名称（功能简述）作者： XXX时间： 2012-01-01 09:00:00说明： 功能详细说明修改记录： （修改时间 修改人 修改原因及修改过程或函数名）************************************/变量及常量可在上方使用：/**/，或后方使用：--过程中分支需注释，一般使用：--程序段落注释：一般使用：/**/错误处理及反馈信息规范供应用层调用的过程需捕获处理各种异常，并反馈信息给应用层，供应用层进行后续处理。反馈信息 (返回参数：out_code, out_msg)格式如下：CREATE OR REPLACE PACKAGE pkg_bu_demo IS PROCEDURE p_test(in_firstname IN VARCHAR2, in_lastname IN VARCHAR2, ... out_code OUT NUMBER, out_msg OUT VARCHAR2);END pkg_bu_demo;Oracle系统异常，事务回滚，反馈系统异常信息：out_code := -1;out_msg := pkg_sp_msg.f_msg(error.general, 操作未完成，详细原因为{0}, SQLERRM);业务逻辑异常，事务回滚，返回业务逻辑异常信息：out_code := 0;out_msg := pkg_sp_msg.f_msg(msg.bu.personNotExists, 人员{0}{1}不存在，请检查, in_lastname ||$|| in_firstname);业务正常完成有消息提示，事务提交，反馈成功信息：out_code := 2;out_msg := pkg_sp_msg.f_msg(msg.bu.per