Spring4.2.4 版本中的一个关于XML验证模式获取的bug

最新推荐文章于 2023-06-20 09:04:44 发布
最新推荐文章于 2023-06-20 09:04:44 发布
阅读量367 收藏
点赞数 2
分类专栏： # Spring4.x源码解析 文章标签： spring spring源码 XML验证模式的获取 spring源码中的bug
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_38975553/article/details/88779619
版权

在Spring4.2.4源码的学习中发现了在Spring-core包下的org.springframework.util.xml.XmlValidationModeDetector类中对DTD验证模式获取的逻辑错误

测试程序:
1.先定义一个bean

package bean;
public class MyTestBean {
	private String testStr="testStr";
	public String getTestStr() {
		return testStr;
	}
	public void setTestStr(String testStr) {
		this.testStr = testStr;
	}
}

2.配置文件:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE beans PUBLIC  "-//SPRING//DTD BEAN//EN"  "http://www.springframework.org/dtd/spring-beans.dtd">
<beans>
       <bean id="myTestBean" class="bean.MyTestBean"/>
</beans>

3.测试类:

public class TestClass {
	@Test
	public void testSimpleLoad(){
		Resource resource = new ClassPathResource("beanFactoryTest.xml");
		XmlBeanFactory bf = new XmlBeanFactory(resource);
		MyTestBean bean=(MyTestBean) bf.getBean("myTestBean");
		System.out.println(bean.getTestStr());
	}
}

运行结果:
控制台输出: testStr

但是如果对配置文件做一个小小的更改:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE beans PUBLIC  "-//SPRING//DTD BEAN//EN"  "http://www.springframework.org/dtd/spring-beans.dtd"><!-- 这里添加一行注释 -->
<beans>
       <bean id="myTestBean" class="bean.MyTestBean"/>
</beans>

也就是在头文件的最后面添加一行注释, 然后再次运行测试类:

org.springframework.beans.factory.xml.XmlBeanDefinitionStoreException: Line 3 in XML document from class path resource [beanFactoryTest.xml] is invalid; nested exception is org.xml.sax.SAXParseException; lineNumber: 3; columnNumber: 8; cvc-elt.1: 找不到元素 'beans' 的声明。
	at org.springframework.beans.factory.xml.XmlBeanDefinitionReader.doLoadBeanDefinitions(XmlBeanDefinitionReader.java:399)
	at org.springframework.beans.factory.xml.XmlBeanDefinitionReader.loadBeanDefinitions(XmlBeanDefinitionReader.java:336)
	at org.springframework.beans.factory.xml.XmlBeanDefinitionReader.loadBeanDefinitions(XmlBeanDefinitionReader.java:304)
	at org.springframework.beans.factory.xml.XmlBeanFactory.<init>(XmlBeanFactory.java:79)
	at org.springframework.beans.factory.xml.XmlBeanFactory.<init>(XmlBeanFactory.java:67)
	at test.TestClass.testSimpleLoad(TestClass.java:17)
	at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
	at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.lang.reflect.Method.invoke(Method.java:498)
	at org.junit.runners.model.FrameworkMethod$1.runReflectiveCall(FrameworkMethod.java:50)
	at org.junit.internal.runners.model.ReflectiveCallable.run(ReflectiveCallable.java:12)
	at org.junit.runners.model.FrameworkMethod.invokeExplosively(FrameworkMethod.java:47)
	at org.junit.internal.runners.statements.InvokeMethod.evaluate(InvokeMethod.java:17)
	at org.junit.runners.ParentRunner.runLeaf(ParentRunner.java:325)
	at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:78)
	at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:57)
	at org.junit.runners.ParentRunner$3.run(ParentRunner.java:290)
	at org.junit.runners.ParentRunner$1.schedule(ParentRunner.java:71)
	at org.junit.runners.ParentRunner.runChildren(ParentRunner.java:288)
	at org.junit.runners.ParentRunner.access$000(ParentRunner.java:58)
	at org.junit.runners.ParentRunner$2.evaluate(ParentRunner.java:268)
	at org.junit.runners.ParentRunner.run(ParentRunner.java:363)
	at org.eclipse.jdt.internal.junit4.runner.JUnit4TestReference.run(JUnit4TestReference.java:86)
	at org.eclipse.jdt.internal.junit.runner.TestExecution.run(TestExecution.java:38)
	at org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.runTests(RemoteTestRunner.java:459)
	at org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.runTests(RemoteTestRunner.java:675)
	at org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.run(RemoteTestRunner.java:382)
	at org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.main(RemoteTestRunner.java:192)
