scala开发规范整理

格式与命名

1. 在两个方法、类、对象定义之间使用一个空白行
2. 优先考虑使用val，而非var。
3. 当引入多个包时，使用花括号，当引入的包超过6个时，应使用通配符_：
4. 在条件或循环语句表达式中，即使表达式只有一行也建议使用花括号

//避免
def square(x: Int) = x * x
//推荐

def square(x: Int) = {
   
     x * x
}

5. 常量应该用全大写字母表示，并且放在伴生对象里

class Configuration {
   }

object Configuration {
   
  val DEFAULT_VALUE = 1
}

6. 代码行长度

• 单行代码长度不要超过100个字符
• 作为例外，引入包名时（import）或单个URL超长时可能超过100个字符，但要尽量控制在此之内

7. '30’原则

• 如果一个元素包含了超过30个子元素，可能在设计上有严重问题
• 一般情况：一个方法/函数应该少于30行代码
• 一般情况：一个类应该少于30个方法/函数

8. 空格及代码缩进

• 通常使用两个空格作为代码缩进
• 函数定义：全部参数如果不能一行上展示则下一行使用四个空格作为参数缩进；返回类型与最后一行参数同一代码行或别起一行使用两个空格缩进：

def method1(
    f1: String,
    f2: String,
    f3: String): RDD[K,V] = {
   
    //function body
}

def method2(
    f1: String,
    f2: String,
    f3: String)
  : RDD[K,V]