Mi dirección y requisitos
- La entidad debe almacenar XML como una cadena (java.lang.String)
- La base de datos debe persistir XML en una columna XDB.XMLType
- Permite la indexación y consultas de tipo xpath/ExtractValue/xquery más eficientes
- Consolidar una docena de soluciones parciales que encontré durante la última semana
- Ambiente de trabajo
- Oracle 11g r2 x64
- Hibernar 4.1.x
- Java 1.7.x x64
- Windows 7 Pro x64
Solución paso a paso
Paso 1:busque xmlparserv2.jar (~1350kb)
Este jar es necesario para compilar el paso 2 y está incluido en las instalaciones de Oracle aquí:%ORACLE_11G_HOME%/LIB/xmlparserv2.jar
Paso 1.5:busque xdb6.jar (~257 kb)
Esto es fundamental si utiliza Oracle 11gR2 11.2.0.2 o superior, o lo almacena como XML BINARIO.
¿Por qué?
- En 11.2.0.2+, la columna XMLType se almacena usando SECUREFILE BINARYXML de forma predeterminada, mientras que las versiones anteriores se almacenarán como un BASICFILECLOB
- Las versiones anteriores de xdb*.jar no decodifican correctamente el xml binario y fallan silenciosamente
- Controladores JDBC de Google Oracle Database 11g versión 2 y descarga xdb6.jar
- Diagnóstico y solución para el problema de decodificación de XML binario descrito aquí
Paso 2:Cree un tipo de usuario de hibernación para la columna XMLType
Con Oracle 11g e Hibernate 4.x, esto es más fácil de lo que parece.
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) {}
}
}
}
Paso 3:Anote el campo en su entidad.
Estoy usando anotaciones con spring/hibernate, no archivos de mapeo, pero me imagino que la sintaxis será similar.
@Type(type="your.custom.usertype.HibernateXMLType")
@Column(name="attribute_xml", columnDefinition="XDB.XMLTYPE")
private String attributeXml;
Paso 4:Tratar con los errores del servidor de aplicaciones/junit como resultado del JAR de Oracle
Después de incluir %ORACLE_11G_HOME%/LIB/xmlparserv2.jar (1350kb) en su classpath para resolver errores de compilación, ahora obtiene errores de tiempo de ejecución de su servidor de aplicaciones...
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 ...
¿POR QUÉ LOS ERRORES?
xmlparserv2.jar utiliza la API de servicios JAR (Mecanismo de proveedor de servicios) para cambiar las clases javax.xml predeterminadas utilizadas para SAXParserFactory, DocumentBuilderFactory y TransformerFactory.
¿CÓMO SUCEDIÓ?
javax.xml.parsers.FactoryFinder busca implementaciones personalizadas buscando, en este orden, variables de entorno, %JAVA_HOME%/lib/jaxp.properties, luego archivos de configuración en META-INF/services en classpath, antes de usar el implementaciones predeterminadas incluidas con el JDK (com.sun.org.*).
Dentro de xmlparserv2.jar existe un directorio META-INF/services, que recoge la clase javax.xml.parsers.FactoryFinder. Los archivos son los siguientes:
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)
¿SOLUCIÓN?
Vuelva a cambiar los 3, de lo contrario verá errores extraños.
- javax.xml.parsers.* corrige los errores visibles
- javax.xml.transform.* corrige errores de análisis XML más sutiles
- en mi caso, con configuración de apache commons lectura/escritura
SOLUCIÓN RÁPIDA para solucionar los errores de inicio del servidor de aplicaciones:Argumentos JVM
Para anular los cambios realizados por xmlparserv2.jar, agregue las siguientes propiedades de JVM a los argumentos de inicio del servidor de aplicaciones. La lógica java.xml.parsers.FactoryFinder comprobará primero las variables de entorno.
-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
Sin embargo, si ejecuta casos de prueba usando @RunWith(SpringJUnit4ClassRunner.class) o similar, seguirá experimentando el error.
¿MEJOR SOLUCIÓN para los errores de inicio del servidor de aplicaciones Y errores de casos de prueba? 2 opciones
Opción 1:use argumentos JVM para el servidor de aplicaciones y declaraciones @BeforeClass para sus casos de prueba
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");
Si tiene muchos casos de prueba, esto se vuelve doloroso. Incluso si lo pones en un super.
Opción 2:cree sus propios archivos de definición de proveedor de servicios en el classpath de compilación/tiempo de ejecución de su proyecto, que anulará los incluidos en xmlparserv2.jar
En un proyecto de Maven Spring, anule la configuración de xmlparserv2.jar creando los siguientes archivos en el directorio %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)
El servidor de aplicaciones hace referencia a estos archivos (no se requieren argumentos JVM) y resuelve cualquier problema de prueba de unidad sin necesidad de cambios en el código.
Listo.
