Kotlin代码Review最佳实践（下）

「Generated by Manus, instructions issued by binbinwang」

26. 使用协程取消机制

错误写法：

suspend fun longRunningTask() {
    for (i in 1..1000) {
        heavyComputation()
        delay(100)
    }
}

说明：没有检查协程是否活跃，可能导致资源泄漏和应用无响应。

正确写法：

suspend fun longRunningTask() {
    for (i in 1..1000) {
        ensureActive() // 检查协程是否活跃
        yield() // 定期让出执行权
        heavyComputation()
        delay(100)
    }
}

27. 使用协变和逆变优化泛型

错误写法：

interface Producer<T> {
    fun produce(): T
}

interface Consumer<T> {
    fun consume(item: T)
}

说明：没有使用协变和逆变，可能导致不必要的类型转换或编译错误。

正确写法：

interface Producer<out T> {
    fun produce(): T
}

interface Consumer<in T> {
    fun consume(item: T)
}

28. 避免过度使用扩展函数

错误写法：

1
2
3

fun String.toTitleCase(): String = /* 实现 */
fun String.removeWhitespace(): String = /* 实现 */
fun String.isValidEmail(): Boolean = /* 实现 */

说明：对标准库类型添加过多扩展，可能导致命名冲突、IDE提示过多和代码难以理解。

正确写法：

object StringUtils {
    fun toTitleCase(str: String): String = /* 实现 */
    fun removeWhitespace(str: String): String = /* 实现 */
}

fun String.isValidEmail(): Boolean = /* 实现 */

29. 使用密封接口

错误写法：

interface State {
    object Loading : State
    data class Success(val data: String) : State
    data class Error(val message: String) : State
}

说明：不使用密封接口可能导致when表达式需要else分支，增加出错风险。

正确写法：

sealed interface State {
    object Loading : State
    data class Success(val data: String) : State
    data class Error(val message: String) : State
}

30. 使用内联类优化包装类型

错误写法：

1	class UserId(val value: String)

说明：不使用内联类会导致额外的对象创建和内存开销。

正确写法：

1 2	@JvmInline value class UserId(val value: String)

31. 避免过度使用字符串模板

错误写法：

1	val message = "User ${user?.name?.takeIf { it.isNotBlank() } ?: "Unknown"} has ${user?.posts?.filter { it.isPublished }?.size ?: 0} published posts and ${user?.followers?.size ?: 0} followers."

说明：过度复杂的字符串模板难以阅读和维护。

正确写法：

val userName = user?.name?.takeIf { it.isNotBlank() } ?: "Unknown"
val publishedPostsCount = user?.posts?.filter { it.isPublished }?.size ?: 0
val followersCount = user?.followers?.size ?: 0

val message = "User $userName has $publishedPostsCount published posts and $followersCount followers."

32. 使用适当的集合操作

错误写法：

1 2	val hasAdmin = users.filter { it.role == "ADMIN" }.isNotEmpty() val activeUserCount = users.filter { it.isActive }.size

说明：不适当的集合操作可能导致性能问题和代码冗长。

正确写法：

1 2	val hasAdmin = users.any { it.role == "ADMIN" } // 短路操作，找到即返回 val activeUserCount = users.count { it.isActive } // 直接计数，不创建中间集合

33. 使用适当的作用域函数

错误写法：

val user: User? = getUser()

if (user != null) {
    println("User name: ${user.name}")
    println("Name length: ${user.name.length}")
}

说明：不使用作用域函数可能导致代码冗长。

正确写法：

val user: User? = getUser()

user?.let {
    println("User name: ${it.name}")
    it.name.length // 返回长度
}?.apply {
    println("Name length: $this")
}

34. 避免过度使用运算符重载

错误写法：

data class Point(val x: Int, val y: Int)

fun Point.add(other: Point): Point {
    return Point(x + other.x, y + other.y)
}

说明：不使用运算符重载可能导致代码语义不清晰。

