本文记录的是我对 Android 的「系统缓存」及其扫描和清理方法的探索与理解。
本文讲述内容的完整代码实例见 https://github.com/mzlogin/CleanExpert。
系统缓存的定义
如下是我捏造的非官方定义:
系统缓存: Android APP 在运行过程中保存在手机内置和外置存储上的缓存文件总和。
系统缓存的组成
先说结论:
「系统缓存」由所有已安装应用的 /data/data/packagename/cache 文件夹和 /sdcard/Android/data/packagename/cache 文件夹组成。
如下是原理分析,不感兴趣的可以直接跳到下一节。
我们先来看一个熟悉的界面:
这是手机的「设置」——「应用」里的已安装应用的详情页,这里面会显示缓存的大小,而且提供了清理缓存的功能,这就是我们做「系统缓存」清理想做的事情。
这里显示的大小是如何计算出来的,它实际上的文件组成是怎么样的呢?可以从 Android 系统自带的 Settings APP 的源码中找到答案。
注:下面的分析基于我手边的 Android 4.1 源码,比较古老了,但并不妨碍理解。
探索「外部缓存」
按惯例先说结论:
「外部缓存」由所有已安装应用的 /sdcard/Android/data/packagename/cache 文件夹组成。
Settings APP 的源码在 Android 源码树的 packages/apps/Settings 目录里,在它里面能找到 InstalledAppDetails.java 文件,从名字上看它应该就是对应我们上图中的「应用详情页」,它是一个 Fragment,在它的 onResume
方法中调用了 refreshUi
方法,它里面又调用了 refreshSizeInfo
方法:
1 | private void refreshSizeInfo() { |
这个方法定义在文件 packages/apps/Settings/src/com/android/settings/applications/InstalledAppDetails.java 中。
很显然这里的 cacheSize
就是对应上图里的缓存大小,从这几行代码的字面意义里可以看出缓存是由「内部缓存」加「外部缓存」组成,甚至可以初步推测出本节的结论,当然我是一个严谨的人,继续深究一下其中的原理。
找到给 mAppEntry
赋值的地方:
1 | private boolean refreshUi() { |
这个方法定义在文件 packages/apps/Settings/src/com/android/settings/applications/InstalledAppDetails.java 中。
继续看 getEntry
里做了什么:
1 | AppEntry getEntry(String packageName) { |
这个方法定义在文件 packages/apps/Settings/src/com/android/settings/applications/ApplicationsState.java 中。
找到给 mApplications
添加数据的地方:
1 | void addPackage(String pkgName) { |
这个方法定义在文件 packages/apps/Settings/src/com/android/settings/applications/ApplicationsState.java 中。
它在 mApplications.add(info);
后顺便发了个消息,经过 MSG_LOAD_ENTRIES
到 MSG_LOAD_ICONS
到 MSG_LOAD_SIZES
的消息链,我们看到一个从名字上就看出来很重要的关键方法调用 getPackageSizeInfo
:
1 | class BackgroundHandler extends Handler { |
这个类定义在文件 packages/apps/Settings/src/com/android/settings/applications/ApplicationsState.java 中。
mPm
是 PackageManager
类型的,这是一个抽象类型,它的实现类为 ApplicationPackageManager
,ApplicationPackageManager.getPackageSizeInfo
里调用了 IPackageManager.getPackageSizeInfo
,IPackageManager
的实例在 ContexImpl.getPackageManager
方法里通过 ActivityThread.getPackageManager()
获得,它的方法调用最终是反映到通过 Binder 机制返回的 PackageManagerService
实例上,我们找到 getPackageSizeInfo
的最终实现:
1 | public class PackageManagerService extends IPackageManager.Stub { |
这个方法定义在文件 frameworks/base/services/java/com/android/server/pm/PackageManagerService.java 中。
这里我们注意 msg.obj
的类型为 MeasureParams
,INIT_COPY
消息对应的处理:
1 | class PackageHandler extends Handler { |
这个类定义在文件 frameworks/base/services/java/com/android/server/pm/PackageManagerService.java 中。
mBound
默认值为 false,所以会进 connectToService
方法,里面会触发 DefaultContainerConnection.onServiceConnected
回调,发送了 MCS_BOUND
的消息,通过 params.startCopy()
来到 MeasureParams
的 handleStartCopy
方法里,可以直接看到 externalCacheSize
的计算方法:
1 | void handleStartCopy() throws RemoteException { |
这个方法定义在文件 frameworks/base/services/java/com/android/server/pm/PackageManagerService.java 中。
externalCacheSize
实际即是 Environment.getExternalStorageAppCacheDirectory
返回的文件夹的大小,来看一下它返回的文件夹是什么:
1 | public class Environment { |
这个类定义在文件 frameworks/base/core/java/android/os/Environment.java 中。
一般来讲 /storage/sdcard0 都是挂载到 /sdcard,可见 Environment.getExternalStorageAppCacheDirectory
返回的就是 /sdcard/Android/data/packagename/cache。
即有小结论一:
「外部缓存」由所有已安装应用的 /sdcard/Android/data/packagename/cache 文件夹组成。
探索「内部缓存」
先说结论:
「内部缓存」由所有已安装应用的 /data/data/packagename/cache 文件夹组成。
从上面的 handleStartCopy
方法中可知 Internal 的 cacheSize
部分在 getPackageSizeInfoLI
方法里,
1 | private boolean getPackageSizeInfoLI(String packageName, PackageStats pStats) { |
这个方法定义在文件 frameworks/base/services/java/com/android/server/pm/PackageManagerService.java 中。
1 | class Installer { |
这个方法定义在文件 frameworks/base/services/java/com/android/server/pm/Installer.java 中。
getSizeInfo
方法最终是通过给 /dev/socket/installd 发送 getsize packagename apkpath ...
获取的输出中解析出来。
/dev/socket/installd 的源码在 frameworks/base/cmds/installd,getsize
命令最后在 get_size
函数中处理,
1 | int get_size(const char *pkgname, const char *apkpath, |
这个函数定义在文件 frameworks/base/cmds/installd/Commands.c 中。
我们来看一下 path
是什么值:
1 | int create_pkg_path(char path[PKG_PATH_MAX], |
这个函数定义在文件 frameworks/base/cmds/installd/utils.c 中。
可见 path
就是由 android_data_dir.path
,PRIMARY_USER_PREFIX
,pkgname
和 PKG_DIR_POSTFIX
四段拼接起来的,pkgname
就是包名,其它几个值分别是什么呢?
1 | ...... |
这些宏定义在 frameworks/base/cmds/installd/installd.h 中
1 | int initialize_globals() { |
这个函数定义在文件 frameworks/base/cmds/installd/installd.c 中。
android_data_dir
其实是获取的系统的 ANDROID_DATA
环境变量值,就是 /data
:
1 | shell@aries:/ $ echo $ANDROID_DATA |
所以 path
的值即为 /data/data/pkgname
,而 cacheSize
即为它下面的 cache
文件夹的大小。
即有小结论二:
「内部缓存」由所有已安装应用的 /data/data/packagename/cache 文件夹组成。
以上,我们的结论得证。
系统缓存大小的计算
通过上一节我们已经知道了「系统缓存」的文件构成,在想要计算系统缓存大小的时候下意识的想法就是,用代码计算一下这两个文件夹的大小不就行了?
事实证明这个想法只是 too young, sometimes naive.
/data/data/packagename/cache 文件夹每个应用访问属于自己的无压力,但其它应用是没有权限读取的,如果是做本应用内的缓存清理,那事情就简单了,直接算一算就好了。
如果是要做针对所有应用的缓存清理功能,那就得另想办法了。
这里分了两种情况:能获取 root 权限和不能获取 root 权限。我们这里先讨论非 root 权限的系统缓存计算和清理,root 权限的情况在后文会有说明。
既然直接计算文件夹大小的方法行不通了,那就仍然重复上面的故事,参考 Settings APP 的做法吧。
Settings 计算缓存大小的方法
Settings APP 使用了 PackageManager.getPackageSizeInfo
方法来做此事,难道 so easy?屁颠屁颠去查了一下 Android API,发现 PacakgeManager
的文档中压根就没有出现 getPackageSizeInfo
的身影,好吧这是一个不对外公开的 API。
但是区区困难怎么拦得住一颗改变世界的心?对付隐藏 API 我们还有反射大法。
我们回顾一下 Settings APP 里的做法:
1 | class BackgroundHandler extends Handler { |
这个类定义在文件 packages/apps/Settings/src/com/android/settings/applications/ApplicationsState.java 中。
这里有两个问题需要解决:
getPackageSizeInfo
方法是一个@hide
方法,需要通过反射来调用。从 PackageManager.java 文件的
getPackageSizeInfo
方法定义处可知,它需要GET_PACKAGE_SIZE
权限,幸运的是,从 frameworks/base/core/res/AndroidManifex.xml 文件里可知,该权限的 Protection level 为 normal,是可以正常声明的。1
2
3
4
5
6<!-- Allows an application to find out the space used by any package. -->
<permission android:name="android.permission.GET_PACKAGE_SIZE"
android:permissionGroup="android.permission-group.SYSTEM_TOOLS"
android:protectionLevel="normal"
android:label="@string/permlab_getPackageSize"
android:description="@string/permdesc_getPackageSize" />这段代码定义在文件 frameworks/base/core/res/AndroidManifex.xml 中。
传给
getPackageSizeInfo
方法的第二个参数类型IPackageStatsObserver
是在 android.content.pm 包下,需要自已通过 aidl 方式定义。
计算缓存大小的实现
解决步骤:
在自己的工程的 src/main 目录下创建包目录结构 aidl/android/content/pm。
注:这是使用 Android Studio 的默认做法,使用 Eclipse 默认在 src 目录下创建包目录结构 android/content/pm。
将 Android 源码 frameworks/base/core/java/android/content/pm 目录下的 IPackageStatsObserver.aidl 与其依赖的 PackageStats.aidl 拷贝到上面一步创建的目录里。
根据 frameworks/base/core/java/android/content/pm/PackageManager.java 的
getPackageSizeInfo
接口上面的注释可知,需要在 AndroidManifest.xml 里声明需要GET_PACKAGE_SIZE
权限。1
<uses-permission android:name="android.permission.GET_PACKAGE_SIZE"></uses-permission>
获取 QQ 的系统缓存大小的示例代码:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34public void someFunc() {
IPackageStatsObserver.Stub observer = new PackageSizeObserver();
getPackageInfo("com.tencent.mobileqq", observer);
}
public void getPackageInfo(String packageName, IPackageStatsObserver.Stub observer) {
try {
PackageManager pm = ContextUtil.applicationContext.getPackageManager();
Method getPackageSizeInfo = pm.getClass()
.getMethod("getPackageSizeInfo", String.class, IPackageStatsObserver.class);
getPackageSizeInfo.invoke(pm, packageName, observer);
} catch (NoSuchMethodException e ) {
e.printStackTrace();
} catch (IllegalAccessException e) {
e.printStackTrace();
} catch (InvocationTargetException e) {
e.printStackTrace();
}
}
private class PackageSizeObserver extends IPackageStatsObserver.Stub {
public void onGetStatsCompleted(PackageStats packageStats, boolean succeeded)
throws RemoteException {
if (packageStats == null || !succeeded) {
} else {
AppEntry entry = new AppEntry();
entry.packageName = packageStats.packagename;
entry.cacheSize = packageStats.cacheSize + packageStats.externalCacheSize;
// do something else,比如把 entry 通过消息发送给需要的地方,或者添加到你的列表里
}
}
}获取一个应用的缓存的问题解决了,获取所有应用的系统缓存也就是遍历系统已安装应用,然后挨个调用
getPackageInfo
的事儿了。
完整的实例见 https://github.com/mzlogin/CleanExpert。
系统缓存的清理
既然借鉴 Settings APP 的做法如此好使,在做缓存清理时我们当然故伎重施。我们先来看看它是怎样清理某一个应用的缓存的。
Settings 清理缓存的方法
在 InstalledAppDetails.java 里能根据名称找到对应「清除缓存」按钮相关的代码:
1 | public class InstalledAppDetails extends Fragment |
这个类定义在文件 packages/apps/Settings/src/com/android/settings/applications/InstalledAppDetails.java 中。
是不是很熟悉?是不是很激动?是不是觉得顶多再次祭出反射大法就能继续拯救世界了?先冷静一下,看看 frameworks/base/core/java/android/content/pm/PackageManager.java 文件里 deleteApplicationCacheFiles
方法上面的注释。
1 | /** |
没错它又是一个 @hide
方法,关键是它需要 DELETE_CACHE_FILES
权限,而该权限的相关声明如下:
1 | <!-- Allows an application to delete cache files. --> |
这段声明定义在 frameworks/base/core/res/AndroidManifest.xml 中。
它的 protectionLevel 为 signature|system
,系统应用或者与系统采用相同签名的应用才能获得此权限。
此路不通。
新的发现
那就继续想其它办法了。frameworks/base/core/java/android/content/pm/PackageManager.java 里提供了很多实用的功能,比如上面的系统缓存的大小计算以及清理都是它里面声明的方法,仔细看一下它里面声明的其它方法还真是有发现:
1 | /** |
从解释来看它是用来在必要时释放所有应用的缓存所占空间的,在 Android 源码里搜索一下它被调用的地方,有一处是在 frameworks/base/services/java/com/android/server/DeviceStorageMonitorService.java 中,大致的逻辑是在系统空间不够的时候,提示用户清理系统缓存。
我们来看看这个方法实际做了什么事情:
1 | public class PackageManagerService extends IPackageManager.Stub { |
这个类定义在文件 frameworks/base/services/java/com/android/server/pm/PackageManagerService.java 中。
也就是说,这个方法的注释里没有提及它需要申请什么权限,但事实上它是需要 CLEAR_APP_CACHE
权限的。
该权限的相关声明:
1 | <!-- Allows an application to clear the caches of all installed |
这段声明定义在 frameworks/base/core/res/AndroidManifest.xml 中。
虽然它的 protectionLevel 是 dangerous
,但是好歹还是能用的。
另外,跟踪实际执行清理过程的 retCode = mInstaller.freeCache(freeStorageSize);
这一行实际是通过给 /dev/socket/installd 发送 freecache freeStorageSize
来完成清理过程,最终调用到如下函数:
1 | int free_cache(int64_t free_size) |
这个函数定义在文件 frameworks/base/cmds/installd/Commands.c 中。
实际就是遍历 /data/data 下的所有文件夹,依次删除它们下面的 cache 子目录,直到磁盘的可用空间大于需要的空间为止。
也就是说,freeStorageAndNotify
只是删除了「内部缓存」,扩展存储上的「外部缓存」需要我们另外处理。
清理缓存的实现
参考 frameworks/base/services/java/com/android/server/DeviceStorageMonitorService.java 中对 freeStorageAndNotify
的相关调用,最后我们的实现步骤如下:
在自己的工程的 src/main 目录下创建包目录结构 aidl/android/content/pm。
注:这是使用 Android Studio 的默认做法,使用 Eclipse 默认在 src 目录下创建包目录结构 android/content/pm。
将 Android 源码 frameworks/base/core/java/android/content/pm 目录下的 IPackageDataObserver.aidl 拷贝到上面一步创建的目录里。
在 AndroidManifest.xml 里声明
CLEAR_APP_CACHE
权限。1
<uses-permission android:name="android.permission.CLEAR_APP_CACHE"></uses-permission>
通过反射调用
freeStorageAndNotify
方法,第一个参数给它一个足够大的值,它就会帮我们清理掉所有应用的缓存了。1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53public static void freeAllAppsCache(final Handler handler) {
Context context = ContextUtil.applicationContext;
File externalDir = context.getExternalCacheDir();
if (externalDir == null) {
return;
}
PackageManager pm = context.getPackageManager();
List<ApplicationInfo> installedPackages = pm.getInstalledApplications(PackageManager.GET_GIDS);
for (ApplicationInfo info : installedPackages) {
String externalCacheDir = externalDir.getAbsolutePath()
.replace(context.getPackageName(), info.packageName);
File externalCache = new File(externalCacheDir);
if (externalCache.exists() && externalCache.isDirectory()) {
deleteFile(externalCache);
}
}
try {
Method freeStorageAndNotify = pm.getClass()
.getMethod("freeStorageAndNotify", long.class, IPackageDataObserver.class);
long freeStorageSize = Long.MAX_VALUE;
freeStorageAndNotify.invoke(pm, freeStorageSize, new IPackageDataObserver.Stub() {
public void onRemoveCompleted(String packageName, boolean succeeded) throws RemoteException {
Message msg = handler.obtainMessage(JunkCleanActivity.MSG_SYS_CACHE_CLEAN_FINISH);
msg.sendToTarget();
}
});
} catch (NoSuchMethodException e) {
e.printStackTrace();
} catch (IllegalAccessException e) {
e.printStackTrace();
} catch (InvocationTargetException e) {
e.printStackTrace();
}
}
public static boolean deleteFile(File file) {
if (file.isDirectory()) {
String[] children = file.list();
for (String name : children) {
boolean suc = deleteFile(new File(file, name));
if (!suc) {
return false;
}
}
}
return file.delete();
}
完整的实例见 https://github.com/mzlogin/CleanExpert。
备注:经测试该方法在 Android 6.0 版本和部分 5.0+ 版本上已经失效,Android 源码里已经给 freeStorageAndNotify
方法声明添加了 @SystemApi
注释(开始添加了 @PrivateApi
,后修改为 @SystemApi
),见「添加」和「修改」两次提交,而且 CLEAR_APP_CACHE
方法的权限已经由 dangerous
改成了 system|signature
,已经无法通过反射来正常调用,会产生 java.lang.reflect.InvocationTargetException
,所以在这些版本上需要另想办法了,StackOverflow 上的一个相关讨论链接:What’s the meaning of new @SystemApi annotation, any difference from @hide?。
有 root 权限的系统缓存计算与清理
如果能获取到 root 权限,/data/data 目录的访问限制也就不再是问题,计算缓存大小和清理缓存也就不用再受上面说的方法与权限的限制了,而且能做一些没有 root 权限的情况下做不到的事情,比如:
清理单个应用的缓存。
列出应用的缓存文件列表供用户选择性清理。
实现思路很简单粗暴(如下思路未写实例验证):
思路一 通过 su
命令获取一个有 root 权限的 shell,然后通过与它交互来获取缓存文件夹的大小或清理缓存,比如让它执行命令 du -h /data/data/com.trello/cache
就能获取到 trello 的「内部缓存」大小,让它执行 rm -rf /data/data/com.trello/cache
就能删除 trello 的「内部缓存」。
注:du
命令行与参数在不同 ROM 下的不一致,所以并不推荐此做法。
思路二 或者,也可以做一个原生程序专门来负责缓存计算与清理,通过 su
命令获取有 root 权限的 shell,再用 shell 创建该原生程序进程,它继承 shell 的 root 权限,然后它就可以计算缓存大小与清理缓存,再将结果上报给 APP 进程。
- 本文标题:Android 系统缓存扫描与清理方法分析
- 创建时间:2021-03-28 00:00:00
- 本文链接:posts/bb90.html
- 版权声明:本博客所有文章除特别声明外,均采用 BY-NC-SA 许可协议。转载请注明出处!