Caused by: org.xml.sax.SAXParseException; lineNumber: 3; columnNumber: 8; cvc-elt.1: 找不到元素 'beans' 的声明。
	at com.sun.org.apache.xerces.internal.util.ErrorHandlerWrapper.createSAXParseException(ErrorHandlerWrapper.java:203)
	at com.sun.org.apache.xerces.internal.util.ErrorHandlerWrapper.error(ErrorHandlerWrapper.java:134)
	at com.sun.org.apache.xerces.internal.impl.XMLErrorReporter.reportError(XMLErrorReporter.java:396)
	at com.sun.org.apache.xerces.internal.impl.XMLErrorReporter.reportError(XMLErrorReporter.java:327)
	at com.sun.org.apache.xerces.internal.impl.XMLErrorReporter.reportError(XMLErrorReporter.java:284)
	at com.sun.org.apache.xerces.internal.impl.xs.XMLSchemaValidator.handleStartElement(XMLSchemaValidator.java:1900)
	at com.sun.org.apache.xerces.internal.impl.xs.XMLSchemaValidator.startElement(XMLSchemaValidator.java:740)
	at com.sun.org.apache.xerces.internal.impl.dtd.XMLDTDValidator.startElement(XMLDTDValidator.java:745)
	at com.sun.org.apache.xerces.internal.impl.XMLNSDocumentScannerImpl.scanStartElement(XMLNSDocumentScannerImpl.java:380)
	at com.sun.org.apache.xerces.internal.impl.XMLNSDocumentScannerImpl$NSContentDriver.scanRootElementHook(XMLNSDocumentScannerImpl.java:614)
	at com.sun.org.apache.xerces.internal.impl.XMLDocumentFragmentScannerImpl$FragmentContentDriver.next(XMLDocumentFragmentScannerImpl.java:3135)
	at com.sun.org.apache.xerces.internal.impl.XMLDocumentScannerImpl$PrologDriver.next(XMLDocumentScannerImpl.java:880)
	at com.sun.org.apache.xerces.internal.impl.XMLDocumentScannerImpl.next(XMLDocumentScannerImpl.java:606)
	at com.sun.org.apache.xerces.internal.impl.XMLNSDocumentScannerImpl.next(XMLNSDocumentScannerImpl.java:118)
	at com.sun.org.apache.xerces.internal.impl.XMLDocumentFragmentScannerImpl.scanDocument(XMLDocumentFragmentScannerImpl.java:510)
	at com.sun.org.apache.xerces.internal.parsers.XML11Configuration.parse(XML11Configuration.java:848)
	at com.sun.org.apache.xerces.internal.parsers.XML11Configuration.parse(XML11Configuration.java:777)
	at com.sun.org.apache.xerces.internal.parsers.XMLParser.parse(XMLParser.java:141)
	at com.sun.org.apache.xerces.internal.parsers.DOMParser.parse(DOMParser.java:243)
	at com.sun.org.apache.xerces.internal.jaxp.DocumentBuilderImpl.parse(DocumentBuilderImpl.java:339)
	at org.springframework.beans.factory.xml.DefaultDocumentLoader.loadDocument(DefaultDocumentLoader.java:76)
	at org.springframework.beans.factory.xml.XmlBeanDefinitionReader.doLoadDocument(XmlBeanDefinitionReader.java:429)
	at org.springframework.beans.factory.xml.XmlBeanDefinitionReader.doLoadBeanDefinitions(XmlBeanDefinitionReader.java:391)
	... 28 more

结果: 控制台报错,提示找不到元素 ‘beans’ 的声明,但是在添加注释前是可以找到,并正常运行

原因: 这是因为XmlValidationModeDetector类在获取XML验证模式时逻辑有点问题

以下为org.springframework.util.xml.XmlValidationModeDetector类的代码:

public class XmlValidationModeDetector {
	public static final int VALIDATION_NONE = 0;
	public static final int VALIDATION_AUTO = 1;
	public static final int VALIDATION_DTD = 2;
	public static final int VALIDATION_XSD = 3;
	private static final String DOCTYPE = "DOCTYPE";
	private static final String START_COMMENT = "<!--";
	private static final String END_COMMENT = "-->";
	private boolean inComment;
	