正确写法：

data class Point(val x: Int, val y: Int)

operator fun Point.plus(other: Point): Point {
    return Point(x + other.x, y + other.y) // 明确的数学语义
}

35. 使用适当的数值类型

错误写法：

1 2	val price = 19.99 // 使用Double可能导致精度问题 val totalItems = 1000000000 * 10 // 使用Int可能导致溢出

说明：不适当的数值类型可能导致精度问题、溢出或性能问题。

正确写法：

1 2	val price = BigDecimal("19.99") // 精确的货币计算 val totalItems = 1000000000L * 10L // 使用Long避免溢出

36. 使用适当的字符串操作

错误写法：

fun buildString(items: List<String>): String {
    var result = ""
    for (item in items) {
        result += item + ", "
    }
    return result
}

说明：不适当的字符串操作可能导致性能问题和过多的临时对象创建。

正确写法：

1
2
3

fun buildString(items: List<String>): String {
    return items.joinToString(", ")
}

37. 使用适当的日期时间API

错误写法：

val now = Date()
val calendar = Calendar.getInstance()
calendar.time = now
calendar.add(Calendar.DAY_OF_YEAR, 7)
val nextWeek = calendar.time

说明：旧的日期时间API不易使用且容易出错，可能导致日期计算错误。

正确写法：

1 2	val now = LocalDateTime.now() val nextWeek = now.plusDays(7)

38. 使用适当的日志级别

错误写法：

1	Log.d("MyActivity", "User logged in: $userId") // 所有信息都使用DEBUG级别

说明：不适当的日志级别可能导致日志过多或缺少关键信息。

正确写法：

Log.v("MyActivity", "Entering onResume") // 详细跟踪信息
Log.d("MyActivity", "User clicked button") // 调试信息
Log.i("MyActivity", "User logged in: $userId") // 一般信息
Log.w("MyActivity", "Retrying API call (attempt $attempt)") // 警告
Log.e("MyActivity", "Failed to connect to server", exception) // 错误

39. 使用适当的并发控制

错误写法：

class Counter {
    private var count = 0
    
    fun increment() {
        count++
    }
}

说明：不使用原子操作可能导致竞态条件。

正确写法：

class Counter {
    private val _count = AtomicInteger(0)
    val count: Int get() = _count.get()
    
    fun increment() {
        _count.incrementAndGet()
    }
}

40. 使用适当的异常类型

错误写法：

fun parseJson(json: String): Data {
    try {
        return jsonParser.parse(json)
    } catch (e: Exception) {
        throw Exception("Invalid JSON", e)
    }
}

说明：使用过于通用的异常类型会使错误处理不精确，难以区分不同类型的错误。

正确写法：

class JsonParseException(message: String, cause: Throwable? = null) : 
    RuntimeException(message, cause)

fun parseJson(json: String): Data {
    try {
        return jsonParser.parse(json)
    } catch (e: JsonSyntaxException) {
        throw JsonParseException("Invalid JSON syntax", e)
    }
}

41. 使用适当的集合实现

错误写法：

1 2	val randomAccessList = LinkedList<String>() // 频繁随机访问使用LinkedList val orderedMap = HashMap<String, Int>() // 需要保持插入顺序使用HashMap

说明：不适当的集合实现可能导致性能问题。

正确写法：

1 2	val randomAccessList = ArrayList<String>() // 需要频繁随机访问，使用ArrayList val orderedMap = LinkedHashMap<String, Int>() // 需要保持插入顺序，使用LinkedHashMap

42. 使用适当的函数类型

错误写法：

1
2
3

fun fetchData(onSuccess: Function1<Data, Unit>, onError: Function1<Throwable, Unit>) {
    // 实现
}

说明：不使用函数类型可能导致代码冗长。

正确写法：

fun fetchData(
    onSuccess: (Data) -> Unit,
    onError: (Throwable) -> Unit
) {
    // 实现
}

