Rosie 项目启动与配置教程

1. 项目目录结构及介绍

Rosie 是一个为了帮助开发者遵循 Clean Architecture 原则来创建 Android 应用的框架。项目目录结构如下：

• app/: 包含了应用的主要代码，包括 Java 类、资源文件等。
• config/: 存放配置文件，如 Checkstyle 配置。
• gradle/: 存放 Gradle 构建脚本和_wrapper文件。
• sample/: 包含了一个示例应用，展示了如何使用 Rosie。
• build.gradle: 项目级别的 Gradle 构建脚本。
• gradlew 和 gradlew.bat: Gradle 命令行工具的包装器脚本，分别用于 Unix 和 Windows 系统。
• settings.gradle: 初始化项目时被 Gradle 用于配置设置。
• .gitignore: 指定 Git 忽略的文件和目录。
• CONTRIBUTING.md: 提供贡献指南。
• LICENSE: 项目许可证文件。
• README.md: 项目描述和文档。
• _config.yml: 可能用于项目文档的配置文件。

2. 项目的启动文件介绍

要启动这个项目，首先确保你已经设置了 Android 开发环境，并且安装了 Android Studio。

• 在 Android Studio 中导入项目：File -> Open -> [选择项目目录]
• 检查 app/build.gradle 文件确保所有的依赖都已正确配置。
• 在 SampleApplication.java 文件中，确保你的应用类继承了 RosieApplication 类，并且正确配置了依赖注入模块。

public class SampleApplication extends RosieApplication {
    @Override
    protected List<Object> getApplicationModules() {
        return Arrays.asList(new SampleGlobalModule());
    }
}

• 运行示例应用：在 Android Studio 中选择 sample 模块，然后点击运行按钮。

3. 项目的配置文件介绍

项目的配置主要通过以下几个文件进行：

• build.gradle: 这个文件定义了项目的构建逻辑，包括项目的编译选项、依赖管理以及任务。

// Top-level build file where you can add configuration options common to all sub-projects/modules.
buildscript {
    repositories {
        google()
        jcenter()
    }
    dependencies {
        classpath "com.android.tools.build:gradle:3.6.4"
        // NOTE: Do not place your application dependencies here; they belong
        // in the individual module build.gradle files
    }
}

allprojects {
    repositories {
        google()
        jcenter()
    }
}

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

• settings.gradle: 这个文件用于配置 Gradle 的 settings，包括声明所有项目模块。

include ':app'

• config/checkstyle.xml: 这个文件定义了 Checkstyle 的配置，用于维护代码格式和规范。

确保在使用之前，检查并配置这些文件以符合你的项目需求。