Merge pull request #4 from NasdaqGodzilla/develop

Develop

Author: NasdaqGodzilla

Android.bp

@@ -0,0 +1,9 @@
+java_binary_host {
+    name: "framework_injector",
+    manifest: "manifest.txt",
+    srcs: ["src/**/*.java"],
+    static_libs: [
+        "javassist_default",
+        "jackson_2.13.1",
+    ],
+}

MANIFEST.MF

@@ -0,0 +1,2 @@
+Main-Class: peacemaker.frameworkinjector.Main
+Class-Path: libs/jackson-annotations-2.13.1.jar libs/jackson-core-2.13.1.jar libs/jackson-databind-2.13.1.jar libs/javassist.jar

README.md

@@ -0,0 +1,72 @@
+# FrameworkInjector
+
+![](https://cdn.jsdelivr.net/gh/NasdaqGodzilla/PeacePicture/img/logo_frameworkInjector.png)
+
+[中文说明](https://github.com/NasdaqGodzilla/FrameworkInjector/blob/develop/README_CN.md)
+
+`FrameworkInjector` is an AOP framework for Java which is managing pointcut configurations by json and performing code weaving with `Javassist`.
+
+_At the begining, `FrameworkInjector` is designed for AOP code weaving of Android framework. This is the origin of the name._
+
+# Feature
+1. Managing AOP pointcut configurations by JSON
+2. Perform code weaving on specified Java class method
+3. Support wildcard while matching class and method name
+4. [BUG][TODO] Skipping interface class so that interface currently would not perform code weaving.
+
+# Setup
+```
+source build.sh
+```
+
+Run `build.sh` to compile by `javac` and package by `jar`. The final target is runnable jar.
+
+# Usage
+The runnable jar of this program support parameters:
+1. `--pointcuts_json` Sets path of json that managing pointcut configurations
+2. `-i` Sets the input jar file which performing weaving from
+3. `-o` Sets the output jar file which is been injected
+4. `-cplist` Class Path List for Javassist. In case of class that exists in the input jar is not able to found in system class path, passing the path of the class to Javassist with this params to help Javassist load it. Every path is concat by ':'(Check it on JDK specifications).
+
+## Run the sample
+```
+source build_and_run_sample.sh
+```
+
+`build_and_run_sample.sh` contains a lot of steps. It will make this program by calling `build.sh`. And then runs the inside sample(`sample/sample.json`). The sample will make this program perform code weaving on the jar generated by `build.sh`
+
+## Run
+
+Perform code weaving on foo.jar:
+
+```
+java -jar frameworkinjector.jar -cplist "libs" -pointcuts_json myPointcuts.json -i foo.jar -o injected_foo.jar
+```
+
+When error like "Class NotFound" happends, it is useful that add class path:
+
+```
+java -Xbootclasspath/a:/path/myPath:<other> <...other cmd parts...>
+```
+
+# How it works
+
+![](https://cdn.jsdelivr.net/gh/NasdaqGodzilla/PeacePicture/img/FrameworkInjector架构.drawio.png)
+
+- Perform code weaving with [Javasist](https://github.com/jboss-javassist/javassist)
+- Parse json with [Jackson](https://github.com/FasterXML/jackson)
+
+# Sample
+1. Run `build_and_run_sample.sh`, which will perform code weaving configed by [sample.json](https://github.com/NasdaqGodzilla/FrameworkInjector/blob/main/sample/sample.json)
+2. A new jar that is injected will be produced from step 1. It containes codes injected by this program. In the case of the sample, a new `System.out.println` call is injected which shown as below.
+
+![](https://cdn.jsdelivr.net/gh/NasdaqGodzilla/PeacePicture/img/FrameworkInject_Wildcard_result.png)
+
+# LICENSE
+Copyright (C) <2022> <copyright Niko Zhong>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README_CN.md

@@ -0,0 +1,72 @@
+# FrameworkInjector
+
+![](https://cdn.jsdelivr.net/gh/NasdaqGodzilla/PeacePicture/img/logo_frameworkInjector.png)
+
+[English Edition](https://github.com/NasdaqGodzilla/FrameworkInjector)
+
+`FrameworkInjector`是一个Java的AOP框架。它通过json文件配置AOP切点信息，使用`Javassist`对Jar包进行插桩实现AOP。
+
+_最初，`FrameworkInjector`被设计用于对Android framework进行AOP插桩，这是其命名的渊源。_
+
+# Feature
+1. JSON文件管理AOP插桩切点配置
+2. 对指定方法进行插桩
+3. 支持通配符匹配类和方法
+4. [BUG][TODO] 目前暂时跳过了接口类，对接口类（interface）不执行插桩
+
+# Setup
+```
+source build.sh
+```
+
+执行`build.sh`即可编译得到`frameworkinjector.jar`，它通过`javac`编译，`jar`打包。
+
+# Usage
+本工具通过java执行编译得到的jar包，其中需要传递参数：
+1. `--pointcuts_json` 设置切点配置文件json的路径
+2. `-i` 输入的被插桩的jar包
+3. `-o` 输出的被插桩后的jar包
+4. `-cplist` Class Path List。作为额外的类加载路径提供给Javassist。当被插桩的类依赖了其他jar包且该jar包不在ClassLoader的默认搜索路径时，通过该参数告知Javassist以使其能够找到并加载类。多个路径使用冒号分隔(详见对应平台的JDK标准)
+
+## Run the sample
+```
+source build_and_run_sample.sh
+```
+
+`build_and_run_sample.sh`集成了一些步骤，它能完成一次编译打包，并运行一个内置的样本。该样本是对本工程编译出来的jar包进行插桩，即自己对自己进行插桩。
+
+## Run
+
+对foo.jar进行插桩：
+
+```
+java -jar frameworkinjector.jar -cplist "libs" -pointcuts_json myPointcuts.json -i foo.jar -o injected_foo.jar
+```
+
+当出现Class NotFound时，尝试加入对应类的jar包的路径：
+
+```
+java -Xbootclasspath/a:/path/myPath:<other> <...other cmd parts...>
+```
+
+# How it works
+
+![](https://cdn.jsdelivr.net/gh/NasdaqGodzilla/PeacePicture/img/FrameworkInjector架构.drawio.png)
+
+- Perform code weaving with [Javasist](https://github.com/jboss-javassist/javassist)
+- Parse json with [Jackson](https://github.com/FasterXML/jackson)
+
+# Sample
+1. Run `build_and_run_sample.sh`, which will perform code weaving configed by [sample.json](https://github.com/NasdaqGodzilla/FrameworkInjector/blob/main/sample/sample.json)
+2. A new jar that is injected will be produced from step 1. It containes codes injected by this program. In the case of the sample, a new `System.out.println` call is injected which shown as below.
+
+![](https://cdn.jsdelivr.net/gh/NasdaqGodzilla/PeacePicture/img/FrameworkInject_Wildcard_result.png)
+
+# LICENSE
+Copyright (C) <2022> <copyright Niko Zhong>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

build.sh

@@ -0,0 +1,27 @@
+#!/bin/bash
+
+OUT="out""$RANDOM"
+LIB="libs"
+MANIFEST="MANIFEST.MF"
+TARGET="frameworkinjector"_"$OUT"".jar"
+
+function setup() {
+    rm -rf "$OUT"
+    mkdir "$OUT"
+}
+
+function clean() {
+    rm -rf "$OUT"
+}
+
+function build_impl() {
+    javac -cp "$LIB""/*" -d "$OUT"  src/frameworkinjector/*
+    jar cvfm "$TARGET" "$MANIFEST" -C "$OUT" peacemaker/frameworkinjector/
+}
+
+setup
+build_impl
+clean
+
+echo
+ls "$TARGET"

build_and_run_sample.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+source build.sh
+
+INJECTED_TARGET="injected_""$TARGET"
+
+java -jar "$TARGET" -cplist "$LIB" -pointcuts_json sample/sample.json -i "$TARGET" -o "$INJECTED_TARGET"
+
+echo
+ls "$INJECTED_TARGET"
+