【解密 Kotlin 扩展函数】顶级函数和顶级属性(十五)

导读大纲

- - [1.1.1 摆脱静态实用类的束缚--顶级函数](#1.1.1 摆脱静态实用类的束缚--顶级函数)
  - [1.1.2 更改顶级声明所在的类名](#1.1.2 更改顶级声明所在的类名)
  - [1.1.3 顶层属性](#1.1.3 顶层属性)

1.1.1 摆脱静态实用类的束缚--顶级函数

我们都知道,作为一种面向对象的语言,Java要求将所有代码都写成类的方法
- 通常情况下,这样做效果很好,但在现实中,几乎每个大型项目
  1. 最终都会产生大量不属于任何一个类的代码
- 有时,一个操作会与两个不同类的对象 一起工作
  1. 而这两个类对该操作起着同等重要的作用
- 还有一些时候,虽然只有一个主对象
  1. 不想通过将操作添加为实例方法来臃肿其 API
- 因此,你最终会得到不包含任何状态或实例方法的类 ---实用工具类
  1. 这种类只充当几个静态方法的容器
- JDK 中的 Collections 类就是一个很好的例子
  1. 要在开源项目中找到其他例子,请查找名称中包含 Util 的类
在 Kotlin 中,不需要创建那些毫无意义的类
- 相反,可以直接将函数放在源文件的顶层 ,任何类的外边
  1. 这些函数仍然是文件顶层声明的包的成员
- 如果想从其他包中调用这些函数 ,仍然需要导入它们
  1. 但不必要的额外嵌套层 已不复存在
创建一个名为 Join.kt 的文件,直接将 joinToString 函数放到 strings 包中
- 关于joinToString 函数的实现--传送门

kotlin 复制代码

package strings
@JvmOverloads
fun <T> joinToString(
    collection: Collection<T>,
    separator: String = ", ",
    prefix: String = "",
    postfix: String = ""
) : String {
    val result = StringBuilder(prefix)
    for ((index, elem) in collection.withIndex()){
        if (index > 0) result.append(separator)
        result.append(elem)
    }
    result.append(postfix)
    return result.toString()
}

现在,让我们看看编译成相同类的 Java 代码
- <1> 可以看到,Kotlin 编译器生成的类名 与包含函数的文件名一致
  1. 大写以匹配 Java 的命名规范 ,后缀为 Kt
- <2> 文件中的所有顶级函数 都被编译为该类的静态方法
- <3> 因此, 从 Java 中调用该函数 就像调用其他静态方法一样简单

kotlin 复制代码

/* Java */
package strings;
public class JoinKt {                                       // <1>
    public static String joinToString(// ... ) { // ...  }  // <2>
}
===========================================================
/* Java */
import strings.JoinKt;
// ... 
JoinKt.joinToString(list, ", ", "", "");                   // <3>

1.1.2 更改顶级声明所在的类名

默认情况 下,编译器生成的类名与文件名相对应 ,并带有 Kt 后缀
- 要更改包含 Kotlin 顶级函数的生成类名称
  1. 可以添加一个 JvmName 注解
- <1> 将其放在文件开头 ,包名之前
- <2> 此时在Java代码中导入 时, 可以直接使用新命名"StringFunctions"

kotlin 复制代码

@file:JvmName("StringFunctions")                     // <1>
package strings
@JvmOverloads
fun <T> joinToString(
    collection: Collection<T>,
    separator: String = ", ",
    prefix: String = "",
    postfix: String = ""
) : String {
    val result = StringBuilder(prefix)
    for ((index, elem) in collection.withIndex()){
        if (index > 0) result.append(separator)
        result.append(elem)
    }
    result.append(postfix)
    return result.toString()
}
======================================================
import java.util.List;
import strings.StringFunctions;                                 // <2>
public class Example {
    public static void main(String[] args){
        System.out.println(StringFunctions.joinToString(List.of("1", "2")));
    }
}

1.1.3 顶层属性

与函数一样,属性也可以放在文件的顶层
- 在类外部存储单个数据并不常见 ,但仍然很有用
- 例如,你可以使用 var 属性来计算某些操作的执行次数
- <1> 声明顶级属性
- <2> 改变属性的值
- <3> 读取属性的值

kotlin 复制代码

var opCount = 0                     // <1>
fun performOperation() {
    opCount++                       // <2>
    // ...
}
fun reportOperationCount() {
    println("Operation performed $opCount times")     // <3>
}

顶级属性还允许在代码中定义常量 : val UNIX_LINE_SEPARATOR = "\n"
- 默认情况 下,顶层属性与其他属性一样
  1. 以访问器方法的形式暴露给 Java 代码的
  2. val 属性的 getter 和 var 属性的 getter-setter 对
- <1> 如果想将常量作为"public static final"字段 暴露给 Java 代码
  1. 使其使用更自然,可以使用 const 修饰符对其进行标记
    - 这对基本类型和String类型的属性都是允许的
- <2> 与顶级函数一样，顶级属性在编译后会变成Java的静态字段
  1. 由于这里使用const修饰属性 ，所以会得到"public static final"字段*

kotlin 复制代码

const val UNIX_LINE_SEPARATOR = "\n"            // <1>
=============================================== // <2>
/* Java */
public static final String UNIX_LINE_SEPARATOR = "\n";

注意 Kotlin 标准库还包含几个有用的顶级函数和属性
- kotlin.math 包就是一个例子
  1. 它为典型的数学运算和三角运算提供有用的函数
- <1> 例如用于计算两个数字最大值的 max 函数
  1. 它还提供许多数学常量 ,如欧拉数或圆周率

kotlin 复制代码

fun main() {
    println(max(PI, E))          // <1>
    // 3.141592653589793
}