简体中文 | English |

Xerath

Xerath 是一个通过 [自定义注解]+ASM + Gradle Transform API 实现的一套功能强大，方便开发，并且能够有效减少重复代码的Android Aop 整合开发方案。
旨在编译器进行全局性的修改，来完成一些诸如方法耗时统计，异常收集，拦截，动态代理等特殊需求,以及降低包Size等优化需求
核心思想基于AOP编程，AOP为Aspect Oriented Programming的缩写，意为：面向切面编程
🔧持续开发中，欢迎共建!

快速上手

clone 本工程到本地以后，在根目录打开终端执行以下指令，就可以成功跑起来!

sh upload.sh 

### 引入方式 待上传到Maven,目前可以主动依赖 XerathLib 到你自己的工程中。

功能列表(补充中)

使用说明

1.限制方法频繁调用
在目标方法处增加 @Xerath_LimitCall(time = 1000L) 注解,其中time为频繁调用的时间阈值。

    @Xerath_LimitCall(time = 1000L)
    public static void doubleClick() {
        //do something
    }

2.方法try-catch异常捕获
在目标方法处增加 @Xerath_TryCatch 注解。

    @TryCatch
    public static void tryCatchMethod() {
        int a = 1 / 0;
    }

3.方法移除
在目标方法处增加 @Xerath_MethodRemove 注解,其中removeMethods传入需要移除的目标方法，可传多个。

    @Xerath_MethodRemove(
            removeMethods = {
                    "android/util/Log|d|(Ljava/lang/String;Ljava/lang/String;)I",
                    "android/widget/Toast|makeText|(Landroid/content/Context;Ljava/lang/CharSequence;I)Landroid/widget/Toast;",
                    "android/widget/Toast|()V"
            }
    )
    public static void tryRemoveMethod(Context context) {
        Log.d("nangua","nangua");
        Toast.makeText(context,"",Toast.LENGTH_SHORT).show();
    }

4.弹出Toast
在目标方法处增加 @Xerath_PopToast 注解,其中str为需要显示Toast的内容。

    @Xerath_PopToast(str = "测试Toast")
    public static void popToast() {
        //do something
    }

5.统计方法耗时
在目标方法处增加 @Xerath_CalculateTime 注解。

    @CalculateTime
    public static void CalculateTimeMethod() {
        //do something
    }

6.方法出入参和返回值统计
在目标方法处增加 @Xerath_CollectParams 注解。

    @Xerath_CollectParams
    public static String testParams(boolean boolParam, byte byteParam, char charParam, short shortParam, int intParam, long longParam,
                                    float floatParam, double doubleParam, String stringParam, int[] intArrParam, JSONObject json) {
        String result = boolParam + " " + byteParam + " " + charParam + " " + shortParam + " " + intParam + " " +
                longParam + " " + floatParam + " " + doubleParam + " " + stringParam + " " + intArrParam.length + json.toString();
        return result;
    }

7.全局遍历抓取

8.调用链路统计
在需要跟踪调用链路的目标方法处增加 @Xerath_CallChain 注解。

    @Xerath_CallChain
    public void doSomeThing() {
        //do something
    }

参与贡献

1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request

鸣谢

• ByteX
• Hunter
• AopArms

待完成需求

• 增加生效控制(全局，包类名)范围
• 增加快速部署功能，可供第三方应用进行快速部署ASM插件
• 增加包size优化功能-预编译，统计优化前后大小对比
• 增加包size优化功能-删除unused代码
• 增加包size优化功能-方法内联优化
• 增加包size优化功能-静态变量优化

License

Copyright 2022, Jiang Zhengnan

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.