Principios en el diseño del software: KISS, DRY y SOLID

---

Principios del diseño de software

---

Los principios de diseño de software son como una guia que nos ayuda dando pautas para el desarrollo de estas aplicaciones.

A diferencia de los patrones de diseños, los principios no proveen con pasos, situaciones donde aplicarlos, es un poco mas generico.

Alguno de estos principios son siglas en ingles, obviamente, y son autoexplicativos. Alguno de ellos son kiss dry yagni soc solid.

---

Kiss (Keep it simple, stupid)

---

"Mantenelo simple corazón", esa es mi traducción por lo del beso y el corazón, aun que no haga falta ser bilingue para saber a que ser refiere la ultima S.

Otra variante podría ser invertir la palabras finales resultando ser "Mantenelo estupidamente simple" (keep it stupid simple) Este principio nos dice que tanto la documentación, el diseño, el código debe ser tan simple como sea posible, como si se tratará de leer una guia a prueba de tontos. Evitando la sobre-complicacíon cuando ésta sea innecesaria.

Luego de algún tiempo programando tendemos a aplicar nuestra experiencia resolviendo cuestiones no solicitadas, por ejemplo crear un formulario para visualizar datos existentes en una base de datos y queremos realizar una progresive web app con soporte de multilenguaje y personalización de estilos en tiempo de ejecución, con un backend con una arquitectura de microservicios, con servidores de descubrimiento, servidor de para balancear la carga, otro para estadisticas y métricas, montado sobre contenedores... y en fin muchas herramientas cuando existen alternativas mas sencillas.

Este es el principio más dificil de seguir en terminos de escalabildad. Por que nuestra solución sencilla es ideada para unos pocos usuarios, pero nuestro cliente confia que pronto tendrá cientos o miles de usuarios y pronto serán usuarios insatisfechos quejandose de lo lenta que resulta la herramienta que creamos manteniendo las cosas lo mas simple posible.

Será nuestra visión la que determine hasta donde se pueden mantener las cosas simples

---

DRY (Don’t Repeat Yourself))

---

O en español SECO (Siempre evita codigo oscuro), la máxima de este principio es evitar el uso del CTRL+C + CTRL+V, repitiendo funcionalidades entre distintas clases o métodos, ya que esto haria que el proyecto en general tenga mas lineas de codigo, sea dificil de entender y de mantener.

---

SOLID

---

• Single Responsibility
• Open/Closed
• Liskov Sustitution
• Interface segregation
• Dependency inversion

A este principio le pusieron unas solidas ganas, introducido por Robert C. Martin y sus siglas agrupan otros 5 principios de la programacion orientada a objetos.

Single Responsibility, el principio de responsabilidad unica nos dice que una pieza de codigo tiene que tener una unica responsabilidad. Ese metodo getUsuario(id) deberia obtener un usuario por su id, o almenos eso se espera de el, pero si al inspeccionar de cerca el metodo nos damos cuenta que obtiene el usuario, actualiza la fecha de ultima actividad y le envia un mail con las novedades claramente estaria violando este principio, haciendo a la aplicacion dificil de entender por su impredictibilidad. Lo mas razonable sea contar con otros metodos como actulizarUltimaActividad(usuario) y informarNovedades(usuario) que se encarguen de una sola cosa.

Open/Closed, el principio de Abierto/Cerrado nos dice que una pieza de codigo tiene que estar abierta a extensiones pero cerrada al modificaciones. Este principio esta destinado a clases que puedan ser heredadas, donde sus clases hijas puedan extender su funcionalidad, pero sin cambiar lo que existia.

Liskov sustitution, el principio de sustition de Liskov nos dice que cada clase puede ser sustituida en lugar de su padre, sin la necesidad de conocer cual se esta implementando. Esto pasa generalmente al usar colecciones, definimos un objeto tipo List aunque la implementacion podria ser ArrayList, LinkedList.

