hive代码设计规范

664 阅读2分钟

这是我参与2022首次更文挑战的第27天,活动详情查看:2022首次更文挑战

接着上一篇的hive设计常见规范,本文继续来介绍hive开发过程要注意的一些代码设计规范和sql设计规范。

代码设计规范

常见的一些规范要求如下:

  • 减少无用代码,保证简洁明了,提高代码健壮;
  • 代码头部注释包括创建人、创建时间和代码描述;
  • 代码行整体结构性强,段落清晰、规整;
  • 注释一定要详细说重点,增强代码可读性;
  • 规范非强制性约束开发人员的编写行为,在实际应用中,若不违反常规要求,则允许存在可理解的偏差;
  • SQL代码中应用到的所有字母(英文、汉语拼音)尽量都使用小写,如select、from、where、and、or、union、insert、delete、group、having、count等;
  • 为了提高阅读性,代码的缩进也非常关键,一般我们认为4个空格为一个缩进量(即一个tab键),所有的缩进量皆为一个缩进量的整数倍,代码层次对齐;
  • select * 这样的操作不能看到,必须明确指定列名,善用表的别名。

sql代码规范

sql代码注释包括语句块的注释、字段的注释,如果含有特殊逻辑也要加注释:

  • 每个语句块的开始需要注释本语句块的内容
  • 目标表的字段需要注释字段含义且要对齐
  • 复杂逻辑需要简要描述处理逻辑
  • 对于重要的计算逻辑,应加以说明其功能
  • 如果查询的是分区表,where后的过滤条件应该先限定分区(具体包括:一级分区和二级分区);
  • 所有的表都应加上别名,且表的别名应尽量简单、简洁

格式规范

通用的一些规则

默认值:可以设定一些数值、字符串类、描述等的默认值,比如数值为-1,字符串是'',描述为无

统计类的就是null,或者0。

时间类的就有默认格式yyyyMMdd,默认值可以是1000-01-01 00:00:00

养成良好的代码书写习惯,看着赏心悦目,别人读起来也更顺畅,也更有利于发现问题和优化语句。