「转」译、Xposed模块开发教程

原文地址。这是开发者所写的，可以说是官方开发指南。文章讲述了Xposed的原理，以及怎么开发Xposed框架的模块。头一次翻译技术文档，有错误的话请多包涵。

好了，你想学习怎么为Xposed开发新的模块么？那么读读这篇教程（或者我们可以称他为”泛读短文”）学着怎么去做。这不仅包括“创建这个文件然后插入…”这类的技巧，也包括这些技巧背后的思想。这些思想正是创造价值的步骤以及你真正需要了解你做了什么和为什么这么做的原因。如果你觉得本文“太长，不想读”，那么你可以只看最后的源代码和阅读“使工程成为Xposed模块“部分。但是如果你读了整篇文章你就会有更好的理解。你之后会节省出来阅读这个的时间，因为你不必凭自己弄清楚每件事。

修改主题

你将重新创建在github上可以找到的红色钟表的的例子。它包括将状态栏的钟表变为红色并且加入一个笑脸的功能。我选择这个例子是因为它非常小，而且容易看见所做的修改。并且，它也使用了框架所提供的一些基本方法。

Xposed如何工作

在你开始做出自己的修改之前，你应当大致了解Xposed如何工作（如果觉得这部分无聊可以跳过）。以下就是原理：

有一个叫做”Zygote”的进程，它是android运行环境的核心。每个应用都从一份它的拷贝(“fork”)产生。这个进程在手机启动时由一个叫 /init.rc 的脚本启动。这个进程的启动在 /system/bin/app_process 加载所需要的类和调用初始化方法后完成。

这里就是Xposed发挥用处的地方了。当你安装完框架后，一个扩展过的app_process就会被复制到 /system/bin 下。这个扩展过的启动进程会将一个额外的jar包添加到环境变量，并在特定场合调用里面的方法。比如：当虚拟机创建完成后和Zygote的main方法被调用前。并且在那个方法当中，我们已经是Zygote的一部分，而且能够在它的上下文context中活动。

jar包的位置是 /data/data/de.robv.android.xposed.installer/bin/XposedBridge.jar 它的源代码可以在这里找到。查看XposedBridge的类，你能找到main方法。这就是我上文中所写过的，它在每个进程的最开始部分被调用。一些初始化的工作在那里完成，并且我们的模块在那里加载（之后我再讲模块的加载）。

方法的hook/替换

真正使Xpoesed有威力的就是hook方法调用。当你反编译并修改APK时，你能够在任何你想的地方直接修改/替换指令。然而，你事后需要重新编译/给APK签名，并且只能发布整个安装包。使用Xposed能让你放置的hook，你并不能修改程序内部的方法代码(清楚地定义你想要在何处做什么样的修改是不可能的)。然而，你可以在方法调用的前后注入你的代码。这也是java中能够被清楚寻址的最小单位。

XposedBridge 有一个私有的 native 方法叫做 hookMethodNative。这个方法也在扩展后的 app_process 中被实现了。它会将方法类型转为“native”，并把方法的实现与本地的通用方法相连。这意味着，每当被hook的方法调用后，调用者不知道实际调用的是通用的方法。在这个方法中，位于 XposedBridge 的 handleHookedMethod 方法会被调用，并向方法调用传递参数、this指针以及其他东西。之后这个方法负责唤起之前方法调用注册过的回调。上述这些行为能够改变调用的参数、实例/静态变量、唤起其他方法、处理调用结果。。。或者跳过这些东西。它的弹性非常大。

好了，理论讲够了。我们现在创建一个模块吧！

创建工程

一个模块就是一个普通的app，只不过多了一些特殊的文件和元数据。所以在我们创建新的android工程以前，我假设你已经做过这个了。如果没有，官方文档讲的很详细。对于SDK，我选择了4.0.3（API15）。我建议你也使用这个，并且不要立刻开始。你不需要创建Activity，因为我们的修改不需要任何用户界面。回答过了这个问题后，你应该有一个空白的工程项目。

使工程成为Xposed模块

现在我们把工程变成Xposed能加载的东西。我们需要以下几个步骤。

AndroidManifest.xml

Xposed Installer的模块列表搜寻所有有一种特殊元数据标记的应用程序。你可以到 AndroidManifest.xml => Application => Application Nodes (在底部) => Add => Meta Data 下面去创建这个标记。标记名称应该是 xposedmodule ，值应该是 true。给resource留空。重复以上过程创建 xposedminversion (见下文) 和 xposeddescription (你创建的模块的简单描述)。XML文件现在就是这个样子的：