Interface segregation, el principio de segregacion de interfaces dice que el codigo cliente no debiera estar atado a funcionalidades innecesarias al implementar una interfaz, esta no debe segregar metodos de proposito general. Una solucion a este problema es romper la interfaz en varias interfaces mas pequeñas y mas especificas. Otra solucion es el patron adapter, que permite heredar de una clase que implementa una interfaz extensa

Dependency inversion, el pricipio de inversion de dependencia nos dice que se debe depender de abstracciones y no de implementaciones, desacoplando asi los modulos de alto nivel de los modulos de bajo nivel. La Inyección de Dependencias es uno de los métodos que siguen este principio.

---

YAGNI (You aren’t gonna need it)

---

El principio de lo no vas a necesitar tiene su origen en la programación extrema, y propone evitar aquellas piezas de codigo que se desarrollan por si acaso, generalmente sobrevalidaciones, sin estar seguros de necesitarlo y nos dice no, no lo vas a necesitar.

---

SOC (Separation of concern)

---

El principio de separacion de conceptos nos habla de los diferentes aspectos de la funcionalidad de nuestra aplicación. Por ejemplo la capa de negocio, la capa de datos etc. Un buen ejemplo de separación es el patrón MVC(Modelo, vista, controlador).

---

The Boy Scout rule

---

Este no es un acronimo, si lo fuese seria TBSR, pero basicamente nos propone aplicar la regla del boyscout, dejar el campo en mejores condiciones de lo que lo encontamos. Como desarrolladores siempre se puede hacer un pequeño cambio para mejorar la calidad de nuestro codigo, algo que veamos al pasar y que estamos seguros que podemos mejorar, siempre y cuando este no sea un cambio.

---

La Ley de Demeter

---

Según este principio, una pieza de codigo solo debe tener conocimiento limitado de otras piezas de codigo, y solo conocer aquellas que con las que está relacionadas. Es como aquella frase que dice nunca hables con extraños, podriamos agregar con amigos cerrcanos.

---

El principio de Hollywood

---

Este principio está basado en la típica respuesta que se les da a los actores que hacen una audicion para una película: "No nos llame, nosotros le llamaremos". Un ejemplo del principio de Hollywood es la inversión de control (IoC), que hace que una clase obtenga las referencias a objetos que necesita para poder funcionar, a través de una entidad externa, como el contenedor de Spring.

---

Principios ACID

---

El acrónimo ACID en el mundo de base de datos se refiere a un estándar de propiedades que garantizan que las transacciones de la base de datos se procesen de manera confiable.

Está especialmente enfocado en cómo una DB se recupera ante cualquier falla que pueda ocurrir al procesar una transacción.

Puntualmente este acrónimo es:

• Atomicity
  Si cuando una operación consiste en una serie de pasos, bien todos ellos se ejecutan o bien ninguno, es decir, las transacciones son completas. Lo que hace que la serie de operaciones sea "indivisible". Una garantía de atomicidad evita que las actualizaciones de la base de datos se produzcan solo parcialmente
• Consistency
  La coherencia es un término muy general, que exige que los datos deben cumplir con todas las reglas de validación. Todas las reglas de validación deben verificarse para garantizar la coherencia.
• Isolation
  Esta propiedad asegura que una operación no puede afectar a otras.
• Durability
  Esta propiedad asegura que una vez realizada la operación, esta persistirá y no se podrá deshacer aunque falle el sistema y que de esta forma los datos sobrevivan de alguna manera.

Cumpliendo estos 4 requisitos un sistema gestor de bases de datos puede ser considerado ACID Compliant.

Que una DB cumpla con las propiedades ACID, es un factor que ayuda a determinar cual opción tomar.

Ejemplos de bases de datos ACID-compliant:

• Postgres
• SQLite
• MySQL with InnoDB
• Oracle Database
• MariaDB with XtraDB Engine
• SQL Server Express

---

Principios Solid

---

SOLID es el acrónimo en el mundo de desarrollo de software, no sólo se limita a java sino a todos los lenguajes, que Michael Feathers creó, basado el paper “Design Principles and Design Patterns” sobre los principios de la programación orientada a objetos que Robert C. Martin(uncle bob) había recopilado en el año 2000.

