Min riktning och krav
- Entiteten bör lagra XML som en sträng (java.lang.String)
- Databasen ska bestå XML i en XDB.XMLType-kolumn
- Tillåter indexering och mer effektiva frågor av typen xpath/ExtractValue/xquery
- Konsolidera ett dussintal dellösningar som jag hittade under den senaste veckan
- Arbetsmiljö
- Oracle 11g r2 x64
- Viloläge 4.1.x
- Java 1.7.x x64
- Windows 7 Pro x64
Steg-för-steg-lösning
Steg 1:Hitta xmlparserv2.jar (~1350kb)
Denna jar krävs för att kompilera steg 2 och ingår i Oracle-installationer här:%ORACLE_11G_HOME%/LIB/xmlparserv2.jar
Steg 1.5:Hitta xdb6.jar (~257kb)
Detta är avgörande om du använder Oracle 11gR2 11.2.0.2 eller senare, eller lagrar som BINÄR XML.
Varför?
- I 11.2.0.2+ lagras XMLType-kolumnen med SECUREFILE BINARYXML som standard, medan tidigare versioner kommer att lagras som en BASICFILECLOB
- Äldre versioner av xdb*.jar avkodar inte binär xml korrekt och misslyckas tyst
- Google Oracle Database 11g Release 2 JDBC-drivrutiner och ladda ner xdb6.jar
- Diagnos och lösning för binär XML-avkodningsproblem som beskrivs här
Steg 2:Skapa en viloläge UserType för XMLType-kolumnen
Med Oracle 11g och Hibernate 4.x är detta enklare än det låter.
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) {}
}
}
}
Steg 3:Anteckna fältet i din enhet.
Jag använder annoteringar med spring/hibernate, inte mappningsfiler, men jag antar att syntaxen kommer att vara liknande.
@Type(type="your.custom.usertype.HibernateXMLType")
@Column(name="attribute_xml", columnDefinition="XDB.XMLTYPE")
private String attributeXml;
Steg 4:Hantera appserver/junit-fel som ett resultat av Oracle JAR
Efter att ha inkluderat %ORACLE_11G_HOME%/LIB/xmlparserv2.jar (1350kb) i din klasssökväg för att lösa kompileringsfel, får du nu runtime-fel från din applikationsserver...
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 ...
VARFÖR FEL?
xmlparserv2.jar använder JAR Services API (Service Provider Mechanism) för att ändra standard javax.xml-klasserna som används för SAXParserFactory, DocumentBuilderFactory och TransformerFactory.
HUR HÄNDE DET?
javax.xml.parsers.FactoryFinder letar efter anpassade implementeringar genom att leta efter, i denna ordning, miljövariabler, %JAVA_HOME%/lib/jaxp.properties, sedan efter konfigurationsfiler under META-INF/tjänster på klasssökvägen, innan du använder standardimplementationer som ingår i JDK (com.sun.org.*).
Inuti xmlparserv2.jar finns en META-INF/services-katalog, som klassen javax.xml.parsers.FactoryFinder plockar upp. Filerna är följande:
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)
LÖSNING?
Byt tillbaka alla 3, annars kommer du att se konstiga fel.
- javax.xml.parsers.* fixa de synliga felen
- javax.xml.transform.*fixar mer subtila XML-tolkningsfel
- i mitt fall, med apache commons-konfiguration läsa/skriva
SNABB LÖSNING för att lösa applikationsserverns startfel:JVM-argument
För att åsidosätta ändringarna som gjorts av xmlparserv2.jar, lägg till följande JVM-egenskaper till startargumenten för applikationsservern. Java.xml.parsers.FactoryFinder-logiken kontrollerar miljövariablerna först.
-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
Men om du kör testfall med @RunWith(SpringJUnit4ClassRunner.class) eller liknande kommer du fortfarande att uppleva felet.
BÄTTRE LÖSNING för applikationsserverns startfel OCH testfallsfel? 2 alternativ
Alternativ 1:Använd JVM-argument för appservern och @BeforeClass-satser för dina testfall
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");
Om du har många testfall blir detta smärtsamt. Även om du lägger den i en super.
Alternativ 2:Skapa dina egna definitionsfiler för tjänsteleverantörer i kompilerings-/körningsklassvägen för ditt projekt, som kommer att åsidosätta de som ingår i xmlparserv2.jar
I ett Maven Spring-projekt, åsidosätt xmlparserv2.jar-inställningarna genom att skapa följande filer i katalogen %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)
Dessa filer refereras av både applikationsservern (inga JVM-argument krävs) och löser eventuella enhetstestproblem utan att kräva några kodändringar.
Klart.