Android 编码规范

Tips

请务必按照以下约束严格要求

提交规范

• 代码提交前请自检AS中是否有黄线，代码黄块或者红色波浪线，在提交gitlab前务必去除所有警告，更正单词拼写错误

// 添加滚动条目,下面代码放入AS，会有黄色波浪线，请修改完再提交
private fun addScrollitem(
    rowNumber: Int,
    dataBeans: ArrayList<HotBannerDataBean>,
    listStyle: Int
) {...}

// 下面代码放入AS，var会有黄色块，建议修改为val
var layoutparams: RelativeLayout.LayoutParams = img.layoutParams as RelativeLayout.LayoutParams

• 代码merger reqeust前慎重确认合入的版本分支

命名规则

包和类名称

• 包的名称总是小写且不使用下划线

比如 com.yonghui.yhd.xxx，不鼓励使用多个词，如果使用多个词，请全部小写，比如 cn.yonghui.hyd.category.business.newcategory

• 类与对象的名称以大写字母开头并使用驼峰风格

open class DeclarationProcessor { ... }
object EmptyDeclarationProcessor : DeclarationProcessor() { ... }

方法和属性名称

• 函数名称以小写字母开头、使用驼峰风格而不使用下划线

fun processDeclarations() { ... }

• 属性名称，全局不再使用m开头的成员变量和临时变量，尤其是右值变量（入参变量）

Good

private var toolbarTitle: Int = 0

Bad

fun setData(products: ArrayList<HotSuggestProductDataBean>?, mCartView: View?){...}

如何选择方法名称或者类名称

• 类的名称通常是用来解释类是什么的名词或者名词短语：List、 PersonReader。

• 方法的名称通常是动词或动词短语，说明该方法做什么：close、 readPersons。

• 当使用首字母缩写作为名称的一部分时，如果缩写由两个字母组成，就将其大写（IOStream）； 而如果缩写更长一些，就只大写其首字母（XmlFormatter、 HttpInputStream）

格式

新增类或者方法，请使用ktlint插件格式化

• 单行的when语句分支、单行的if语句（用于代替三目运算符）不强制要求添加花括号

if (string.isEmpty()) return
val value = if (a == b) 0 else 1
when (value) {
    0 -> return
    // …
}

• 除以上情况外，任何使用if、when、for、do、while语句时，对于其有效作用域，都必须使用花括号，即使其中只有一行代码

Good

val myValue = if (condition) {
    0
} else {
    1
}

Bad

val myValue = if (condition) 
    0
else 
    1

类布局

通常，一个类的内容按以下顺序排列：

• 版权（Copyright）及许可证（License）头部声明（可选）
• package声明语句
• import语句
• 文件级的注解 （建议增加类的相关注释）
• 属性声明与初始化块
• 次构造函数
• 方法声明
• 伴生对象

不要按字母顺序或者可见性对方法声明排序，也不要将常规方法与扩展方法分开。而是要把相关的东西放在一起，这样从上到下阅读类的人就能够跟进所发生事情的逻辑。选择一个顺序（高级别优先，或者相反）并坚持下去。

将嵌套类放在紧挨使用这些类的代码之后。如果打算在外部使用嵌套类，而且类中并没有引用这些类，那么把它们放到末尾，在伴生对象之后。

安全性和可读性

• 方法里的参数要声明为可空类型，防止由于运行时数据为空或Kotlin与Java代码相互调用产生IllegalStateException异常导致Crash

• 对于Java中要求强制加try-catch的场景，编译器不会自动提示，需要我们自己加上，如：new JSONObject("xxx")，xx.toInt()等

• I/O操作及加锁操作或可能出现内存泄露的场景，必须使用finally语句进行处理

• 建议所有进行类型转换的操作，都使用as?，以防止类型不匹配导致的异常问题

class MyFragment : Fragment() {
    // Good
    (context as? Activity)?.finish()
    // Not Good
    (context as Activity).finish()
}

• 禁止使用!!修饰
• 禁止使用lateinit来定义不可空类型的变量，可能会在使用时出现null的情况
• 只读变量可以使用by lazy { }实现懒加载，并根据场合设置线程安全类型，UI线程建议设置为NONE

private val lazyImmutableValue: String by lazy {
    "Hello"
}
private val lazyImmutableValueNoThreadSafe: String by lazy(LazyThreadSafetyMode.NONE) {
    "Hello"
}

• 禁止使用魔数