Proguard无法保留MyBatis接口方法参数名问题求助

一、为什么Proguard设置后仍无法保留接口方法参数名？ #

你遇到的问题可能由以下几个原因导致：

1. Proguard配置的范围与规则配合问题
   -keepparameternames 需要和具体的 -keep 规则精准配合，单独使用可能无法生效。你需要明确指定保留参数名的目标接口及方法：

   -keep interface com.xxx.data.mapper.** {
       <methods>;
   }
   -keepparameternames interface com.xxx.data.mapper.** {
       <methods>;
   }
   

   用 ** 匹配所有子包下的Mapper接口，<methods> 确保覆盖所有方法，避免遗漏。

2. Proguard优化阶段移除了参数元数据
   Proguard默认的优化规则会移除调试相关的元数据（包括存储参数名的LocalVariableTable和MethodParameters属性），你需要显式配置保留这些属性：

   -keepattributes LocalVariableTable,MethodParameters
   

   这两个属性分别对应Java 8之前（LocalVariableTable）和Java 8+（MethodParameters）存储参数名的位置，必须保留才能让MyBatis读取到参数名。

3. javac的-parameters参数未正确生效
   确认构建工具确实配置了该参数：

   • Maven：在maven-compiler-plugin中添加

     <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-compiler-plugin</artifactId>
         <version>3.8.1</version>
         <configuration>
             <compilerArgs>
                 <arg>-parameters</arg>
             </compilerArgs>
         </configuration>
     </plugin>
     

   • Gradle：在build.gradle中添加

     tasks.withType(JavaCompile) {
         options.compilerArgs << "-parameters"
     }
     

   如果该参数未生效，class文件中根本不存在参数名元数据，Proguard也无法保留不存在的内容。

4. Proguard版本兼容性问题
   部分旧版本Proguard对-keepparameternames和MethodParameters属性的支持不完善，建议升级到最新稳定版的Proguard或Google的R8工具。

二、未混淆时MyBatis为何能正常工作？ #

未混淆时MyBatis能获取参数名的核心原因：

• 默认编译保留调试元数据：javac默认编译会生成LocalVariableTable（调试用局部变量表），其中包含方法参数名。MyBatis通过ASM字节码工具读取该表获取参数名，即使未加-parameters参数也能生效。
• @Param注解兜底：如果你的Mapper方法参数添加了@Param注解，MyBatis会直接使用注解指定的名字，完全不依赖class文件中的参数名元数据，这也是很多项目未配置-parameters却能正常运行的原因。

混淆时，Proguard默认移除LocalVariableTable这类调试元数据，若未配置正确的保留规则，参数名会被混淆或丢失，导致MyBatis无法匹配XML中的参数名，进而抛出BindingException。

内容的提问来源于stack exchange，提问作者J Freebird