Validate a JAXB Object Model With an XML Schema

最新推荐文章于 2024-09-02 18:07:17 发布
最新推荐文章于 2024-09-02 18:07:17 发布
阅读量1k 收藏
点赞数
分类专栏： service 文章标签： jaxb schema xml object validation exception
n this post I will demonstrate how to validate a JAXB object model against an XML schema.  This will be done using the javax.xml.validation APIs.

Background Information

In JAXB 1.0 there was the concept of a Validator. This Validator could be used to determine if when marshalled a graph of objects would produce valid XML. Since JAXB 1.0 had standard interfaces backed by vendor specific implementation classes it was easy for vendors to code generate the necessary validation logic. When JAXB 2.0 moved to annotated POJO classes the ability to have generated validation logic was lost and Validator was deprecated. In this post I'll demonstrate how to leverage the j avax.xml.validation APIs to get the same sort of behaviour.

Java Model

The following object model will be used for this example.  Notice how the model classes do not contain any validation specific information.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
package blog.validation;
 
import java.util.ArrayList;
import java.util.List;
 
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
 
@XmlRootElement
public class Customer {
 
     private String name;
 
     private List<PhoneNumber> phoneNumbers;
 
     public Customer() {
         phoneNumbers = new ArrayList<PhoneNumber>();
     }
 
     public String getName() {
         return name;
     }
 
     public void setName(String name) {
         this .name = name;
     }
 
     @XmlElement (name= "phone-number" )
     public List<PhoneNumber> getPhoneNumbers() {
         return phoneNumbers;
     }
 
     public void setPhoneNumbers(List<PhoneNumber> phoneNumbers) {
         this .phoneNumbers = phoneNumbers;
     }
 
}

?
1
2
3
4
5
package blog.validation;
 
public class PhoneNumber {
 
}

XML Schema

The following is our XML schema.  The following are the interesting constraints:
  • The customer's name cannot be longer than 5 characters.
  • The customer cannot have more than 2 phone numbers.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
<? xml version = "1.0" encoding = "UTF-8" ?>
< xs:schema xmlns:xs = "http://www.w3.org/2001/XMLSchema" >
 
     < xs:element name = "customer" >
         
         < xs:complexType >
             < xs:sequence >
                 < xs:element name = "name" type = "stringMaxSize5" />
                 < xs:element ref = "phone-number" maxOccurs = "2" />
              </ xs:sequence >
         </ xs:complexType >
     </ xs:element >
 
     < xs:element name = "phone-number" >
         < xs:complexType />
     </ xs:element >
 
     < xs:simpleType name = "stringMaxSize5" >
         < xs:restriction base = "xs:string" >
             < xs:maxLength value = "5" />
         </ xs:restriction >
     </ xs:simpleType >
 
</ xs:schema >

Demo Code

In this example we will create an instance of Customer that would produce an XML document that does not conform to our XML schema.  The customers name will be too long, and it will contain more than two phone numbers.

A Validator will be created from the customer XML Schema.  This Validator can accept different types of XML inputs.  We will leverage JAXBSource (which implements javax.xml.transform.Source ) to expose our JAXB object model as an XML input to the Validator.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
package blog.validation;
 
import java.io.File;
 
import javax.xml.XMLConstants;
import javax.xml.bind.JAXBContext;
import javax.xml.bind.util.JAXBSource;
import javax.xml.validation.Schema;
import javax.xml.validation.SchemaFactory;
import javax.xml.validation.Validator;
 
public class Demo {
 
     public static void main(String[] args) throws Exception {
         Customer customer = new Customer();
         customer.setName( "Jane Doe" );
         customer.getPhoneNumbers().add( new PhoneNumber());
         customer.getPhoneNumbers().add( new PhoneNumber());
         customer.getPhoneNumbers().add( new PhoneNumber());
 
         JAXBContext jc = JAXBContext.newInstance(Customer. class );
         JAXBSource source = new JAXBSource(jc, customer);
 
         SchemaFactory sf = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);
         Schema schema = sf.newSchema( new File( "customer.xsd" ));
 
         Validator validator = schema.newValidator();
         validator.setErrorHandler( new MyErrorHandler());
         validator.validate(source);
     }
 
}

An ErrorHandler provides a mechanism to capture the validation exceptions.  If you re-throw the exception then parsing stops, and if you swallow the exception parsing continues.  This provides a useful mechanism to ignore validation constraints.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
package blog.validation;
 
