以下内容为原创,欢迎转载,转载请注明

来自天天博客:http://www.cnblogs.com/tiantianbyconan/p/6732128.html

Android Gradle 插件 DiscardFilePlugin(清空类和方法)

An android gradle plugin for discard class or method in compile time.

用于在编译构建时期忽略清空类和方法的一个Android Gradle插件。

Github: https://github.com/wangjiegulu/DiscardFilePlugin

1.1 使用场景

在实际的生产中,我们总是会在我们的app中增加一些调试的工具,比如在debug模式下加入DebugPanelActivity(调试面板工具页面,提供比如“切换服务器”等操作)。我们需要在正式上线的release版本中清空相关类和方法,或者修改boolean isProductionEnvironment()方法,让它永远返回true以此来避免上线之后调试相关代码通过反编译等手段暴露出来。

1.2 @Discard注解

1.2.1 Target

  • ElementType.METHOD: 表示清空方法中的代码,编译过程中该方法中代码被清空。

  • ElementType.TYPE: 表示清空类,其实是清空类中的所有方法。

1.2.2 参数

1.2.2.1 apply

apply参数规范:key==exceptValue

表示当key==exceptValue时,Discard才会生效,才会真正在编译时去对方法或者类进行清空。因此可以在每个方法或者类中去进行不同的配置,在不同状态下通过如下方式对不同方法进行Discard:

@Discard(apply = "test1==true")
public void testMethod_1() {
System.out.println("testMethod_1...");
} @Discard(apply = "test2==true")
public void testMethod_2() {
System.out.println("testMethod_2...");
}

使用gradle assembleDebug -Ptest1=true -Ptest2=false来构建时,testMethod_1()方法会被discard,而testMethod_2()不会被discard。构建完毕反编译class结果如下:

@Discard(apply = "test1==true")
public void testMethod_1() {
} @Discard(apply = "test2==true")
public void testMethod_2() {
System.out.println("testMethod_2...");
}

1.2.2.2 srcCode

替换方法的方法体,如果不设置,默认discard方法实现:

  • 返回类型为void: discard后方法体为{}
  • 返回类型为原始数据类型:discard后方法返回默认值,比如{ return 0; }
  • 返回类型为类对象时: discard后方法返回为{ return null; }

可以如下填写具体的方法体代码块:

@Discard(srcCode = "{super.onCreate($1); System.out.println(\"this: \" + $0);}")
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
usernameEt = (EditText) findViewById(R.id.activity_main_username_et);
passwordEt = (EditText) findViewById(R.id.activity_main_password_et);
setTestAccount();
}

discard之后的class反编译代码如下:

@Discard(
srcCode = "{super.onCreate($1); System.out.println(\"this: \" + $0);}"
)
protected void onCreate(Bundle var1) {
super.onCreate(var1);
System.out.println("this: " + this);
}

方法的$0表示当前对象this,方法参数依次为$1, $2, $3...详细文档参考这里

1.2.2.3 makeClassNames

可以在这里指定具体的类名,在discard时对未在classPath的类进行make。不常用,可以省略。

1.2.2.4 enable

表示该方法或者类的discard是否开启,默认为true,比较典型的场景为,在类上面增加@Discard对该类所有方法进行discard,但是需要某个方法不discard,这时可以使用@Discard(enable = false)来对方法进行排除在discard范围外。

1.3 使用方式

Gradle(Check newest version):

build.gradle in Project:

buildscript {
repositories {
jcenter()
}
dependencies {
classpath 'com.android.tools.build:gradle:2.2.2'
// NOTE: Do not place your application dependencies here; they belong
// in the individual module build.gradle files
classpath 'com.github.wangjiegulu:discardfile:x.x.x'
}
}

build.gradle in app or library:

apply plugin: 'com.github.wangjiegulu.plg.discardfile'

dependencies {
compile 'com.github.wangjiegulu:discardfile-api:x.x.x'
}

1.3.1. build.gradle

// 使用插件
apply plugin: 'com.github.wangjiegulu.plg.discardfile' // 配置需要修改的类所属在那些包下
discard {
includePackagePath 'com.wangjie.plg.discardfile.sample.ui', 'com.wangjie.plg.discardfile.sample.include'
excludePackagePath 'com.wangjie.plg.discardfile.sample.exclude'/*, 'com.wangjie.plg.discardfile.sample.ui.MainActivity'*/
}

