告别混乱代码：Android Architecture Samples的Kotlin编码规范与最佳实践-优快云博客

告别混乱代码：Android Architecture Samples的Kotlin编码规范与最佳实践

【免费下载链接】architecture-samples A collection of samples to discuss and showcase different architectural tools and patterns for Android apps. 项目地址: https://gitcode.com/gh_mirrors/ar/architecture-samples

版权与许可声明规范

所有源代码文件必须包含标准的版权和许可声明头部。Android Architecture Samples采用Apache License 2.0协议，声明模板位于spotless/copyright.kt和spotless/copyright.xml。

/*
 * Copyright $YEAR The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

<?xml version="1.0" encoding="utf-8"?>
<!--
     Copyright $YEAR The Android Open Source Project

     Licensed under the Apache License, Version 2.0 (the "License");
     you may not use this file except in compliance with the License.
     You may obtain a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

     Unless required by applicable law or agreed to in writing, software
     distributed under the License is distributed on an "AS IS" BASIS,
     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     See the License for the specific language governing permissions and
     limitations under the License.
-->

命名约定与代码风格

类与函数命名

项目采用清晰的命名约定，确保代码可读性：

类名使用PascalCase，如TasksViewModel、FilteringUiInfo
函数名使用camelCase，如setFiltering()、clearCompletedTasks()
常量使用UPPER_SNAKE_CASE，如TASKS_FILTER_SAVED_STATE_KEY

以app/src/main/java/com/example/android/architecture/blueprints/todoapp/tasks/TasksViewModel.kt为例：

// 类名使用PascalCase
@HiltViewModel
class TasksViewModel @Inject constructor(
    private val taskRepository: TaskRepository,
    private val savedStateHandle: SavedStateHandle
) : ViewModel() {
    // 常量使用UPPER_SNAKE_CASE
    const val TASKS_FILTER_SAVED_STATE_KEY = "TASKS_FILTER_SAVED_STATE_KEY"
    
    // 函数名使用camelCase
    fun setFiltering(requestType: TasksFilterType) {
        savedStateHandle[TASKS_FILTER_SAVED_STATE_KEY] = requestType
    }
}

代码格式化规则

使用4个空格缩进，不使用Tab
每行代码长度控制在100字符以内
函数之间保留一个空行
控制流语句（if/for/while）的花括号必须另起一行

架构分层编码实践

Android Architecture Samples采用清晰的架构分层，每个模块有明确的职责边界：

数据层编码规范

数据层包含数据模型和仓库实现，如app/src/main/java/com/example/android/architecture/blueprints/todoapp/data/目录下的代码：

数据类使用data class关键字，只包含数据字段和简单的辅助方法
仓库接口以Repository结尾，实现类以Default为前缀
数据源接口区分本地和网络，如TaskDao(本地)和NetworkDataSource(网络)

// 数据模型示例
data class Task(
    val id: String = "",
    val title: String = "",
    val description: String = "",
    val isCompleted: Boolean = false
)

// 仓库接口示例
interface TaskRepository {
    suspend fun getTasks(): List<Task>
    suspend fun getTask(taskId: String): Task?
    suspend fun saveTask(task: Task)
    suspend fun completeTask(taskId: String)
    suspend fun activateTask(taskId: String)
    suspend fun clearCompletedTasks()
    suspend fun deleteAllTasks()
    suspend fun deleteTask(taskId: String)
}

领域层编码规范

领域层包含业务逻辑，如app/src/main/java/com/example/android/architecture/blueprints/todoapp/tasks/TasksViewModel.kt：

ViewModel类以ViewModel结尾
UI状态使用UiState后缀的数据类封装
使用Flow处理数据流，遵循响应式编程范式
协程作用域使用viewModelScope

// UI状态封装示例
data class TasksUiState(
    val items: List<Task> = emptyList(),
    val isLoading: Boolean = false,
    val filteringUiInfo: FilteringUiInfo = FilteringUiInfo(),
    val userMessage: Int? = null
)

// ViewModel实现示例
@HiltViewModel
class TasksViewModel @Inject constructor(
    private val taskRepository: TaskRepository,
    private val savedStateHandle: SavedStateHandle
) : ViewModel() {
    // 使用Flow处理数据流
    val uiState: StateFlow<TasksUiState> = combine(
        _filterUiInfo, _isLoading, _userMessage, _filteredTasksAsync
    ) { filterUiInfo, isLoading, userMessage, tasksAsync ->
        // 状态转换逻辑
    }
    .stateIn(
        scope = viewModelScope,
        started = WhileUiSubscribed,
        initialValue = TasksUiState(isLoading = true)
    )
}

UI层编码规范

UI层使用Jetpack Compose构建，如app/src/main/java/com/example/android/architecture/blueprints/todoapp/tasks/TasksScreen.kt：

组合函数以大写字母开头，如TasksScreen()
UI状态通过ViewModel的StateFlow提供
事件处理使用lambda表达式，遵循单向数据流原则

自动化代码质量检查

项目使用Spotless和静态分析工具确保代码质量：

Spotless配置

spotless/copyright.kt: Kotlin文件版权模板
spotless/copyright.xml: XML文件版权模板
spotless/copyright.kts: Spotless配置脚本

运行以下命令检查并修复代码格式问题：

./gradlew spotlessApply

代码审查流程

根据CONTRIBUTING.md，所有代码提交必须经过审查：

通过Pull Request提交代码
至少需要一名项目成员批准
所有自动化测试必须通过
代码必须符合项目编码规范

总结与实践建议

Android Architecture Samples的编码规范确保了代码的可读性、可维护性和一致性。要在实际项目中应用这些规范：

从项目初始化阶段就引入自动化代码检查工具
为团队创建编码规范文档，并定期更新
将编码规范检查集成到CI/CD流程中
定期进行代码审查，关注编码规范的遵守情况

官方文档：README.md

项目架构图：

通过遵循这些编码规范和最佳实践，你的Android项目将更加专业、易维护，团队协作效率也将大幅提升。

创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考