Android MVVM 示例项目教程

Android MVVM 示例项目教程

本教程旨在引导您了解和使用 android-mvvm 开源项目。该项目展示了如何在Android应用中实施MVVM（Model-View-ViewModel）架构。接下来，我们将逐步探索项目的结构、关键文件及其用途。

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

android-mvvm/
|-- app                            # 应用模块主目录
    |-- src                         # 源码目录
        |-- main                     # 主代码分支
            |-- java                 # Java源码
                |-- com.example.androidmvvm   # 主包名
                    |-- activity           # 包含所有Activity文件
                    |-- adapter           # 数据适配器
                    |-- model             # Model层，数据处理和访问
                    |-- viewmodel         # ViewModel层，业务逻辑和数据绑定
                    |-- util              # 辅助工具类
            |-- res                   # 资源文件夹，包括布局文件、图片等
                |-- layout             # XML布局文件
                |-- drawable           # 图片资源
                |-- values              # 字符串、颜色等值定义
        |-- test                      # 测试代码分支
            |-- java                 # 测试源码
                |-- com.example.androidmvvm   # 测试包
|-- .gitignore                       # Git忽略文件配置
|-- build.gradle (Module: app)      # 应用模块的构建脚本
|-- README.md                        # 项目简介和说明文档
|-- gradle.properties                # Gradle属性配置
|-- settings.gradle                  # 项目设置文件

2. 项目的启动文件介绍

项目的主要入口通常位于 app/src/main/java/com/example/androidmvvm/activity 目录下，文件名为 MainActivity.java。此文件负责初始化UI以及关联对应的ViewModel。它通常是这样的结构：

package com.example.androidmvvm.activity;

import androidx.appcompat.app.AppCompatActivity;
import androidx.lifecycle.ViewModelProvider;

import android.os.Bundle;
import android.view.View;
import android.widget.Button;
import android.widget.TextView;

import com.example.androidmvvm.viewmodel.MainViewModel;

public class MainActivity extends AppCompatActivity {

    private TextView textView;
    private Button button;
    private MainViewModel viewModel;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        viewModel = new ViewModelProvider(this).get(MainViewModel.class);
        
        // 初始化UI元素
        textView = findViewById(R.id.text_view);
        button = findViewById(R.id.button);
        
        // 绑定ViewModel的事件或数据变更到UI
        viewModel.getData().observe(this, text -> textView.setText(text));
        
        // 设置按钮点击事件
        button.setOnClickListener(v -> viewModel.updateData());
    }
}

这里，MainActivity 通过ViewModel来处理数据和UI更新逻辑，实现了业务逻辑和表示层的分离。

3. 项目的配置文件介绍

build.gradle (Module: app)

这是应用模块的构建配置文件，包含了项目的依赖声明、编译选项等重要信息。示例配置片段可能如下：

apply plugin: 'com.android.application'
apply plugin: 'kotlin-android'
apply plugin: 'kotlin-kapt'

android {
    compileSdkVersion 31
    defaultConfig {
        applicationId "com.example.androidmvvm"
        minSdkVersion 21
        targetSdkVersion 31
        versionCode 1
        versionName "1.0"
        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
    }
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }
}

dependencies {
    implementation 'androidx.core:core-ktx:1.6.0'
    implementation 'androidx.appcompat:appcompat:1.3.1'
    implementation 'com.google.android.material:material:1.4.0'
    implementation 'androidx.constraintlayout:constraintlayout:2.1.0'
    kapt 'androidx.databinding:databinding-compiler:7.1.0-alpha08' // 若使用Data Binding
    implementation 'androidx.lifecycle:lifecycle-viewmodel-ktx:2.3.1'
    implementation 'androidx.lifecycle:lifecycle-livedata-ktx:2.3.1'
    // 其他相关依赖...
}

此文件确保项目使用正确的Android SDK版本和库，同时也引入了MVVM架构中必要的依赖，如LiveData和ViewModel相关的库。

---

以上是对android-mvvm项目的简要概览，通过上述介绍，您可以初步了解项目结构、启动流程及核心配置，为进一步的学习和开发打下基础。记得根据实际项目情况进行适当调整和扩展。