import org.xml.sax.ErrorHandler;
import org.xml.sax.SAXException;
import org.xml.sax.SAXParseException;
 
public class MyErrorHandler implements ErrorHandler {
 
     public void warning(SAXParseException exception) throws SAXException {
         System.out.println( "\nWARNING" );
         exception.printStackTrace();
     }
 
     public void error(SAXParseException exception) throws SAXException {
         System.out.println( "\nERROR" );
         exception.printStackTrace();
     }
 
     public void fatalError(SAXParseException exception) throws SAXException {
         System.out.println( "\nFATAL ERROR" );
         exception.printStackTrace();
     }
 
}

Output

The following output is produced when EclipseLink MOXy is used as the JAXB implementation.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
ERROR
org.xml.sax.SAXParseException: cvc-maxLength-valid: Value 'Jane Doe' with length = '8' is not facet-valid with respect to maxLength '5' for type 'stringWithMaxSize5' .
  at com.sun.org.apache.xerces.internal.util.ErrorHandlerWrapper.createSAXParseException(ErrorHandlerWrapper.java: 195 )
  at com.sun.org.apache.xerces.internal.util.ErrorHandlerWrapper.error(ErrorHandlerWrapper.java: 131 )
  at com.sun.org.apache.xerces.internal.impl.XMLErrorReporter.reportError(XMLErrorReporter.java: 384 )
  at com.sun.org.apache.xerces.internal.impl.XMLErrorReporter.reportError(XMLErrorReporter.java: 318 )
  at com.sun.org.apache.xerces.internal.impl.xs.XMLSchemaValidator$XSIErrorReporter.reportError(XMLSchemaValidator.java: 417 )
  at com.sun.org.apache.xerces.internal.impl.xs.XMLSchemaValidator.reportSchemaError(XMLSchemaValidator.java: 3181 )
  at com.sun.org.apache.xerces.internal.impl.xs.XMLSchemaValidator.elementLocallyValidType(XMLSchemaValidator.java: 3096 )
  at com.sun.org.apache.xerces.internal.impl.xs.XMLSchemaValidator.processElementContent(XMLSchemaValidator.java: 3006 )
  at com.sun.org.apache.xerces.internal.impl.xs.XMLSchemaValidator.handleEndElement(XMLSchemaValidator.java: 2149 )
  at com.sun.org.apache.xerces.internal.impl.xs.XMLSchemaValidator.endElement(XMLSchemaValidator.java: 817 )
  at com.sun.org.apache.xerces.internal.jaxp.validation.ValidatorHandlerImpl.endElement(ValidatorHandlerImpl.java: 563 )
  at org.xml.sax.helpers.XMLFilterImpl.endElement(XMLFilterImpl.java: 546 )
  at org.eclipse.persistence.oxm.record.ContentHandlerRecord.endElement(ContentHandlerRecord.java: 235 )
  at org.eclipse.persistence.internal.oxm.XPathNode.marshal(XPathNode.java: 315 )
  at org.eclipse.persistence.internal.oxm.TreeObjectBuilder.buildRow(TreeObjectBuilder.java: 325 )
  at org.eclipse.persistence.oxm.XMLMarshaller.marshal(XMLMarshaller.java: 934 )
  at org.eclipse.persistence.oxm.XMLMarshaller.marshal(XMLMarshaller.java: 648 )
  at org.eclipse.persistence.oxm.XMLMarshaller.marshal(XMLMarshaller.java: 608 )
  at org.eclipse.persistence.jaxb.JAXBMarshaller.marshal(JAXBMarshaller.java: 233 )
  at javax.xml.bind.util.JAXBSource$ 1 .parse(JAXBSource.java: 222 )
  at javax.xml.bind.util.JAXBSource$ 1 .parse(JAXBSource.java: 210 )
  at com.sun.org.apache.xerces.internal.jaxp.validation.ValidatorHandlerImpl.validate(ValidatorHandlerImpl.java: 697 )
  at com.sun.org.apache.xerces.internal.jaxp.validation.ValidatorImpl.validate(ValidatorImpl.java: 97 )
  at javax.xml.validation.Validator.validate(Validator.java: 127 )
  at blog.validation.Demo.main(Demo.java: 29 )
 