Cada letra en inglés la palabra SOLID representa:

• S – Single Responsibility Principle (SRP)
• O – Open/Closed Principle (OCP)
• L – Liskov Substitution Principle (LSP)
• I – Interface Segregation Principle (ISP)
• D – Dependency Inversion Principle (DIP)

Recordar:

Cohesión es el grado en que el contenido de un módulo está relacionado entre sí.
Acoplamiento es el grado de interdependencia que tienen dos módulos de software entre sí.

---

SRP: Principio de responsabilidad única:

---

A class should have only one reason to change.

Robert C. Martin

Traducido al español sería “una clase debería tener una, y solo una, razón para cambiar”. Esto es precisamente, “razón para cambiar”, lo que Robert Martin identifica como “responsabilidad”. El propio Bob te lo resume asi nomás: “Gather together the things that change for the same reasons. Separate those things that change for different reasons”, es decir: “Reunir las cosas que cambian por las mismas razones. Separa aquellas que cambian por razones diferentes”.

OCP: Principio de abierto/cerrado:

---

Software entities (classes, modules, functions, etc.) should be open for extension but closed for modification.

Bertrand Meyer

El segundo principio de SOLID lo formuló Bertrand Meyer en 1988 en su libro “Object Oriented Software Construction” y dice: “Deberías ser capaz de extender el comportamiento de una clase, sin modificarla”. En otras palabras: las clases que usas deberían estar abiertas para poder extenderse y cerradas para modificarse.

Imaginemos un pintor que pinta figuras, como el siguiente ejemplo:

MAL

 class Figura {}
 
 class Cuadrado extends Figura {}
 
 class Circulo extends Figura {}

 class Pintor {
  void pinta (Collection<Figura> figuras) {
   for (Figura figura: figuras) {
    if (figura instanceof Cuadrado) {
     pinta((Cuadrado) figura);
    } else if (figura instanceof Circulo) {
     pinta((Circulo) figura);
    }
   }
  }

  void pinta (Cuadrado cuadrado) {
   // ...
  }

  void pinta (Circulo circulo) {
   // ...
  }
 }

El problema con el ejemplo anterior es que cuando necesitemos agregar nuevas figuras, el pintor debe modificarse violando el principio de abierto/cerrado. Una solución a este problema que permita extender pero se cierre a modificaciones es el siguiente:

OK

 interface Figura {
  void pinta();
 }

 class Cuadrado implements Figura {
  @Override
  public void pinta() {
   // ...
  }
 }
 class Circulo implements Figura {
  @Override
  public void pinta() {
   // ...
  }
 }

 class Pintor {
  void pinta (Collection<Figura> figuras) {
   for (Figura figura: figuras) {
    figura.pinta();
   }
  }
 }

---

LSP: Principio de substitución de Liskov:

---

T obj = new T();
 T obj = new S();

Subtype Requirement: Let φ(x) be a property provable about objects x of type T. Then φ(y) should be true for objects y of type S where S is a subtype of T.

Barbara Liskov

En español y dice que “Sea φ (x) una propiedad comprobable sobre objetos x de tipo T, Entonces φ (y) debería ser verdadero para los objetos Y de tipo S donde S es un subtipo de T”.
Dicho de otra manera: "las clases derivadas deben poder sustituirse por sus clases base".
Esto significa que los objetos deben poder ser reemplazados por instancias de sus subtipos sin alterar el correcto funcionamiento del sistema o lo que es lo mismo: si en un programa utilizamos cierta clase, deberíamos poder usar cualquiera de sus subclases sin interferir en la funcionalidad del programa.
Según el propio Robert Martin incumplir el principio de substitución de Liskov implica violar a su vez también el principio de Abierto-Cerrado.

Dado los siguientes arreglos de objetos:

 Integer[] array;
 Object[] arrayObjects;

¿Hay alguna relación de subtipo entre ellos?

Integer[] array = { 1,2,3 };
 Object[] arrayObjects = array;

Se puede decir que Integer[] es sub-tipo de Object[] ¿Pero es seguro?

 Integer[] array = { 1,2,3 };
 Object[] arrayObjects = array;
 arrayObjects[0] = "Hola";

