Buenas prácticas y consejos para mejorar tu código en Symfony

Symfony es un framework PHP que recientemente ha cumplido los 500 Millones de descargas y es conocido por su gran ecosistema de componentes. También es la base de proyectos como drupal, magento y prestashop(en sus fases iniciales al port hacia symfony) entre otros. Cuenta con una comunidad muy activa, y su creador está entre los miembros del PHP-FIG, es por ello que desde acceseo os queremos mostrar en este articulo una serie de buenas prácticas y consejos para mejorar vuestro código en Symfony.

Una de las principales características, conjuntamente con el sistema de componentes, es la calidad de su documentación, así como un amplio repertorio de test que le proporcionan una gran aceptación por parte de la comunidad y una base muy sólida para empezar cualquier proyecto sin importar su magnitud.

Vamos a citar en primer lugar algunos tips and tricks, y acto seguido, algunas buenas prácticas, extraídas directamente desde la propia sección.

Trucos y consejos para optimizar Symfony

Existen multitud de plataformas que hacen uso de las variables de entorno para almacenar los credenciales de las aplicaciones. Recientemente, symfony (en su versión 3.3) ha publicado un componente llamado Dotenv, el cual nos permite parsear archivos .env. En nuestra aplicación, podemos añadir las variables como parámetros:

// app/AppKernel.php