ERROR
org.xml.sax.SAXParseException: cvc-type. 3.1 . 3 : The value 'Jane Doe' of element 'name' is not valid.
  at com.sun.org.apache.xerces.internal.util.ErrorHandlerWrapper.createSAXParseException(ErrorHandlerWrapper.java: 195 )
  at com.sun.org.apache.xerces.internal.util.ErrorHandlerWrapper.error(ErrorHandlerWrapper.java: 131 )
  at com.sun.org.apache.xerces.internal.impl.XMLErrorReporter.reportError(XMLErrorReporter.java: 384 )
  at com.sun.org.apache.xerces.internal.impl.XMLErrorReporter.reportError(XMLErrorReporter.java: 318 )
  at com.sun.org.apache.xerces.internal.impl.xs.XMLSchemaValidator$XSIErrorReporter.reportError(XMLSchemaValidator.java: 417 )
  at com.sun.org.apache.xerces.internal.impl.xs.XMLSchemaValidator.reportSchemaError(XMLSchemaValidator.java: 3181 )
  at com.sun.org.apache.xerces.internal.impl.xs.XMLSchemaValidator.elementLocallyValidType(XMLSchemaValidator.java: 3097 )
  at com.sun.org.apache.xerces.internal.impl.xs.XMLSchemaValidator.processElementContent(XMLSchemaValidator.java: 3006 )
  at com.sun.org.apache.xerces.internal.impl.xs.XMLSchemaValidator.handleEndElement(XMLSchemaValidator.java: 2149 )
  at com.sun.org.apache.xerces.internal.impl.xs.XMLSchemaValidator.endElement(XMLSchemaValidator.java: 817 )
  at com.sun.org.apache.xerces.internal.jaxp.validation.ValidatorHandlerImpl.endElement(ValidatorHandlerImpl.java: 563 )
  at org.xml.sax.helpers.XMLFilterImpl.endElement(XMLFilterImpl.java: 546 )
  at org.eclipse.persistence.oxm.record.ContentHandlerRecord.endElement(ContentHandlerRecord.java: 235 )
  at org.eclipse.persistence.internal.oxm.XPathNode.marshal(XPathNode.java: 315 )
  at org.eclipse.persistence.internal.oxm.TreeObjectBuilder.buildRow(TreeObjectBuilder.java: 325 )
  at org.eclipse.persistence.oxm.XMLMarshaller.marshal(XMLMarshaller.java: 934 )
  at org.eclipse.persistence.oxm.XMLMarshaller.marshal(XMLMarshaller.java: 648 )
  at org.eclipse.persistence.oxm.XMLMarshaller.marshal(XMLMarshaller.java: 608 )
  at org.eclipse.persistence.jaxb.JAXBMarshaller.marshal(JAXBMarshaller.java: 233 )
  at javax.xml.bind.util.JAXBSource$ 1 .parse(JAXBSource.java: 222 )
  at javax.xml.bind.util.JAXBSource$ 1 .parse(JAXBSource.java: 210 )
  at com.sun.org.apache.xerces.internal.jaxp.validation.ValidatorHandlerImpl.validate(ValidatorHandlerImpl.java: 697 )
  at com.sun.org.apache.xerces.internal.jaxp.validation.ValidatorImpl.validate(ValidatorImpl.java: 97 )
  at javax.xml.validation.Validator.validate(Validator.java: 127 )
  at blog.validation.Demo.main(Demo.java: 29 )
 