<uses-sdk android:minSdkVersion="15" />

<application
    android:icon="@drawable/ic_launcher"
    android:label="@string/app_name" >
    <meta-data
        android:name="xposedmodule"
        android:value="true" />
    <meta-data
        android:name="xposeddescription"
        android:value="Easy example which makes the status bar clock red and adds a smiley" />
    <meta-data
        android:name="xposedminversion"
        android:value="30" />
</application>

XposedBridgeApi.jar

接下来，让程序能够找到 XposedBridge 的API。你可以从
这里下载 XposedBridgeApi-<version>.jar 的最新版。把它复制到叫做lib的子文件夹下。右键单击选择Build Path => Add to Build Path。文件名当中的<version>是你在manifest文件的xposedminversion标签所插入的版本。

保证API类没有被包含（但仅仅是参考）在你编译过的APK里，否则你会得到一个IllegalAccessError错误。libs（含有s）文件夹是eclipse自动生成的，不要把API文件放在那里。

模块的实现

现在你可以给你的模块创建一个类了。我的类叫做”Tutorial”，位于de.robv.android.xposed.mods.tutorial这个包中。

package de.robv.android.xposed.mods.tutorial;

public class Tutorial {

}

第一步，我们仅仅生成一些日志表明模块已经加载。一个模块可以有多个入口点。你选择哪个取决于你想修改什么。你可以在安卓系统启动时、在一个app将要启动时、在一个app的资源文件初始化时或其他时候，调用一个函数。

在这个教程靠后面的一部分，你将了解到在一个特定的app中需要做出的修改。那么先让我们了解一下 “让我知道什么时候加载一个新app” 这个入口点。所有入口点都被标记为IXposedMod的子接口。这种情况下，你需要实现 IXposedHookLoadPackage 这个接口。其实它只有一个仅有一个参数的方法。这个方法向被实现的模块提供更多关于运行环境上下文的信息。在我们的例子中，我们用log输出加载的app的名称。

package de.robv.android.xposed.mods.tutorial;

import de.robv.android.xposed.IXposedHookLoadPackage;
import de.robv.android.xposed.XposedBridge;
import de.robv.android.xposed.callbacks.XC_LoadPackage.LoadPackageParam;

public class Tutorial implements IXposedHookLoadPackage {
    public void handleLoadPackage(final LoadPackageParam lpparam) throws Throwable {
        XposedBridge.log("Loaded app: " + lpparam.packageName);
    }
}

这个log方法向标准logcat以及 /data/data/de.robv.android.xposed.installer/log/debug.log（通过Xposed Installer可以轻易访问到）输出信息（tag Xposed）。

assets/xposed_init

现在唯一遗漏的就是提示XposedBridge哪些类包含了入口点。这项工作通过一个叫 xposed_init 的文件完成。在assets文件夹下创建一个新的名叫xposed_init的text文件。在该文件中每行包含一个类的全名。在这个例子中，它是 de.robv.android.xposed.mods.tutorial.Tutorial。

试试看

保存你的文件。以Android Application的方式运行你的程序。因为这是你第一次安装它，在使用前你需要先启用。打开Xposed Installer这个app并确保你安装了xposed框架。之后切换到Modules标签。你应该能在那里找到你的app。在选择框内打钩使得它可用。然后重启。你当然什么变化也看不到，但如果检查log记录，以应该会看见以下的东西：

Loading Xposed (for Zygote)...
Loading modules from   /data/app/de.robv.android.xposed.mods.tutorial-1.apk
Loading class de.robv.android.xposed.mods.tutorial.Tutorial
Loaded app: com.android.systemui
Loaded app: com.android.settings
... (many more apps follow)

瞧！它起作用了。现在你拥有了一个Xposed模块。它能够变得比写一些log更加有用…

探索你的目标并寻找修改它的方式

好了，下面要开始讲的部分也许会非常不同，这取决于你想做什么。如果你之前修改过apk，也许你会知道在这里应当如何思考。总的来说，你需要了解目标的一些实现细节。在本教程中，目标选定为状态栏的时钟。这有助于了解到状态栏以及其他一些东西都是系统UI的一部分。现在让我们在那里开始我们的探索。

