McImage 项目使用教程

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

McImage 是一个用于 Android 项目的自动化图片压缩插件。以下是项目的目录结构及其介绍：

McImage/
├── gradle/
│   └── wrapper/
├── src/
│   └── main/
├── .gitignore
├── LICENSE
├── README-CN.md
├── README.md
├── build.gradle
├── gradle.properties
├── gradlew
├── gradlew.bat
├── publish.gradle
└── mctools/

• gradle/ 和 gradle/wrapper/：包含 Gradle 包装器的配置文件。
• src/main/：项目的源代码目录。
• .gitignore：Git 忽略文件配置。
• LICENSE：项目许可证文件。
• README-CN.md 和 README.md：项目的中文和英文说明文档。
• build.gradle：项目的构建脚本。
• gradle.properties：Gradle 属性配置文件。
• gradlew 和 gradlew.bat：Gradle 包装器的可执行文件。
• publish.gradle：发布配置文件。
• mctools/：包含插件所需的工具文件夹。

2. 项目的启动文件介绍

McImage 项目的启动文件主要是 build.gradle 文件。以下是该文件的主要内容：

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath 'com.smallsoho.mobcase:McImage:1.5.1'
    }
}

apply plugin: 'McImage'

• buildscript 块：配置项目的构建脚本依赖。
• repositories：指定依赖的仓库。
• dependencies：指定构建脚本的依赖。
• apply plugin: 'McImage'：应用 McImage 插件。

3. 项目的配置文件介绍

McImage 插件的配置主要在 build.gradle 文件中进行。以下是配置示例：

McImageConfig {
    isCheckSize true // 是否进行图片大小超标的检查
    optimizeType "Compress" // 优化类型
    maxSize 1*1024*1024 // 图片大小超标的标准大小
    isWebpConvert true // 是否进行对图片的 webp 处理
    isJPGConvert true // 是否对 jpg 进行 webp 处理
    enableWhenDebug true // 是否在 debug 的时候启用插件
    isCheckSize true // 是否开启图片宽高检查
    maxWidth 500 // 如果开启图片宽高检查，默认的最大宽度
    maxHeight 500 // 如果开启图片宽高检查，默认的最大高度
    whiteList = [ "drawable-xxhdpi-v4/img_five_stars.png" ] // 默认为空，如果添加，对图片不进行任何处理
}

• isCheckSize：是否进行图片大小超标的检查。
• optimizeType：优化类型，例如 "Compress"。
• maxSize：图片大小超标的标准大小。
• isWebpConvert：是否进行对图片的 webp 处理。
• isJPGConvert：是否对 jpg 进行 webp 处理。
• enableWhenDebug：是否在 debug 的时候启用插件。
• isCheckSize：是否开启图片宽高检查。
• maxWidth 和 maxHeight：图片宽高检查的默认最大宽度和高度。
• whiteList：不进行任何处理的图片白名单。

以上是 McImage 项目的目录结构、启动文件和配置文件的介绍。希望这份教程能帮助你更好地理解和使用 McImage 插件。