MVVMFrame快速入门指南

MVVMFrame快速入门指南

MVVMFrame🏰 MVVMFrame for Android 是一个基于Google官方推出的Architecture Components dependencies（现在叫JetPack）{ Lifecycle，LiveData，ViewModel，Room } 构建的快速开发框架。有了MVVMFrame的加持，从此构建一个MVVM模式的项目变得快捷简单。项目地址:https://gitcode.com/gh_mirrors/mv/MVVMFrame

1. 项目目录结构及介绍

MVVMFrame是一个基于Google JetPack构建的Android快速开发框架，其设计旨在简化MVVM架构模式下的项目搭建过程。下面是该框架的基本目录结构及其简介：

- MVVMFrame/
  ├── app/                    # 主应用模块，包含了示例代码和核心应用场景
    │   ├── src/              # 源码目录
    │       ├── main/         # 应用的主要代码
    │           ├── java/     # Java或Kotlin源码，包括ViewModel, Repository等
    │           └── res/      # 资源文件，如布局文件、字符串等
    │   ├── build.gradle      # 模块级别的构建配置文件
    ├── mvvmframe/             # 核心库模块，封装了MVVM常用组件和逻辑
    │   ├── src/main/...       # 包含核心功能的源码
    │   └── build.gradle      # 核心库的构建配置
  ├── build.gradle            # 项目顶级构建配置文件
  ├── README.md               # 项目介绍和快速入门文档
  ├── proguard-rules.pro      # ProGuard混淆规则文件
  └── settings.gradle        # 设置文件，指定要构建的模块

• app 目录包含了示例应用，是实践MVVMFrame框架的最佳起点，展示了如何结合各种JetPack组件。
• mvvmframe 是框架的核心库，提供了对Dagger-Hilt、Room等关键库的支持，简化MVVM的实现。

2. 项目的启动文件介绍

项目启动主要从app/src/main/java/下的主Activity开始。虽然具体的活动名称没有直接提供，但按照惯例，可能会有一个名为MainActivity的类作为应用程序入口点。此活动通常初始化Dagger-Hilt的组件，设置初始界面，以及通过ViewModel来管理UI相关的数据。例如：

// 假设的MainActivity示例
package com.example.mvvmframe

import androidx.appcompat.app.AppCompatActivity
import dagger.hilt.android.AndroidEntryPoint

@AndroidEntryPoint
class MainActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        
        // 初始化工作或者导航到主界面
    }
}

3. 项目的配置文件介绍

build.gradle (Project)

顶级的build.gradle文件包含项目级的依赖管理和构建脚本版本。重要的是配置JitPack.io作为远程仓库，以便能够获取到这个框架的最新版本。

buildscript {
    repositories {
        ...
        maven { url 'https://jitpack.io' } // 添加JitPack仓库
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:version'
        classpath 'com.google.dagger:hilt-android-gradle-plugin:2.51' // 如果使用Hilt，需要对应的插件版本
        // 其他依赖
    }
}

allprojects {
    repositories {
        google()
        mavenCentral()
        maven { url 'https://jitpack.io' } // 确保所有模块都能访问到JitPack上的依赖
    }
}

build.gradle (Module: app)

模块级别的配置文件需要引入MVVMFrame库依赖，以及任何必要的编译时注解处理器，比如Hilt和Kotlin KAPT。

plugins {
    id 'com.android.application'
    id 'kotlin-android'
    id 'kotlin-kapt' // 用于Kotlin注解处理
    id 'dagger.hilt.android.plugin' // Hilt插件
}

dependencies {
    implementation 'com.github.jenly1314:mvvmframe:3.0.0' // 替换为最新版
    kapt 'com.google.dagger:hilt-android:2.51' // Hilt注解处理器
    implementation 'androidx.hilt:hilt-lifecycle-viewmodel:latest.version' // 若使用ViewModel注入
}

请注意，这里的版本号应替换为实际发布的最新版本，或者遵循项目README.md中提供的版本说明进行更新。这样可以确保项目能够正确地集成MVVMFrame并利用其特性。

MVVMFrame🏰 MVVMFrame for Android 是一个基于Google官方推出的Architecture Components dependencies（现在叫JetPack）{ Lifecycle，LiveData，ViewModel，Room } 构建的快速开发框架。有了MVVMFrame的加持，从此构建一个MVVM模式的项目变得快捷简单。项目地址:https://gitcode.com/gh_mirrors/mv/MVVMFrame