可能性1：反汇编。这会告诉你它实际的实现，但是会很难阅读和理解，因为你得到的都是smali格式的东西。可能性2：获得AOSP源代码。比如这里，这里。ROM不同代码也很不一样，但在本例中他们的实现是相似的甚至是相同的。我会先看AOSP，然后看看这么做够不够。如果我需要细节，我会看看实际的反汇编的代码。

你可以找找名称中有“clock”的类。其他需要找的是用到的资源和布局。如果你下载官方的AOSP代码，你可以从 frameworks/base/packages/SystemUI 开始找。你会找到好几处“clock”出现的地方。找到有好几种方式实现修改是正常而且真实的。时刻记住你“只能” hook方法。所以你必须另找其他能够插入代码实现功能的地方，要么在方法的前面或是后面，或者是替换掉方法。你应当hook一个尽可能明确的方法，而不是一个被调用成千上万次的用于解决性能问题和非计划中的副作用的方法。

在本例当中，你或许会发现布局 res/layout/status_bar.xml 包含一个指向带有类com.android.systemui.statusbar.policy.Clock的自定义view。现在你脑子里也许会有好多点子。文字的颜色是通过textAppearance属性定义的，所以最干净的更改它的方法就是修改外观的定义。然而，用Xposed框架改变外观属性几乎是不可能的（这需要深入本地代码）。替换状态栏的布局也许是可能的，但对于你试图做出的小小修改来说是杀鸡用牛刀。取而代之的是，看看这个类。有一个叫updateLock的方法，似乎每分钟都调用一次用于更新时间。

final void updateClock() {
    mCalendar.setTimeInMillis(System.currentTimeMillis());
    setText(getSmallTime());
}

这个方法用于修改来说是很好的，因为这是一个足够具体的看似唯一能够修改时钟文字的方法。如果我们在这个方法的每次调用之后都加些修改时钟文字和颜色的东西，应该就能起作用。那么，我们开始做吧。

对于单独修改字体颜色部分，有一种更好的办法。参见“替换资源”中“修改布局”的例子。

使用反射寻找并hook方法

现在我们已经知道了哪些东西？我们在com.android.systemui.statusbar.policy.Clock有一个叫做updateClock的希望干涉的方法。我们在系统UI资源中找到了这个类，所以它仅仅在系统UI进程当中有效。其它一些类属于框架，而且在任何地方都有效。如果我们在 handleLoadPackage 中试图直接获取任何这个类的信息和引用，就会失败。因为处于错误的进程中。所以让我们实现一种仅在某个特定包即将加载时执行特定代码的情况：

public void handleLoadPackage(LoadPackageParam lpparam) throws Throwable {
    if (!lpparam.packageName.equals("com.android.systemui"))
        return;

    XposedBridge.log("we are in SystemUI!");
}

使用参数，我们能轻松检查是否在正确的包中。一旦我们核实了这一点，我们就通过ClassLoader取得那个包中的也被这个变量引用的类。现在我们可以寻找com.android.systemui.statusbar.policy.Clock这个类以及它的updateClock方法，然后告诉XposedBridge去hook这个方法：

package de.robv.android.xposed.mods.tutorial;

import static de.robv.android.xposed.XposedHelpers.findAndHookMethod;
import de.robv.android.xposed.IXposedHookLoadPackage;
import de.robv.android.xposed.XC_MethodHook;
import de.robv.android.xposed.callbacks.XC_LoadPackage.LoadPackageParam;

public class Tutorial implements IXposedHookLoadPackage {
    public void handleLoadPackage(final LoadPackageParam lpparam) throws Throwable {
        if (!lpparam.packageName.equals("com.android.systemui"))
            return;

        findAndHookMethod("com.android.systemui.statusbar.policy.Clock", lpparam.classLoader, "updateClock", new XC_MethodHook() {
                @Override
                protected void beforeHookedMethod(MethodHookParam param) throws Throwable {
                // this will be called before the clock was updated by the original method
            }
            @Override
            protected void afterHookedMethod(MethodHookParam param) throws Throwable {
                // this will be called after the clock was updated by the original method
            }
    });
    }
}

