วิธีที่ดีที่สุดในการตรวจสอบไฟล์ XML กับไฟล์ XSD คืออะไร

ฉันกำลังสร้างไฟล์ xml บางไฟล์ที่ต้องสอดคล้องกับไฟล์ xsd ที่มอบให้ฉัน วิธีที่ดีที่สุดในการตรวจสอบว่าพวกเขาสอดคล้องอะไร

Java runtime library สนับสนุนการตรวจสอบความถูกต้อง ครั้งล่าสุดที่ฉันตรวจสอบนี่คือ Apache Xerces parser ภายใต้หน้ากาก คุณอาจจะใช้javax.xml.validation.Validator

import javax.xml.XMLConstants;
import javax.xml.transform.Source;
import javax.xml.transform.stream.StreamSource;
import javax.xml.validation.*;
import java.net.URL;
import org.xml.sax.SAXException;
//import java.io.File; // if you use File
import java.io.IOException;
...
URL schemaFile = new URL("http://host:port/filename.xsd");
// webapp example xsd: 
// URL schemaFile = new URL("http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd");
// local file example:
// File schemaFile = new File("/location/to/localfile.xsd"); // etc.
Source xmlFile = new StreamSource(new File("web.xml"));
SchemaFactory schemaFactory = SchemaFactory
    .newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);
try {
  Schema schema = schemaFactory.newSchema(schemaFile);
  Validator validator = schema.newValidator();
  validator.validate(xmlFile);
  System.out.println(xmlFile.getSystemId() + " is valid");
} catch (SAXException e) {
  System.out.println(xmlFile.getSystemId() + " is NOT valid reason:" + e);
} catch (IOException e) {}

ค่าคงที่สกีมาที่โรงงานคือสตริงhttp://www.w3.org/2001/XMLSchemaที่กำหนด XSD รหัสด้านบนตรวจสอบตัวบ่งชี้การปรับใช้ WAR กับ URL http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsdแต่คุณสามารถตรวจสอบไฟล์ท้องถิ่นได้อย่างง่ายดาย

คุณไม่ควรใช้ DOMParser เพื่อตรวจสอบความถูกต้องของเอกสาร (เว้นแต่ว่าเป้าหมายของคุณคือการสร้างแบบจำลองวัตถุเอกสาร) สิ่งนี้จะเริ่มสร้างวัตถุ DOM เมื่อแยกวิเคราะห์เอกสาร - สิ้นเปลืองหากคุณไม่ได้ใช้งาน

นี่คือวิธีการทำโดยใช้Xerces2 บทช่วยสอนสำหรับสิ่งนี้ที่นี่ (ต้องสมัครใช้งาน)

ที่มาดั้งเดิม: คัดลอกโจ๋งครึ่มจากที่นี่ :

import org.apache.xerces.parsers.DOMParser;
import java.io.File;
import org.w3c.dom.Document;

public class SchemaTest {
  public static void main (String args[]) {
      File docFile = new File("memory.xml");
      try {
        DOMParser parser = new DOMParser();
        parser.setFeature("http://xml.org/sax/features/validation", true);
        parser.setProperty(
             "http://apache.org/xml/properties/schema/external-noNamespaceSchemaLocation", 
             "memory.xsd");
        ErrorChecker errors = new ErrorChecker();
        parser.setErrorHandler(errors);
        parser.parse("memory.xml");
     } catch (Exception e) {
        System.out.print("Problem parsing the file.");
     }
  }
}

เราสร้างโครงการของเราโดยใช้มดเพื่อให้เราสามารถใช้งาน schemavalidate เพื่อตรวจสอบไฟล์กำหนดค่าของเรา:

<schemavalidate> 
    <fileset dir="${configdir}" includes="**/*.xml" />
</schemavalidate>

ตอนนี้ไฟล์ปรับแต่งที่ซุกซนจะไม่สามารถสร้างได้

http://ant.apache.org/manual/Tasks/schemavalidate.html

เนื่องจากนี่เป็นคำถามยอดนิยมฉันจะชี้ให้เห็นว่า java ยังสามารถตรวจสอบกับ "อ้างอิงถึง" xsd's เช่นถ้าไฟล์. xml ระบุตัวเอง XSD ในส่วนหัวของการใช้xsi:SchemaLocationหรือxsi:noNamespaceSchemaLocation(หรือ xsi สำหรับ namespaces เฉพาะ) อดีต :

<document xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:noNamespaceSchemaLocation="http://www.example.com/document.xsd">
  ...

หรือ SchemaLocation (รายการเนมสเปซไปที่การแม็พ xsd เสมอ)

