我写了款依赖检查的插件

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

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

向工程腐化开炮系列:

目录
相关文章
|
消息中间件 负载均衡 流计算
gRPC ZeroMQ (ZMQ) D-Bus SOME/IP 通讯方式的比较
gRPC ZeroMQ (ZMQ) D-Bus SOME/IP 通讯方式的比较
850 3
|
监控 JavaScript 数据可视化
FineReport 11 在线学习
FineReport 11 在线学习
251 7
|
SpringCloudAlibaba API 开发者
新版-SpringCloud+SpringCloud Alibaba
新版-SpringCloud+SpringCloud Alibaba
|
Python
【Leetcode刷题Python】53. 最大子数组和
LeetCode第53题"最大子数组和"的Python解决方案,利用动态规划的思想,通过一次遍历数组并维护当前最大和以及全局最大和来求解。
291 2
|
8月前
|
人工智能 自然语言处理 算法
企业内训|AI赋能业务和研发实战训练营-某卫星通信公司
TsingtaoAI为北京某卫星通信公司交付AI赋能业务和研发实战训练营,课程一共3天,覆盖全体员工和研发人员。本课程基于该公司“天地海一体化”业务场景,融合最新AI工具链与大模型技术(如DeepSeek、Coze、通义法睿等),以“场景驱动、工具落地、技术深化”为核心逻辑,覆盖全员通用能力与研发专项能力,通过案例实战实现业务与技术的双提升。
237 0
|
SQL 数据采集 Oracle
实时计算 Flink版产品使用问题之如何读取oracle中的blob类型的数据
实时计算Flink版作为一种强大的流处理和批处理统一的计算框架,广泛应用于各种需要实时数据处理和分析的场景。实时计算Flink版通常结合SQL接口、DataStream API、以及与上下游数据源和存储系统的丰富连接器,提供了一套全面的解决方案,以应对各种实时计算需求。其低延迟、高吞吐、容错性强的特点,使其成为众多企业和组织实时数据处理首选的技术平台。以下是实时计算Flink版的一些典型使用合集。
|
移动开发 前端开发 JavaScript
JS配合canvas实现贪吃蛇小游戏
本文通过详细的代码示例介绍了如何使用JavaScript和HTML5的Canvas API实现一个贪吃蛇游戏,包括蛇的移动、食物的生成、游戏的开始与结束逻辑,以及如何响应键盘事件来控制蛇的方向。
351 1
|
数据采集
以“股票代码实时抓取股票信息”为例的爬虫案例
爬虫—根据股票代码实时抓取股票信息
548 0
|
JavaScript
js监听页面或元素scroll事件,滚动到底部或顶部
js监听页面或元素scroll事件,滚动到底部或顶部
1547 0
js监听页面或元素scroll事件,滚动到底部或顶部
|
运维 监控 安全
阿里云轻量应用服务器与经济型e云服务器区别及选择参考
经济型e云服务器和轻量应用服务器是目前阿里云活动中价格最优惠的云服务器产品,本文为大家介绍一下阿里云轻量应用服务器与经济型e实例云服务器的主要区别及适用场景,以供大家选择时做个参考。
阿里云轻量应用服务器与经济型e云服务器区别及选择参考