Android MVVM 项目技术文档

Android MVVM 项目技术文档

1. 安装指南

1.1 环境准备

在开始使用本项目之前，请确保您的开发环境满足以下要求：

• Android Studio 3.0 或更高版本
• Android SDK 21 或更高版本
• Gradle 4.1 或更高版本

1.2 依赖库

本项目依赖于以下库，请在您的 build.gradle 文件中添加这些依赖：

dependencies {
    implementation 'androidx.appcompat:appcompat:1.3.1'
    implementation 'androidx.databinding:databinding-runtime:4.1.3'
    implementation 'io.reactivex.rxjava2:rxjava:2.2.21'
    implementation 'io.reactivex.rxjava2:rxandroid:2.1.1'
}

1.3 配置 Data Binding

确保在您的 build.gradle 文件中启用了 Data Binding：

android {
    ...
    dataBinding {
        enabled = true
    }
}

2. 项目的使用说明

2.1 项目结构

本项目采用 MVVM 架构，主要分为以下几个部分：

• Model: 负责数据的获取和处理。
• View: 负责用户界面的展示。
• ViewModel: 作为 View 和 Model 之间的桥梁，处理业务逻辑。

2.2 快速入门

请参考项目中的 Documentation/GettingStarted.md 文件，了解如何设置库并理解其功能。

2.3 MVVM 实现

本项目使用 Data Binding 技术，确保 View 中只包含一个变量 vm，即 ViewModel。ViewModel 应包含所有显示 View 所需的信息。多个 View 可以共享同一个 ViewModel，从而实现功能的复用。

3. 项目 API 使用文档

3.1 ViewModel 绑定

在 onCreate 方法中配置 ViewModel 绑定：

BindingUtils.setDefaultBinder(new ViewModelBinder() {
    @Override
    public void bind(ViewDataBinding viewDataBinding, ViewModel viewModel) {
        viewDataBinding.setVariable(BR.vm, viewModel);
    }
});

3.2 创建 ViewModel

ViewModel 是一个简单的 POJO，包含用于存储数据（输入/输出）和事件监听器的字段。

3.2.1 输出数据

输出数据存储在 ViewModel 类中，可以是常量或可变数据：

public class OutputDataViewModel {
  public final String constantOutput = "";
  public final ObservableField<String> changingOutput = new ObservableField<String>("");
}

3.2.2 输入数据

输入数据始终存储为 ObservableField<TYPE>：

public class InputDataViewModel {
  public final ObservableField<String> inputText = new ObservableField<String>("");
}

3.2.3 输入事件

事件监听器可以简单地实现为 ViewModel 中的方法：

public class EventViewModel {
  MessageHelper messageHelper; // 外部依赖

  public void onClick() {
    messageHelper.show("Something got clicked");
  }  
}

3.3 使用 RxJava

RxJava 提供了丰富的操作符来处理数据变化。例如，可以使用 map 操作符来格式化数据：

public final ReadOnlyField<String> totalAmountText;
public CartViewModel(Cart cart) {
  totalAmountText = FieldUtils.toField(cart.getTotalAmount().map(a -> a + " Rs"));
}

4. 项目安装方式

4.1 克隆项目

首先，从 GitHub 克隆项目到本地：

git clone https://github.com/manas-chaudhari/android-mvvm.git

4.2 导入项目

使用 Android Studio 打开克隆的项目，等待 Gradle 同步完成。

4.3 运行项目

在 Android Studio 中，点击 Run 按钮，选择您的设备或模拟器来运行项目。

通过以上步骤，您可以成功安装并运行本项目，开始使用 MVVM 架构进行 Android 应用开发。