ERROR
org.xml.sax.SAXParseException: cvc-complex-type. 2.4 .d: Invalid content was found starting with element 'customer' . No child element '{phone-number}' is expected at this point.
  at com.sun.org.apache.xerces.internal.util.ErrorHandlerWrapper.createSAXParseException(ErrorHandlerWrapper.java: 195 )
  at com.sun.org.apache.xerces.internal.util.ErrorHandlerWrapper.error(ErrorHandlerWrapper.java: 131 )
  at com.sun.org.apache.xerces.internal.impl.XMLErrorReporter.reportError(XMLErrorReporter.java: 384 )
  at com.sun.org.apache.xerces.internal.impl.XMLErrorReporter.reportError(XMLErrorReporter.java: 318 )
  at com.sun.org.apache.xerces.internal.impl.xs.XMLSchemaValidator$XSIErrorReporter.reportError(XMLSchemaValidator.java: 417 )
  at com.sun.org.apache.xerces.internal.impl.xs.XMLSchemaValidator.reportSchemaError(XMLSchemaValidator.java: 3181 )
  at com.sun.org.apache.xerces.internal.impl.xs.XMLSchemaValidator.elementLocallyValidComplexType(XMLSchemaValidator.java: 3168 )
  at com.sun.org.apache.xerces.internal.impl.xs.XMLSchemaValidator.elementLocallyValidType(XMLSchemaValidator.java: 3104 )
  at com.sun.org.apache.xerces.internal.impl.xs.XMLSchemaValidator.processElementContent(XMLSchemaValidator.java: 3006 )
  at com.sun.org.apache.xerces.internal.impl.xs.XMLSchemaValidator.handleEndElement(XMLSchemaValidator.java: 2149 )
  at com.sun.org.apache.xerces.internal.impl.xs.XMLSchemaValidator.endElement(XMLSchemaValidator.java: 817 )
  at com.sun.org.apache.xerces.internal.jaxp.validation.ValidatorHandlerImpl.endElement(ValidatorHandlerImpl.java: 563 )
  at org.xml.sax.helpers.XMLFilterImpl.endElement(XMLFilterImpl.java: 546 )
  at org.eclipse.persistence.oxm.record.ContentHandlerRecord.endElement(ContentHandlerRecord.java: 235 )
  at org.eclipse.persistence.oxm.XMLMarshaller.marshal(XMLMarshaller.java: 961 )
  at org.eclipse.persistence.oxm.XMLMarshaller.marshal(XMLMarshaller.java: 648 )
  at org.eclipse.persistence.oxm.XMLMarshaller.marshal(XMLMarshaller.java: 608 )
  at org.eclipse.persistence.jaxb.JAXBMarshaller.marshal(JAXBMarshaller.java: 233 )
  at javax.xml.bind.util.JAXBSource$ 1 .parse(JAXBSource.java: 222 )
  at javax.xml.bind.util.JAXBSource$ 1 .parse(JAXBSource.java: 210 )
  at com.sun.org.apache.xerces.internal.jaxp.validation.ValidatorHandlerImpl.validate(ValidatorHandlerImpl.java: 697 )
  at com.sun.org.apache.xerces.internal.jaxp.validation.ValidatorImpl.validate(ValidatorImpl.java: 97 )
  at javax.xml.validation.Validator.validate(Validator.java: 127 )
  at blog.validation.Demo.main(Demo.java: 29 )

Summary

This example demonstrates the benefit of standards.  JAXB was not written specifically to work with javax.xml.validation APIs, but since it can be exposed as a javax.xml.transform.Source (using JAXBSource) it does.   In future posts I write more about schema validation, and other uses for JAXBSource.