<document xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:SchemaLocation="http://www.example.com/my_namespace http://www.example.com/document.xsd">
  ...

คำตอบอื่น ๆ ก็ทำงานที่นี่เช่นกันเพราะไฟล์. xsd "แมป" กับเนมสเปซที่ประกาศในไฟล์. xml เพราะพวกเขาประกาศเนมสเปซและถ้าตรงกับเนมสเปซในไฟล์. xml คุณก็ดี แต่บางครั้งก็สะดวกที่จะมีตัวแก้ไขที่กำหนดเอง...

จาก javadocs: "หากคุณสร้างสคีมาโดยไม่ระบุ URL ไฟล์หรือแหล่งที่มาจากนั้นภาษา Java จะสร้างหนึ่งที่ดูในเอกสารที่มีการตรวจสอบความถูกต้องเพื่อหาสคีมาที่ควรใช้ตัวอย่างเช่น"

SchemaFactory factory = SchemaFactory.newInstance("http://www.w3.org/2001/XMLSchema");
Schema schema = factory.newSchema();

และใช้ได้กับเนมสเปซหลายรายการ ฯลฯ ปัญหาของวิธีนี้คือที่xmlsns:xsiตั้งอาจเป็นเครือข่ายดังนั้นโดยค่าเริ่มต้นจะออกไปและเข้าสู่เครือข่ายด้วยการตรวจสอบความถูกต้องทุกครั้ง

นี่คือตัวอย่างที่ตรวจสอบความถูกต้องของไฟล์ XML กับ XSD ใด ๆ ที่อ้างอิงถึง (แม้ว่าจะต้องดึงพวกเขาออกจากเครือข่าย):

  public static void verifyValidatesInternalXsd(String filename) throws Exception {
    InputStream xmlStream = new new FileInputStream(filename);
    DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
    factory.setValidating(true);
    factory.setNamespaceAware(true);
    factory.setAttribute("http://java.sun.com/xml/jaxp/properties/schemaLanguage",
                 "http://www.w3.org/2001/XMLSchema");
    DocumentBuilder builder = factory.newDocumentBuilder();
    builder.setErrorHandler(new RaiseOnErrorHandler());
    builder.parse(new InputSource(xmlStream));
    xmlStream.close();
  }

  public static class RaiseOnErrorHandler implements ErrorHandler {
    public void warning(SAXParseException e) throws SAXException {
      throw new RuntimeException(e);
    }
    public void error(SAXParseException e) throws SAXException {
      throw new RuntimeException(e);
    }
    public void fatalError(SAXParseException e) throws SAXException {
      throw new RuntimeException(e);
    }
  }

คุณสามารถหลีกเลี่ยงการดึงอ้างอิง XSD จากเครือข่ายแม้ว่าไฟล์ XML อ้างอิงของ URL โดยระบุ xsd เอง (เห็นบางคำตอบอื่น ๆ ที่นี่) หรือโดยการใช้ "XML แค็ตตาล็อก" จำแนกรูปแบบ เห็นได้ชัดว่าสปริงยังสามารถสกัดกั้นคำขอ URL เพื่อแสดงไฟล์ในเครื่องสำหรับการตรวจสอบความถูกต้อง หรือคุณสามารถตั้งค่าของคุณเองผ่านsetResourceResolverเช่น:

Source xmlFile = new StreamSource(xmlFileLocation);
SchemaFactory schemaFactory = SchemaFactory
                                .newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);
Schema schema = schemaFactory.newSchema();
Validator validator = schema.newValidator();
validator.setResourceResolver(new LSResourceResolver() {
  @Override
  public LSInput resolveResource(String type, String namespaceURI,
                                 String publicId, String systemId, String baseURI) {
    InputSource is = new InputSource(
                           getClass().getResourceAsStream(
                          "some_local_file_in_the_jar.xsd"));
                          // or lookup by URI, etc...
    return new Input(is); // for class Input see 
                          // https://stackoverflow.com/a/2342859/32453
  }
});
validator.validate(xmlFile);

ดูที่นี่สำหรับบทช่วยสอนอื่น

ฉันเชื่อว่าค่าเริ่มต้นคือการใช้การแยกวิเคราะห์ DOM คุณสามารถทำสิ่งที่คล้ายกับ SAX parser ที่ตรวจสอบได้เช่นกัน saxReader.setEntityResolver(your_resolver_here);

โดยใช้ Java 7 คุณสามารถทำตามเอกสารที่ระบุไว้ในรายละเอียดแพคเกจ

// create a SchemaFactory capable of understanding WXS schemas
SchemaFactory factory = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);

