很久没有更新了,最近做了个小功能,想把代码打成 .jar文件给别人引用。除了基本的调用方法,其余核心代码都经过混淆打包。用到了ant+proguard,这里记录一下。
ProGuard是一个压缩、优化和混淆Java字节码文件的免费的工具,它可以删除无用的类、字段、方法和属性。可以删除没用的注释,最大限度地优化字节码文件。它还可以使用简短的无意义的名称来重命名已经存在的类、字段、方法和属性。常常用于Android开发用于混淆最终的项目,增加项目被反编译的难度。android的sdk中已经有此工具,在sdk\tools\proguard\lib\proguardgui.jar,打包是可以直接用此工具混淆,只是流程比较复杂,需要手动更改其中的配置。如图:
大致的流程就是选择需要打包的java文件,export执行打包成一个.jar文件 然后通过proguard一步一步选择,配置就可以混淆打包了。详细步骤及配置就不说了,网上很多例子。 下面主要讲一下 怎样用ant执行build文件来混淆打包 。
Ant是Apache软件基金会JAKARTA目录中的一个子项目,它有以下的优点。跨平台性。Ant是纯Java语言编写的,所以具有很好的跨平台性。操作简单。Ant是由一个内置任务和可选任务组成的。Ant运行时需要一个XML文件(构建文件)。 Ant通过调用target树,就可以执行各种task。每个task实现了特定接口对象。由于Ant构建文件 是XML格式的文件,所以很容易维护和书写,而且结构很清晰。Ant可以集成到开发环境中。由于Ant的跨平台性和操作简单的特点,它很容易集成到一些开发环境中去。
安装和配置环境变量
到官方主页http://ant.apache.org下载新版的ant,得到的是一个apache-ant-bin.zip的压缩包。将其解压到你的硬盘上。
window中设置ant环境变量:
ANT_HOME C:/ apache-ant-1.8.1
path C:/ apache-ant-1.8.1/bin
classpath C:/apache-ant-1.8.1/lib
测试是否配置成功
ant执行需要一个build文件,此次项目用到的build文件配置
<?xml version="1.0" encoding="UTF-8"?> <project name="ProjectName" basedir="." default="optimize_class" > <!-- 设置全局属性 --> <property file="project.properties" /> <property environment="env" /> <property name="encode" value="utf-8"/> <property name="debug" value="false"/> <property name="includeAntRuntime" value="false"/> <property name="target_version" value="1.7"/> <property name="src_dir" value="${basedir}\src"/> <!-- ======================================== 工程构建目录 ======================================== --> <property name="build_dir" value="${basedir}\build" /> <property name="java_build_dir" value="${build_dir}\java" /> <property name="class_build_dir" value="${build_dir}\class" /> <property name="jar_build_dir" value="${build_dir}\jar"/> <property name="unOptimize_jar_build_dir" value="${jar_build_dir}\unOptimize.jar"/> <!-- ======================================== 构建完成文件 ======================================== --> <property name="release_jar_dir" value="${basedir}\${releaseJar}"/> <!-- 声明第三方依赖的jar --> <path id="dependencies"> <fileset dir="${basedir}\libs"> <include name="**/*.jar" /> </fileset> </path> <!-- 引入Android依赖 --> <property name="lib.android" value="${sdk.dir}\platforms\${target}\android.jar" /> <!-- 引入混淆依赖 --> <property name="lib.proguard" value="E:\adt-bundle-windows-x86_64-20140702\sdk\tools\proguard\lib\proguard.jar" /> <!-- dx命令(当前系统为windows,如果系统为linux,可将.bat文件替换成相对应的命令) --> <property name="dx" value="${sdk.dir}\build-tools\24.0.1\dx.bat" /> <!-- 拆分java文件--> <target name="init"> <mkdir dir="${build_dir}" /> <mkdir dir="${java_build_dir}" /> <mkdir dir="${class_build_dir}" /> <mkdir dir="${jar_build_dir}" /> </target> <!-- 拆分java文件 --> <target name="separate_java" depends="init"> <copy todir="${java_build_dir}" > <fileset dir="${src_dir}" > <include name="com/project/package/*.java" /> </fileset> </copy> </target> <!-- 编译java文件 --> <target name="compile_java" depends="separate_java" > <javac bootclasspath="${lib.android}" debug="${debug}" destdir="${class_build_dir}" encoding="${encode}" includeAntRuntime="${includeAntRuntime}" srcdir="${java_build_dir}" target="${target_version}"> <classpath refid="dependencies" /> </javac> </target> <!-- 混淆class文件 --> <target name="optimize_class" depends="compile_java" > <!-- class文件生成jar包 --> <jar destfile="${unOptimize_jar_build_dir}" > <fileset dir="${class_build_dir}" includes="**/*.class" /> </jar> <!-- jar包进行混淆 --> <java failοnerrοr="true" fork="true" jar="${lib.proguard}" > <jvmarg value="-Dmaximum.inlined.code.length=32" /> <arg value="-injars ${unOptimize_jar_build_dir}"/> <arg value="-outjars ${release_jar_dir}"/> <arg value="-libraryjars ${lib.android}"/> <arg value="-dontpreverify"/> <arg value="-dontoptimize"/> <arg value="-dontusemixedcaseclassnames"/> <arg value="-allowaccessmodification"/> <arg value="-optimizationpasses 7"/> <arg value="-verbose"/> <arg value="-dontskipnonpubliclibraryclasses"/> <arg value="-dontskipnonpubliclibraryclassmembers"/> <arg value="@${proguard.cfg}"/> </java> <!-- 删除构建目录 --> <delete dir="${build_dir}"/> </target> </project>
常用基本配置不用管,注意其中几个地方:
1. <property file="project.properties" /> 指定文件,设置全局属性
2.<property name="encode" value="utf-8"/> 项目的编码格式
3.<property name="target_version" value="1.7"/> java的jdk版本
4. <include name="com/project/package/*.java" /> 需要混淆的java类,这里是将package包下面的所有类都混淆,可以根据自己的项目结构更改此处。
build.xml常用标签说明:
1 .<project> 标签 每个构建文件对应一个项目。<project>标签是构建文件的根标签。它可以有多个内在属性, 就如代码中所示,其各个属性的含义分别如下。 (1) default表示默认的运行目标,即指定默认的target(即任务)。这个属性是必须的。 (2) basedir表示项目的基准目录。 (3) name表示项目名。 (4) description表示项目的描述。 2 .<target> 标签 一个项目标签下可以有一个或多个target标签。一个target标签可以依赖其他的target标签。例 如,有一个target用于编译程序,另一个target用于生成 可执行文件。在生成可执行文件之前必须先编译该文件,因此可执行文件的target依赖于编译程序的target。Target的所有属性如下。 (1).name表示目标名,这个属性是必须的。 (2).depends表示依赖的目标。 (3)if表示仅当属性设置时才执行。 (4)unless表示当属性没有设置时才执行。 (5)description表示项目的描述。 Ant的depends属性指定了target的执行顺序。Ant会依照depends属性中target出现顺序依次执行 每个target。在执行之前,首先需要执行它所依赖的target。程序中的名为run的target的 depends属性compile,而名为compile的target的depends属性是prepare,所以这几个target执 行的顺序是prepare->compile->run。一个target只能被执行一次,即使有多个target依赖于它。如果没有if或unless属性target总 会被执行。 3.<mkdir> 标签 该标签用于创建一个目录,它有一个属性dir用来指定所创建的目录名,其代码如下: <mkdir dir=”${class.root}”/> 通过以上代码就创建了一个目录,这个目录已经被前面的property标签所指定。 4 <jar> 标签 该标签用来生成一个JAR文件,其属性如下。 (1) destfile表示JAR文件名。 (2) basedir表示被归档的文件名。 (3) includes表示被归档的文件模式。 (4) excludes表示被排除的文件模式。 5 .<javac标签> 该标签用于编译一个或一组java文件,其属性如下。 (1).srcdir表示源程序的目录。 (2).destdir表示 class文件的输出目录。 (3).include表示被编译的文件的模式。 (4).excludes表示被排除的文件的模式。 (5).classpath表示所使用的类路径。 (6).debug表示包含的调试信息。 (7).optimize表示是否使用优化。 (8).verbose 表示提供详细的输出信息。 (9).fileonerror表示当碰到错误就自动停止。 6 .<java>标签 该标签用来执行编译生成的. class文件,其属性如下。 (1).classname 表示将执行的类名。 (2).jar表示包含该类的JAR文件名。 (3).classpath所表示用到的类路径。 (4).fork表示在一个新的 虚拟机中运行该类。 (5).failonerror表示当出现错误时自动停止。 (6).output 表示输出文件。 (7).append表示追加或者覆盖默认文件。 7 .<delete> 标签 该标签用于删除一个文件或一组文件,去属性如下。 (1)/file表示要删除的文件。 (2).dir表示要删除的目录。 (3).includeEmptyDirs 表示指定是否要删除空目录,默认值是删除。 (4).failonerror 表示指定当碰到错误是否停止,默认值是自动停止。 (5).verbose表示指定是否列出所删除的文件,默认值为不列出。 8 .<copy> 标签 该标签用于文件或文件集的拷贝,其属性如下。 (1).file 表示 源文件。 (2).tofile 表示目标文件。 (3).todir 表示目标目录。 (4).overwrite 表示指定是否覆盖目标文件,默认值是不覆盖。 (5).includeEmptyDirs 表示指定是否拷贝空目录,默认值为拷贝。 (6).failonerror 表示指定如目标没有发现是否自动停止,默认值是停止。 (7).verbose 表示制定是否显示详细信息,默认值不显示。 9 .<exec> 执行文件: <execexecutable="${base.dir}/email.bat" > </exec> 配置 project.properties文件 # This file is automatically generated by Android Tools. # Do not modify this file -- YOUR CHANGES WILL BE ERASED! # # This file must be checked in Version Control Systems. # # To customize properties used by the Ant build system edit # "ant.properties", and override values to adapt the script to your # project structure. # # To enable ProGuard to shrink and obfuscate your code, uncomment this (available properties: sdk.dir, user.home): #proguard.config=${sdk.dir}/tools/proguard/proguard-android.txt:proguard-project.txt # Project target. sdk.dir=E:\\adt-bundle-windows-x86_64-20140702\\sdk target=android-17 android.library=false proguard.cfg=proguard.cfg releaseJar=output.jar sdk.dir是android的sdk目 releaseJar是输出的jar名字,可以任取 再配置 proguard.cfg文件,此文件就是混淆要设置的,哪些类的方法要公开,哪些类的方法要混淆,都是在这里设置 -optimizationpasses 5 -dontusemixedcaseclassnames -dontskipnonpubliclibraryclasses -dontpreverify -dontwarn -dontnote -verbose -optimizations !code/simplification/arithmetic,!field/*,!class/merging/* -dump proguard/class_files.txt -printseeds proguard/seeds.txt -printusage proguard/unused.txt -printmapping proguard/mapping.txt -keep public class * extends android.app.Activity -keep public class * extends android.app.Application -keep public class * extends android.app.Service -keep public class * extends android.content.BroadcastReceiver -keep public class * extends android.content.ContentProvider -keep public class * extends android.app.backup.BackupAgentHelper -keep public class * extends android.preference.Preference -keep public class com.android.vending.licensing.ILicensingService -keep public class com.gn.qiaw.mn.Entry { public static <methods>; } -keep public class com.gn.qiaw.mn.PayCallBack { public <methods>; } -keepclasseswithmembernames class * { native <methods>; } -keepclasseswithmembers class * { public <init>(android.content.Context, android.util.AttributeSet); } -keepclasseswithmembers class * { public <init>(android.content.Context, android.util.AttributeSet, int); } -keepclassmembers class * extends android.app.Activity { public void *(android.view.View); } -keepclassmembers enum * { public static **[] values(); public static ** valueOf(java.lang.String); } -keep class * implements android.os.Parcelable { public static final android.os.Parcelable$Creator *; } 最后, 添加proguard文件夹,拷入需要引用的文件proguard.jar,proguardgui.jar,retrace.jar 整个项目的文件目录为: 准备工作做完了, 开始执行build文件,打开cmd命令,输入ant -f build.xml,开始执行 执行成功显示BUILD SUCCESSFUL。 刷新项目,项目根目录就会出现刚刚要输入的 output.jar。 用反编译工具 gd-gui 打开刚刚的文件查看是否混淆成功 可以看到,除了我们在proguard.cfg设置的两个类没有被混淆,其余的都混淆成功了 -keep public class com.gn.qiaw.mn.Entry { public static <methods>; } -keep public class com.gn.qiaw.mn.PayCallBack { public <methods>; } 最后就可以把你的jar给别人用啦!! jar运行时如果出现了下面这个错误,一般都是jdk运行无法解析某些类,我的jdk版本是1.8的,但是proguard可以尝试将build.xml文件中的 <property name="target_version" value="1.7"/> jdk版本改为1.7,就可以运行了。 Dx unsupported class file version 52.0 Conversion to Dalvik format failed with error 1