gson-plugin深入原始碼分析（三）

月籠冰泉發表於2019-01-19
Plugin原始碼

一、專案地址

專案地址：github-gson-plugin

二、ReaderTools解析

/**
 * Created by tangfuling on 2018/10/23.
 */

public class ReaderTools {

  private static JsonSyntaxErrorListener mListener;

  public static void setListener(JsonSyntaxErrorListener listener) {
    mListener = listener;
  }

  /**
   * used for array、collection、map、object
   * skipValue when expected token error
   *
   * @param in input json reader
   * @param expectedToken expected token
   */
  public static boolean checkJsonToken(JsonReader in, JsonToken expectedToken) {
    if (in == null || expectedToken == null) {
      return false;
    }
    JsonToken inToken = null;
    try {
      inToken = in.peek();
    } catch (IOException e) {
      e.printStackTrace();
    }
    if (inToken == expectedToken) {
      return true;
    }
    if (inToken != JsonToken.NULL) {
      String exception = "expected " + expectedToken + " but was " + inToken + " path " + in.getPath();
      notifyJsonSyntaxError(exception);
    }
    skipValue(in);
    return false;
  }

  /**
   * used for basic data type, we only deal type Number and Boolean
   * skipValue when json parse error
   *
   * @param in input json reader
   * @param exception json parse exception
   */
  public static void onJsonTokenParseException(JsonReader in, Exception exception) {
    if (in == null || exception == null) {
      return;
    }
    skipValue(in);
    notifyJsonSyntaxError(exception.getMessage());
  }

  private static void skipValue(JsonReader in) {
    if (in == null) {
      return;
    }
    try {
      in.skipValue();
    } catch (IOException e) {
      e.printStackTrace();
    }
  }

  private static void notifyJsonSyntaxError(String exception) {
    if (mListener == null) {
      return;
    }
    String invokeStack = Log.getStackTraceString(new Exception("syntax error exception"));
    mListener.onJsonSyntaxError(exception, invokeStack);
  }

  public interface JsonSyntaxErrorListener {
    public void onJsonSyntaxError(String exception, String invokeStack);
  }
}

1.對外暴露setListener()介面，使用者可以監聽到Json解析異常。
2.checkJsonToken()方法，用於判斷輸入欄位的資料型別是否與預期的資料型別一致，如果資料型別不一致，則跳過解析，同時通知listener解析失敗。該方法用於判斷array、collection、map、object是否合法。
3.onJsonTokenParseException()方法，會利用javassist對Gson丟擲的Exception進行捕獲，然後呼叫該方法，同時通知listener解析失敗。該方法用於判斷Integer、Boolean等基本資料型別。

三、GsonPlugin外掛編寫

1.ReaderTools.java的setListener()方法需要暴露給使用者使用，但Plugin僅僅是一個外掛，無法將java語言的介面暴露出去給使用者使用，所以需要建立2個工程。
2.gson-plugin-sdk：主要包含ReaderTools.java，與使用者互動的類及方法需要在這個sdk中定義並實現。
3.gson-plugin：主要是侵入編譯流程，並修改Gson的位元組碼，同時在特定的地方呼叫ReaderTools.java中的方法，如checkJsonToken()方法，onJsonTokenParseException()方法等。
4.這樣使用者接入需要引入兩個庫，gson-plugin-sdk和gson-plugin。
5.為了方便使用者接入，可以在gson-plugin中幫助使用者引入gson-plugin-sdk，這樣使用者就只需要引入gson-plugin即可。
6.在gson-plugin中幫助使用者引入gson-plugin-sdk

project.dependencies.add("compile", "com.ke.gson.sdk:gson_sdk:1.3.0")

7.GsonPlugin為外掛入口類，在此註冊自定義的GsonJarTransform

/**
 * Created by tangfuling on 2018/10/25.
 */

class GsonPlugin implements Plugin<Project> {

  @Override
  void apply(Project project) {
    //add dependencies
    project.dependencies.add("compile",
        "com.ke.gson.sdk:gson_sdk:1.3.0")
    //add transform
    project.android.registerTransform(new GsonJarTransform(project))
  }
}