   //inputStream为读取的xml文件的输入流
	public int detectValidationMode(InputStream inputStream) throws IOException {
		BufferedReader reader = new BufferedReader(new InputStreamReader(inputStream));
		try {
		    //默认为XSD约束
			boolean isDtdValidated = false;
			String content;
			while ((content = reader.readLine()) != null) {
				//将读取到的内容去掉注释和空的部分,将剩下的内容返回
				content = consumeCommentTokens(content);
				
				if (this.inComment || !StringUtils.hasText(content)) {
					continue;
				}
				//如果该行含有DOCTYPE,则就是DTD,否则就是XSD
				if (hasDoctype(content)) {
					isDtdValidated = true;
					break;
				}
				//读取到<开始符号,验证模式的设置一定会在开始符号之前
				if (hasOpeningTag(content)) {
					// End of meaningful data...
					break;
				}
			}
			return (isDtdValidated ? VALIDATION_DTD : VALIDATION_XSD);
		}
		catch (CharConversionException ex) {
			// Choked on some character encoding...
			// Leave the decision up to the caller.
			return VALIDATION_AUTO;
		}
		finally {
			reader.close();
		}
	}

	private boolean hasDoctype(String content) {
		return content.contains(DOCTYPE);
	}

	private boolean hasOpeningTag(String content) {
		if (this.inComment) {
			return false;
		}
		//开始标签的位置
		int openTagIndex = content.indexOf('<');
		
		return (openTagIndex > -1 && (content.length() > openTagIndex + 1) &&
				Character.isLetter(content.charAt(openTagIndex + 1)));
	}


	private String consumeCommentTokens(String line) {
		//如果不含有注释,则返回该行内容
		if (!line.contains(START_COMMENT) && !line.contains(END_COMMENT)) {
			return line;
		}
		//如果含有注释,则将注释内容去掉,返回剩余内容
		//例如:<a>aa</a><!-- 注释部分  --><a>bb</a>
		while ((line = consume(line)) != null) {
			
			// inComment:指示当前解析位置是否位于XML注释中
			if (!this.inComment && !line.trim().startsWith(START_COMMENT)) {
				return line;
			}
			
		}
		return line;
	}
	
	private String consume(String line) {
		int index = (this.inComment ? endComment(line) : startComment(line));
		// line.substring(index):返回该标记之后的内容
		return (index == -1 ? null : line.substring(index));
	}
	
	private int startComment(String line) {
		return commentToken(line, START_COMMENT, true);
	}
	
	private int endComment(String line) {
		return commentToken(line, END_COMMENT, false);
	}

	private int commentToken(String line, String token, boolean inCommentIfPresent) {
	    //找到开始或结束标签在该行位置
		//<a>aa</a><!-- 注释部分  --><a>bb</a>
		int index = line.indexOf(token);
		//如果<!-- 符号在该行中,那么将inComment改为true;
		//如果--> 符号在该行中,那么将inComment改为false;
		if (index > - 1) {
			this.inComment = inCommentIfPresent;
		}
		
		return (index == -1 ? index : index + token.length());
	}

}

XmlValidationModeDetector类的大概逻辑如下:

  1. detectValidationMode方法中接收到传递过来的输入流,并定义变量isDtdValidated =flase,
    即默认为XSD验证模式
  2. 由BufferedReader类实例对象reader每次读取一行信息,传递给consumeCommentTokens(content)方法,把读取到的内容去掉注释和空的部分,将剩下的内容返回
  3. if (hasDoctype(content)) {
    isDtdValidated = true;
    break;
    }
    判断返回的内容中是否含"DOCTYPE",如果含有,则为DTD约束,不含有则为XSD约束
  4. 根据isDtdValidated 变量ture/false 来决定返回是XSD约束还是DTD约束
    return (isDtdValidated ? VALIDATION_DTD : VALIDATION_XSD);

问题出现在consumeCommentTokens(content)方法中的consume方法上:

private String consumeCommentTokens(String line) {
		//如果不含有注释,则返回该行内容
		if (!line.contains(START_COMMENT) && !line.contains(END_COMMENT)) {
			return line;
		}
		//如果含有注释,则将注释内容去掉,返回剩余内容
		while ((line = consume(line)) != null) {
			// inComment:指示当前解析位置是否位于XML注释中(默认值为false)
			if (!this.inComment && !line.trim().startsWith(START_COMMENT)) {
				return line;
			}	
		}
		return line;
	}

	private String consume(String line) {
		int index = (this.inComment ? endComment(line) : startComment(line));
		// line.substring(index):返回该标记之后的内容
		return (index == -1 ? null : line.substring(index));
	}

	private int startComment(String line) {
		return commentToken(line, START_COMMENT, true);
	}

	private int endComment(String line) {
		return commentToken(line, END_COMMENT, false);
	}

	private int commentToken(String line, String token, boolean inCommentIfPresent) {
	    //找到开始或结束标签在该行位置
		int index = line.indexOf(token);
		//如果<!-- 符号在该行中,那么将inComment改为true;
		//如果--> 符号在该行中,那么将inComment改为false;
		if (index > - 1) {
			this.inComment = inCommentIfPresent;
		}
		return (index == -1 ? index : index + token.length());
	}