1.3.2. 使用@Discard注解

创建自定义apply配置(publishdisable两种apply配置):

public class ApplyConstants {
public static class Publish {
private static final String PUBLISH = "publish";
public static final String _TRUE = PUBLISH + "==true";
}
public static class DISABLE {
private static final String DISABLE = "disable";
public static final String _TRUE = DISABLE + "==true";
}
}

在需要清空的类上添加@Discard注解,apply = ApplyConstants.Publish._TRUE表示只有在publish=true的情况下,才会执行Discard。

@Discard(apply = ApplyConstants.Publish._TRUE)
public class IncludeClassC { /**
* 因为IncludeClassC类增加了`@Discard`注解,所以该方法也会被discard。
*/
public void onIncludeMethodC() {
System.out.println("onIncludeMethodC...");
} /**
* 替换该方法的实现为:{System.out.println("onIncludeMethodC_2... injected!");}
*/
@Discard(apply = ApplyConstants.Publish._TRUE, srcCode = "{System.out.println(\"onIncludeMethodC_2... injected!\");}")
public void onIncludeMethodC_2() {
System.out.println("onIncludeMethodC_2...");
} /**
* 替换该方法永远返回true
*/
@Discard(apply = ApplyConstants.Publish._TRUE, srcCode = "{return true;}")
public boolean onIncludeMethodC_3() {
System.out.println("onIncludeMethodC_3...");
return false;
} /**
* 因为IncludeClassC类增加了`@Discard`注解,所以该方法也会被discard。
*/
public int onIncludeMethodC_4() {
System.out.println("onIncludeMethodC_4...");
return 100;
} /**
* 由于使用了`@Discard`注解进行显式地声明禁用了本地的discard,所以该方法不会被discard
*/
@Discard(apply = ApplyConstants.Publish._TRUE, enable = false)
public String onIncludeMethodC_5() {
System.out.println("onIncludeMethodC_5...");
return "hello world";
} /**
* 替换该方法永远返回"hello world"字符串
*/
@Discard(apply = ApplyConstants.Publish._TRUE, srcCode = "{return \"hello world injected!\";}")
public String onIncludeMethodC_6() {
System.out.println("onIncludeMethodC_6...");
return "hello world";
}
}

1.3.3. build运行

通过以下命令进行构建:

gradle clean assembleFullDebug -Ppublish=true -Pdisable=true

命令编译完成之后,该类的class文件将会根据配置的@Discard注解被自动修改成如下:

build/intermediates/transforms/discardFile/.../IncludeClassC.class
@Discard(
apply = "publish==true"
)
public class IncludeClassC {
public IncludeClassC() {
} public void onIncludeMethodC() {
Object var10000 = null;
} @Discard(
apply = "publish==true",
srcCode = "{System.out.println(\"onIncludeMethodC_2... injected!\");}"
)
public void onIncludeMethodC_2() {
System.out.println("onIncludeMethodC_2... injected!");
} @Discard(
apply = "publish==true",
srcCode = "{return true;}"
)
public boolean onIncludeMethodC_3() {
return true;
} public int onIncludeMethodC_4() {
return 0;
} @Discard(
apply = "publish==true",
enable = false
)
public String onIncludeMethodC_5() {
System.out.println("onIncludeMethodC_5...");
return "hello world";
} @Discard(
apply = "publish==true",
srcCode = "{return \"hello world injected!\";}"
)
public String onIncludeMethodC_6() {
return "hello world injected!";
}
}

