bitlap / scala-best-practices

Scala 最佳实践（scala-best-practices）

Scala 最佳实践

• 版本： 1.3
• 更新时间: 2023-10-20
• 翻译&维护者：梦境迷离

说明

• MUST 👍 强制/必须
• SHOULD ✅ 推荐/应该
• SHOULD NOT ❎ 不推荐/不应该
• MUST NOT 👎禁止

目录

• 0. 序言

  • 0.1 切勿盲从建议

• 1. 卫生规范

  • 1.1. ✅ 应该强制实行合理的代码行长度
  • 1.2. 👎 禁止依靠 SBT 或 IDE 插件进行代码格式化
  • 1.3. ✅ 应该避免长函数
  • 1.4. 👎 在命名和注释中引入拼写错误
  • 1.5. 👍 命名必须有意义

• 2. 语言规范

  • 2.1. 👎 禁止使用 return
  • 2.2. ✅ 应该使用不可变数据结构
  • 2.3. ❎ 不应该使用循环或条件更新一个 var
  • 2.4. ❎ 不应该定义无用的特质
  • 2.5. 👎 禁止在样例类中使用 var
  • 2.6. ❎ 不应该声明抽象的 var 成员
  • 2.7. 👎 禁止在验证用户输入或流控制时抛出异常
  • 2.8. 👎 禁止捕获 Exception 时，不要捕获 Throwable
  • 2.9. 👎 禁止使用 null
  • 2.10. 👎 禁止使用 Option.get
  • 2.11. 👎 禁止使用Java的日期或日历，而不是使用 java.time (JSR-310)
  • 2.12. ❎ 不应该使用 Any 或 AnyRef 或 isInstanceOf / asInstanceOf
  • 2.13. 👍 必须将日期序列化为 Unix 时间戳或 ISO 8601
  • 2.14. 👎 禁止使用魔法值
  • 2.15. ❎ 不应该使用 var 作为共享状态
  • 2.16. ✅ 应该为公共函数显式声明返回类型
  • 2.17. ❎ 不应该定义嵌套在其他类中的样例类
  • 2.18. 👎 禁止在包对象中包含类、特质和对象
  • 2.19. ✅ 应该仅当 head / tail 和 init / last 分解可以在常数时间和内存中完成时，才使用它们
  • 2.20. 👎 禁止使用 Seq.head
  • 2.21. ✅ 样例类应该标记为 final
  • 2.22. ❎ 不应该使用 scala.App

• 3. 应用架构

  • 3.1. ❎ 不应该使用 Cake pattern
  • 3.2. 👎 禁止将内容放入 Play 的 Global
  • 3.3. ❎ 没有经过分析不应该优化
  • 3.4. ✅ 应当注意垃圾收集器
  • 3.5. 👎 禁止使用无参数的 ConfigFactory.load() 或直接访问 Config 对象

• 4. 并发和并行

  • 4.1. ✅ 应该视并发如瘟疫
  • 4.2. ✅ 应该只在适当的情况下使用适当的抽象
  • 4.3. ❎ 不应该在 Futures 中封装纯 CPU 绑定的操作
  • 4.4. 👍 强制在阻塞 I/O 中使用 Scala 的 BlockContext
  • 4.5. ❎ 不应该阻塞
  • 4.6. ✅ 应该为阻塞 I/O 使用单独的线程池
  • 4.7. ✅ 所有公共 APIs 都应该为线程安全
  • 4.8. ✅ 应该避免共享读取时出现竞争
  • 4.9. 👍 强制为通过异步边界进行通信的每个组件或行为体提供定义明确并记录在案的协议
  • 4.10. ✅ 应该始终倾向于单个生产者的方案
  • 4.11. 👎 禁止硬编码线程池/执行上下文

• 5. Akka Actors

  • 5.1. ✅ 应该只在收到外部信息时才改变 actors 的状态
  • 5.2. ✅ 应该只使用 context.been 来改变 actors 的状态
  • 5.3. 👎 禁止在异步闭包中泄漏actors的内部状态
  • 5.4. ✅ 应该使用背压
  • 5.5. ❎ 不应该使用 Akka FSM

---

贡献

打开问题以提出建议，或创建拉取请求 ;-)

---

Copyright © 2015-2016, Some Rights Reserved.
Licensed under CC BY 4.0.