Použití sloupce Oracle XMLType v režimu spánku

Můj směr a požadavky

• Entita by měla ukládat XML jako řetězec (java.lang.String)
• Databáze by měla uchovávat XML ve sloupci XDB.XMLType
  • Umožňuje indexování a efektivnější dotazy typu xpath/ExtractValue/xquery
• Konsolidujte asi tucet dílčích řešení, která jsem našel za poslední týden
• Pracovní prostředí
  • Oracle 11g r2 x64
  • Hibernace 4.1.x
  • Java 1.7.x x64
  • Windows 7 Pro x64

Řešení krok za krokem

Krok 1:Najděte soubor xmlparserv2.jar (~1350 kb)

Tento jar je nutný ke kompilaci kroku 2 a je součástí instalací oracle zde:%ORACLE_11G_HOME%/LIB/xmlparserv2.jar

Krok 1.5:Najděte soubor xdb6.jar (~257 kb)

To je důležité, pokud používáte Oracle 11gR2 11.2.0.2 nebo vyšší nebo ukládáte jako BINARY XML.

Proč?

• Ve verzi 11.2.0.2 a novější je sloupec XMLType uložen pomocí SECUREFILE BINARYXML ve výchozím nastavení, zatímco dřívější verze budou uloženy jako BASICFILECLOB
• Starší verze xdb*.jar správně nedekódují binární xml a tiše selhávají
  • Google Oracle Database 11g Release 2 JDBC Drivers a stáhněte si xdb6.jar
• Zde je popsána diagnostika a řešení problému s binárním dekódováním XML

Krok 2:Vytvořte hibernaci UserType pro sloupec XMLType

S Oracle 11g a Hibernate 4.x je to jednodušší, než se zdá.