public function registerContainerConfiguration(LoaderInterface $loader)
{
    $loader->load($this->getRootDir().'/config/config_'.$this->getEnvironment().'.yml');

    try {
        (new Dotenv\Dotenv(__DIR__.'/../'))->load();
        $envParameters = $this->getEnvParameters();
        $loader->load(function($container) use($envParameters) {
            $container->getParameterBag()->add($envParameters);
        });
    } catch (Dotenv\Exception\InvalidPathException $e) {
        // don't do much at the moment, possibly the env variables are set differently (e.g. AWS)
    }

En su versión 3.2 de symfony, se integró el uso de la función env, encargada de obtener el valor de la variable de entorno desde la configuración en yaml con el siguiente formato:

# app/config/config.yml
doctrine:
    dbal:
    # ...
        password: "%env(DB_PASSWORD)%"

En la versión 2.6 fue añadido LockHandler, y en su versión mas reciente, la 3.3, han anunciado el componente llamado Lock component, el cual nos permite bloquear el acceso a los recursos a través de diversos métodos, tales como flock de php, PHP Semaphore extension, Redis y Memcache.

Yaml, human friendly data serialization standard, mantenido por Clark C. Evans, es un standard que tiene por objetivo la serialización de la información de forma descriptiva. En los últimos años ha ganado popularidad, debido a la facilidad de parseado frente a alternativas como XML. Herramientas como Docker, también lo usan para expresar sus archivos de configuración. Symfony cuenta con un componente llamado YAML Parser. Desde la versión 3.3, ahora se nos permite crear etiquetas personalizadas.

$yaml = "!my_tag { foo: bar }";
$config = Yaml::parse($yaml, Yaml::PARSE_CUSTOM_TAGS);

$tag = $config->getTag(); // $tag = 'my_tag'
$value = $config->getValue(); // $value = array('foo' => 'bar')

Lo podemos usar para añadir funcionalidades específicas para la configuración de nuestro bundle, por ejemplo.

Como última novedad, han incorporado la carga de archivos locales con patrones globales. Ahora podemos hacer lo siguiente:

const CONFIG_EXTS = '.{php,xml,yaml,yml}';

// ...
protected function configureContainer(ContainerBuilder $container, LoaderInterface $loader)
{
    $confDir = dirname($this->getRootDir()).'/etc';
    $loader->import($confDir.'/packages/*'.self::CONFIG_EXTS, 'glob');
    $loader->import($confDir.'/packages/'.$this->getEnvironment().'/**/*'.self::CONFIG_EXTS, 'glob');
    $loader->import($confDir.'/container'.self::CONFIG_EXTS, 'glob');
}

Existe una característica del componente Config no muy conocida, que nos permite hacer override de los archivos que hemos cargado:

# app/config/config.yml
imports:
    - { resource: 'parameters.yml' }
    - { resource: '/etc/sites/mysite.com/parameters.yml', ignore_errors: true }

De esta forma, podemos tener en el servidor de producción un archivo con los parámetros correspondientes. Sin embargo, en local, como no existe dicho archivo y le hemos indicado que no lance excepción seguirá el flujo habitual de la aplicación.

Por lo que a conexión con capa de persistencia de datos se refiere, symfony usa Doctrine, un ORM (Object Relational Mapper). Los bundles con los que viene symfony, por regla general, vienen con una gran cantidad de configuración por defecto que nosotros podemos modificar según nuestras necesidades. Por lo que respecta al naming de las tablas, resulta común que la estrategia varíe según los requisitos del proyecto. Para tal propósito, podemos forzar la estrategia de naming con una configuración, para evitar la redundancia de escribir el parámetro en cada valor de la entidad en caso de pretender modificar el comportamiento habitual:

    #app/config/config.yml
        config:
            doctrine:
                dbal:
                # ...
                orm:
                    # ...
                    entity_managers:
                        default:
                            naming_strategy: doctrine.orm.naming_strategy.underscore

También podremos hacer nuestras propias estrategias de naming haciendo uso de la clase: Doctrine\ORM\Mapping\NamingStrategy según indican en su documentación.

En lo referente a su motor de plantillas, twig, hay interesantes mejoras que podemos utilizar.

Disponemos de la posibilidad de evaluar si existe un bloque, a través de la siguiente sintaxis:

{%if 'block_name' is block%}
   Esto es un bloque
{% endif %}

Cuando creamos nuestros propios filtros, y necesitamos proporcionarle un número arbitrario de parámetros de entrada, podemos usar la opción is_variadic

$filter = new Twig_Filter('thumbnail', function ($file, array $options = array()) {
// ...
}, array('is_variadic' => true));

Para finalizar, podemos usar lo que llaman, named arguments. Nos confían una mayor legibilidad en el código:

{{ data|convert_encoding(from='iso-2022-jp', to='UTF-8') }}

En cuanto a los logs, symfony cuenta con su propio componente, que nos ayuda identificar los estados por los cuales pasa nuestra aplicación. Es un gran desconocido,
pero cuenta con muchas funcionalidades que nos pueden ayudar identificar problemáticas futuras.

Podemos crear canales personalizados, de forma muy sencilla:

    # app/config/config.yml
    monolog:
        channels: ['foo', 'bar']

Ahora symfony ya permite pasar el canal de log a través de un argumento:

#app/config/config.yml
services:
    some_service:
        class: Namespace\Some\Service
        arguments: ["@monolog.logger.alert"]

Podemos crear formatters personalizados desde la configuración, sin necesidad de implementar una clase de formateo:

#config.yml
services:
    app.log.formatter:
        class: Monolog\Formatter\LineFormatter
        public: false
        arguments:
            - '%%level_name%% [%%datetime%%] [%%channel%%] %%message%%\n' #mensaje a escribir en el archivo de log
            - 'H:i:s' #formato
            - false #ignorar \n en los logs

Configurando donde queremos usar dicho formato:

#app/config/config.yml
monolog:
    handlers:
        main:
            formatter: app.log.formatter

Gestión de correos en entorno de desarrollo

Cuando se trata de correos, son una parte básica de cualquier aplicación, sobretodo si la aplicación tiene usuarios y deseamos verificar el correo de registro, por ejemplo. En entornos de desarrollo, es importante que los emails, sigan el flujo habitual. Así como la posibilidad de poder visualizarlos. Nosotros lidiamos con este problema con una herramienta llamada Mailhog, el cual cuenta con repositorio en github. Podemos ir a la sección releases de la documentación para encontrar la última versión compilada de la misma. Está dotado con un servidor de stmp y un panel web para visualizar todos los correos salientes de la aplicación. Es una gran opción que no necesita de instalar daemons en el caso de linux, tan sólo ejecución en el momento en que necesitemos de la funcionalidad.

En symfony tenemos una guía para organizar los entornos con diferentes archivos de configuración de manera jerárquica en función de los directorios como se muestra en la documentación. Esto nos puede servir para cargar diferentes configuraciones, como por ejemplo en este caso, que nos interesa cambiar los datos del servidor smtp para poder evaluar la aplicación al completo.

Buenas prácticas en Symfony

Por último vamos a citar algunas de las buenas prácticas a modo de resumen, que nos proporcionan desde la sección de best practices.

Configuración:

  • Define toda la configuración de la infraestructura en el archivo parameters.
  • Define todos los parámetros en parameters.yml.dist. Ten en cuenta que composer evalua este archivo para regenerar el parameters.yml.
  • Define la configuración de la aplicación en config.yml.
  • Usa constantes para definir la configuración.
  • El naming de los parámetros debería ser lo mas corto posible.

Organizar la lógica de negocio:

  • Usa nombres lo mas cortos posibles para los servicios del bundle.
  • Escribe la configuración de los servicios en archivos YAML
  • Como hemos comentado anteriormente, mueve los datos sensibles fuera de la aplicación con variables de entorno.

Controladores:

  • Los controladores deben extender siempre del controlador base de FrameworkBundle.
  • No uses la anotación @Template.
  • Usa ParamConverters para obtener la entidad en el controlador.
  • Por norma general, como indican en la documentación, los controladores deberían seguir la regla 5-10-20. 5 líneas variables o menos, 10 acciones o menos y 20 líneas o menos

Como conclusión final, symfony tiene una curva de aprendizaje en sus inicios algo elevada, pero cuando se domina el framework en sus aspectos más básicos nos puede ayudar con un ágil desarrollo con poco esfuerzo y una gran calidad del código, siguiendo unas normas básicas de buenas prácticas.

Cómo usar composer y aumentar la productividad de tu equipo

Composer se ha convertido en una herramienta fundamental del ecosistema PHP. Se trata de un gestor de dependencias que nos facilita la siempre tediosa tarea de lidiar con las dependencias de nuestro proyecto. Los proyectos crecen y tienden a acumular grandes cantidades de dependencias y no siempre es fácil tenerlas actualizadas a la última versión, decidir qué versión instalar o instalar las dependencias de nuestras dependencias para que nada falle en esa cadena de confianza que se genera entre proyectos y librerías.

 

El uso de composer orbita alrededor de los ficheros composer.json, composer.lock y el directorio vendor, de manera que en nuestro proyecto únicamente tendremos que incluir el autoloader para cargar todas las dependencias. Una de las cosas que ha facilitado tanto la existencia como la rápida adopción de composer es la creación de estándares de autoload por parte del PHP-FIG (PSR-0 y más tarde PSR-4).

Vamos a ver paso a paso cómo instalar composer, establecer las dependencias de nuestro proyecto y cargarlas con una sola línea. A lo largo del artículo describiremos y utilizaremos algunos comandos, los relativos a composer son independientes del sistema operativo pero la instalación está basada en la máquina de vagrant ubuntu/xenial64 siguiendo los pasos del artículo Crea y gestiona tus entornos de desarrollo con Vagrant del que hablamos hace algún tiempo.

Instalar composer paso a paso

Para instalar la herramienta en Ubuntu tendremos que ejecutar únicamente un comando. Hecho esto vamos a hacer disponible el binario de manera global. Desde el terminal ejecutamos las siguientes instrucciones.

curl -s https://getcomposer.org/installer | php
sudo mv composer.phar /usr/local/bin/composer

Una vez ejecutado debemos comprobar que el paquete está listo para su uso, podemos ejecutar por ejemplo composer –version y la salida nos mostrará algo similar a lo siguiente

Composer version 1.3.2 2017-01-27 17:23:41

¿Cómo actualizar de composer?

Composer es una herramienta que pese a haber alcanzado la versión 1.0 en 2016 sigue en desarrollo y por tanto deberíamos actualizar con cierta frecuencia. Esto se consigue lanzando el comando composer self-update.

Empezando a usar composer

Para empezar a usar composer en un proyecto necesitaremos generar un fichero composer.json en el que especificaremos las dependencias del proyecto. Dentro del json usaremos la clave require para especificar nuestras dependencias que composer descargará usando packagist.

Packagist es el repositorio central en el que encontraremos el catálogo de paquetes disponibles para composer identificados usando cadenas del tipo vendor/package, por ejemplo la librería monolog la encontraremos referenciada como monolog/monolog. Si accedemos a la página correspondiente de la librería en packagist podremos ver información adicional como el comando para instalar el paquete usando composer, la url del repositorio en github, estadísticas del proyecto como instalaciones o paquetes que dependen a su vez de éste, sus requerimientos, versiones, etc.

El contenido mínimo del fichero composer.json con el que podríamos definir monolog como dependencia de nuestro proyecto para instalarla con composer sería el siguiente:

{
    "require": {
        "monolog/monolog": "1.*"
    }
}

Con este fichero en la carpeta podemos lanzar el comando composer install que nos mostrará paso a paso qué va sucediendo durante la instalación. En nuestro caso se instalará el paquete psr/log como dependencia de monolog y posteriormente el propio monolog/monolog que es nuestra dependencia.
Tras los paquetes instalados aparece una serie de paquetes sugeridos. Desde la página de packagist también podemos consultar estas dependencias sugeridas que normalmente nos permiten ampliar la funcionalidad del paquete instalado. Por ejemplo entre las sugerencias de monolog aparece mongodb/mongodb que nos permitiría enviar nuestros logs a un servidor mongodb.

Al final de la salida se muestran dos líneas más referentes a los últimos pasos que realiza composer al instalar:

Writing lock file
Generating autoload files

Con estas dos líneas nos especifica que se ha creado el fichero composer.lock en base a la instalación y el autoload del que hablabamos más arriba cuando mencionabamos PSR-4 como uno de los pilares fundamentales de composer que permite un uso tan cómodo de la herramienta.

Cuando ejecutamos composer install la aplicación trata de leer el fichero composer.lock en el que se especifica una serie de información, probablemente la más relevante sean las versiones exactas a instalar. Si no existe el fichero se resuelven las dependencias usando la información de composer.json y se genera el fichero composer.lock en base a la instalación realizada. En nuestro caso aparecerán entradas referentes a monolog/monolog 1.22.0 y a psr/log 1.0.2.

El fichero composer.lock nos va a permitir reinstalar exactamente las mismas dependencias una y otra vez. Pongamos por ejemplo que en el repositorio de nuestro proyecto incluimos el fichero composer.json, en unos meses se une un compañero al equipo e instala el proyecto desde cero en su máquina para empezar a desarrollar, si hay una versión más reciente que cumpla con la expresión 1.* será esa la que se le descargue, por ejemplo la 1.5.1 pudiendo ser incompatible con nuestro proyecto. En su caso se generaría un fichero composer.lock con la versión instalada que sería distinto a la nuestra.
Por el contrario si le facilitamos ambos ficheros al ejecutar composer install su proyecto contará exactamente con las mismas dependencias que el nuestro o que el servidor de producción.

Hasta aquí hemos realizado manualmente la edición de composer.json para especificar nuestras dependencias, hemos creado el fichero y hemos añadido las líneas necesarias pero podemos delegar estas acciones mecánicas en el propio composer.

Para generar el fichero composer.json usaremos el comando composer init que nos guiará a través de la creación del fichero, en nuestro caso lo único que haremos es darle nombre a nuestro proyecto como acceseo/composer-test y obviar el resto de pasos como aparece en nuestro terminal:

ubuntu@ubuntu-xenial:~$ composer init

Welcome to the Composer config generator
This command will guide you through creating your composer.json config.

Package name (<vendor>/<name>) [ubuntu/ubuntu]: acceseo/composer-test
Description []:
Author [, n to skip]: n
Minimum Stability []:
Package Type (e.g. library, project, metapackage, composer-plugin) []:
License []:

Define your dependencies.

Would you like to define your dependencies (require) interactively [yes]? no
Would you like to define your dev dependencies (require-dev) interactively [yes]? no

{
"name": "acceseo/composer-test",
"require": {}
}

Do you confirm generation [yes]? yes

Una vez confirmada la generación del fichero nos habrá generado el siguiente composer.json mínimo con el nombre del proyecto y sin dependencias:

{
"name": "acceseo/composer-test",
"require": {}
}

Para llegar al punto que hemos alcanzado antes necesitamos establecer como dependencia de nuestro proyecto la librería monolog, y descargar nuestras dependencias. Esto lo haríamos con el comando composer require de la siguiente manera: composer require monolog/monolog:1.*

La aplicación nos mostrará una salida similar a la de composer install especificando qué paquetes y versiones se han instalado, las sugerencias, generación del lock, etc como ya hemos tratado, pero además nos especificará que se está actualizando el fichero composer.json.

Utilizando nuestras dependencias

Hasta ahora hemos hablado de composer como tal, pero la finalidad de gestionar nuestras dependencias con composer es por un lado ahorrarnos gestionar manualmente el árbol de dependencias y por otro facilitar el uso de las dependencias en nuestro código olvidándonos de decenas de require necesarios en cada fichero.

Una vez instaladas las dependencias se ha generado la carpeta vendors de la que he no hemos hablado hasta ahora, esa carpeta es la que almacena los paquetes descargados y los ficheros necesarios para el autoload.

Para empezar a usar monolog únicamente tendríamos que importar en nuestro código el fichero /vendors/autoload.php, vamos a usar el ejemplo que hay disponible en el fichero readme.md de monolog para ver cómo haríamos esto. En el mismo directorio que tenemos el fichero composer.json creamos el fichero composer-test.php con el siguiente contenido.

En este fichero con una sola línea podemos cargar todas las dependencias y utilizarlas sin realizar ningún paso extra más.

<?php
require __DIR__.'/vendor/autoload.php';

use Monolog\Logger;
use Monolog\Handler\StreamHandler;

// create a log channel
$log = new Logger('name');
$log->pushHandler(new StreamHandler(__DIR__.'/monolog.log', Logger::WARNING));

// add records to the log
$log->warning('Foo');
$log->error('Bar');

Al ejecutar el script se nos generará el fichero monolog.log correspondiente sin errores de clases o funciones no definidas.

Aunque hemos tratado un ejemplo sencillo a lo largo del artículo composer se utiliza extensivamente en los proyectos PHP más importantes del mundo, ya que nos permite hacer muchas más cosas que quedan fuera del alcance de la introducción que hemos llevado a cabo.

¿Tienes alguna incidencia?

Cuéntanos qué ocurre
y nos pondremos con ello lo antes posible.

Este sitio está protegido por reCAPTCHA, y la Política de privacidad y Términos de servicio de Google.
Sucríbete a
nuestra newsletter

para estar al día en el mundo online

¡Cuéntanos tus ideas!
+34 96 653 19 14
+info@acceseo.com
He leído y acepto la política de privacidad

Este sitio está protegido por reCAPTCHA, y la Política de privacidad y Términos de servicio de Google.