[Android]Gradle 插件 DiscardFilePlugin(class注入&清空类和方法)的更多相关文章

  1. Android Gradle插件

    目录 什么是Gradle 编写方法 buildSrc 基础概念 Extension 自定义Task Plugin Transformer Gradle用处 好文章 常见问题 Gradle插件练习地址: ...

  2. 《Gradle权威指南》--Android Gradle插件

    No1: Android Gradle插件分类 App插件id:com.android.application Library插件id:com.android.library Test插件id:com ...

  3. Android Gradle 学习笔记(七):Android Gradle 插件

    我们知道Android Gradle其实就是一个Gradle的一个第三方插件,它是由Google的Android团队开发的,基于Gradle构建的,和Android Studio完美搭配.相比于旧的构 ...

  4. 【Gradle】Android Gradle 插件

    Android Gradle 插件 Android Gradle 插件简介 从Gradle角度来看,Android其实是Gradle的一个第三方插件,它是由Google的Android团队开发的.但从 ...

  5. Gradle系列之Android Gradle插件

    原文发于微信公众号 jzman-blog,欢迎关注交流. 通过前面几篇文章学习了 Gradle 基础知识以及 Gradle 插件相关的知识,关于 Gradle 及其插件相关知识请先阅读下面几篇文章: ...

  6. Android Gradle插件(plugin)版本(version)与Gradle、SDK Build Tools版本关系

    具体关系如下图: 比如,Android Studio 2.0发布,其中有个新功能“Instant Run”,需要Android Gradle Plugin版本2.0.0以上,那么我们项目的.gradl ...

  7. Android端生成META-INF信息文件的Gradle插件 RapidMetaInfPlugin

    来源博客:Wang Jie's Blog 本文链接:<http://blog.wangjiegulu.com/2018/02/05/Android端生成META-INF信息文件的Gradle插件 ...

  8. Android官方技术文档翻译——Gradle 插件用户指南(7)

    本文译自Android官方技术文档<Gradle Plugin User Guide>,原文地址:http://tools.android.com/tech-docs/new-build- ...

  9. Android Gradle 学习笔记(六):Gradle 插件

    Gradle 本身提供了一些基本的概念和整体核心的框架,其他用于描述真实使用场景的都可以通过插件扩展的方式来实现.这样就可以通过抽象的方式提供一个核心的框架,其他具体的功能和业务都通过插件扩展的方式来 ...

随机推荐

  1. 微信小程序之提高应用速度小技巧

    作者:vicyao, 腾讯web前端开发 高级工程师商业转载请联系腾讯WeTest获得授权,非商业转载请注明出处. 原文链接:http://wetest.qq.com/lab/view/294.htm ...

  2. PHP文本的读写

    <?php $txtPart="test0.txt"; //export $txtPartContent=fopen($txtPart,"r"); //读 ...

  3. Oracle物化视图,物化视图日志,增量刷新同步远程数据库

    1.创建DBLINK -- Drop existing database link drop public database link LQPVPUB; -- Create database link ...

  4. 安装Eclipse(android)新建项目时遇到的问题

    ---恢复内容开始--- 解决方案: 我先删掉了新建的项目,重新建立项目时 将API都选成相同的API19:... 然后就成功了 ---恢复内容结束---

  5. 学习ASP.NET MVC(十一)——分页

    在这一篇文章中,我们将学习如何在MVC页面中实现分页的方法.分页功能是一个非常实用,常用的功能,当数据量过多的时候,必然要使用分页.在今天这篇文章中,我们学习如果在MVC页面中使用PagedList. ...

  6. web从入门开始(2)----基础

    HTML文件结构 <html> <head>//网页头标记 <title>放置标题</title> </head> <body> ...

  7. spring定时器的使用

    Spring定时任务在有的项目中起到很关键的作用,它允许你通过配置来指定特定时间去调用特定类的特定方法. 一. 分类 1.作业类需要继承特定的类.特定的类有: org.springframework. ...

  8. 实用 .htaccess 用法大全

    这里收集的是各种实用的 .htaccess 代码片段,你能想到的用法几乎全在这里. 免责声明: 虽然将这些代码片段直接拷贝到你的 .htaccess 文件里,绝大多数情况下都是好用的,但也有极个别情况 ...

  9. Brackets--我的初恋编辑器

    大学毕业以后,因为一些个人琐事没有找到自己专业的对口工作,整天混混沌沌得过着也没有打破现状的决心和机会.但是每当独自思考的时候总是一阵阵的害怕,怕自己从此一事无成一无所有.于是在某个心潮澎湃的瞬间开始 ...

  10. dotweb——go语言的一个微型web框架(一)

    dotweb是16年正式托管到github的一个开源项目,go语言的web框架目前也有很多,出名的有bee和echo.它们都是很优秀的框架,但是我们喜欢更轻.更小的东西,经历一些之后我们更青睐微服务这 ...