// load a WXS schema, represented by a Schema instance
Source schemaFile = new StreamSource(new File("mySchema.xsd"));
Schema schema = factory.newSchema(schemaFile);

// create a Validator instance, which can be used to validate an instance document
Validator validator = schema.newValidator();

// validate the DOM tree
try {
    validator.validate(new StreamSource(new File("instance.xml"));
} catch (SAXException e) {
    // instance document is invalid!
}

หากคุณมี Linux-Machine คุณสามารถใช้เครื่องมือบรรทัดคำสั่งฟรี SAXCount ฉันพบว่ามันมีประโยชน์มาก

SAXCount -f -s -n my.xml

มันตรวจสอบกับ dtd และ xsd 5s สำหรับไฟล์ 50MB

ในเดเบียนบีบมันจะอยู่ในแพคเกจ "libxerces-c-samples"

คำจำกัดความของ dtd และ xsd ต้องอยู่ใน xml! คุณไม่สามารถกำหนดค่าแยกกันได้

อีกหนึ่งคำตอบ: เนื่องจากคุณบอกว่าคุณต้องตรวจสอบความถูกต้องของไฟล์ที่คุณกำลังสร้าง (การเขียน) คุณอาจต้องการตรวจสอบความถูกต้องของเนื้อหาในขณะที่คุณกำลังเขียนแทนการเขียนครั้งแรกจากนั้นอ่านกลับเพื่อตรวจสอบความถูกต้อง คุณสามารถทำได้ด้วย JDK API สำหรับการตรวจสอบ Xml หากคุณใช้ตัวเขียนที่ใช้ SAX: ถ้าเป็นเช่นนั้นเพียงลิงก์ในตัวตรวจสอบความถูกต้องโดยเรียก 'Validator.validate (แหล่งที่มาผลลัพธ์)' แหล่งที่มาจากนักเขียนของคุณและผลลัพธ์คือ ตำแหน่งที่เอาต์พุตต้องไป

อีกทางเลือกหนึ่งถ้าคุณใช้ Stax สำหรับการเขียนเนื้อหา (หรือไลบรารีที่ใช้หรือสามารถใช้ stax) Woodstoxยังสามารถรองรับการตรวจสอบความถูกต้องโดยตรงเมื่อใช้ XMLStreamWriter นี่คือรายการบล็อกที่แสดงวิธีการทำ:

หากคุณกำลังสร้างไฟล์ XML แบบเป็นโปรแกรมคุณอาจต้องการดูไลบรารีXMLBeans การใช้เครื่องมือบรรทัดคำสั่ง XMLBeans จะสร้างและจัดทำชุดของวัตถุ Java โดยอัตโนมัติตาม XSD จากนั้นคุณสามารถใช้วัตถุเหล่านี้เพื่อสร้างเอกสาร XML โดยยึดตามสคีมานี้

มันมีการสนับสนุนในตัวสำหรับการตรวจสอบความถูกต้องของสคีมาและสามารถแปลงวัตถุ Java เป็นเอกสาร XML และในทางกลับกัน

CastorและJAXBเป็นห้องสมุด Java อื่น ๆ ที่ให้บริการวัตถุประสงค์คล้ายกับ XMLBeans

ด้วย JAXB คุณสามารถใช้รหัสด้านล่าง:

    @Test
public void testCheckXmlIsValidAgainstSchema() {
    logger.info("Validating an XML file against the latest schema...");

    MyValidationEventCollector vec = new MyValidationEventCollector();

    validateXmlAgainstSchema(vec, inputXmlFileName, inputXmlSchemaName, inputXmlRootClass);

    assertThat(vec.getValidationErrors().isEmpty(), is(expectedValidationResult));
}

private void validateXmlAgainstSchema(final MyValidationEventCollector vec, final String xmlFileName, final String xsdSchemaName, final Class<?> rootClass) {
    try (InputStream xmlFileIs = Thread.currentThread().getContextClassLoader().getResourceAsStream(xmlFileName);) {
        final JAXBContext jContext = JAXBContext.newInstance(rootClass);
        // Unmarshal the data from InputStream
        final Unmarshaller unmarshaller = jContext.createUnmarshaller();

        final SchemaFactory sf = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);
        final InputStream schemaAsStream = Thread.currentThread().getContextClassLoader().getResourceAsStream(xsdSchemaName);
        unmarshaller.setSchema(sf.newSchema(new StreamSource(schemaAsStream)));

        unmarshaller.setEventHandler(vec);

        unmarshaller.unmarshal(new StreamSource(xmlFileIs), rootClass).getValue(); // The Document class is the root object in the XML file you want to validate

        for (String validationError : vec.getValidationErrors()) {
            logger.trace(validationError);
        }
    } catch (final Exception e) {
        logger.error("The validation of the XML file " + xmlFileName + " failed: ", e);
    }
}