四、GsonJarTransform編譯流程

 @Override
  String getName() {
    return "GsonJarTransform"
  }

  @Override
  void transform(TransformInvocation transformInvocation)
      throws TransformException, InterruptedException, IOException {
    //初始化ClassPool
    MyClassPool.resetClassPool(mProject, transformInvocation)

    //處理jar和file
    TransformOutputProvider outputProvider = transformInvocation.getOutputProvider()
    for (TransformInput input : transformInvocation.getInputs()) {
      for (JarInput jarInput : input.getJarInputs()) {
        // name must be unique，or throw exception "multiple dex files define"
        def jarName = jarInput.name
        if (jarName.endsWith(`.jar`)) {
          jarName = jarName.substring(0, jarName.length() - 4)
        }
        def md5Name = DigestUtils.md5Hex(jarInput.file.getAbsolutePath())
        //source file
        File file = InjectGsonJar.inject(jarInput.file, transformInvocation.context, mProject)
        if (file == null) {
          file = jarInput.file
        }
        //dest file
        File dest = outputProvider.getContentLocation(jarName + md5Name,
            jarInput.contentTypes, jarInput.scopes, Format.JAR)
        FileUtils.copyFile(file, dest)
      }

      for (DirectoryInput directoryInput : input.getDirectoryInputs()) {
        File dest = outputProvider.getContentLocation(directoryInput.name,
          directoryInput.contentTypes, directoryInput.scopes, Format.DIRECTORY)
        FileUtils.copyDirectory(directoryInput.file, dest)
      }
    }
  }

1.初始化ClassPool，javassist中用到的類都需要先加入ClassPath。

/**
 * Created by tangfuling on 2018/10/31.
 */

public class MyClassPool {

  private static ClassPool sClassPool

  public static ClassPool getClassPool() {
    return sClassPool
  }

  public static void resetClassPool(Project project, TransformInvocation transformInvocation) {

    // ClassPool.getDefault() 有可能被其他使用 Javassist 的外掛汙染（如 nuwa），
    // 導致ClassPool中出現重複的類，Javassist丟擲異常，所以不能使用預設的
    sClassPool = new ClassPool()
    sClassPool.appendSystemPath()

    // bootClasspath 包括 android.jar 和 useLibrary 指定的library 的路徑（如 org.apache.http.legacy )
    project.android.bootClasspath.each {
      sClassPool.appendClassPath(it.absolutePath)
    }

    // 其它class
    for (TransformInput input : transformInvocation.getInputs()) {
      for (JarInput jarInput : input.getJarInputs()) {
        sClassPool.appendClassPath(jarInput.file.getAbsolutePath())
      }
      for (DirectoryInput directoryInput : input.getDirectoryInputs()) {
        sClassPool.appendClassPath(directoryInput.file.getAbsolutePath())
      }
    }
  }
}

2.transform處理過程
2.1.在編譯過程中，transform會對專案中所有依賴的jar檔案和專案本身的class檔案進行處理，將處理結果交給下一個步驟，繼續處理。
2.2.如果不做任何處理，那麼transform至少會做一件事情，將輸入的jar檔案和class檔案，拷貝到build/intermediates/transforms/GsonJarTransform目錄。
2.3.gson-plugin需要對gson.jar做處理。

File file = InjectGsonJar.inject(jarInput.file, transformInvocation.context, mProject)

五、處理gson.jar包

/**
 * Created by tangfuling on 2018/10/25.
 */

class InjectGsonJar {

  public static File inject(File jarFile, Context context, Project project) throws NotFoundException {
    if (!jarFile.name.contains("gson")) {
      return null
    }
    println("GsonPlugin: inject gson jar start")
    //原始jar path
    String srcPath = jarFile.getAbsolutePath()

    //原始jar解壓後的tmpDir
    String tmpDirName = jarFile.name.substring(0, jarFile.name.length() - 4)
    String tmpDirPath = context.temporaryDir.getAbsolutePath() + File.separator + tmpDirName

    //目標jar path
    String targetPath = context.temporaryDir.getAbsolutePath() + File.separator + jarFile.name

    //解壓
    Decompression.uncompress(srcPath, tmpDirPath)

    //修改
    InjectReflectiveTypeAdapterFactory.inject(tmpDirPath)
    InjectMapTypeAdapterFactory.inject(tmpDirPath)
    InjectArrayTypeAdapter.inject(tmpDirPath)
    InjectCollectionTypeAdapterFactory.inject(tmpDirPath)
    InjectTypeAdapters.inject(tmpDirPath)

    //重新壓縮
    Compressor.compress(tmpDirPath, targetPath)

    //刪除臨時目錄
    StrongFileUtil.deleteDirPath(tmpDirPath)

    println("GsonPlugin: inject gson jar success")

    //返回目標jar
    File targetFile = new File(targetPath)
    if (targetFile.exists()) {
      return targetFile
    }
    return null
  }
}

1.輸入的gson.jar位置：.gradle/caches/modules-2/files-2.1/com.google.code.gson/gson
2.對輸入的jar包解壓到一個臨時目錄，並對解壓後的class檔案進行修改：build/tmp/transformClassesWithGsonJarTransformForDebug，會生成一個資料夾gson-2.8.5
3.將修改後的檔案重新壓縮到當前目錄：build/tmp/transformClassesWithGsonJarTransformForDebug，會重新生成一個jar包gson-2.8.5.jar
4.刪除步驟2中生成的資料夾gson-2.8.5
5.將tmp目錄下的gson-2.8.5.jar返回
6.transform會將tmp目錄下gson-2.8.5.jar拷貝到build/intermediates/transforms/GsonJarTransform目錄供下一個步驟使用。

