Keyvan Akbary Follow

Keyvan Akbary

Lead Dev at TransferWise
Spaniard in London
Built Funddy

I wrote a book too

Learn more

Anotaciones, un foco de problemas

Si utilizas un ORM como Doctrine 2 te habrás percatado que utilizar anotaciones para mapear entidades es una practica sorprendentemente popular:

/** @Document */
class User
{
    /** @Id */
    private $id;

    /** @Field(type="string") */
    private $name;
}

También el de utilizarlas como configuración en tus controladores en Symfony 2:

/**
 * @Route("/")
 * @Template("BlogBundle:Blog:home.html.twig")
 */
public function homeAction() {}

Utilizar anotaciones es una mala idea

Las anotaciones son algo mágico. La magia en el software es mala por definición, lo es porque no sabemos como funciona exactamente. Son un foco de malentendidos, provocan inesperados side effects y dependen de interpretes de terceros.

Depurarlas no es sencillo

Debido a que no son nativas del lenguaje y funcionan de una forma poco habitual, requieren de intérpretes que normalmente bifurcan o interrumpen el flujo natural de tu código para ejecutarlas. Seguir la ejecución es cuanto menos una odisea.

Contaminan tu dominio

La capa de dominio debe ser agnóstica a los detalles. Así pues, persistir o no tus entidades de dominio sobre una base de datos o mantenerlas en memoria es un detalle de infraestructura en que el dominio no es partícipe. Incrustar anotaciones (configuración) en tu dominio es de las peores aberraciones que puedes cometer, hacen que tu dominio sea frágil y rígido y no permiten una clara separación en capas.

Dificultan la lectura

No nos olvidemos, las anotaciones son comentarios y si estos ya de por si un síntoma de un problema mayor, el hecho de que ejecuten cosas debería hacer saltar todas las alarmas. Las anotaciones se mezclan con tu código, entorpeciendo su lectura y convirtiéndolo en un popurrí indescifrable.

Alternativas

Dado que detrás de las anotaciones, en algún lugar recóndito, hay código respaldándolas, siempre va a haber una forma de evitarlas.

Por ejemplo, en Symfony 2 liberar a tu controlador de la configuración de enrutado es tan sencillo como crear un fichero YAML:

home:
    pattern: /
    defaults: { _controller: Bundle:Controller:home }

De la misma forma, Doctrine 2 permite separar tu dominio de los detalles de persistencia a través de ficheros de mapeo:

Documents\User:
    db: documents
    collection: user
    fields:
        id:
            id: true
        name:
            type: string

¡Mucho mas claro! A la larga te aseguro que lo agradecerás.

Referencias

¿Ves algo raro? ¡Editame!

Copyright © 2015