Scala开发规范小结（一）

• 查询与数据

  • 尽量不要使用字符串拼接 sql
  • 更新插入db尽量使用清晰易维护的语句

  insert into user set id = 1, user_name = "张三"
  

  • 查询尽量建立索引
  • 查询结果尽量建立 dto
  • 服务接口数据严进松出
  • 在请求和响应时，对于 Option 字段所存在的意义有所不同
  • 如果 Option 类型的数据返回，必须要 match case 匹配一番

• 检查和异常

  • 尽量使用断言 assert 断言检查
  • 如果返回数据为List之类的数据，返回空List也不要已抛出异常的形式或者null
  • 尽量不要将异常流程作为程序的正常流程
  • 所有的异常在返回给前端或者服务调用者时都应转换为业务异常
  • 所有返回的业务异常应当返回对应的错误码，并且做好错误码归档

• 书写

  • 命名语义化，见名知意
  • 未使用的变量可以使用 _ 代替
  • 不要在方法每次执行时都去解析正则(正则消耗大量时间)，尽量提取成为静态常量
  • 函数的行数尽量不要超过50行，emmmm
  • 程序的单行字符不应当超过可视范围
  • 程序的流程应当存在适当的书写停顿，该换行的时候就该换行
  • 结果 dto 与返回 dto 转换赋值时，字段较多时尽量加上字段名易维护易阅读

  ……
  case Some(x) => Some(
      LoginUserResponse(
          userName = x.user_name,
          telephone = x.telephone,
          status = findByValue(x.user_status),
          integral = x.integral,
          createdAt = x.created_at.getTime,
          updatedAt = x.updated_at.getTime,
          email = x.email,
          qq = x.qq
      ))
  ……
  
  // 以上转换推荐老司机的 BeanBuilder(宇宙最强)
  
  ……
  case Some(x) => Some(
      BeanBuilder
      .build[LoginUserResponse](x)(
          "userName" -> x.user_name,
          "status" -> findByValue(x.user_status),
          "createdAt" -> x.created_at.getTime,
          "updatedAt" -> x.updated_at.getTime
      ))
  ……