Páginas

lunes, 3 de mayo de 2021

Cómo conseguir una buena arquitectura y un buen diseño del software

Robert C. Martin en su libro “Clean Architecture: A Craftsman's Guide to Software Structure and Design” muestra una perspectiva muy acertada de lo que es la arquitectura y el diseño del software. En el capítulo 1 dice:

“La palabra arquitectura se usa a menudo en el contexto de algo de alto nivel que es contrapuesto a algo de bajo de nivel, mientras que diseño parece que implica decisiones de bajo nivel. Esta separación entre arquitectura y diseño no tiene sentido si se mira a lo que hace un arquitecto de software en su día a día.

Considere el arquitecto que diseño mi nueva casa. ¿Tiene la casa una arquitectura? Por supuesto que la tiene. ¿Y en qué consiste esa arquitectura? Pues contiene la forma de la casa, el aspecto exterior, la elevación del terreno y el diseño de los espacios y habitaciones. A medida que analizo los diagramas que el arquitecto me ha preparado, veo una inmensa cantidad de detalles. Veo donde se colocará cada interruptor, cada enchufe y cada punto de luz. Veo que interruptores manejan que luces. Veo dónde está colocado el horno y el tamaño y la ubicación del calentador de agua y la bomba de desagüe. Veo descripciones detalladas de cómo se construirán las paredes, los techos y los cimientos.

En resumen, veo todos los pequeños detalles que dan soporte a las decisiones de alto nivel. En definitiva los detalles y las decisiones de alto nivel son parte de un todo que es la casa que se construirá.

Lo mismo pasa con el diseño de software. Los detalles de bajo nivel y las estructuras de alto nivel son parte de un todo. Forman un tejido continuo que define la forma del sistema. No se puede tener uno sin el otro, por lo tanto no hay una clara línea que los divida. Son realmente un continuo de toma de decisiones desde el nivel de detalle más alto al más bajo.

El objetivo de la arquitectura del software no es más ni menos que minimizar los recursos humanos necesarios para construir y mantener el sistema.

La medida de la calidad de la arquitectura y el diseño del software puede ser simplemente la medida del esfuerzo requerido para cumplir con los requisitos del cliente. Si el esfuerzo es pequeño, y permanece bajo a lo largo de la vida del sistema el diseño es bueno. Si el esfuerzo crece con cada nueva versión, el diseño es malo. Es tan simple como esto.”

La forma de conseguir una buena arquitectura para un sistema software es más compleja a medida que el sistema a construir es más complejo. La complejidad no es la misma si estamos construyendo una web para la venta online de una pequeña librería que si el sistema es una app para acceder a un banco en la cual podemos hacer todo tipo de operaciones, desde transferencias de dinero, abrir una cuenta, invertir en fondos, etc . Cuanto más complejo es el sistema, más importante es que la arquitectura y el diseño sean de calidad.

Cuando se trata de sistemas complejos es difícil plantear una arquitectura idónea al comienzo de la construcción. Esto se debe a que al inicio todo son hipótesis, no hay nada construido sobre lo que probar la efectividad de las estructuras y abstracciones ideadas. Es por esto que actualmente existe una corriente dentro de los “Métodos Ágiles” que invita a crear la arquitectura poco a poco, sin empezar por establecer estructuras rígidas desde el comienzo del desarrollo. Lo importante es encontrar un equilibrio y no implantar estructuras más complejas, ni más simples de lo necesario.

Un inicio de lo que supone construir una arquitectura flexible y ajustada a las necesidades del sistema que se va a construir la aportó Peter De Grace con la Arquitectura Sashimi en 1990 en el libro “Wicked Problems, Righteous Solutions: A Catalog of Modern Software Engineering Paradigms” que se puede leer de forma gratuita registrándose en la web Internet Archive.

Para sistemas construidos con lenguajes basados en el paradigma de Orientación a Objetos, que son los que actualmente están más en boga, existen arquitecturas de referencia acuñadas por reconocidos expertos. Estas arquitecturas recomiendan estructuras genéricas altamente cohesionadas y poco acopladas que hacen uso de las herramientas suministradas por el paradigma OO, concretamente uno de los elementos más extensivamente usado son los interfaces.

Estás son:

  • Arquitectura Onion de Jeffrey Palermo. Se puede consultar en Arquitectura onion
  • Arquitectura Hexagonal de Alistar Cockburn. Se puede consultar en Arquitectura hexagonal
  • Clean Arquitecture de Robert C. Martin que está ampliamente explicada en su libro “Clean Architecture: A Craftsman's Guide to Software Structure and Design: A Craftsman's Guide to Software Structure and Design” que se puede comprar en:

sábado, 23 de enero de 2021

JavaScript: Ejemplo de prueba unitaria con Mocha y Chai

Mocha es un framework de pruebas para JavaScript. Se puede utilizar tanto cuando se ejecutan las funciones de JavaScript en Node, como si ejecutan en un browser.