findAndHookMethod是一个Helper函数。注意静态导入，如果你像连接中说的一样做了，那就会被自动加入。这个方法使用系统UI包的ClassLoader寻找 Clock 这个类，然后寻找其中的updateClock方法。如果这个方法中有任何参数，你必须事后列出这些参数的类型。有许多方法做这件事，但因为我们的方法没有参数，所以就先跳过这个步骤。至于最后一点，你需要提供一个 XC_MethodHook 类的实现。对于更小的更改，你可以使用匿名类。如果你的代码很多，最好创建普通的类并且只在这里创建实例。helper之后会如之前所说的，做出所有hook这个方法的必要工作。

XC_MethodHook中有两个你可以重写的方法。你可以两个都重写，或者都不重写。但后者的做法显然是没有道理的。这些方法就是beforeHookedMethod 和 afterHookedMethod。不难猜出他们在原有方法之前/后执行。你可以使用“before”方法在方法调用前估计/操纵参数（通过param.args）。甚至阻止调用原来的方法（发送你自己的结果）。“after”方法可以用来做一些基于原来方法的结果的事。你也可以在这个地方操纵结果。当然，你可以在方法调用的前/后添加你自己要执行的代码。

如果你要彻底替换一个方法，去看看子类XC_MethodReplacement。在那里，你只需要重写replaceHookedMethod。

XposedBridge为每个hook过的方法维护一个注册过的回调的表。拥有最高优先级（在hookMethod中被定义）的将被优先调用。原有的方法总是具有最低的优先级。所以如果你hook了一个拥有回调A（高优先级）和回调B（默认优先级）的方法，那么不管被hook的方法是如何被调用的，执行顺序总是这样的：A.before -> B.before -> original method -> B.after -> A.after。所以A可以影响B看到的参数，即把它们传递下去以前大幅度地修改它们。原有的方法的结果会先被B处理，但是A拥有原先调用者最终将得到什么样结果的决定权。

最终步骤：在方法调用之前/后执行你自己的代码

好了，你已经在正确的上下文运行环境中（比如：系统UI进程）有了一个在updateClock方法每次被调用时都会被调用的方法。现在让我们修改一些东西吧。

第一个要检查的：我们有具体的Clock类型的引用么？是的，我们有。这就是param.thisObject参数。所以如果方法通过myClock.updateClock()被调用，那么param.thisObject 就是 myClock。

接下来：我们对clock做什么？Clock类型并不可用，你不能将param.thisObject转换为类（也不要试着这样做）。然而它是从TextView继承而来。所以一旦你把Clock的引用转换为TextView，你可以使用像setText, getText 和 setTextColor之类的方法。我们的改动应该在原有的方法设置了新的时间以后进行。因为在方法被调用前什么都没有做，我们可以空着beforeHookedMethod。没有必要调用（空的）“super”方法。

所以以下是完整的源代码：

package de.robv.android.xposed.mods.tutorial;

import static de.robv.android.xposed.XposedHelpers.findAndHookMethod;
import android.graphics.Color;
import android.widget.TextView;
import de.robv.android.xposed.IXposedHookLoadPackage;
import de.robv.android.xposed.XC_MethodHook;
import de.robv.android.xposed.callbacks.XC_LoadPackage.LoadPackageParam;

public class Tutorial implements IXposedHookLoadPackage {
    public void handleLoadPackage(final LoadPackageParam lpparam) throws Throwable {
        if (!lpparam.packageName.equals("com.android.systemui"))
            return;

        findAndHookMethod("com.android.systemui.statusbar.policy.Clock", lpparam.classLoader, "updateClock", new XC_MethodHook() {
            @Override
            protected void afterHookedMethod(MethodHookParam param) throws Throwable {
                TextView tv = (TextView) param.thisObject;
                String text = tv.getText().toString();
                tv.setText(text + " :)");
                tv.setTextColor(Color.RED);
            }
        });
    }
}

对结果感到满意

现在启动/安装你的app。因为你第一次启动它时已经在Xposed Installer中把它设置为了可用，你就不需要在做这一步了。重启即可。然而，如果你正在使用这个红色钟表的例子，你也许想禁用它。两者都对它们的updateClock 处理程序使用了默认的优先级。所以你不清楚哪个会胜出（实际上这依赖于处理方法的字符串表示形式，但不要依赖这个方式）。

结论

我知道这个教程很长。但我希望你现在不但能实现一个绿色的表，也能够做出一些完全不同的东西。找到好的被hook的方法是经验的问题，所以先从简单的做起。试着一开始多使用log函数确保每次调用都是你预期的。现在：祝玩得开心!

原文地址：http://billvyoung.gitcafe.io/2015/02/10/xposed-1/