SQL编码规范
< 返回列表时间: 2019-05-13来源:OSCHINA
文件头部注释
文件头部注释主要是表明该SQL语句的一些基本信息,是该SQL语句实现功能的总体说明,可以增强SQL语句的可读性和可维护性。文件头部注释一般位于 文件顶部。要求至少写出文件名、创建者、创建时间和内容描述。其格式应该尽量约束如下
/**
* @author("张三")
* @description("表描述")
* @version("1.0.0")
* @reference(依赖的表1,依赖的表2)
*/
字段排列要求 SELECT 语句选择的字段按每行一个字段方式编排; SELECT 单字后一个缩进量后直接跟首个选择的字段,即字段离首起二个缩进量; 其它字段首起二个缩进量,逗号之后放置字段名; 两个字段之间的逗号分割符紧跟在第二个字段前; ‘AS’语句应与相应的字段在同一行; 多个字段的‘AS’建议尽量对齐在同一列上;
 
SELECT子句排列要求
SELECT 语句中所用到的FROM、WHERE、GROUP BY、HAVING、ORDER BY、J OIN、UNION等子句,需要遵循如下要求: 换行编写; 与相应的SELECT 语句左对齐编排; 子句后续的代码离子句首字母二个缩进量起编写; WHERE 子句下的逻辑判断符 AND、OR等与WHERE左对齐编排; 超过两个缩进量长度的子句加一空格后编写后续代码
 
运算符前后间隔要求
算术运算符、逻辑运算符的前后要保留一个空格。

CASE语句的编写
SELECT 语句中对字段值进行判断取值的操作将用到CASE语句,正确的编排CASE语句的写法对加强代码行的可阅读性也是很关键的一部分。对CASE语句编排作如下约定: WHERE 子句下的逻辑判断符 AND、OR等与WHERE左对齐编排; 每个WHEN子语句一行编写,当然如果语句较长可换行编排; CASE语句必须包含ELSE子句,ELSE子句与WHEN子句对齐。

子查询嵌套编写规范
子查询嵌套在数据仓库系统ETL开发中是经常要用到,因此代码的分层编排就非常重要。

表别名定义约定
所有的表建议都加上别名。因为一旦在SELECT 语句中给操作表定义了别名,那么在整个语句中对此表的引用都必须惯以别名替代,因此考虑到编写代码的方便性,约定别名尽量简单、简洁,同时避免使用关键字。 表别名采用简单字符命名; 多层次的嵌套子查询别名之前要体现层次关系,SQL语句别名的命名,分层命名,从第一层次至第四层次,分别用P 、S、 U 、D表示,取意为Part , Segment , Unit , Detail。也可用a、b、c、d来表示第一层次到第四层次;对于同一层次的多个子句,在字母后加1、2、3、4……区分; 有需要的情况下对表别名加注释。

SQL注释 每条SQL语句均应添加注释说明; 每条SQL语句的注释单独成行、放在语句前面; 字段注释紧跟在字段后面; 应对不易理解的分支条件表达式加注释; 对重要的计算应说明其功能; 过长的函数实现,应将其语句按实现的功能分段加以概括性说明; 常量及变量注释时,应注释被保存值的含义(必须),合法取值的范围(可选)。
热门排行