public class HibernateXMLType implements UserType, Serializable {
static Logger logger = Logger.getLogger(HibernateXMLType.class);


private static final long serialVersionUID = 2308230823023l;
private static final Class returnedClass = String.class;
private static final int[] SQL_TYPES = new int[] { oracle.xdb.XMLType._SQL_TYPECODE };

@Override
public int[] sqlTypes() {
    return SQL_TYPES;
}

@Override
public Class returnedClass() {
    return returnedClass;
}

@Override
public boolean equals(Object x, Object y) throws HibernateException {
    if (x == null && y == null) return true;
    else if (x == null && y != null ) return false;
    else return x.equals(y);
}


@Override
public int hashCode(Object x) throws HibernateException {
    return x.hashCode();
}

@Override
public Object nullSafeGet(ResultSet rs, String[] names, SessionImplementor session, Object owner) throws HibernateException, SQLException {

    XMLType xmlType = null;
    Document doc = null;
    String returnValue = null;
    try {
        //logger.debug("rs type: " + rs.getClass().getName() + ", value: " + rs.getObject(names[0]));
        xmlType = (XMLType) rs.getObject(names[0]);

        if (xmlType != null) {
            returnValue = xmlType.getStringVal();
        }
    } finally {
        if (null != xmlType) {
            xmlType.close();
        }
    }
    return returnValue;
}

@Override
public void nullSafeSet(PreparedStatement st, Object value, int index, SessionImplementor session) throws HibernateException, SQLException {

    if (logger.isTraceEnabled()) {
        logger.trace("  nullSafeSet: " + value + ", ps: " + st + ", index: " + index);
    }
    try {
        XMLType xmlType = null;
        if (value != null) {
            xmlType = XMLType.createXML(getOracleConnection(st.getConnection()), (String)value);
        }
        st.setObject(index, xmlType);
    } catch (Exception e) {
        throw new SQLException("Could not convert String to XML for storage: " + (String)value);
    }
}


@Override
public Object deepCopy(Object value) throws HibernateException {
    if (value == null) {
        return null;
    } else {
        return value;
    }
}

@Override
public boolean isMutable() {
    return false;
}

@Override
public Serializable disassemble(Object value) throws HibernateException {
    try {
        return (Serializable)value;
    } catch (Exception e) {
        throw new HibernateException("Could not disassemble Document to Serializable", e);
    }
}

@Override
public Object assemble(Serializable cached, Object owner) throws HibernateException {

    try {
        return (String)cached;
    } catch (Exception e) {
        throw new HibernateException("Could not assemble String to Document", e);
    }
}

@Override
public Object replace(Object original, Object target, Object owner) throws HibernateException {
    return original;
}



private OracleConnection getOracleConnection(Connection conn) throws SQLException {
    CLOB tempClob = null;
    CallableStatement stmt = null;
    try {
        stmt = conn.prepareCall("{ call DBMS_LOB.CREATETEMPORARY(?, TRUE)}");
        stmt.registerOutParameter(1, java.sql.Types.CLOB);
        stmt.execute();
        tempClob = (CLOB)stmt.getObject(1);
        return tempClob.getConnection();
    } finally {
        if ( stmt != null ) {
            try {
                stmt.close();
            } catch (Throwable e) {}
        }
    }
}   

Krok 3:Označte pole ve své entitě.

Používám anotace s pružinou/hibernací, ne mapováním souborů, ale myslím si, že syntaxe bude podobná.

@Type(type="your.custom.usertype.HibernateXMLType")
@Column(name="attribute_xml", columnDefinition="XDB.XMLTYPE")
private String attributeXml;

Krok 4:Řešení chyb appserver/junit v důsledku Oracle JAR

Po zahrnutí %ORACLE_11G_HOME%/LIB/xmlparserv2.jar (1350 kb) do vaší classpath k vyřešení chyb kompilace, nyní dostáváte runtime chyby z vašeho aplikačního serveru...

http://www.springframework.org/schema/beans/spring-beans-3.1.xsd<Line 43, Column 57>: XML-24509: (Error) Duplicated definition for: 'identifiedType'
http://www.springframework.org/schema/beans/spring-beans-3.1.xsd<Line 61, Column 28>: XML-24509: (Error) Duplicated definition for: 'beans'
http://www.springframework.org/schema/beans/spring-beans-3.1.xsd<Line 168, Column 34>: XML-24509: (Error) Duplicated definition for: 'description'
http://www.springframework.org/schema/beans/spring-beans-3.1.xsd<Line 180, Column 29>: XML-24509: (Error) Duplicated definition for: 'import'
... more ...

PROČ CHYBY?

Soubor xmlparserv2.jar používá rozhraní JAR Services API (mechanismus poskytovatele služeb) ke změně výchozích tříd javax.xml používaných pro SAXParserFactory, DocumentBuilderFactory a TransformerFactory.

JAK SE TO STALO?

Nástroj javax.xml.parsers.FactoryFinder hledá vlastní implementace tak, že v tomto pořadí zkontroluje proměnné prostředí, %JAVA_HOME%/lib/jaxp.properties, a poté konfigurační soubory pod META-INF/services na cestě ke třídě, než použijete výchozí implementace zahrnuté v JDK (com.sun.org.*).

Uvnitř xmlparserv2.jar existuje adresář META-INF/services, který třída javax.xml.parsers.FactoryFinder přebírá. Soubory jsou následující:

META-INF/services/javax.xml.parsers.DocumentBuilderFactory (which defines oracle.xml.jaxp.JXDocumentBuilderFactory as the default)
META-INF/services/javax.xml.parsers.SAXParserFactory (which defines oracle.xml.jaxp.JXSAXParserFactory as the default)
META-INF/services/javax.xml.transform.TransformerFactory (which defines oracle.xml.jaxp.JXSAXTransformerFactory as the default)

ŘEŠENÍ?

Přepněte všechny 3 zpět, jinak uvidíte podivné chyby.

• javax.xml.parsers.* opraví viditelné chyby
• javax.xml.transform.*opravuje jemnější chyby analýzy XML
  • v mém případě s konfigurací apache commons čtení/psaní

RYCHLÉ ŘEŠENÍ k vyřešení chyb spouštění aplikačního serveru:Argumenty JVM

Chcete-li přepsat změny provedené souborem xmlparserv2.jar, přidejte do argumentů při spuštění aplikačního serveru následující vlastnosti JVM. Logika java.xml.parsers.FactoryFinder nejprve zkontroluje proměnné prostředí.

-Djavax.xml.parsers.SAXParserFactory=com.sun.org.apache.xerces.internal.jaxp.SAXParserFactoryImpl -Djavax.xml.parsers.DocumentBuilderFactory=com.sun.org.apache.xerces.internal.jaxp.DocumentBuilderFactoryImpl -Djavax.xml.transform.TransformerFactory=com.sun.org.apache.xalan.internal.xsltc.trax.TransformerFactoryImpl

Pokud však spustíte testovací případy pomocí @RunWith(SpringJUnit4ClassRunner.class) nebo podobně, k chybě dojde i nadále.

LEPŠÍ ŘEŠENÍ chyb při spouštění aplikačního serveru A chyb testovacího případu? 2 možnosti

Možnost 1:Použijte argumenty JVM pro aplikační server a příkazy @BeforeClass pro své testovací případy

System.setProperty("javax.xml.parsers.DocumentBuilderFactory","com.sun.org.apache.xerces.internal.jaxp.DocumentBuilderFactoryImpl");
System.setProperty("javax.xml.parsers.SAXParserFactory","com.sun.org.apache.xerces.internal.jaxp.SAXParserFactoryImpl");
System.setProperty("javax.xml.transform.TransformerFactory","com.sun.org.apache.xalan.internal.xsltc.trax.TransformerFactoryImpl");

Pokud máte mnoho testovacích případů, bude to bolestivé. I když to dáte do super.

Možnost 2:Vytvořte si vlastní definiční soubory poskytovatele služeb v cestě ke třídě kompilace/běhu pro váš projekt, které přepíší soubory obsažené v xmlparserv2.jar

V projektu maven spring přepište nastavení xmlparserv2.jar vytvořením následujících souborů v adresáři %PROJECT_HOME%/src/main/resources:

%PROJECT_HOME%/src/main/resources/META-INF/services/javax.xml.parsers.DocumentBuilderFactory (which defines com.sun.org.apache.xerces.internal.jaxp.DocumentBuilderFactoryImpl as the default)
%PROJECT_HOME%/src/main/resources/META-INF/services/javax.xml.parsers.SAXParserFactory (which defines com.sun.org.apache.xerces.internal.jaxp.SAXParserFactoryImpl as the default)
%PROJECT_HOME%/src/main/resources/META-INF/services/javax.xml.transform.TransformerFactory (which defines com.sun.org.apache.xalan.internal.xsltc.trax.TransformerFactoryImpl as the default)

Na tyto soubory odkazuje aplikační server (nejsou vyžadovány žádné argumenty JVM) a řeší jakékoli problémy s testováním jednotek bez nutnosti jakýchkoli změn kódu.

Hotovo.