Skip to content

Latest commit

 

History

History
195 lines (159 loc) · 7.45 KB

README.md

File metadata and controls

195 lines (159 loc) · 7.45 KB
Raw

福uu Kotlin MultiPlatform 客户端

项目信息

本项目由学长的试验项目FuTalk发展而来，因此项目中会出现此关键字，我们会在后期进行统一。

签名文件的配置：请在项目根目录创建android-sign.properties文件，示例内容如下：

file=/path/to/your/key.jks
keyPassword=keyPassword
alias=alias
password=storePassword

代码格式化

本项目通过 ktfmt 对 kotlin 文件格式化。 由于使用 compose 会导致源码中包含大量缩进，因此对 .kt 文件使用 2 空格缩进。 对于 .kts 文件，使用默认的 4 空格缩进，考虑到一些因素，不对其强制要求执行格式化规则。

IDE 插件

ktfmt 提供了 IDE 插件 用于复写 IDE 的代码格式化功能。 由于无法分别配置 kt 和 kts 文件的格式化策略，所以不建议使用。

editorconfig

本项目提供了 .editorconfig，它在 IDEA 和 Android Studio 上应该开箱即用。

pre-commit

本项目提供了 pre-commit hooks 配置。

# 直接使用 pip 安装 pre-commit 框架
pip install pre-commit
# 设置 git hooks 脚本
pre-commit install
# 立即进行全文件检查
pre-commit run --all-files

gradle task

# 检查代码格式化
gradlew ktfmtCheck
# 修复代码格式化
gradlew ktfmtFormat

Kotlin Multiplatform

Get started with Kotlin Multiplatform | Kotlin Multiplatform Development Documentation (jetbrains.com)

Compose Multiplatform

Compose Multiplatform 入门 — 教程 |Kotlin 多平台开发文档 (jetbrains.com)

项目结构

image-20240516010640404

image-20240516012202645

为了保证可维护性，项目将最大限度的减少ios端的代码，尽量使用跨平台库或逻辑

image-20240516012916445

  • config 部分参数设置
  • dao 与数据库 key_value 的交互
  • data 负责依赖注入网络请求序列化的类
  • di 负责依赖注入
  • repository 仓库层
  • ui 负责ui编写
  • image-20240516013314655
    • compose 该目录下的每个文件夹都代表一个功能，一个主界面 每个文件夹包括ui和viewModel
  • root 根ui
  • buildBridge 负责逻辑的特别平台特别实现
  • util 工具类

架构

image-20240516012703681

仓库层

仓库层包含大部分的网络逻辑和数据逻辑，所有的网络逻辑必须用flow来包装，来供viewModel使用，

ViewModel

viewModel处理大部分的逻辑，并为ui提供了网络访问能力，它时仓库层和ui层的桥梁，同时它应存储网络请求的状态，来通知ui更新 其中的网络状态应使用flow 网络请求的状态应该禁止ui直接更改，而是依赖viewModel的内部函数来完成，ui仅仅只有监听的权力

UI

主要采用voyager，ui应时刻考虑自适应的屏幕大小，voyager类的参数要特别关注，因为voyager可能为其序列化，请用注解标记他们跳过序列化 ui应主要负责ui的绘画而将逻辑委托给viewModel层，ui应只保留非常重要的参数，以便他们可以在任何地方重新使用

沉浸式效果

对于的任何继承voyager 的screen 或 tab 应该有parentPaddingControl 参数，用来传递父布局对于子布局的上下padding控制 子布局对于父布局的约束进行自定义，理论上来说，父布局除了topbar和底部栏外应该给予子布局足够的自定义权限，而子布局对于父布局的约束有履行的义务，但是对于部分特殊布局，子布局仍可以无视父布局的约束， 但这必须用注释来为接下来的开发者提示

网络请求

  1. 用ktor写出网络请求的逻辑

    val response = client.submitForm(
                url = "/emptyRoom/available",
                formParameters = parameters {
                    append("Campus",campus)
                    append("Build",build)
                    append("RoomType",roomType)
                    append("Date",date)
                    append("Start",start)
                    append("End",end)
                }
            ).body<EmptyRoomData>()

  2. flow包装

    fun availableEmptyRoom(
        campus:String,
        date:String,
        roomType:String,
        start:String,
        end:String,
        build:String,
    ):Flow<EmptyRoomData>{
        return flow {
            val response = client.submitForm(
                url = "/emptyRoom/available",
                formParameters = parameters {
                    append("Campus",campus)
                    append("Build",build)
                    append("RoomType",roomType)
                    append("Date",date)
                    append("Start",start)
                    append("End",end)
                }
            ).body<EmptyRoomData>()
            emit(response)
        }
    }

  3. viewModel 处理

    private val _availableEmptyRoomData = CMutableStateFlow(MutableStateFlow<NetworkResult<Map<String, List<EmptyRoom>?>?>>(NetworkResult.UnSend()))
    val availableEmptyRoomData = _availableEmptyRoomData.asStateFlow()

    fun getAvailableEmptyRoomData(
        campus:String,
        date:String,
        roomType:String,
        start:String,
        end:String,
        build:String,
    ){
        viewModelScope.launchInDefault {
            _availableEmptyRoomData.logicIfNotLoading {
                emptyHouseRepository.availableEmptyRoom(
                    campus = campus,
                    date = date,
                    roomType = roomType,
                    start = start,
                    end = end,
                    build = build,
                ).actionWithLabel(
                    "availableEmptyRoomData/availableEmptyRoom",
                    catchAction = { label, error ->
                        _availableEmptyRoomData.resetWithLog(label, networkErrorWithLog(error,"获取空教室失败"))
                    },
                    collectAction = { label, data ->
                        _availableEmptyRoomData.resetWithLog(label,data.toNetworkResult())
                    }
                )
            }
        }
    }

  4. 等待ui调用

    emptyHouseVoyagerViewModel.getAvailableEmptyRoomData(
                                  campus = selectCampus.value,
                                  date = dateForSend,
                                  roomType = "普通教室",
                                  start = startClass.value.toString(),
                                  end = endClass.value.toString(),
                                  build = buildForSend
                              )

  5. 注：大部分的网络请求都要设置一个state，类型为 NetworkResult接口，NetworkResult有四个实现 Success，Loading，Error，UnSend，根据网络请求结果不同设置不同的值，通过绑定toast或者监听来更新ui