条条小小kotlin编码规范

Kotlin

文件名

文件名命名遵守大驼峰规则（首字母大写）

        如果一个文件中仅包含一个class, 那么则应该以该类的名称来命名文件

// Main.KT
class Main {
    fun print() {
        println("Hello World.")
    }
}

        如果一个文件中包含多个top-level declarations(顶级的类/方法/变量/常量等), 则可以选一个合适名字命名

// ServiceInfo.KT
data class AreaInfo(
        val areaImg: String,
        val areaTotal: Int)
data class AvgPrice(
        val title: String,
        val amount: String,
        val unit: String)
data class ServiceInfo(
        // 服务区域
        val serviceAreaInfo: AreaInfo?,
        // 服务报价
        val serviceAvgPrice: AvgPrice?)

文件结构

一个文件可以包含多个top-level declarations, 但是需要尽可能的保证以下几点:

• 尽可能的保证文件中的top-level declarations 都是相关联的(例如: 一组拓展函数, 一组Bean类)

• 尽可能的保证文件中的publish属性的数量是最小的

类名与方法名

同Java中的写法, 类名命名遵守大驼峰规则（首字母大写）, 方法名命名遵守小驼峰规则（首字母小写）

class Main {
    fun print() {
        println("Hello World.")
    }
}

字段名

• 非公开且非静态字段的名称以 m 开头。
• 静态字段的名称以 s 开头。
• 其他字段以小写字母开头。
• 公开静态 final 字段（常量）为全部大写并用下划线连接 (ALL_CAPS_WITH_UNDERSCORES)。

lass Person {
    val mName: String = "石硕"
    val mHeight: Int = 190
    fun print() {
        println(TEXT_PRINT)
    }
    companion object {
        const val TEXT_PRINT = "Hello World."
    }
}

常量

• 在Kotlin中常量一般可以选择定义在伴生对象(companion object)中, 也可以单独定义在一个自定义的Object中

class Person {
    val sex: Int = Sex.MAN
    val height: Int = 190
    val name: String = "石硕"
    val country: String = CHINA
    fun print() {
        println(TEXT_PRINT)
    }
    companion object {
        const val TEXT_PRINT = "Hello World."
        // 定义在companion object中
        const val CHINA = "china"
        const val OTHER = "other"
    }
    object Sex {
        // 定义在自定义的Object中
        const val MAN = 0
        const val WOMAN = 1
    }
}

• Kotlin中常量需要用Const/@JvmField来修饰, 修饰后编译成的Java文件会生成对应的public static final对象, 否则会生成一个private static final对象及对应的get方法, 此时如果通过Java调用在Kotlin中定义的非Const常量的话, 就会很奇怪

// Kotlin
class TestConst {
    companion object {
        const val TEXT = "Text."
        val TEXT_WITHOUT_CONST = "Text without Const."
        @JvmField
        val TEXT_WITH_JVM_FIELD = "Text without Const but with JvmField"
        @JvmStatic
        val TEXT_WITH_JVM_STATIC = "Text without Const but with JvmStatic"
    }
}
// Java
class JAVATest {
    public static void main(String[] args) {
        // 调用Const常量
        System.out.println(TestConst.TEXT);
        // 调用非Const常量
        System.out.println(TestConst.Companion.getTEXT_WITHOUT_CONST());
        // 调用非Const但是用@JvmStatic修饰的常量(两种调用方式都可以)
        System.out.println(TestConst.getTEXT_WITH_JVM_STATIC());
        System.out.println(TestConst.Companion.getTEXT_WITH_JVM_STATIC());
        // 调用非Const但是用@JvmField修饰的常量
        System.out.println(TestConst.TEXT_WITH_JVM_FIELD);
    }
}

作用域函数的使用(let, also, run, apply, with)

• 涉及到多层作用域函数嵌套时, 尽量使用let和also来指明参数的命名. 而不要使用run和apply, 这样会使可读性变差
• 传递参数时, 尽量使用先用清晰的变量名存储作用域函数获得的值, 而不是直接把作用域函数传递到函数参数里

正确

错误

匿名函数的嵌套调用可能会引发编译问题, 所以应尽量避免嵌套调用

class Foo {
    fun bar(obj: Any) {
        val v = V()
        obj.let {
            // 这样有问题
            v.methodA(null) {
                v.methodB(null) {
                }
            }
            // 这样没问题
            v.methodA(null) {}
            v.methodB(null) {}
        }
    }
    private class V {
        fun methodA(s: String?, callback: (Boolean) -> Unit) {
        }
        fun methodB(s: String?, callback: (Boolean) -> Unit) {
        }
    }
}