// 或使用协程
suspend fun fetchData(): Result<Data> {
    // 实现
    return Result.success(data)
}

43. 使用适当的字符串格式化

错误写法：

1	val message = "User " + user.name + " has " + user.posts.size + " posts."

说明：不使用字符串模板可能导致代码难以阅读。

正确写法：

val message = "User ${user.name} has ${user.posts.size} posts."

// 复杂格式使用String.format
val formatted = String.format("Score: %.2f (Rank: %d)", score, rank)

44. 使用适当的数字格式化

错误写法：

1	val formattedPrice = "$price" // 直接使用字符串拼接

说明：不适当的数字格式化可能导致显示不一致或本地化问题。

正确写法：

1 2	val currencyFormat = NumberFormat.getCurrencyInstance() val formattedPrice = currencyFormat.format(price)

45. 使用适当的资源管理

错误写法：

fun readFile(path: String): String {
    val reader = BufferedReader(FileReader(path))
    return reader.readText()
}

说明：不正确管理资源可能导致资源泄漏。

正确写法：

fun readFile(path: String): String {
    return BufferedReader(FileReader(path)).use { reader ->
        reader.readText()
    }
}

46. 使用适当的并行集合操作

错误写法：

1	val result = hugeList.map { processItem(it) }

说明：不使用并行操作可能导致性能不佳，特别是对于大型集合。

正确写法：

1
2
3

val result = coroutineScope {
    hugeList.map { async { processItem(it) } }.awaitAll()
}

47. 使用适当的测试方法

错误写法：

class CalculatorTest {
    private lateinit var calculator: Calculator
    
    @Before
    fun setup() {
        calculator = Calculator()
    }
    
    @Test
    fun testAdd() {
        assertEquals(5, calculator.add(2, 3))
    }
}

说明：不适当的测试可能导致未捕获的错误和回归问题。

正确写法：

class CalculatorTest {
    private lateinit var calculator: Calculator
    
    @Before
    fun setup() {
        calculator = Calculator()
    }
    
    @Test
    fun `add should return sum of two numbers`() {
        assertEquals(5, calculator.add(2, 3))
    }
    
    @Test
    fun `add should handle negative numbers`() {
        assertEquals(-1, calculator.add(2, -3))
    }
}

48. 使用适当的文档注释

错误写法：

1
2
3

fun processData(data: String, options: Map<String, Any>): Result {
    // 实现
}

说明：缺少文档会使API难以使用和维护。

正确写法：

/**
 * 处理指定的数据并返回结果。
 *
 * @param data 要处理的数据字符串
 * @param options 处理选项
 * @return 处理结果
 * @throws IllegalArgumentException 如果数据格式无效
 */
fun processData(data: String, options: Map<String, Any>): Result {
    // 实现
}

49. 使用适当的命名约定

错误写法：

1
2
3

val user_name = "John" // 属性名使用下划线
fun calculate_total(items: List<Item>): Double { /* 实现 */ } // 方法名使用下划线
const val maxCount = 100 // 常量使用小写字母

说明：不一致的命名约定会降低代码可读性。

正确写法：

1
2
3

val userName = "John" // 属性名以小写字母开头
fun calculateTotal(items: List<Item>): Double { /* 实现 */ } // 方法名使用驼峰命名法
const val MAX_COUNT = 100 // 常量使用大写字母和下划线

50. 使用适当的代码组织

错误写法：

// 所有代码都放在同一个文件中
data class User(val name: String, val email: String)
class UserAdapter(private val users: List<User>) : RecyclerView.Adapter<UserViewHolder>() {
    // 适配器代码
}

说明：不良的代码组织会导致代码难以理解和维护。

正确写法：

// model/User.kt
data class User(val name: String, val email: String)

// ui/adapter/UserAdapter.kt
class UserAdapter(private val users: List<User>) : RecyclerView.Adapter<UserViewHolder>() {
    // 适配器代码
}

BinbinWang's blog