Proguard在SpringBoot中的使用方法

在项目发布时,有时为了保护代码,防止他人反编译,发布者会对代码采取一定的保护措施。保护代码的措施有很多种,而且安全性也不一样。本文以SpringBoot项目为例,主要介绍的是在项目在发布时使用Proguard工具对代码进行混淆,增加代码的阅读难度。

1.在pom.xml文件中添加Proguard插件配置

<plugin>
            <groupId>com.github.wvengen</groupId>
            <artifactId>proguard-maven-plugin</artifactId>
            <version>2.0.11</version>
            <executions>
                <execution>
                    <!-- 混淆时刻,这里是打包的时候混淆-->
                    <phase>package</phase>
                    <goals>
                        <!-- 使用插件的什么功能,当然是混淆-->
                        <goal>proguard</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                配置内容下面介绍
            </configuration>
            <dependencies>
                <dependency>
                    <groupId>net.sf.proguard</groupId>
                    <artifactId>proguard-base</artifactId>
                    <version>6.2.2</version>
                </dependency>
            </dependencies>
        </plugin> 

2.对Proguard进行配置

在进行配置之前,对哪些类进行混淆,哪些类不进行混淆需要搞清楚。在SpringBoot项目中,容易混淆出问题的有以下几个方面:
(1)dao代码混淆
一般dao会有对应的mapper文件,如果对dao进行混淆,mapper中指向的dao会找不到,报错。
可不进行混淆:

<option>-keep class domain.dao.** {*;}</option>

(2)Spring中bean重名的问题
spring容器中,默认会将类名首字母小写后作为bean的名称。混淆代码之后,不同包下的类可能被命名成相同的类,这样就会出现bean重复。
解决方法:可以改变bean名称的生成策略,可以加上包名来生成bean的名称。修改main的方法,如下:

public class Application {
       public static class CustomGenerator implements BeanNameGenerator {
            @Override
            public String generateBeanName(BeanDefinition definition, BeanDefinitionRegistry registry) {
                return definition.getBeanClassName();
            }
        }
     
        public static void main(String[] args) {
            SpringApplicationBuilder sab=new SpringApplicationBuilder(Application.class)
                    .beanNameGenerator(new CustomGenerator());
            ApplicationContext ac =sab.run(args);
            //Arrays.stream(ac.getBeanDefinitionNames()).forEach(System.out::println);
        }
}

(3)controller方法参数名不能修改
因为controller是和前端交互的地方,controller方法的参数名不能改变,否则前台传参会有问题。

<option>-keepclassmembers class domain.controller.** {*;}</option>

(4)自定义注解不能混淆
(5)实体类不能混淆
实体类混淆之后,可能会出现mabatis别名冲突

<option>-keep class domain.entity.** {*;}</option>

上述是代码混淆配置的常见问题,整个配置可参考下面的配置:

<configuration>
                <!-- 是否将生成的PG文件安装部署-->
                <attach>true</attach>
                <!-- 是否混淆-->
                <!--<obfuscate>false</obfuscate>-->
                <obfuscate>true</obfuscate>
                <!-- 指定生成文件分类 -->
                <attachArtifactClassifier>pg</attachArtifactClassifier>
                <options>
                    <!-- JDK目标版本1.8-->
                    <option>-target 1.8</option>
                    <!-- 不做收缩(删除注释、未被引用代码)-->
                    <option>-dontshrink</option>
                    <option>-keepdirectories</option><!-- 配合spring -->
                    <!-- 不做优化(变更代码实现逻辑)-->
                    <option>-dontoptimize</option>
                    <!-- 不路过非公用类文件及成员-->
                    <option>-dontskipnonpubliclibraryclasses</option>
                    <option>-dontskipnonpubliclibraryclassmembers</option>
                    <!-- 混淆时不生成大小写混合的类名 -->
                    <option>-dontusemixedcaseclassnames</option>
                    <!-- 优化时允许访问并修改有修饰符的类和类的成员 --> 
                    <!--<option>-allowaccessmodification</option>-->
                    <!-- 确定统一的混淆类的成员名称来增加混淆-->
                    <option>-useuniqueclassmembernames</option>
                    <!-- 不混淆所有包名-->
                    <option>-keeppackagenames</option>
                    <!-- 不混淆所有特殊的类-->
                    <option>-keepattributes Exceptions,InnerClasses,Signature,Deprecated,SourceFile,LineNumberTable,LocalVariable*Table,*Annotation*,Synthetic,EnclosingMethod</option>
                    <!-- 不混淆所有的set/get方法,毕竟项目中使用的部分第三方框架(例如Shiro)会用到大量的set/get映射-->
                    <!--                        <option>-keepclassmembers public class * {void set*(***);*** get*();}</option>-->

                    <!-- global -->
                    <option>-keep public class domain.Application {*;}</option>
                    <option>-keep class domain.*.aop.** {*;}</option>
                    <option>-keep class domain.dao.** {*;}</option>
                    <option>-keep class domain.entity.** {*;}</option>
                    <!-- common-->
                    <option>-keepclassmembers class domain.controller.** {*;}</option>
                    <!-- <option>-keepclassmembers class com.iot.common.config.ConfigValue {*;}</option>
                    <option>-keepclassmembers class com.iot.common.shiro.config.* {*;}</option>
                    <option>-keep class com.iot.common.log.* {*;}</option>
                    <option>-keep class com.iot.common.result.* {*;}</option> -->
                    <!-- data -->
                </options>
                <libs>
                    <lib>${java.home}/lib/rt.jar</lib>
                </libs>
                <!-- 加载文件的过滤器,也就是工程目录-->
                <inFilter>domain/**</inFilter>
                <!-- 对什么东西进行加载,这里仅有classes成功-->
                <injar>classes</injar>
                <outjar>${project.build.finalName}-pg.jar</outjar>
                <!-- 输出目录-->
                <outputDirectory>${project.build.directory}</outputDirectory>
            </configuration>
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

友情链接更多精彩内容