Número de consultas
| Sigla | Query |
| Aspecto | «Tamaño» |
| Se mide en | clase, interfaz |
| Tipo de valor | recuento (entero, mínimo 0) |
| Dirección | informativa: ni alto ni bajo es mejor |
| Origen | la idea de separar comandos y consultas, de Bertrand Meyer (Object-Oriented Software Construction, 1988) |
| Stau Metro | NumQueriesClass, NumQueriesInterface |
En pocas palabras
Cuenta los métodos que devuelven un valor. Son los que sirven para preguntar algo a un objeto. Su contrapartida son los
«comandos», los métodos void.
Qué mide
Cuánto de la interfaz de una clase es acceso a datos o cálculo. Procede del principio de separación entre comandos y consultas de Meyer: una consulta devuelve un resultado sin cambiar el estado observable del sistema, un comando lo cambia y no devuelve valor (en la formulación de Fowler).
Ojo. La métrica solo mira el tipo de retorno. Un método que devuelve un valor y además cambia el estado (como
popde una pila, el ejemplo de Fowler) cuenta como consulta aunque el principio no lo consideraría tal.
Cómo se calcula
Se cuenta 1 por cada método declarado en el código fuente de la clase o interfaz cuyo tipo de retorno no es void.
- Los constructores no cuentan.
- Los heredados tampoco.
- Cuentan los abstractos, estáticos, privados y, en interfaces, los
default. - En una clase solo cuentan los métodos escritos en el fuente: los que el lenguaje genera en un enumerado (
values,valueOf) o en un record no entran. Un accesor de record escrito a mano sí. - Se calcula para clases con nombre (también abstractas, enumerados y records) y para interfaces que no sean tipos de anotación; no para clases anónimas o locales.
Ejemplo
interface Shape {
enum Kind { ROUND, POLYGON } // tipo anidado: no es un método
double area(); // consulta
double perimeter(); // consulta
Kind kind(); // consulta
default void print() { } // comando
}
Query = 3, Command = 1. Sin print (y con Kind declarado fuera), es la interfaz Shape de los datos de prueba
del proyecto, que fijan Query = 3 y Command = 0.
Cómo interpretarla
Sin umbrales. Un valor alto indica que la clase o interfaz trata sobre todo de devolver datos. Léela junto al número de comandos: el cociente entre ambas dice si el tipo es más de consulta (modelos, vistas de solo lectura) o más de acción (servicios, manejadores). Una clase con muchas consultas y pocos comandos es típica de objetos de datos; con muchos comandos y pocas consultas, de objetos que se manipulan desde fuera.
Relación con otras métricas
- «Número de comandos» (
Command): la otra mitad del reparto. - «Tamaño de la clase (operaciones)» (
CSO) y «de la interfaz» (ISO): el total de operaciones, de las que las consultas son una parte. - «Número de constructores» (
Cons): los métodos que quedan fuera de ambos recuentos.
En las herramientas
Stau Metro (NumQueriesClass, NumQueriesInterface). Solo cuenta lo que la clase o interfaz declara. En una
clase se usan los métodos escritos en el fuente; en una interfaz, los que esta declara. Los métodos que devuelven
Void (el tipo envoltorio) cuentan como consulta.
MetricsReloaded (Query, por clase y por interfaz). Hace el mismo recuento por tipo de retorno, pero en una
clase toma todos los métodos que el IDE conoce, sin quitar los que genera el lenguaje: en un enumerado o un record
puede contar también values, valueOf o los accesores implícitos. A diferencia de Stau Metro, da valor a las
clases locales.
Referencias
- Fowler, M. «CommandQuerySeparation». https://www.martinfowler.com/bliki/CommandQuerySeparation.html
- Meyer, B. (1988). Object-Oriented Software Construction. Prentice Hall.
- MetricsReloaded, código del cálculo por clase: https://github.com/BasLeijdekkers/MetricsReloaded/blob/master/stockmetrics/src/com/sixrr/stockmetrics/classCalculators/NumQueriesClassCalculator.java