AutoRegister 插件使用教程

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

AutoRegister 是一个基于字节码插桩的 Gradle 插件，用于在 Android 中实现跨模块自动注册，主要用于模块解耦。以下是项目的目录结构及各部分介绍：

AutoRegister/
├── app/                  # 示例应用模块
├── app_lib/              # 示例库模块
├── app_lib_interface/    # 示例接口模块
├── autoregister/         # 插件核心模块
├── gradle/wrapper/       # Gradle 包装器
├── .gitignore            # Git 忽略文件配置
├── LICENSE               # 许可证文件
├── README.md             # 项目说明文档
├── build.gradle          # 根项目构建脚本
├── gradle.properties     # Gradle 属性文件
├── gradlew               # Gradle 包装器脚本（Unix）
├── gradlew.bat           # Gradle 包装器脚本（Windows）
└── settings.gradle       # 项目设置脚本

主要目录介绍

• app/: 包含示例应用的源代码和资源文件。
• app_lib/: 包含示例库的源代码和资源文件。
• app_lib_interface/: 包含示例接口的源代码和资源文件。
• autoregister/: 插件的核心实现代码。
• gradle/wrapper/: 包含 Gradle 包装器的文件，用于确保项目使用特定版本的 Gradle。
• .gitignore: 配置 Git 忽略的文件和目录。
• LICENSE: 项目的许可证文件。
• README.md: 项目的说明文档。
• build.gradle: 根项目的构建脚本，包含插件的配置和依赖管理。
• gradle.properties: 包含 Gradle 构建的属性配置。
• gradlew 和 gradlew.bat: Gradle 包装器脚本，用于在不同操作系统上运行 Gradle。
• settings.gradle: 项目的设置脚本，包含模块的包含和排除配置。

2、项目的启动文件介绍

AutoRegister 插件的启动文件主要是 build.gradle 文件，该文件位于项目的根目录下。以下是启动文件的主要内容和作用：

// 应用插件
apply plugin: 'auto-register'

// 插件配置
autoregister {
    registerInfo = [
        [
            'scanInterface': 'com.billy.app_lib_interface.ICategory',
            'scanSuperClasses': ['com.billy.android.autoregister.demo.BaseCategory'],
            'codeInsertToClassName': 'com.billy.app_lib_interface.CategoryManager',
            'registerMethodName': 'register'
        ],
        [
            'scanInterface': 'com.billy.app_lib.IOther',
            'codeInsertToClassName': 'com.billy.app_lib.OtherManager',
            'codeInsertToMethodName': 'init',
            'registerMethodName': 'registerOther'
        ]
    ]
}

主要配置项介绍

• apply plugin: 'auto-register': 应用 AutoRegister 插件。
• autoregister { registerInfo = [...] }: 配置插件的注册信息，包括扫描接口、扫描父类、插入代码的类和方法等。

3、项目的配置文件介绍

AutoRegister 插件的配置文件主要是 build.gradle 文件和 gradle.properties 文件。以下是配置文件的主要内容和作用：

build.gradle

// 应用插件
apply plugin: 'auto-register'

// 插件配置
autoregister {
    registerInfo = [
        [
            'scanInterface': 'com.billy.app_lib_interface.ICategory',
            'scanSuperClasses': ['com.billy.android.autoregister.demo.BaseCategory'],
            'codeInsertToClassName': 'com.billy.app_lib_interface.CategoryManager',
            'registerMethodName': 'register'
        ],
        [
            'scanInterface': 'com.billy.app_lib.IOther',
            'codeInsertToClassName': 'com.billy.app_lib.OtherManager',
            'codeInsertToMethodName': 'init',
            'registerMethodName':