¿Dónde debería colocar los archivos SQL en mi proyecto Java?

Question

Tengo un proyecto Java que incluirá varias sentencias SQL grandes para consultar la base de datos. Mi pregunta es: ¿dónde debería almacenarlos?

Estoy bastante seguro de que quiero que cada declaración tenga su propio archivo de texto administrado por control de código fuente. Como Java no es compatible con cadenas de varias líneas, no puedo colocar fácilmente el SQL en mis archivos .java y no creo que quiera hacerlo de todos modos. En tiempo de compilación puedo poner estos archivos de texto en JAR y obtener los contenidos con ClassLoader.getResourceAsStream().

Así que mi problema es en qué directorios debería poner estos archivos y cómo los debería llamar. Idealmente me gustaría que la gente diga del archivo .sql que la clase Java lo usa. Lo que definitivamente no quiero es un solo directorio lleno de muchos archivos llamados cosas como report1.sql y report3.sql y así sucesivamente.

Mi inclinación es ponerlos en el directorio del paquete con todos los archivos .java, pero tengo un colega que no le gusta tener nada más que .java archivos en este árbol. Por lo tanto, esto conduce a una alternativa de una estructura de directorios separada que refleja los paquetes de Java, pero esto parece una sobrecarga innecesaria.

Me gustaría saber qué hace con sus archivos SQL.

Estamos utilizando Netbeans 6.5 en caso de que afecte sus respuestas.

(This question es similar, pero por desgracia las respuestas son muy C# específica, que es bueno para esa pregunta, pero malo para mí.)

Answer 1

En un entorno Java/Maven utilizamos como jerarquía del proyecto:

project/src/main/java/Package/Class.java 
project/src/test/java/Package/ClassTest.java 
project/src/main/resources/Package/resource.properties 
project/src/test/resources/Package/test_resource.properties 

Y para responder a su pregunta: Yo pondría los archivos SQL junto con los recursos en src/main/resources.

Es posible que desee echarle un vistazo a este thread.

Answer 2

Estoy totalmente de acuerdo con Boutta. Maven establece un buen estándar para la administración de carpetas src. ¿Has considerado almacenar tu SQL en XML? Mantener las consultas en un solo archivo puede facilitar la administración del SQL. Mi primera intuición es algo sencillo:

<?xml version="1.0" encoding="UTF-8"?> 
<queries> 
    <query id="getUserByName"> 
     select * from users where name=? 
    </query> 
    <query id="getUserByEmail"> 
     select * from users where email=? 
    </query> 
</queries> 

para analizar el archivo, utiliza XPath o incluso SAX para crear un mapa de consultas tecleados por el ID de consulta para búsquedas rápidas.

Answer 3

Estaría tentado de poner las consultas SQL en una carpeta dedicada SQL bajo src. Esto separa el código de Java desde el SQL:

+ src 
    + java 
    + sql 
    - Package/Class.sql 
+ test 

alternativa usted puede ponerlos en archivos de propiedades simples utilizando la estructura anterior:

getUserByName = select * from users where name=? 

getUserByEmail = select * from users where email=? 

getUserByLongQuery = select * from users where email=? \ 
    and something = ? \ 
    where something_else = ? 

Además, creo que vale la pena mencionar que se puede poner múltiples cadenas de líneas en una clase Java, si usted prefiere tomar esa ruta:

class MyClass { 
    MY_QUERY = "select * from users where email = ? " + 
       "and something_else = ?"; 
} 

Answer 4

Este es un ligero riff en la pregunta inicial, pero sin duda el más complejo es el SQL es el más pertenece en la base de datos (o en una capa de servicios) y no en su código Java.

De lo contrario, como el código madura, issues like this surgen.

Answer 5

para ser consistente a http://maven.apache.org/pom.html#Resources este lugar puede ser uno de:

• src/main/sql
• src/main/upgrade - para scripts de actualización entre versiones
• src/main/db, src/main/schema, src/main/ddl - para el esquema actual proyecto de DB, por primera Despliegue del proyecto
• etc., solo ponerlo en src/main/NAME directorio

Otras cosas a considerar:

• herramienta de migración de la vía de migración DB asume que la actualización Vxx__YYY.sql scripts localizados en el directorio classpath:resources/db/migrationso you place them into projectsrc/main/resources/db/migration.
• herramienta de migración LiquiBase DB recomienda Choose a package in your classpath to store the changelogs, preferably near your database access classes

Tenga en cuenta que el IDE no es compatible con otros directorios escuchar a continuación src/main/java y src/main/resources en visor de proyectos, para que el uso del visor de archivos .