我写了款依赖检查的插件

简介: 我写了款依赖检查的插件

写这款工具主要是看了优酷的几篇 向工程腐化开炮 的系列文章,觉得其中的几个点可以通过依赖检查的方式提前找到问题,所以着手找了几个点写了下,并输出 report html 方便查看。


一、检查


目前该检查工具提供了 5 项内容的检查:


  • so 文件检查
  • 64 位 so 未适配检查
  • 更安全的导出组件检查
  • 未匹配的权限检查
  • uses-sdk 检查


1、so 文件检查


so 文件检查可以分析出依赖里面包含了多少个 so 文件,并且展示 so 大小,做这个可以辅助 apk 包体积优化来提前分析,哪些 so 文件过大,并且这个 so 文件属于哪个依赖,然后根据依赖找到开发责任人进行沟通,如下是检查结果展示:

image.png

2、64 位 so 未适配检查


Google Play 自 2019 年 8 月 1 日起就强制应用必须支持 64 位 架构,但国内的应用市场会相对应的滞后:


平台 32 位库文件夹 64 位库文件夹
ARM lib/armeabi-v7a lib/arm64-v8a
x86 lib/x86 lib/x86_64

对于我们工具的检查,只需要遍历获取 32 位 so 的文件名称,然后去查下这个文件在 64 位的目录下存不存在,如果存在,说明该 so 支持,反之不支持,检测效果如下:

image.png

3、更安全的导出组件检查


Android 12 的适配中,如果 activity、received 和 service 有使用 intent-filter,则必须显示申明 exported 的值,否则应用将无法在搭载 Android 12 或更高版本的设备上进行安装。工具检测效果如下:

image.png

4、未匹配的权限检查

在我们的应用开发中,会对所有的权限申明进行管控,每个敏感权限的申请都需要经过团队的把关,也即意味着权限不能乱申请和乱用。所以,我们需要事先申明好一份白名单配置,在检查依赖的过程中,如果依赖中的 AndroidManifest.xml 申明的权限不在这个白名单中,则会提示该依赖使用了白名单之外的敏感权限,需要进行确认。工具检测效果如下:

image.png

5、uses-sdk 检查


manifest 中一些全局性配置,对 apk 安装和运行时行为具有重要影响,最为典型的就是 minSdkVersion和 targetSdkVersion,一旦非预期变更被带到线上,后果不堪设想。

检查工具会检查如果与白名单的配置不一致,则会输出结果:

image.png

二、使用


如果想体验 demo 的话,可以直接执行命令:


./gradlew checkDependency -Pbuild=debug


他会在 build 的 checkPlugin 目录输出 html 报告文件,用浏览器打开即可预览:

image.png

当然,你也可以直接查看 demo 输出的报告,我已经给仓库开通了 github pages,html 浏览地址为 mrwangqi.github.io/pluginDemo/

1、接入


尝试过几次在 jitpack 发布 gradle 插件,经常会报莫名的错误,所以,就不打算对外发布插件了,如果想用到自己项目的话,可以发布到 maven local,展开 task 点击 publish 发布到本地:


image.png

然后在在自己项目的 build.gradle 中配置 mavenLocal 镜像源和依赖,示例如下:


buildscript {
    repositories {
        ...
        // 配上本地 maven 源
        mavenLocal()
    }
    dependencies {
        classpath "com.android.tools.build:gradle:7.0.4"
        // 依赖 check 插件,版本号可以发布本地 maven 之前修改
        classpath "com.github.MRwangqi:checkPlugin:1.0.0"
    }
}
复制代码


然后在 app 工程的 build.gradle 中依赖插件,并且在工程下面配置白名单文件:


plugins {
    id 'com.android.application'
    // apply check 插件
    id 'checkPlugin'
}
check{
    // 配置白名单
    manifestWhiteFile="ManifestWhite.xml"
}
复制代码


ManifestWhite.xml 文件如下:


