Thrifty 项目启动与配置教程

1. 项目目录结构及介绍

Thrifty 项目是一个为 Android 优化的 Apache Thrift 实现。项目的目录结构如下：

thrifty/
├── .circleci/                # CircleCI 配置文件
├── .github/                  # GitHub Actions 工作流配置
├── build.gradle              # 项目构建文件
├── gradle.properties          # Gradle 属性配置文件
├── gradlew                   # Gradle Wrapper 脚本（Unix）
├── gradlew.bat               # Gradle Wrapper 脚本（Windows）
├── settings.gradle           # Gradle 设置文件
├── thrifty-compiler/         # Thrifty 编译器模块
├── thrifty-compiler-plugins/ # Thrifty 编译器插件模块
├── thrifty-example-postprocessor/ # 示例后处理器模块
├── thrifty-gradle-plugin/    # Thrifty Gradle 插件模块
├── thrifty-integration-tests/ # Thrifty 集成测试模块
├── thrifty-java-codegen/     # Thrifty Java 代码生成器模块
├── thrifty-kotlin-codegen/   # Thrifty Kotlin 代码生成器模块
├── thrifty-runtime/          # Thrifty 运行时模块
├── thrifty-schema/           # Thrifty 架构模块
├── thrifty-test-server/      # Thrifty 测试服务器模块
├── CHANGELOG.md              # 项目更新日志
├── CONTRIBUTING.md           # 贡献指南
├── LICENSE                   # 项目许可证
├── NOTICE                    # 项目通知文件
├── README.md                 # 项目介绍文件
├── SECURITY.md               # 安全策略文件

每个模块包含了该功能的相关代码和资源文件。

2. 项目的启动文件介绍

项目的启动主要通过 Gradle 进行。以下是一些主要的启动文件：

• gradlew 和 gradlew.bat：这两个是 Gradle Wrapper 脚本，用于简化构建过程。gradlew 用于 Unix 系统，而 gradlew.bat 用于 Windows 系统。
• build.gradle：这是项目的主构建文件，定义了项目的构建逻辑和依赖。
• settings.gradle：这是 Gradle 的设置文件，用于配置项目的多模块结构。

要启动项目，可以在项目根目录下执行以下命令：

./gradlew build

这将执行项目的构建过程，包括编译源代码和运行测试。

3. 项目的配置文件介绍

项目的主要配置文件如下：

• build.gradle：此文件用于定义项目的构建脚本。在这里，你可以添加依赖、配置构建任务、定义 Android 的编译选项等。
• gradle.properties：此文件包含了一些可以全局应用到所有子项目的 Gradle 属性。

以下是一个简单的 build.gradle 配置示例：

// Top-level build file where you can add configuration options common to all sub-projects/modules.
buildscript {
    repositories {
        google()
        mavenCentral()
    }
    dependencies {
        classpath "com.android.tools.build:gradle:7.0.2"
        // ANDROID_HOME path
        classpath "com.microsoft.thrifty:thrifty-gradle-plugin:3.1.0"
    }
}

allprojects {
    repositories {
        google()
        mavenCentral()
    }
}

task clean(type: Delete) {
    delete rootProject.buildDir
}

在 gradle.properties 文件中，你可以定义如 Gradle 版本、Java 版本等全局属性。

# Project-wide Gradle settings.
# IDE (e.g. Android Studio) users:
# Set this to the version of Gradle you want to use for this project. If you don't have this property set,
# the IDE will use the latest version of Gradle available for your project.
gradle_version=7.0.2

# Set this to the Java version you want to use for this project. It must be a valid Java version string, e.g. "11".
# If you don't specify this property, the Java version will be determined by the Android plugin.
java_version=11

通过这些配置文件，你可以根据项目的需求调整构建流程和项目设置。