假如读取到的一行数据为: <a>aa</a><!-- 注释部分 --><a>bb</a>将会执行以下流程:

  1. 由于inComment默认值为false, 在consume()方法中会调用startComment(line)方法;
  2. 最终执行的方法为:commentToken("<a>aa</a><!-- 注释部分–><a>bb</a>", “<!- -”,true) ;
  3. 在commentToken方法中通过line.indexOf()方法获取到 “<!- -” 的下标(假设为9) , 那么返回的数值为:9+token.length()=13;
  4. 因此在consume()方法中返回的字符串line.substring(13)= " 注释部分 --><a>bb</a>“在后续的循环中会返回”<a>bb</a>" ,那么 "<a>aa</a>"部分数据被line.substring(index)舍弃了;
  5. 在测试类中,因为头文件后面的一行注释,导致头文件信息被删除掉,那么由于isDtdValidated的初始值为false,所以detectValidationMode()方法将按照XSD模式进行返回,也就导致了xml文件的读取失败,所以会报出找不到元素 'beans’的异常;

目前spring中该问题好像还没有被修复,所以还是要注意下…

AnEra
关注
专栏目录
spring4.2.4源码
04-14
Spring框架是中国Java开发领域中最广泛使用的轻量级框架之一，其4.2.4版本是一个稳定且成熟的版本，包含了对IoC（Inversion of Control，控制反转）和AOP（Aspect Oriented Programming，面向切面编程）的重要实现。...
文档根元素configuration必须匹配DOCTYPE根null解决方法
热门推荐
Candice_JDY的博客
01-31 2万+
完整报错： org.apache.ibatis.exceptions.PersistenceException:  ### Error building SqlSession. ### Cause: org.apache.ibatis.builder.BuilderException: Error creating document instance.  Cause: org.xml.sax
跟我读Spring——Spring源码浅析(二)
悟达居士
07-27 994
目录目录 Spring配置文件的解析逻辑 整个流程概览 XML Validator模式的判断 XML验证文件的URL解析 注册BeanDefinition 自带命名空间标签的解析 外部标签的解析Spring配置文件的解析逻辑整个流程概览 首先新建一个Maven项目（参照序），配置好spring依赖，maven下载好源码和doc。 随便建一个类TestBeanpublic class TestBean
SpringBoot之STS配置
suzhou_xj的博客
12-24 1307
1.工具下载 配置JDK1.8，网上大把攻略 配置maven，并进行相关配置(本地库，私服)。// 下载sts最新版，Springboot官网下载，以后会写篇IDEA的配置，两者差不多。 确定好自己的版本，如果你是从github下载项目，记得配置差不多的版本 1.1Maven配置 1.1.1解压压缩包，打开maven中的setting.xml文件 <local...
Eclipse & Spring Tool Suite常用配置
孤云博客
06-19 2570
转自：https://blog.csdn.net/ThinkWon/article/details/101025543 Eclipse 是一个开放源代码的、基于Java的可扩展开发平台。Eclipse是Java开发人员常用的开发工具，虽然现在很多人转向使用IDEA，但是Eclipse给我们还是留下了一段美好的回忆。 在基于Eclipse的基础上，Spring提供了针对Spring开发的Spring Tool Suite集成开发工具，通过该工具，可以很轻易地生成一个Spring的工程，比如web工程，最令
Spring源码学习(七)——Spring.Beans（四）
毅本无言的成长之路
07-04 227
上一篇说到loadBeanDefinitions这个方法主要干了三件事儿，第一件是获取xml文件的验证模式；第二件是加载xml文件，获得对应的Document；第三件是对bean信息进行注册。本篇先对第一件事进行介绍。 在程序中如何判定某个文件是xml文件，只凭后缀肯定是不行的，只有对文件中的格式进行验证，才能证明确实是xml文件，这也为接下来的程序提供了保障。常用的验证模式有D...
spring 4.2.4 最新版本所有jar包
02-24
Spring 4.2.4是该框架的一个稳定版本，发布于2016年，包含了对先前版本的改进和修复。在这个版本中，Spring团队继续优化性能，增强稳定性和支持新的技术标准。 1. **模块划分**： Spring框架由多个模块组成，包括...
Spring MVC 4.2.4.RELEASE 中文文档
03-08
4.2.4.RELEASE是Spring MVC的一个稳定版本，包含了对先前版本的改进和新功能。 1. **模型-视图-控制器（MVC）架构** - **模型（Model）**：包含业务逻辑和数据，负责处理应用程序的核心功能。 - **视图（View）**...
spring-4.2.4 所有jar包
01-30
Spring 框架是Java开发中的一个核心组件，它提供了丰富的功能来简化应用程序的构建、管理和维护。在Spring 4.2.4版本中，这个轻量级框架继续强化其核心特性并支持现代开发需求。以下是一些关于Spring 4.2.4的关键...
XML文件解析工具化基础篇
a_un_l的博客
01-26 344
在今后的Java学习过程中，我们会遇到很多使用XML文件等来存储必要信息的情况，每次都要进行解析，这样岂不是很繁琐。在学习Java的过程中，我们必须要有一种思想–工具化。将所有重复动作工具化，使其解决具有普遍性的情况。下面就将之前所讲的《XML文件解析》进行工具化，使其适用于大多数解析情况。 如果看不懂这篇文章，可以先看看前面提到的，了解一下XML解析的基本过程。 一、思路 为了使解析过程工具化，...
XML DTD 初学
weixin_42646630的博客
08-26 280
XML DTD
xml基础、DTD验证、Schema验证（备忘）
槿墨色
02-27 8752
一、xml基础详解： 1、概述：     xml:即可扩展标记语言，xml是互联网数据传输的重要工具，它可以跨越互联网任何的平台，不受编程语言和操作系统的限制，可以说它是一个拥有互联网最高级别通行证的数据携带者。xml是当前处理结构化文档信息中相当给力的技术，xml有助于在服务器之间穿梭结构化数据，这使得开发人员更加得心应手的控制数据的存储和传输。 Xml用于标记电子文件使其具有结构性的标记
XML之解析（知识详解即基本使用）
最新发布
weixin_74352229的博客
06-20 7026
总之，XML解析在现代软件开发中扮演着非常重要的角色，能够帮助程序员轻松处理和操作基于XML的数据结构。无论在何种应用场景下，简单且易于理解的XML格式仍然是开发人员最喜欢的数据格式之一。
初次使用Mybatis配置出现错误待解决
weixin_30642869的博客
05-10 487
数据库： create table STUDENT ( STUID NUMBER(9) not null, SNAME VARCHAR2(50) not null, SEX VARCHAR2(4), ADDRESS VARCHAR2(50), BIRTHDAY DATE ) 目录结构： Student类： pa...
xml解析请求DTD错误的解决办法（断网服务器下）：org.xml.sax.SAXParseExceptionpublicId
lizhikang2009的博客
10-21 1万+
最近我的web程序部署到一台新的服务器（这是台无法访问网络的服务器），启动时总是报解析XML错误，说某个jar包里的XML文件不可用的错误：xml] is invalid 原来这是因为解析XML文件的时候校验dtd失效，因为我的XML里对xsd文件引用都是http路径的网络资源文件，而在断网情况下http请求失败，所以导致无法下载xsd文件而无法解析xml 经过一番百度、google，终于
http://www.springframework.org/dtd/spring-beans-2.0.dtd配置出错
chenxu6
12-12 3459
http://www.springframework.org/dtd/spring-beans-2.0.dtd配置出错 1.出错例子 2.解决方法 如果用的是spring2，头确实是这样写的。 如果用的是spring3，头应该至少用的是schema。 可以直接从自己的spring版本附带的文档中随便找一个包含了头的示例配置文件就行了。 把那两个2.0去掉就能用了。
SpringMVC（一）搭建ssm框架全过程，遇到得坑记录
养只狗名叫猫
07-04 215
题记：找到一篇关于activiti的书，打算根据书去做一些学习，自己搭建ssm框架遇到一些坑，以做记录！ 一，搭建过程，代码记录 二，项目结构 三、配置文件代码 applicationContext.xml代码示例： <?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.spr...
Spring的XML解析中关于DTD的路径问题-
xumingrencai
06-28 352
在Spring中最简单的一个xml如下： &lt;?xml version="1.0" encoding="UTF-8"?&gt;&lt;!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN" "http://www.springframework.org/dtd/spring-beans.dtd"&gt; &lt;beans&gt;
Spring MVC 4.2.4.RELEASE 中文文档详解与核心特性
文档首先介绍了Spring MVC的背景和目的，强调了它在企业级Web应用开发中的重要性，以及4.2.4版本的主要改进和新特性。 **1.2 新特性** 这部分着重讨论了4.2.4版本新增或优化的功能，可能包括如RESTful支持增强、...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值