class MyValidationEventCollector implements ValidationEventHandler {
    private final List<String> validationErrors;

    public MyValidationEventCollector() {
        validationErrors = new ArrayList<>();
    }

    public List<String> getValidationErrors() {
        return Collections.unmodifiableList(validationErrors);
    }

    @Override
    public boolean handleEvent(final ValidationEvent event) {
        String pattern = "line {0}, column {1}, error message {2}";
        String errorMessage = MessageFormat.format(pattern, event.getLocator().getLineNumber(), event.getLocator().getColumnNumber(),
                event.getMessage());
        if (event.getSeverity() == ValidationEvent.FATAL_ERROR) {
            validationErrors.add(errorMessage);
        }
        return true; // you collect the validation errors in a List and handle them later
    }
}

คุณกำลังมองหาเครื่องมือหรือไลบรารีอยู่หรือไม่?

เท่าที่ห้องสมุดไปสวยมากมาตรฐานพฤตินัยเป็นXerces2ซึ่งมีทั้งภาษา C ++และJavaรุ่น

เตือนก่อนว่ามันเป็นทางออกที่มีน้ำหนักมาก แต่แล้วอีกครั้งการตรวจสอบ XML กับไฟล์ XSD เป็นปัญหาที่ค่อนข้างหนัก

สำหรับเครื่องมือในการทำเช่นนี้สำหรับคุณXMLFoxน่าจะเป็นโซลูชันฟรีแวร์ที่ดี แต่ไม่ได้ใช้มันเป็นการส่วนตัวฉันไม่สามารถพูดได้อย่างแน่นอน

ตรวจสอบกับ schema ออนไลน์

Source xmlFile = new StreamSource(Thread.currentThread().getContextClassLoader().getResourceAsStream("your.xml"));
SchemaFactory factory = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);
Schema schema = factory.newSchema(Thread.currentThread().getContextClassLoader().getResource("your.xsd"));
Validator validator = schema.newValidator();
validator.validate(xmlFile);

ตรวจสอบกับสคีมาท้องถิ่น

การตรวจสอบ XML ออฟไลน์ด้วย Java

ใช้Woodstoxกำหนดค่าตัวแยกวิเคราะห์ StAX เพื่อตรวจสอบกับ schema ของคุณและแยกวิเคราะห์ XML

หากจับข้อยกเว้น XML ไม่ถูกต้องมิฉะนั้นจะถูกต้อง:

// create the XSD schema from your schema file
XMLValidationSchemaFactory schemaFactory = XMLValidationSchemaFactory.newInstance(XMLValidationSchema.SCHEMA_ID_W3C_SCHEMA);
XMLValidationSchema validationSchema = schemaFactory.createSchema(schemaInputStream);

// create the XML reader for your XML file
WstxInputFactory inputFactory = new WstxInputFactory();
XMLStreamReader2 xmlReader = (XMLStreamReader2) inputFactory.createXMLStreamReader(xmlInputStream);

try {
    // configure the reader to validate against the schema
    xmlReader.validateAgainst(validationSchema);

    // parse the XML
    while (xmlReader.hasNext()) {
        xmlReader.next();
    }

    // no exceptions, the XML is valid

} catch (XMLStreamException e) {

    // exceptions, the XML is not valid

} finally {
    xmlReader.close();
}

หมายเหตุ : หากคุณจำเป็นต้องตรวจสอบหลายไฟล์คุณควรพยายามที่จะนำมาใช้ใหม่ของคุณXMLInputFactoryและXMLValidationSchemaเพื่อเพิ่มประสิทธิภาพการทำงาน

ฉันต้องตรวจสอบ XML กับ XSD เพียงครั้งเดียวดังนั้นฉันจึงลอง XMLFox ฉันพบว่ามันสับสนและแปลกมาก คำแนะนำวิธีใช้ดูเหมือนจะไม่ตรงกับอินเทอร์เฟซ

ฉันลงเอยด้วยการใช้ LiquidXML Studio 2008 (v6) ซึ่งใช้งานง่ายกว่าและคุ้นเคยมากกว่าในทันที (UI นั้นคล้ายกับ Visual Basic 2008 Express ซึ่งฉันใช้บ่อย) ข้อเสีย: ความสามารถในการตรวจสอบไม่ได้อยู่ในรุ่นฟรีดังนั้นฉันต้องใช้การทดลอง 30 วัน