阿里 SQL 代码编码原则和规范

阿里 SQL 代码编码原则和规范

编码原则

SQL 代码的编码原则如下：

• 代码功能完善。
• 代码行清晰、整齐，代码行的整体层次分明、结构化强。
• 代码编写充分考虑执行速度最优的原则。
• 代码中需要添加必要的注释，以增强代码的可读性。
• 规范要求并非强制性约束开发人员的代码编写行为。实际应用中，在不违反常规要求的前提下，允许存在可以理解的偏差。
• SQL 代码中应用到的所有 SQL 关键字、保留字都需使用全大写或小写，例如 select/SELECT、from/FROM、where/WHERE、and/AND、or/OR、union/UNION、insert/INSERT、delete/DELETE、group/GROUP、having/HAVING 和 count/COUNT 等。不能使用大小写混合的方式，例如 Select 或 seLECT 等方式。
• 4 个空格为 1 个缩进量，所有的缩进均为 1 个缩进量的整数倍，按照代码层次对齐。
• 禁止使用select *操作，所有操作必须明确指定列名。
• 对应的括号要求在同一列的位置上。

SQL 编码规范

SQL 代码的编码规范如下：

• 代码头部

  代码头部添加主题、功能描述、作者和日期等信息，并预留修改日志及标题栏，以便后续添加修改记录。注意每行不超过 80 个字符，模板如下。

  -- MaxCompute(ODPS) SQL
  --**************************************************************************
  -- ** 所属主题: 交易
  -- ** 功能描述: 交易退款分析
  -- ** 创建者 : 有码
  -- ** 创建日期: 20170616 
  -- ** 修改日志:
  -- ** 修改日期 修改人 修改内容
  -- yyyymmdd name comment 
  -- 20170831 无码 增加对biz_type=1234交易的判断 
  --**************************************************************************
  

• 字段排列要求

  • SELECT 语句选择的字段按照每行 1 个字段的方式编排。
  • 首个选择的字段与 SELECT 之间隔 1 个缩进量。
  • 换行缩进 2 个缩进量后，添加逗号再输入其它字段名。
  • 2 个字段之间的逗号分隔符紧跟在第 2 个字段的前面。
  • AS 语句应与相应的字段在同一行，多个字段的 AS 建议尽量对齐在同一列上。

• INSERT 子句排列要求

  INSERT 子句写在同一行，请勿换行。

• SELECT 子句排列要求

  SELECT 语句中所用到的from、where、group by、having、order by、join和union等子句，需要遵循如下要求：

  • 换行编写。
  • 与相应的 SELECT 语句左对齐编排。
  • 子句首个单词后添加 2 个缩进量，再编写后续的代码。
  • WHERE 子句下的逻辑判断符and、or等，与 WHERE 左对齐编排。
  • 超过 2 个缩进量长度的子句加 1 个空格后，再编写后续代码，例如order by和group by等。

• 运算符前后间隔要求

  算术运算符、逻辑运算符前后要保留 1 个空格，并写在同一行（超过每行 80 个字符长度的限制除外）。

• CASE 语句的编写

  CASE 语句可以用于 SELECT 语句中对字段值进行判断取值的操作。CASE 语句编排的规则如下：

  • WHEN 子语在 CASE 语句的同一行，并缩进 1 个缩进量后开始编写。
  • 每个 WHEN 子句尽量在 1 行内编写，如果语句较长可以换行。
  • CASE 语句必须包含 ELSE 子语，ELSE 子句与 WHEN 子句对齐。

• 查询嵌套编写规范

  在数据仓库系统 ETL 开发中经常使用子查询嵌套，其编写规范示例如下。

• 表别名定义约定

  • 一旦在 SELECT 语句中给操作表定义了别名，在整个语句中对此表的引用都必须以别名替代，所以需要给所有的表添加别名。

  • 表别名采用简单字符命名，建议按 a、b、c、d…的顺序进行命名，并避免使用关键字。

  • 多层次的嵌套子查询别名之前要体现层次关系，SQL 语句的别名需要分层命名，从第 1 层次至第 4 层次，分别用 P（Part） 、S（Segment）、 U（Unit） 和 D（Detail）表示。您也可以用 a、b、c、d 来表示第 1 层次到第 4 层次。

    对于同一层次的多个子句，在字母后加 1、2、3、4……区分，并根据情况对表别名添加注释。

• SQL 注释

  • 每条 SQL 语句均应添加注释说明。
  • 每条 SQL 语句的注释单独成行，并放在语句的前面。
  • 字段注释紧跟在字段后面。
  • 对不易理解的分支条件表达式添加注释。
  • 对重要的计算添加注释，说明其功能。
  • 过长的函数实现，应将其语句按实现的功能分段，添加注释进行说明。
  • 添加常量及变量的注释时，应注释被保存值的含义（必选），合法取值的范围（可选）。

原文链接：https://www.alibabacloud.com/help/zh/doc-detail/137491.htm