dream8062
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Java XML技术体系
ldk99_的博客
07-13 263
Java XML技术体系涵盖了一系列用于处理和操作XML（可扩展标记语言）的技术和工具。
JAXB学习 （三）验证
Josh_Persistence
07-20 375
一个完整个对象-模型映射，一定少不了对验证的支持。     jaxb当然也支持验证，分为两个部分：marshall和unmarshall。     一、unmarshall端   unmarshall是从xml到java对象的过程，因此验证的是这个xml文件是不是有效的，要在unmarshall端使用验证非常简单： Unmarshaller unmarshal...
JAXB validation failed because the necessary plug-ins were unavailable
past__time的博客
09-21 286
JAXB validation failed because the necessary plug-ins were unavailable 首先了解什么是JAXB 这个错误，两种方法去解决，第一：包不对。第二：包重复
xsd文件校验xml内容
zhaoyi105的专栏
12-02 3445
Notepad++方式： 如何安装Notepad++插件：http://jingyan.baidu.com/article/4b07be3c69172648b380f383.html java代码： import java.io.File; import java.util.Iterator; import java.util.Map; import javax.xml.p
亚马逊MWS开发--上传商品常见错误
小薯条的博客
03-30 8337
一、错误来源 不管通过哪种方式上传商品都会出现各种问题，每一类问题亚马逊都有固定的错误码，比如常见5000,8541等，这些错误都会体现在上传的结果报告中 <?xml version="1.0" encoding="UTF-8" ?> <AmazonEnvelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="amzn-envelope.xsd">
JAXB: 通过schema验证XML文件
hld_hepeng的专栏
04-12 2845
<br />在使用JAXB解析XML文件的时候我们有时候可能会需要通过schema文件验证XML的格式，接上文的XMLParser.java<br /> <br />示例代码如下：Java代码  public static Object unmarshal(InputStream xml, Class<?> clazz) throws SAXException {          Object obj = null;                    ValidationEventCollector 
JAXB（Java Architecture for XML Binding）下载、使用
听海边涛声
09-21 1835
JAXB（Java Architecture for XML Binding）下载、使用
对xml进行解析；进行增删改查还有schema验证
03-06
常见的解析方式有两种：DOM（Document Object Model）和SAX（Simple API for XML）。DOM解析器将整个XML文档加载到内存中，形成一棵树形结构，便于随机访问任何部分；而SAX解析器则采用事件驱动模型，逐个处理元素，...
Xml本地格式化工具(Java代码显示，图形操作)
08-10
在Java编程环境下，XML的格式化通常涉及到DOM（Document Object Model）、SAX（Simple API for XML）或StAX（Streaming API for XML）等解析器，以及相关的库和API。 "Xml本地格式化工具(Java代码显示，图形操作)" ...
java操作xml实例
06-24
- **DOM（Document Object Model）**: DOM 提供了一种结构化的表示 XML 文档的方式，通过创建一棵节点树来代表整个文档。Java 中的 `javax.xml.parsers.DocumentBuilderFactory` 和 `org.w3c.dom.Document` 类可以...
digester 解析xml
03-21
在Java中，我们可以使用JAXB（Java Architecture for XML Binding）或DOM（Document Object Model）等API来验证XML文件是否符合XSD。 **使用Digester解析XML并验证** 1. **设置 Digester 规则** 在使用Digester...
cvc-enumeration-valid: Value 'CONTAINER' is not facet-valid with respect to enumeration问题
傲世狂少
04-09 9607
web.xml中配置如下： CONTAINER   结果，myeclipse报错，描述如下： Severity and Description Path Resource Location Creation Time Id cvc-enumeration-valid: Value 'CONTAINER' is not facet-valid with respect to enumera
java fastxml json 科学计数法转换处理
lliinnhhhan的博客
09-01 407
由于 canal 切换为 tx dbbridge后，发现dbbridge对于canal的兼容性存在较大问题，从而引发 该文档的实践。就目前发现 dbbrige 的字段 大小写 和 数据类型格式 从binlog 写入kafka 同canal 都会存在差异。canal之前导出都是小写，但是dbbrige接出来后部分字段名大写，部分字段名小写。另外就是 数据格式 毕竟是 java 侧的所以 容易出现一些 科学计数法转换问题。但是如果 大boss 的意思 硬要换，那 咋 还有啥说的。
xml获取对象工具类
z2768557792的博客
09-01 514
【代码】xml获取对象工具类。
Xml 映射文件中常见的标签
Flying_Fish_roe的博客
09-01 850
mapper>：定义一个映射文件。：定义一个结果映射。：定义一个查询结果的映射关系。：定义一个查询语句。：定义一个插入语句。：定义一个更新语句。：定义一个删除语句。：引入其他的映射文件或者语句片段。：定义一个关联对象的映射关系。：定义一个集合对象的映射关系。：条件判断标签。：选择标签，根据条件选择执行其中的一个分支。
Android 读取 XML 文件之 SAX 解析编码模板
weixin_52173250的博客
09-01 1468
SAX（Simple API for XML）是一种基于事件的 XML 解析技术，它一边读取 XML 文件一边解析，占用内存少，适用于大型文件SAX 解析器会触发一系列事件，例如，开始解析元素、结束解析元素、遇到字符数据等，我们只需要实现对应的事件处理器来处理这些事件即可。
【Protobuf】xml、json与protobuf有什么区别，protobuf详解（保姆篇）
最新发布
A的博客
09-02 772
Protocol Buffers（简称 Protobuf）是 Google 开发的一种语言中立、平台中立、可扩展的序列化结构数据的机制。它主要用于将数据结构序列化为二进制格式，以便于高效传输和存储。Protobuf 在性能、文件大小和数据兼容性方面有着显著的优势。Protobuf 适用于多种编程语言，包括 C++、Java、Python、Go 和 C# 等。本文将详细介绍 Protobuf 的工作原理、如何定义消息结构、生成代码及其在实际应用中的使用。Protobuf 使用.proto文件定义数据结构。
XSLT 实例：掌握 XML 转换的艺术
lly202406的博客
09-02 648
XSLT 是一种基于 XML 的语言，用于转换 XML 文档。它使用 XSLT 处理器将源 XML 文档转换为另一种格式，这个过程通常涉及将 XML 元素和属性映射到目标格式中的相应元素和属性。
QT 怎么实现XML Schema
07-13
在QT中，可以使用QXmlSchema类来实现XML Schema的验证和处理。下面是一些基本的步骤： 1. 创建QXmlSchema实例：通过创建QXmlSchema实例，你可以加载和解析XML Schema文件。 ```cpp QXmlSchema schema; ``` 2. ...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值