Con Mocha se pueden escribir funciones que prueban las funciones de los sistemas web desarrollados. Esta práctica consigue automatizar las pruebas de manera que cada vez que se tienen repetir las pruebas sobre el código desarrollado solo es necesario "apretar un botón". Se obtienen automáticamente los resultados permitiendo saber al desarrollador si han ido bien o mal. En el caso de que haya habido resultados incorrectos de las funciones de prueba, estás indicarán exactamente en que parte del código se ha producido el resultado incorrecto y el motivo que lo ha provocado. Esta información es muy valiosa cuando estamos haciendo frente a miles o decenas de miles de líneas de código que están intimamente relacionadas. Muchas veces cambiar algo en una línea, resulta que provoca que falle algo en otra parte del código de forma inesperada. Esto es debido a el acoplamiento entre funciones, que no es deseable pero es inavitable. Las pruebas no resuelven al 100% este problema, pero ayudan mucho. Por ejemplo en las pruebas de regresión que sirven para comprobar que lo que estaba funcionado no ha dejado de funcionar cuando se modifica el código.

En este artículo se muestra un ejemplo de uso de Mocha para probar una función que obtiene usuarios desde el API Rest https://dummyapi.io/data/api . La función a probar es:

A esta función con Mocha se le va a construir una función de prueba. Esta función es:

