解决Tomcat在版本9.0.86以上发生异常:org.apache.tomcat.util.codec.binary.Base64.decode问题
在 Tomcat 9.0.86 版本及以上移除了 org.apache.tomcat.util.codec.binary.Base64.decodeBase64(byte[] input)
这个方法。Tomcat 开发团队在该版本中删除了一些旧的、重复的 API,以减少代码冗余。这可能导致你的 Spring Boot 程序在升级到 Tomcat 9.0.86 及以上版本时,尝试调用该方法时发生异常。
解决方案1:
你可以采取以下几种方式解决这个问题:
1. 使用 Apache Commons Codec 库
org.apache.tomcat.util.codec.binary.Base64
类其实是来自于 Apache Commons Codec 的 Base64
类的拷贝,因此最简单的解决方案是直接依赖 Apache Commons Codec 库并使用它的 Base64
类。
步骤:
-
在
pom.xml
文件中添加对 Apache Commons Codec 的依赖:<dependency> <groupId>commons-codec</groupId> <artifactId>commons-codec</artifactId> <version>1.15</version> <!-- 可以选择最新版本 --> </dependency>
-
替换
org.apache.tomcat.util.codec.binary.Base64.decodeBase64(byte[] input)
方法为org.apache.commons.codec.binary.Base64.decodeBase64(byte[] input)
:import org.apache.commons.codec.binary.Base64; byte[] decodedBytes = Base64.decodeBase64(inputBytes);
这样,代码将继续正常工作,而且 Apache Commons Codec 是一个常用的库,非常稳定。
2. 直接使用 Java 自带的 Base64
Java 8 开始提供了原生的 Base64 编码解码支持,你可以使用 java.util.Base64
来替换 Tomcat 版本的 Base64。
步骤:
替换你当前代码中的 org.apache.tomcat.util.codec.binary.Base64.decodeBase64(byte[] input)
为 java.util.Base64.getDecoder().decode(byte[] input)
:
import java.util.Base64;
byte[] decodedBytes = Base64.getDecoder().decode(inputBytes);
这个方法是标准库中的一部分,不需要额外添加依赖,同时性能也很不错。
3. 避免直接依赖 Tomcat 特定 API
如果你的应用程序不强依赖于 Tomcat 提供的工具类,建议避免使用 Tomcat 特定的 API,因为这可能导致在未来升级 Tomcat 时出现类似的兼容性问题。推荐使用标准的 Java API 或稳定的开源库,如 Apache Commons Codec。
总结:
- 如果你希望最小化更改,可以直接添加 Apache Commons Codec 依赖,并修改为使用
org.apache.commons.codec.binary.Base64
。 - 如果你愿意更新到现代的标准 API,推荐使用
java.util.Base64
。
解决方案2:
如何在 Tomcat 内部解决?
虽然不能直接通过插件的方式解决这个问题,但如果你有很强的需求,可以尝试以下几种方式来变通处理。
1. 手动添加 Apache Commons Codec 库
虽然 Tomcat 本身不再包含该 API,但你可以通过将 Apache Commons Codec 库手动添加到 Tomcat 的 lib
目录来提供相同的功能。
步骤:
- 下载最新版本的 Apache Commons Codec jar 文件。
- 将
commons-codec-x.x.jar
文件放入 Tomcat 的lib
目录中,路径通常是{TOMCAT_HOME}/lib
。 - 重启 Tomcat 服务器。
这样,Tomcat 内的应用程序就可以访问 org.apache.commons.codec.binary.Base64
类了。
2. 自定义类加载器
你可以创建一个自定义类加载器或者将相应的库(如 Apache Commons Codec)作为 Tomcat 的全局库,这样你项目中可以在不修改代码的情况下继续使用 Base64 解码。
步骤:
- 在
TOMCAT_HOME/lib
中添加commons-codec.jar
。 - 重启 Tomcat。
这种方式适用于多个应用同时部署到同一个 Tomcat,并且不希望在每个应用中重复加入同样的依赖。
3. 重新引入移除的 Tomcat 类
如果你特别依赖 org.apache.tomcat.util.codec.binary.Base64
,你可以尝试从旧版本的 Tomcat 中提取相关类文件并将其手动添加到 Tomcat 的 lib
目录中。但这不被推荐,因为:
- 这些类是被刻意移除的,未来可能会引发更多的兼容性问题。
- 直接操作 Tomcat 内部类库是一种不安全的做法,容易影响到后续升级和维护。
更推荐的解决方案:
通过外部库或 Java 自带的 Base64
API 来解决这个问题,避免直接修改 Tomcat 的核心库是最佳实践。
- Java 8 及以上 推荐使用
java.util.Base64
,这样不需要任何外部依赖,代码简洁且具备良好的性能和维护性。 - 通过 Apache Commons Codec 是一个更灵活的方式,能够保证你使用的
Base64
编解码工具具备足够的兼容性和丰富功能,同时你可以通过在项目或 Tomcatlib
目录中加入commons-codec.jar
实现。
通过外部库的方式解决问题,更加标准和稳定,避免直接依赖 Tomcat 的内部实现,尤其是这种被移除的旧类。