六、修改內部類的方法

1.這個Adapter.class的read()方法是對Object型別的資料進行解析，我們判斷輸入的資料型別不是Object型別，就直接跳過解析，核心是在read()方法中插入ReaderTools.checkJsonToken()方法。
2.每一個類、每一個內部類、每一個匿名內部類，都會生成一個獨立的.class檔案，如ReflectiveTypeAdapterFactory.class,ReflectiveTypeAdapterFactory$Adapter.class,ReflectiveTypeAdapterFactory$BoundField.class,ReflectiveTypeAdapterFactory$1.class。
3.遍歷資料夾找到對應的class，通過javassist在read()方法前面插入判斷程式碼。

/**
 * Created by tangfuling on 2018/10/30.
 */

public class InjectReflectiveTypeAdapterFactory {

  public static void inject(String dirPath) {

    ClassPool classPool = MyClassPool.getClassPool()

    File dir = new File(dirPath)
    if (dir.isDirectory()) {
      dir.eachFileRecurse { File file ->
        if ("ReflectiveTypeAdapterFactory.class".equals(file.name)) {
          CtClass ctClass = classPool.getCtClass("com.google.gson.internal.bind.ReflectiveTypeAdapterFactory$Adapter")
          CtMethod ctMethod = ctClass.getDeclaredMethod("read")
          ctMethod.insertBefore("     if (!com.ke.gson.sdk.ReaderTools.checkJsonToken($1, com.google.gson.stream.JsonToken.BEGIN_OBJECT)) {
" +
              "        return null;
" +
              "      }")
          ctClass.writeFile(dirPath)
          ctClass.detach()
          println("GsonPlugin: inject ReflectiveTypeAdapterFactory success")
        }
      }
    }
  }
}

七、位元組碼加 try-catch

1.TypeAdapters.class處理基本資料型別，每個基本資料型別都對應一個匿名內部類

    public static final TypeAdapter<Boolean> BOOLEAN = new TypeAdapter<Boolean>() {
      public Boolean read(JsonReader in) throws IOException {
        if(in.peek() == JsonToken.NULL) {
          in.nextNull();
          return null;
        } else {
          return in.peek() == JsonToken.STRING?Boolean.valueOf(Boolean.parseBoolean(in.nextString())):Boolean.valueOf(in.nextBoolean());
        }
      }

      public void write(JsonWriter out, Boolean value) throws IOException {
        if(value == null) {
          out.nullValue();
        } else {
          out.value(value.booleanValue());
        }
      }
    };

2.找到TypeAdapters的所有內部類，獲取內部類的read()方法的返回值，如果是Number或Boolean型別，新增try-catch程式碼塊，並回撥ReaderTools.onJsonTokenParseException()方法。

/**
 * Created by tangfuling on 2018/10/30.
 */

public class InjectTypeAdapters {

  public static void inject(String dirPath) {

    ClassPool classPool = MyClassPool.getClassPool()

    File dir = new File(dirPath)
    if (dir.isDirectory()) {
      dir.eachFileRecurse { File file ->
        if (file.name.contains("TypeAdapters$")) {
          String innerClassName = file.name.substring(13, file.name.length() - 6)
          CtClass ctClass = classPool.getCtClass("com.google.gson.internal.bind.TypeAdapters$" + innerClassName)
          //only deal type Boolean and Number
          CtMethod[] methods = ctClass.declaredMethods
          boolean isModified = false
          for (CtMethod ctMethod : methods) {
            if ("read".equals(ctMethod.name)) {
              String returnTypeName = ctMethod.getReturnType().name
              if ("java.lang.Number".equals(returnTypeName)
                  || "java.lang.Boolean".equals(returnTypeName)) {
                CtClass etype = classPool.get("java.lang.Exception")
                ctMethod.addCatch("{com.ke.gson.sdk.ReaderTools.onJsonTokenParseException($1, $e); return null;}", etype)
                isModified = true
              }
            }
          }
          if (isModified) {
            ctClass.writeFile(dirPath)
            println("GsonPlugin: inject TypeAdapters success")
          }
          ctClass.detach()
        }
      }
    }
  }
}

3.其中$1表示read()方法的第1個引數JsonReader，$e表示捕獲的Exception

八、目錄

1.gson-plugin告別Json資料型別不一致（一）
2.gson-plugin基礎原始碼分析（二）
3.gson-plugin深入原始碼分析（三）
4.gson-plugin如何在JitPack釋出（四）

相關文章