proguard的作用
ProGuard是一个压缩、优化和混淆Java字节码文件的免费的工具,它可以删除无用的类、字段、方法和属性。可以删除没用的注释,最大限度地优化字节码文件。它还可以使用简短的无意义的名称来重命名已经存在的类、字段、方法和属性。常常用于Android开发用于混淆最终的项目,增加项目被反编译的难度。 ——百度百科
混淆前准备
确定需要混淆的包(目前大致确定为除runner外的所有包)
具体步骤
1)引入maven插件
这里以base-common模块作为示例
示例代码如下
<!-- ProGuard混淆插件 -->
<plugin>
<groupId>com.github.wvengen</groupId>
<artifactId>proguard-maven-plugin</artifactId>
<version>2.6.0</version>
<executions>
<execution>
<!-- 混淆时刻,这里是打包的时候混淆 -->
<phase>package</phase>
<goals>
<!-- 使用插件的什么功能,当然是混淆 -->
<goal>proguard</goal>
</goals>
</execution>
</executions>
<configuration>
<!-- 是否将生成的PG文件安装部署 -->
<attach>true</attach>
<!-- 是否混淆 -->
<obfuscate>true</obfuscate>
<!-- 指定生成文件分类 -->
<attachArtifactClassifier>pg</attachArtifactClassifier>
<options>
<!-- JDK目标版本1.8 -->
<option>-target 1.8</option>
<!-- 不做收缩(删除注释、未被引用代码) -->
<option>-dontshrink</option>
<!-- 不做优化(变更代码实现逻辑) -->
<option>-dontoptimize</option>
<!-- 不路过非公用类文件及成员 -->
<option>-dontskipnonpubliclibraryclasses</option>
<option>-dontskipnonpubliclibraryclassmembers</option>
<!-- 优化时允许访问并修改有修饰符的类和类的成员 -->
<option>-allowaccessmodification</option>
<!-- 确定统一的混淆类的成员名称来增加混淆 -->
<option>-useuniqueclassmembernames</option>
<!-- 不混淆所有包名,本人测试混淆后WEB项目问题实在太多 -->
<option>-keeppackagenames</option>
<option>-dontwarn com.hlyz.**</option>
<!-- 不混淆所有特殊的类 -->
<option>-keepattributes
Exceptions,InnerClasses,Signature,Deprecated,SourceFile,LineNumberTable,LocalVariable*Table,*Annotation*,Synthetic,EnclosingMethod,NettyGatewayDispactherApplication
</option>
<!-- 不混淆所有的set/get方法 ,会用到大量的set/get映射 -->
<option>
-keep public class *
{
void set* ( *** );
*** get* ();
}
</option>
<!-- 不混淆注解切面 -->
<option>-keep public class com.hlyz.base.common.core.aspectj.OpLogAspect { *; }</option>
<!-- 不混淆工具类中的public-->
<option>-keep public class com.hlyz.base.common.core.utils.** { *; }</option>
<!-- 不混淆线程池配置中的public-->
<option>-keep public class com.hlyz.base.common.core.thread.ThreadPoolConfig { *; }</option>
<!-- 不混淆配置文件中的public-->
<option>-keep public class com.hlyz.base.common.config.* { *; }</option>
<!-- 不混淆凭证包下的所有类名,但对类中的属性、方法进行混淆,dispacther -->
<option>-keep class com.hlyz.base.common.**</option>
</options>
<outjar>${project.groupId}-${project.artifactId}-pg.jar</outjar>
<!-- 添加依赖,这里你可以按你的需要修改,这里测试只需要一个JRE的Runtime包就行了 -->
<libs>
<lib>${java.home}/lib/rt.jar</lib>
</libs>
<!-- 加载文件的过滤器,就是你的工程目录了 -->
<inFilter>com/hlyz/base/common/**</inFilter>
<!-- 对什么东西进行加载,这里仅有classes成功,毕竟你也不可能对配置文件及JSP混淆吧 -->
<injar>classes</injar>
<!-- 输出目录 -->
<outputDirectory>${project.build.directory}</outputDirectory>
</configuration>
</plugin>
需要放在build标签→plugins标签内作为插件使用,具体的配置方法在代码中已经用备注写上了
2)打包
上述maven插件完成后,使用maven的打包,会自动生成原有的jar包和另一个名为classes-pg.jar的包
原有jar包逻辑不变,classes-pg.jar包内容是混淆之后的class文件
需要的操作为解压原有jar包与classes的jar包,使用classes解压出来的文件覆盖原有的com/路径下所有文件
解压中问题:mapper层的方法参数会被加密,需要保留原有的mapper文件
解压使用cmd,解压语句如下
jar -xvf xxxxxxxx.jar
覆盖之后需要重新打包,打包也使用cmd,打包语句如下
jar -cvfM0 xxxxxx.jar 目录a/ 目录b/ 文件名
3)总包打包
在2)步骤中为单模块的打包
运行模块(runner)的操作与上一步类似
首先解压jar包,其次将2)中混淆完毕的jar包替换掉解压出来的路径中BOOT-INF/lib中的同名文件,最后重新打包
遇到的问题
混淆打包失败
检查jdk版本,文件输出路径,插件版本,OPTION、inFilter等标签中包含的包是否匹配等
项目启动失败
分为多种情况,查看具体报错信息
例1:没有主清单属性——jar包重新打包没有使用命令,classes文件会被压缩丢失信息
例2:NoSuchMethodError——常见于A包依赖B包,B包代码被混淆,A包对应的混淆不清晰。解决方式:尽量避免包的交叉,上面的common示例中已经配置不混淆utils包下的文件
例3:Bean报找不到或重复定义——查看具体的Bean报错信息,报重复注解的使用Bean注解的就在代码混淆中加入不混淆;找不到Bean可能是@Resource注解注入,因为具体名称已经被混淆,所以找不到,使用@Autowired注解代替。
拓展信息:简单描述@Resource和@Autowired的区别,前者使用名称注入,后者使用类型注入
其他报错:暂未遇见