<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.codelang.includebuildingdemo">
    <!--  插件会读取 uses-sdk ,如果分析出的依赖不等于 targetSdk 或是如果不等 minSDK 则会输出分析-->
    <uses-sdk android:minSdkVersion="14" android:targetSdkVersion="30" />
    <!--  插件会读取 uses-permission ,如果分析出的依赖权限不在下面则会输出分析-->
    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
</manifest>
复制代码


2、使用


执行命令模板如下:


./gradlew checkDependency -Pbuild=${build variant}

要执行的 build variant 可以在 Android studio 中查看:

image.png

比如我们要检查 debug 的依赖分析,则命令如下:

./gradlew checkDependency -Pbuild=debug

当然,也可以直接使用如下命令进行检查,插件默认的 build variant 是 debug

./gradlew checkDependency

三、原理


原理很简单,就是从 configurations 中拿到继承自 implements 的 CompileClassPath configuration,然后通过 asPath 方法拿到所有依赖缓存到本地的路径,然后解析依赖拿到文件和内容进行分析,然后产出报告,具体可以查看源码。


四、总结:


基于工程腐化系列的文章其实可以做很多的检查,比如混淆章节中:


layout 中引用不存在的 class 需要进行检查,而且在 apk 编译过程中,并不会引发构建失败,但依然会生成相对应的keep规则,并且这个layout 一旦在运行时被“加载“,那么会引发 Java 类找不到的异常


其他的实现就交给大家自己发挥实现了,最后附上源码地址:

github.com/MRwangqi/pl…

向工程腐化开炮系列:

目录
相关文章
|
7月前
自动检查以确保依赖项始终与使用的electron版本相匹配的小技巧
自动检查以确保依赖项始终与使用的electron版本相匹配的小技巧
110 0
|
3天前
|
缓存 Java Maven
【简单四步教你解决♥十分有效】Maven依赖报错、依赖或插件导入失败的万能解决办法
【简单四步教你解决♥十分有效】Maven依赖报错、依赖或插件导入失败的万能解决办法!在处理Maven项目问题时,首先检查Maven配置是否正确。接着通过“File--Invalidata Caches”清除IDEA缓存并重启。使用Maven命令`mvn dependency:purge-local-repository`和`mvn dependency:resolve`清除本地依赖缓存。最后,在Terminal中输入`mvn clean install`完成构建。
【简单四步教你解决♥十分有效】Maven依赖报错、依赖或插件导入失败的万能解决办法
|
2月前
|
Java Spring
Gradle 如何确保依赖的版本兼容性
Gradle 通过依赖管理机制确保版本兼容性,使用声明式配置定义项目依赖,自动解析和下载所需库。它支持版本范围和动态版本,通过冲突解决策略选择最佳版本,保证构建的一致性和可靠性。
183 3
|
jenkins 持续交付
Manage Jenkins管理界面提示“依赖错误: 部分插件由于缺少依赖无法加载...“问题解决办法
Manage Jenkins管理界面提示“依赖错误: 部分插件由于缺少依赖无法加载...“问题解决办法
1302 0
Manage Jenkins管理界面提示“依赖错误: 部分插件由于缺少依赖无法加载...“问题解决办法
|
6月前
|
Java Maven
maven执行 打包时报错提示:不再支持源选项 5。请使用 7 或更高版本。
maven执行 打包时报错提示:不再支持源选项 5。请使用 7 或更高版本。
100 0
|
7月前
|
Java Maven
Maven【3】( 依赖的范围,传递性和依赖的排除)(命令行操作)
Maven【3】( 依赖的范围,传递性和依赖的排除)(命令行操作)
74 0
|
7月前
|
JSON 前端开发 JavaScript
如何检查前端项目中未使用的依赖包?
如何检查前端项目中未使用的依赖包?
281 0
|
7月前
|
Java Maven
依赖版本与环境冲突问题
切换依赖版本需要刷新maven文件夹 !
71 0
|
JSON JavaScript 数据格式
如何使用depcheck检查依赖?
如何使用depcheck检查依赖?
如何使用depcheck检查依赖?
|
Java Maven
tomocat7插件不能用,报错
tomocat7插件不能用,报错
tomocat7插件不能用,报错