记一次SPI机制导致的BUG定位【不支持:http://javax.xml.XMLConstants/property/accessExternalDTD】

1、前因

今天在生产环境启用了某个功能,结果发现有个文件上传华为云OBS失败了,报错如下:

Caused by: java.lang.IllegalArgumentException: 不支持:http://javax.xml.XMLConstants/property/accessExternalDTD
        at org.apache.xalan.processor.TransformerFactoryImpl.setAttribute(TransformerFactoryImpl.java:576) ~[xalan-2.7.1.jar:?]
        at com.obs.services.internal.xml.OBSXMLBuilder.asString(OBSXMLBuilder.java:306) ~[esdk-obs-java-bundle-3.23.9.1.jar:?]
        at com.obs.services.internal.V2Convertor.transCompleteMultipartUpload(V2Convertor.java:96) ~[esdk-obs-java-bundle-3.23.9.1.jar:?]
        at com.obs.services.internal.service.ObsMultipartObjectService.completeMultipartUploadImpl(ObsMultipartObjectService.java:96) ~[esdk-obs-java-bundle-3.23.9.1.jar:?]
        at com.obs.services.AbstractMultipartObjectClient.access$400(AbstractMultipartObjectClient.java:39) ~[esdk-obs-java-bundle-3.23.9.1.jar:?]
        at com.obs.services.AbstractMultipartObjectClient$5.action(AbstractMultipartObjectClient.java:185) ~[esdk-obs-java-bundle-3.23.9.1.jar:?]
        at com.obs.services.AbstractMultipartObjectClient$5.action(AbstractMultipartObjectClient.java:182) ~[esdk-obs-java-bundle-3.23.9.1.jar:?]
        at com.obs.services.AbstractClient.doActionWithResult(AbstractClient.java:388) ~[esdk-obs-java-bundle-3.23.9.1.jar:?]
        ... 50 more

2、BUG定位

首先看抛异常的第一条信息,org.apache.xalan.processor.TransformerFactoryImpl,这个类首先看名称,后面带了Impl,一般来说应该是某个接口的实现类,因为这个是引用的jar包里报的错,还是apache的jar包,一般来说不太可能是apache代码写错了,所以很有可能是我们调这个接口的时候,调错实现类了,实际上不应该调apache的这个实现类。

直接来看调用方com.obs.services.internal.xml.OBSXMLBuilder的asString方法:

java 复制代码
public String asString() throws TransformerException {
    TransformerFactory tf = TransformerFactory.newInstance();
    tf.setAttribute("http://javax.xml.XMLConstants/property/accessExternalDTD", "");
    tf.setAttribute("http://javax.xml.XMLConstants/property/accessExternalStylesheet", "");
    Transformer transformer = tf.newTransformer();
    transformer.setOutputProperty("omit-xml-declaration", "yes");
    StringWriter writer = new StringWriter();
    transformer.transform(new DOMSource(this.getDocument()), new StreamResult(writer));
    return writer.getBuffer().toString().replaceAll("|\r", "");
}

代码里的TransformerFactory是个抽象类,整个方法中也没有指定使用到底用哪个实现类,这个时候就应该想到Java的SPI机制了,打开org.apache.xalan.processor.TransformerFactoryImpl所在Jar包,Jar包里有个文件夹META-INF,里面有个services的文件夹,这里面的文件,就指定了程序会使用TransformerFactory的哪个实现类,如下图:

打开该文件,文件内容如下:

org.apache.xalan.processor.TransformerFactoryImpl

由于我们的程序里没有相应的SPI配置,所以程序会优先使用org.apache.xalan.processor.TransformerFactoryImpl类

3、BUG修复

知道了问题所在,接下来就是要找到那个正确的类,我们进到TransformerFactory这个类里,由于我用的是IDEA,点类边上的蓝色按钮就可以找到这个类的子类,如下图:

可以看到同样叫TransformerFactoryImpl名字的,还有com.sun.org.apache.xalan.internal.xsltc.trax包下的类,然后我们就在项目的META-INF的目录下新增services目录(如果没有的话),在该目录下新增文件javax.xml.transform.TransformerFactory,如图:

文件内容如下:

com.sun.org.apache.xalan.internal.xsltc.trax.TransformerFactoryImpl

再启动服务时,服务就正常了

4、疑惑

眼尖的小伙伴可能会发现,我这个异常是在生产环境抛出来的,难道我之前测试环境没测出来这个问题吗,是的,测试环境当时测的时候没有指定实现类也没有报错,文件也正常上传到了华为云OBS上,但是这个问题发生后,再在测试环境就没法复现这个问题了,所以也没有再深究。


找到问题了,我们在引入OBS的jar包时是这样写的:

xml 复制代码
<dependency>
	<groupId>com.huaweicloud</groupId>
	<artifactId>esdk-obs-java-bundle</artifactId>
	<version>[3.21.8,)</version>
</dependency>

这种写法会导致使用最新版本的jar包,来看jar包的发布时间:

我们测试的时候大概是在十月份,十一月、十二月都有过发布,功能启用时间更是在后面,所以我们测试的jar跟生产的jar实际上版本是不一样的,生产是3.23.9.1,而测试是3.23.9,我们将版本指定为3.23.9后查看com.obs.services.internal.xml.OBSXMLBuilder源码,里面并没有使用抽象类TransformerFactory,所以也不会有上面所说的问题。

相关推荐
阿伟*rui40 分钟前
配置管理,雪崩问题分析,sentinel的使用
java·spring boot·sentinel
XiaoLeisj3 小时前
【JavaEE初阶 — 多线程】单例模式 & 指令重排序问题
java·开发语言·java-ee
paopaokaka_luck3 小时前
【360】基于springboot的志愿服务管理系统
java·spring boot·后端·spring·毕业设计
dayouziei3 小时前
java的类加载机制的学习
java·学习
Yaml45 小时前
Spring Boot 与 Vue 共筑二手书籍交易卓越平台
java·spring boot·后端·mysql·spring·vue·二手书籍
小小小妮子~5 小时前
Spring Boot详解:从入门到精通
java·spring boot·后端
hong1616885 小时前
Spring Boot中实现多数据源连接和切换的方案
java·spring boot·后端
aloha_7895 小时前
从零记录搭建一个干净的mybatis环境
java·笔记·spring·spring cloud·maven·mybatis·springboot
记录成长java6 小时前
ServletContext,Cookie,HttpSession的使用
java·开发语言·servlet
睡觉谁叫~~~6 小时前
一文解秘Rust如何与Java互操作
java·开发语言·后端·rust