Sandwich: 轻量级API处理库的快速上手指南

Sandwich: 轻量级API处理库的快速上手指南

sandwich 🥪 Sandwich is an adaptable and lightweight sealed API library designed for handling API responses and exceptions in Kotlin for Retrofit, Ktor, and Kotlin Multiplatform. 项目地址: https://gitcode.com/gh_mirrors/sa/sandwich

---

一、项目目录结构及介绍

Sandwich项目采用了标准的Kotlin多平台项目布局，确保了代码的组织性和易于导航。下面是其主要的目录结构及其简要说明：

sandwich/
├── build.gradle.kts           <- 项目的构建脚本
├── src/
│   ├── commonMain/             <- 共享代码，适用于所有平台（Kotlin多平台特性）
│       ├── kotlin/             <- 核心逻辑代码
│   ├── androidMain/            <- 专用于Android的额外代码
│   ├── jvmMain/                <- Java虚拟机运行时所需的代码
│   ├── jsMain/                 <- 如项目支持JavaScript，放置相关代码
│   └── nativeCommonMain/       <- 假设支持原生，存放跨平台代码
├── scripts/                   <- 工具脚本或自定义构建任务
├── gradle.properties          <- 构建属性配置
├── settings.gradle.kts        <- 项目设置，如子项目导入
├── README.md                  <- 项目介绍和快速入门文档
├── LICENSE                    <- 许可证文件
└── ...                        <- 其他辅助文件如gitignore, CODE_OF_CONDUCT等

重要文件解释:

• src/commonMain/kotlin: 存放核心库代码，确保在不同平台间共享。
• build.gradle.kts: Gradle构建脚本，配置依赖、编译选项等。
• README.md: 项目的主要文档，包括安装、使用方法等。

二、项目的启动文件介绍

Sandwich作为一个库，并没有传统的“启动文件”。不过，集成到应用中时，关键的接入点通常在于你首次调用它的API之处。这可能发生在你的应用服务初始化阶段或者某个特定功能模块的入口。例如，在Android项目中，你可能会在Application类或者某个网络请求发起的地方开始使用它，如：

// 示例：在应用启动时配置Retrofit并使用Sandwich
val retrofit = Retrofit.Builder()
    .baseUrl(BASE_URL)
    .addConverterFactory(SandwichAdapterFactory.create())
    .build()

val service = retrofit.create(MyApiService::class.java)

这里假设SandwichAdapterFactory.create()是用于将Sandwich的响应处理能力注入到Retrofit中，使你能够以统一的方式处理API响应和错误。

三、项目的配置文件介绍

对于配置，Sandwich的核心配置主要是通过Kotlin代码进行的，比如添加依赖、配置适配器工厂等，而不是通过外部配置文件。但是，你可以通过修改build.gradle.kts来控制项目的构建配置，包括依赖项、编译设置等。以下是示例配置段落，展示如何加入Sandwich依赖：

dependencies {
    implementation("com.github.skydoves:sandwich:2.0.10")
    implementation("com.github.skydoves:sandwich-retrofit:2.0.10")
    // 更多项目特定配置...
}

对于更具体的配置，比如全局错误处理策略或自定义映射器，这些通常在业务逻辑层通过Kotlin代码实现，而非独立配置文件。

---

以上就是对Sandwich项目的简单入门介绍，包括其基本结构、集成的关键点以及配置说明。进一步深入使用 Sandwitch 库时，详细阅读其官方文档是了解进阶特性的关键。

sandwich 🥪 Sandwich is an adaptable and lightweight sealed API library designed for handling API responses and exceptions in Kotlin for Retrofit, Ktor, and Kotlin Multiplatform. 项目地址: https://gitcode.com/gh_mirrors/sa/sandwich