开源项目 `routing-compose` 使用教程

开源项目 routing-compose 使用教程

routing-composeRouting feature for Compose Web and Desktop项目地址:https://gitcode.com/gh_mirrors/ro/routing-compose

1. 项目的目录结构及介绍

routing-compose 项目的目录结构如下：

routing-compose/
├── src/
│   ├── main/
│   │   ├── kotlin/
│   │   │   ├── com/
│   │   │   │   ├── example/
│   │   │   │   │   ├── Main.kt
│   │   │   │   │   ├── Router.kt
│   │   │   │   │   ├── HashRouter.kt
│   │   │   │   │   ├── BrowserRouter.kt
│   │   │   │   │   ├── DesktopRouter.kt
│   │   │   │   │   ├── Screen.kt
│   │   │   │   │   ├── ...
│   │   │   │   ├── ...
│   │   │   ├── ...
│   │   ├── resources/
│   │   │   ├── application.conf
│   │   │   ├── ...
│   │   ├── ...
│   ├── test/
│   │   ├── kotlin/
│   │   │   ├── com/
│   │   │   │   ├── example/
│   │   │   │   │   ├── RouterTest.kt
│   │   │   │   │   ├── ...
│   │   │   ├── ...
│   │   ├── ...
│   ├── ...
├── build.gradle.kts
├── settings.gradle.kts
├── README.md
├── LICENSE
├── ...

目录结构介绍

• src/main/kotlin/com/example/：包含项目的主要源代码文件，如 Main.kt、Router.kt 等。
• src/main/resources/：包含项目的配置文件，如 application.conf。
• src/test/kotlin/com/example/：包含项目的测试代码文件，如 RouterTest.kt。
• build.gradle.kts 和 settings.gradle.kts：Gradle 构建脚本文件。
• README.md 和 LICENSE：项目的说明文档和许可证文件。

2. 项目的启动文件介绍

项目的启动文件是 Main.kt，位于 src/main/kotlin/com/example/Main.kt。该文件包含了项目的主入口点，负责初始化路由和启动应用。

package com.example

import androidx.compose.runtime.Composable
import androidx.compose.ui.platform.LocalUriHandler
import androidx.compose.ui.window.Window
import androidx.compose.ui.window.application

fun main() {
    application {
        Window(onCloseRequest = ::exitApplication) {
            App()
        }
    }
}

@Composable
fun App() {
    val router = Router.current
    val uriHandler = LocalUriHandler.current

    router.render {
        when (it) {
            "/profile" -> ProfileScreen()
            "/friendslist" -> FriendsListScreen()
            else -> NoMatchScreen()
        }
    }
}

启动文件介绍

• main 函数：应用的入口点，启动一个窗口并调用 App 函数。
• App 函数：定义了应用的主要界面和路由逻辑。
• Router.current：获取当前的路由实例。
• when 表达式：根据不同的路由路径渲染不同的界面。

3. 项目的配置文件介绍

项目的配置文件是 application.conf，位于 src/main/resources/application.conf。该文件使用 HOCON 格式，用于配置应用的一些基本参数。

routing {
    strategy = "hash"
    baseUrl = "/"
}

logging {
    level = "info"
}

配置文件介绍

• routing 部分：配置路由策略和基础 URL。
  • strategy：路由策略，可以是 hash、browser 或 desktop。
  • baseUrl：应用的基础 URL。
• logging 部分：配置日志级别。
  • level：日志级别，可以是 info、debug、warn 或 error。

以上是 `routing-

routing-composeRouting feature for Compose Web and Desktop项目地址:https://gitcode.com/gh_mirrors/ro/routing-compose