美团Robust实践—原理篇

Robust是美团新出的hotfix方案，市场上的热更新方案也很多比如基于multiDex的Tinker和基于native hook方案的阿狸的Andfix，本文先不做与其他hotfix方案的对比，主要说明Robust的原理等。

原理图

基本原理如上图所示，Robust会在旧的类里面插入一个静态的字段ChangeQuickRedirect，当这个字段为空时，执行旧的方法，不为空时，就可以对badMethod做拦截，执行新的逻辑，替代掉badMethod，从而达到修复的目的。patch.dex就是我们需要下发的patch包，patch包下发后，使用DexClassLoader加载，然后将badClass里的ChangeQuickRedirect字段赋值成新创建的patched.class的实例，实时修复badMethod。由于使用的是最基础的DexClassLoader，也就不存在兼容性问题。

以Test类做具体分析

1.原始Test类，方法为getIndex()返回一个int 类型101；由于在编译时会做内联的优化，所以额外增加了一个RobustModify.modify()方法调用。

public class Test {
    public int getIndex() {
        //该方法仅仅是一次额外的调用，也可以替换成其他方法调用
        RobustModify.modify();       
        return 101;    
    }
}

2.接入Robust打包混淆后的Test类

package robust.ss.com.myrobust;
public class a
{
  public static ChangeQuickRedirect a;

  public int a()
  {
    if (a != null)
    {
      ChangeQuickRedirect localChangeQuickRedirect = a;
      if (PatchProxy.isSupport(new Object[0], this, localChangeQuickRedirect, false, 18))
      {
        localChangeQuickRedirect = a;
        return ((Integer)PatchProxy.accessDispatch(new Object[0], this, localChangeQuickRedirect, false, 18)).intValue();
      }
    }
    RobustModify.modify();
    return 101;
  }
}

如上,Robust为Test类插入了一个公共的静态字段ChangeQuickRedirect；在getIndex方法中最后两行为我们的原始代码，而最开始就是ChangeQuickRedirect拦截逻辑,当ChangeQuickRedirect不为空时，就可以对该方法做拦截。拦截用到了PatchProxy的两个方法：

• PatchProxy.isSupport方法主要用于获取具体的方法和参数，进而判断ChangeQuickRedirect是否支持这个方法拦截
• PatchProxy.accessDispatch方法主要用于实施具体的方法拦截，并返回ChangeQuickRedirect修改后的值

由于类里面每个方法都会插入上面的代码，而我们可能只需要修改其中一两个方法，所以需要对Patch方法做过滤。其中参数18是方法的签名，Robust会以整型自增的方式给需要patch的方法打上签名，用于唯一表示某个方法，这在patch里会用到。

3.当我们想返回103而不是101时，我们修改方法如下：

public class Test {
    @Modify    
    public int getIndex() {
        //该方法仅仅是一次额外的调用，也可以替换成其他方法调用
        RobustModify.modify();        
        return 103;    
    }
}

用gradle命令生成patch.jar(里面就是一个dex文件)后patch包含3各类，分别是PatchesInfoImpl，TestPatchControl和TestPatch。

4.PatchesInfoImpl类，返回PatchedClassInfo的列表，由于我们只改了一个Test类，所以列表里只有一个实例；robust.ss.com.myrobust.a就是我们上面的Test类（对应原理图的badClass），XXX.TestPatchControl是给打Patch的类名。

public class PatchesInfoImpl
  implements PatchesInfo
{
  public List getPatchedClassesInfo()
  {
    ArrayList localArrayList = new ArrayList();
    localArrayList.add(new PatchedClassInfo("robust.ss.com.myrobust.a", "com.meituan.robust.patch.TestPatchControl"));
    com.meituan.robust.utils.EnhancedRobustUtils.isThrowable = false;
    return localArrayList;
  }
}

5.TestPatchControl类

public class TestPatchControl
  implements ChangeQuickRedirect
{
  public static final String MATCH_ALL_PARAMETER = "(\\w*\\.)*\\w*";
  private static final Map keyToValueRelation = new WeakHashMap();

  public Object accessDispatch(String paramString, Object[] paramArrayOfObject)
  {
    try
    {
      if (paramString.split(":")[2].equals("false"))
        if (keyToValueRelation.get(paramArrayOfObject[(paramArrayOfObject.length - 1)]) == null)
        {
          TestPatch localTestPatch = new TestPatch(paramArrayOfObject[(paramArrayOfObject.length - 1)]);
          keyToValueRelation.put(paramArrayOfObject[(paramArrayOfObject.length - 1)], localTestPatch);
          paramArrayOfObject = localTestPatch;
        }
      while ("18".equals(paramString.split(":")[3]))
      {
        return Integer.valueOf(paramArrayOfObject.getIndex());
        paramArrayOfObject = (TestPatch)keyToValueRelation.get(paramArrayOfObject[(paramArrayOfObject.length - 1)]);
        continue;
        paramArrayOfObject = new TestPatch(null);
      }
    }
    catch (Throwable paramString)
    {
      paramString.printStackTrace();
    }
    return null;
  }

  public Object getRealParameter(Object paramObject)
  {
    Object localObject = paramObject;
    if ((paramObject instanceof a))
      localObject = new TestPatch(paramObject);
    return localObject;
  }

  public boolean isSupport(String paramString, Object[] paramArrayOfObject)
  {
    return "18:".contains(paramString.split(":")[3]);
  }
}

可以看的，TestPatchControl实现自ChangeQuickRedirect接口，也就是Patch后的ChangeQuickRedirect会被赋值成这个类的实例，从而执行拦截逻辑。这里18就是原始Test类里getIndex方法的签名，如果参数里包含某个签名就表示ChangeQuickRedirect支持修复这个方法。
accessDispatch方法中正常会返回Integer.valueOf(paramArrayOfObject.getIndex())，其中paramArrayOfObject是TestPatch的实例。

6.TestPatch类

public class TestPatch
{
  a originClass;

  public TestPatch(Object paramObject)
  {
    this.originClass = ((a)paramObject);
  }

  public int getIndex()
  {
    EnhancedRobustUtils.invokeReflectStaticMethod("modify", RobustModify.class, getRealParameter(new Object[0]), null);
    return 103;
  }

  public Object[] getRealParameter(Object[] paramArrayOfObject)
  {
    if ((paramArrayOfObject == null) || (paramArrayOfObject.length < 1))
      return paramArrayOfObject;
    Object[] arrayOfObject = new Object[paramArrayOfObject.length];
    int i = 0;
    if (i < paramArrayOfObject.length)
    {
      if (paramArrayOfObject[i] == this)
        arrayOfObject[i] = this.originClass;
      while (true)
      {
        i += 1;
        break;
        arrayOfObject[i] = paramArrayOfObject[i];
      }
    }
    return arrayOfObject;
  }
}

其中getIndex方法对应3中我们修改过Test类中的getIndex方法，返回103。至此我们只需要把这个Patch包打上，就可以实现热修复了。