Si intentamos ejeutar el siguiente código obtendremos la siguiente salida:

Exception in thread "main" java.lang.ArrayStoreException:
java.lang.String
at proves.Main.main(Main.java:12)

En algún momento de la historia existía solo java.util.Date... y llegó java.sql.Timestamp a hacerle compañía que es un Date + nanosegundos, su definición es:

public class Timestamp extends java.util.Date

¿Problemas? No...ninguno, ¿porqué preguntas?
Veamos lo siguiente:

Date date = new Date();
 Timestamp ts = new Timestamp(date.getTime());
 System.out.println(date.equals(ts));
 System.out.println(ts.equals(date));

Recordemos el javadoc para el metodo equals de object: Indicates whether some other object is "equal to" this one. The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

Según el cual, el método implica debe ser simétrico: si x e y son iguales si y solo si y y x también lo son.

Pero...

Date date = new Date();
 Timestamp ts = new Timestamp(date.getTime());
 System.out.println(date.equals(ts));
 System.out.println(ts.equals(date));

Ejecutar el siguiente código resulta en un true seguido de un false

---

ISP: Principio de segregación:

---

Clients should not be forced to depend on methods they do not use.

Robert C. Martin

El cuarto principio definido por el propio Robert Martin dice que "Los clientes no deben ser forzados a depender de métodos que no usen."

En otras palabras es preferible contar con muchas interfaces que definan pocos métodos que tener una interface maestra que haga todo.

Dada la siguiente clase encargada de la comunicación, que decribe 2 métodos para enviar los mismo a través de un String o un Object:

public class Comunicador {
  public void enviaMensaje (String mensaje) {...}
  public void enviaMensaje (Object object) {...}
 }

Se nos pide agregar una encriptación para la misma, por lo tanto agregamos un método mas que se corresponde un nuevo Enum:

enum Encriptacion {
  NINGUNA, ENCRIPTACION_DEBIL, ENCRIPTACION_FUERTE
 }

 public class Comunicador {
  public void setEncriptacion (Encriptacion restriccion) {}
  public void enviaMensaje (String mensaje) {}
  public void enviaMensaje (Object object) {}
 }

Decidimos abstraer la clase a una interface para que distintos clientes puedan hacer uso de ella:

public interface Comunicador {
  static enum Encriptacion {
   NINGUNA, ENCRIPTACION_DEBIL, ENCRIPTACION_FUERTE
  }
  public void setEncriptacion (Encriptacion restriccion);
  public void enviaMensaje (String mensaje);
  public void enviaMensaje (Object object);
 }

Aun que estaríamos forzando a posibles clientes de implementar un nivel de encriptación que nunca necesiten:

public class ComunicadorImpl implements Comunicador {
  ...
 }

La solución es segregar en una interface el envio de los mensajes y en otra la encriptación:

public interface Comunicador {
  public void enviaMensaje (String mensaje);
  public void enviaMensaje (Object object);
 }

public interface Encriptable {
  static enum Encriptacion {
   NINGUNA, ENCRIPTACION_DEBIL, ENCRIPTACION_FUERTE
  }
  public void setEncriptacion (Encriptacion restriccion);
 }

public class ComunicadorImpl implements Comunicador, Encriptable {
  public void setEncriptacion (Encriptacion restriccion) {}
  public void enviaMensaje (String mensaje) {}
  public void enviaMensaje (Object object) {}
 }

---

DIP: Principio de inversión de dependencia:

---

A. High-level modules should not depend on lowlevel modules. Both should depend on abstractions.

B. Abstractions should not depend upon details. Details should depend upon abstractions.

Robert C. Martin

Depende de abstracciones, no de clases concretas es el último principio de la lista.

Así, Robert Martin recomendaría en español:

• A - Los módulos de alto nivel no deberían depender de módulos de bajo nivel. Ambos deberían depender de abstracciones.
• B - Las abstracciones no deberían depender de los detalles. Los detalles deberían depender de las abstracciones.