XModulable 开源项目使用手册

XModulable 开源项目使用手册

XModulable 组件化/模块化 项目地址: https://gitcode.com/gh_mirrors/xm/XModulable

1. 目录结构及介绍

XModulable 是一个旨在实现组件化/模块化的Android项目模板。其结构设计围绕着高内聚低耦合的原则，下面是该项目的核心目录结构概览：

XModulable/
├── idea               # IntelliJ IDEA相关的配置文件夹
├── app                # 主应用模块，通常作为模块间的协调者
├── arts               # 可能存放艺术或示例资源
├── basiclib           # 基础组件库，包含网络请求、图片加载等核心工具类
├── basicres          # 包含通用资源文件
├── common             # 公共层，提供模块间通信的基础服务接口
│   ├── AOP相关（缺失）# 缺失，理论上应包含面向切面编程的配置
│   ├── Service定义    # 如LiveService等服务接口
├── config             # 配置文件夹，特定配置可能存放于此
├── gradle             # Gradle构建脚本相关
│   └── wrapper        # Gradle Wrapper文件，保证一致的构建环境
├── im                 # 示例模块之一，如即时通讯模块
├── live               # 示例模块之一，包含直播功能的模块
├── main               # 核心业务逻辑或主要界面模块
├── .gitignore         # Git忽略文件配置
├── LICENSE            # 许可证文件，遵循Apache-2.0许可
└── README.md          # 项目简介和快速入门指南

每个业务模块（如im, live, main）都可以被设计为独立运行，通过控制gradle.properties中的isStandalone属性。

2. 项目的启动文件介绍

XModulable项目的启动过程并非直接指向某个单一的“启动文件”，而是涉及整个应用初始化流程。通常情况下，应用程序的启动是从app模块的MainActivity开始，但模块化的项目更侧重于模块的动态加载和注册过程。因此，重要的是初始化SDK和模块注册的部分，这可能在App的入口类或通过自定义的Application类中完成，例如通过调用XModulable.init(this)来初始化框架，并且如果有需要，会调用XModulable.openDebug()来开启调试模式。

public class MyApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        if (isDebugMode()) {
            XModulable.openDebug();
        }
        XModulable.init(this);
        // 模块间的注册逻辑可能会在这里扩展
    }

    private boolean isDebugMode() {
        return BuildConfig.DEBUG;
    }
}

3. 项目的配置文件介绍

Gradle 配置

• 全局Gradle配置 (settings.gradle): 引入所有子模块。
• 模块级Gradle配置 (app/build.gradle, basiclib/build.gradle 等): 指定了依赖关系、插件应用、编译选项等。例如，使用implementation或api指定对XModulable的依赖，以及对XModulable-compiler的注解处理器配置。

dependencies {
    implementation 'com.xpleemoon.xmodulable:XModulable-api:<version>'
    annotationProcessor 'com.xpleemoon.xmodulable:XModulable-compiler:<version>'
}

项目内配置

• 模块独立性配置: 在项目根目录的build.gradle中定义了ext.modules，标识每个模块是否独立运行及其相应的applicationId。

ext {
    modules = [
        main: [isStandalone: false],
        im: [isStandalone: false],
        live: [isStandalone: true]
    ]
}

• 特定模块配置: 每个模块可能有自己的特定配置，例如源码路径(sourceSets)调整以适应独立运行需求。

通过上述的结构和配置，XModulable项目为Android开发者提供了良好的模块化开发范式，有利于管理和维护大规模的项目结构。

XModulable 组件化/模块化 项目地址: https://gitcode.com/gh_mirrors/xm/XModulable