Esta función de prueba contiene pruebas para el fichero readUser.js que se especifica con describe('readUsers: ', (). En este fichero hay una única función que es getResource y sus pruebas se especifican con describe('getResource', (). Sobre esta función se realizan 5 casos de prueba, cada uno de ellos descritos con it ('should... En should hay una autoexplicación textual del contenido de la prueba. A continuación se ejercita (ejecuta) la función y con expect y assert se comprueba el resultado de la misma. Es habitual utilizar alguna librería para mejorar la legibilidad de los expect y los assert con los frameworks de prueba. En este ejemplo se está usando Chai.

Para ejecutar la prueba se utiliza el comando:

Y el resultado de la prueba se muestra de la siguiente manera:

Conclusión

La construcción de pruebas automatizadas proporciona una red de seguridad a los sistemas. Esto se debe a que gracias a las pruebas los desarrolladores pueden modificar el código apoyandose en programas que desvelan si al cambiar alguna línea se ha arreglado algo pero se ha estropeado otra parte de forma imprevista. Así los sistemas se mantienen al día con mucho menos esfuerzo y se consigue mantenerlos firmes y robustos a lo largo del tiempo.

Agradecimientos

Este ejemplo lo he podido construir gracias a lo que he aprendido en un curso de Dimitris Loukas llamado JavaScript Testing Best Practices.

Código

El código se puede descargar en https://github.com/MarisaAfuera/exampleMochaChai


sábado, 2 de enero de 2021

JavaScript: Ejemplo de función reduce de array

La función reduce trata los elementos de un array con una función que suministra el programador, siendo su objetivo procesar dichos elementos para obtener un único valor.

Este post muestra un ejemplo codificado de tres maneras distintas con la intención de que sea comprensible para el máximo número de programadores. Las características de las tres formas son:

  • Codificado con arrow function
  • Codificado con función anónima 
  • Codificado con función clásica

El ejemplo aplica reduce sobre un array de objetos que representan comunidades autónomas con nombre(propiedad name) y población(propiedad population). Con la función reduce se suministra una función que suma las poblaciones de cada una de las comunidades autónomas para acabar obteniendo la población total. Notese que la función reduce carga en accumulator un elemento con la misma estructura que los del array que está tratando, es decir un objeto con las propiedades name y population.

Codificado con función arrow


Codificado con función anónima


Codificado con función clásica


La función reduce tiene mas posibilidades siendo posible enviar más parámetros a la función desarrollada por el programador. Para más información Función reduce

Espero que sea de ayuda. 

Ciao

JavaScript: Ejemplo de función filter de array

El método filter() se aplica sobre un array y devuelve un nuevo array que contiene los elementos que cumplan la condición establecida por el programador en la función invocada por filter.

Este post muestra un ejemplo codificado de tres maneras distintas con la intención de que sea comprensible para el máximo número de programadores. Las características de las tres formas son:

  • Codificado con arrow function
  • Codificado con función anónima 
  • Codificado con función clásica

En el ejemplo se trata un array screens que contiene objetos que representan pantallas. De cada pantalla se conoce la marca (propiedad brand), los píxeles horizontales (propiedad horizontalPixel) y los píxeles verticales (propiedad verticalPixel). La función filter procesa cada pantalla seleccionando solo aquellas que tienen más de 1200 píxeles horizontales.

Codificado con arrow function

Codificado con función anonima

Codificado con función clásica 

En este último caso parece como que decideIfBig recibe el parámetro (objeto de tipo screens) 'automágicamente'. Cuando pasamos la función a filter no indicamos que parámetros puede usar. Lo que ocurre es que filter de forma predefinida envía parámetros a la función decideIfBig, en este caso el elemento de screens que es el array que se está procesando. Para más información Función filter

Espero que esto ayude.

viernes, 1 de enero de 2021

JavaScript: Ejemplo de función map de array

La función map permite operar con los elementos de un array sin necesidad de hacer que el programador tenga que realizar operaciones de bucle for o foreach. La función map así facilita el trabajo de los programadores que no tienen que controlar las iteraciones y sus índices, que en muchos casos son el origen de errores inesperados tales como bucles que nunca acaban o tratamientos que se salen de los límites del array.

Supongamos que tenemos el siguiente array:


se requiere tratar cada elemento para añadir la propiedad priceByMeter, que se obtiene de dividir el valor de price por el de meters. Con la función map el código podría ser como sigue:


en este código se define una nueva variable a la que se le asigna el resultado de aplicar la función map al array flats. La función map aplica una función anónima que recibe el parámetro flat, este parámetro representa a cada uno de los elementos de flats que en este caso son objetos. Sobre cada uno de los 3 elementos de flats se aplica la función que devuelve un objeto nuevo robj.  En robj cargamos las propiedades del objeto de flats y añadimos la nueva propiedad priceByMeter calculada con price y meters. La función anónima devuelve el nuevo objeto, que para cada elemento de flats incorpora la nueva propiedad. El resultado es que pricebymeter es un nuevo array que contiene los siguientes elementos:


Conclusión

La función map permite hacer código que se ocupa más de decir lo que hay que hacer que de decir como se ha de hacer. Esto es el camino hacía la programación funcional que produce código más fácil de entender. Pero esto es otra historia.

Espero que este ejemplo sirva para que algún hacendoso programador pueda comprender está función no gastando mucho de su apreciado tiempo.


sábado, 28 de noviembre de 2020

JavaScript: Ejemplo de asincronía, callbacks y promises

 Un ejemplo de código asíncrono es:

este código añade al array inicial tres números, el 4, el 5 y el 6. Estos números se añaden en un orden desconocido, el motivo es que la función addToArray hace uso de la función de javascript setTimeout. Esta función ejecuta el array.push después de un tiempo. En el caso del ejemplo el tiempo es elegido al azar por Math.random(). El resultado es que los elementos 4, 5 y 6 no se conoce de antemano en que orden apareceran. A cada ejecución el orden variará: [1, 2, 3, 5, 4, 6] o [1, 2, 3, 6, 4, 5] o cualquier otra combinación.

Utilizando callbacks esto se puede conseguir que los elementos se añadan en orden creciente siendo el resultado siempre [1, 2, 3, 4, 5, 6]. Esto se consigue con:

en este caso aunque addToArray sigue añadiendo los elementos en un tiempo indeterminado, se consigue que 4, 5 y 6 se añadan en el mismo orden siempre. Aquí la llamada a añadir el siguiente número es un callback del número anterior. Esto debido al funcionamiento interno de javascript que gestiona el orden en que se ejecutan las funciones con el stack queue y el callback queue hace que hasta que no se acaba de añadir el 4, no se añada el 5 y hasta que se acaba de añadir el 5 no se añada el 6. La importancia de esta técnica es conseguir sicronía cuando se necesita. Por ejemplo no mostrar una lista desplegable, mientras no tenemos disponibles los datos.

La técnica de callback, pronto se observó que conduce a un código no "limpio" (callback hell). Para evitar esto se ha incluido en javascript un objeto llamado Promise. Este objeto gestiona la asincronía. El ejemplo con Promise queda:

El método then del objeto promise hace que no se ejecute una función hasta que no haya terminado la anterior. Importante hacer notar que la función a controlar, en este caso addToArray debe devolver un objeto Promise para poder utilizar el método then.

Espero que este sencillo ejemplo le pueda ayudar a algún abnegado desarrollador para entender como funcionan las técnicas para manejar la asincronía intrinseca de javascript. 

Queda pendiente async-await para otro post.





jueves, 15 de octubre de 2020

JavaScript: Ejemplo de Closure

Ejemplo

Definición

Se produce una Closure cuando una función es capaz de recordar y acceder a su lexical scope mientras se ejecuta fuera de él.

Explicación

En este ejemplo a la variable externa se le asigna la función inicial(). Esta función declara dentro de su scope las variables var1 y var2.
 
Cuando en la última línea de código se ejecuta externa(), realmente la función que se está ejecutando es interna() que es el retorno de ejecutar inicial() en la sentencia let externa = inicial();. Esta  función interna() al ejecutarse hace uso de variables que están definidas e inicializadas en el scope de inicial() , pero se está ejecutando desde fuera del scope de inicial(). Esto es la closure.

Conclusión

Gracias a las closures, hay variables que pueden se usadas fuera de su scope. Eso sí, protegidas y manejadas por las funciones dentro de las que están declaradas. 

Bibliografía

'You Don't Know JS: Scope & Closures' de Kyle Simpson publicado por 'Reilly Media, Inc en Marzo 2014