Android Clean Architecture MVI Boilerplate 使用教程

Android Clean Architecture MVI Boilerplate 使用教程

android-clean-architecture-mvi-boilerplateA fork of our clean architecture boilerplate using the Model-View-Intent pattern项目地址:https://gitcode.com/gh_mirrors/an/android-clean-architecture-mvi-boilerplate

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

项目的目录结构如下：

android-clean-architecture-mvi-boilerplate/
├── cache/
├── data/
├── domain/
├── gradle/wrapper/
├── injection/
├── mobile-ui/
├── presentation/
├── remote/
├── .gitignore
├── .travis.yml
├── build.gradle
├── dependencies.gradle
├── gradlew
├── gradlew.bat
├── LICENSE.txt
├── README.md
└── settings.gradle

各目录介绍：

• cache/: 缓存层，使用 Room 进行数据缓存。
• data/: 数据层，处理数据逻辑。
• domain/: 领域层，包含业务逻辑和用例。
• gradle/wrapper/: Gradle 包装器相关文件。
• injection/: 依赖注入相关配置。
• mobile-ui/: 移动端 UI 相关代码。
• presentation/: 展示层，使用 ViewModel 和 MVI 模式。
• remote/: 远程数据源相关代码。
• .gitignore: Git 忽略文件配置。
• .travis.yml: Travis CI 配置文件。
• build.gradle: 项目构建配置文件。
• dependencies.gradle: 依赖管理配置文件。
• gradlew: Gradle 包装器脚本。
• gradlew.bat: Windows 下的 Gradle 包装器脚本。
• LICENSE.txt: 项目许可证文件。
• README.md: 项目说明文档。
• settings.gradle: Gradle 设置文件。

2. 项目的启动文件介绍

项目的启动文件位于 mobile-ui/src/main/java/org/buffer/android/boilerplate/mobile/ui/MainActivity.kt。

package org.buffer.android.boilerplate.mobile.ui

import android.os.Bundle
import androidx.appcompat.app.AppCompatActivity
import org.buffer.android.boilerplate.presentation.browse.BrowseBufferoosViewModel

class MainActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        // 初始化 ViewModel
        val viewModel = ViewModelProviders.of(this).get(BrowseBufferoosViewModel::class.java)
    }
}

MainActivity 是项目的入口 Activity，负责初始化 UI 和 ViewModel。

3. 项目的配置文件介绍

build.gradle

项目的根目录下的 build.gradle 文件包含了项目的构建配置：

// 项目构建配置
buildscript {
    ext.kotlin_version = '1.5.21'
    repositories {
        google()
        mavenCentral()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:7.0.0'
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
    }
}

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

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

dependencies.gradle

dependencies.gradle 文件用于管理项目的依赖：

ext {
    // 依赖版本管理
    kotlin_version = '1.5.21'
    androidx_version = '1.3.1'
    // 其他依赖版本...

    dependencies = [
        kotlin: "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version",
        appcompat: "androidx.appcompat:appcompat:$androidx_version",
        // 其他依赖...
    ]
}

settings.gradle

settings.gradle 文件用于配置项目的模块：

include ':cache', ':data', ':domain', ':injection', ':mobile-ui', ':presentation', ':remote'

以上是 Android Clean Architecture MVI Boilerplate 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。

android-clean-architecture-mvi-boilerplateA fork of our clean architecture boilerplate using the Model-View-Intent pattern项目地址:https://gitcode.com/gh_mirrors/an/android-clean-architecture-mvi-boilerplate