首页 / 软件开发 / 数据结构与算法 / 提前认识软件开发（29） 数据库脚本文件的布局

提前认识软件开发（29） 数据库脚本文件的布局2015-01-25“没有规矩，不成方圆”，规范数据库脚本文件的代码布局具有以下重要意义：

（1） 可表现出代码良好的逻辑结构，提高代码的准确性、连续性、可读性及可维护性。

（2） 有利于提高产品的开发质量和效率，并降低开发成本。

（3） 对于开发人员来说，养成良好的脚本编写习惯有助于提高个人的数据库脚本编程水平，进而提高脚本编程效率。

可见，统一的、良好的脚本代码布局和风格不仅仅是个人主观美学或形式上的问题，而且影响到产品的质量，并涉及到自身脚本编程能力的提高。

1. 脚本布局顺序概述

在实际的软件开发项目中，统一规范脚本布局顺序可方便对代码的阅读，利于后续的维护及测试修改。可采用以下两种方式来布局脚本文件内容：

方式一：

文件头

初始化

用户及访问权限的建立

数据表的创建

存储过程的创建

数据库任务的创建

结束

方式二：

文件头

初始化

数据表的创建

存储过程的创建

数据库任务的创建

用户及访问权限的建立

结束

注意：

（1） 一个普通的脚本文件包含了方式一和方式二中的7个部分。为了便于区分和阅读，各个部分要使用注释块隔离开来（注释符使用“--”）。

（2） “用户及访问权限的建立”可以放在第三部分，也可以放在第六部分。

（3） 各部分前统一使用标注说明，相关内容必须写在对应部分，如果相关内容为空，也必须保留该部分的标注说明。

2. 脚本布局示例

采用方式一，基于Sybase数据库实现的脚本代码示例如下：

--修改记录1：--修改日期：--版本号：--修改人：--修改内容：--**********************************************************************/--**************************************************-- initialization 初始化--**************************************************use mastergouse xxx-- 要使用的数据库gocheckpointgo dump tran xxx with no_log-- 日志截断处理go --************************************************************-- user and right creation用户及权限的建立 --************************************************************exec sp_addalias xxx, dbogo --***********************************************************************-- table creation 数据表的创建--***********************************************************************--样例表tb_exampleif exists（select 1 from sysobjects where id = object_id（"tb_example"））begindrop table tb_exampleendgo create table tb_example（namevarchar（30） not null, --名字age int not null --年龄）go----创建索引create index idx_tb_example1 on tb_example（name）go --************************************************************-- procedure creation存储过程的创建 --************************************************************--信息查询存储过程pr_selectinfo--输入参数：@v_name姓名，@v_age 年龄--输出参数：无if exists （select 1 from sysobjects where id = object_id（"pr_selectinfo"））begindrop procedure pr_selectinfoendgo create procedure pr_selectinfo@v_namevarchar（30）, --姓名@v_ageint--年龄asbegin......endgo print "create procedure pr_selectinfo ok"go --**************************************************-- task creation数据库任务的创建--**************************************************…… --**************************************************-- finalization结束--**************************************************……

在实际的软件项目中，对脚本文件的布局都有其严格的规定，开发人员需要遵照编程规范来书写脚本代码。这不仅有利于对代码的阅读和修改，也有利于团队的技术交流与共享。

From：csdn博客 周兆熊