¿Cómo se hace legible el SQL largo invocado desde otro código?

Question

Esta es una pregunta muy abierta, pero creo que puede ser muy beneficioso para la legibilidad de SQL.

Así que tiene un programa Java, y está tratando de llamar a una declaración SQL monstruosa desde allí, con muchas subconsultas y combinaciones. El punto de partida de mi pregunta es una constante como esta cadena:

static string MONSTER_STATEMENT = 
    "SELECT " + 
    " fields" + 
    "WHERE "+ 
    " fieldA = (SELECT a FROM TableC) " + 
    "AND fieldB IN (%s)" + 
    "AND fieldC = %d " + 
    "FROM " 
    " tableA INNER JOIN tableB ON ..."; 

Más tarde se llena usando String.Format y ejecutado.

¿Cuáles son sus trucos para hacer que este tipo de cosas sean legibles? ¿Separe sus uniones internas? ¿Indenta el SQL mismo dentro de la cadena? ¿Dónde pones los comentarios? Por favor comparte todos los trucos en tu arsenal.

Answer 1

Dicho SQL complejo debe estar en una declaración preparada, no unida por un String.format para evitar problemas de inyección de SQL.

Realizo una de estas dos cosas: Envolverlo en una declaración invocable o ponerlo en un archivo de configuración/xml. Los archivos fuente de Java son un mal lugar para SQL complejo.

Dicho esto, IDEA tiene una característica de formato de idioma que formateará cadenas en Java para que parezcan un idioma diferente (según el método al que se las transfiere o se basa en una anotación), de modo que eso puede ser útil.

Editar: Dada su situación, acepto que las declaraciones invocables pueden no ser factibles. Las declaraciones preparadas aún lo valen, incluso para el desarrollo interno, solo porque un parámetro con un apóstrofo puede hacer explotar todo (incluso si no hay un atacante), por lo que aún vale la pena, IMO, hacer el esfuerzo adicional para crear la cadena. dinámicamente (String.format o cualquier otra cosa) en el código solo para las partes que no se pueden pasar como parámetros (tales como los nombres de tablas temporales como en su ejemplo), y luego usar eso como una declaración preparada que pasa los parámetros adecuados para el resto.

En cuanto a mantenerlo menos feo, parece que un archivo de configuración/tipo xml es lo que yo buscaría.

Answer 2

Mi inclinación es formatear mi declaración de SQL de la misma manera que me gustaría si me preguntara directamente sobre la base de datos usando una consola de administración como Management Studio. Por lo tanto, cuando construyo una declaración SQL, me tomo el tiempo de poner espacios y saltos de línea. El espacio adicional consumido es insignificante en comparación con el ahorro de tiempo de poder leer el SQL si debo imprimirlo o capturarlo usando algo SQL Profiler. Por lo tanto, me inclinaría a usar StringBuilder de montar mi SQL, así:

StringBuilder sql = new StringBuilder(); 
sql.append("Select ...."); 
sql.append("\t\n, AdditionalCol, ..."); 
sql.append("\nFrom ..."); 
sql.append("\n Inner Join ..."); 
sql.append("\n  On ColA = ..."); 
sql.append("\nWhere Col1 = ("); 
sql.append("\n   Select a"); 
sql.append("\n   From TableC"); 
sql.append("\n   "); 
sql.append("\n And ColB In(%s)"); 
sql.append("\n And ColC = %d"); 

Answer 3

una clase de ayuda que Wrapps todo el proceso de construcción puede ayudarle. Eso podría ser uno: http://openhms.sourceforge.net/sqlbuilder/

De todos modos, siempre vaya con las declaraciones preparadas.