miércoles, 28 de julio de 2010

Principios de Diseo POO

Principios de Diseño Orientado a Objetos

  1. SRP - Single Responsibility Principle (Principio de Responsabilidad Única)
  2. OCP - Open/Closed Principle (Principio Abierto / Cerrado)
  3. LSP - Liskov Substitution Principle (Principio de Sustitución de Liskov)
  4. DIP - Dependency Inversion Principle (Principio de Inversión de Dependencias)
  5. ISP - Interface Segregation Principle (Principio de Segregación de Interfaces)
Algunos apuntes encontrados en Wikipedia (inglés)
http://en.wikipedia.org/wiki/Single_responsibility_principle
http://en.wikipedia.org/wiki/Open/closed_principle
http://en.wikipedia.org/wiki/Liskov_substitution_principle

1. SRP - Single Responsibility Principle (Principio de Responsabilidad Única)


Enunciado formal: "Una clase debería tener solo una razón para cambiar"



Vamos a tomar un pequeño conjunto de clases para nuestro ejemplo, empezaremos con una y veremos los males que nos aquejan.


Nuestra clase Cliente es verdaderamente potente, sabe hacer tantas cosas!!!!, con solo tener una instancia de ella puedo resolver una gran cantidad de problemas.

Veamos que cosas sabe hacer:

1 - Persistirse
2 - Eliminarse
3 - Crear una salida HTML que muestre sus atributos
4 - Hacer reportes referidos a ella misma
5 - Calcular su edad en el mercado

Todo parece muy cómodo, pero analicemos como se comporta esta clase frente al cambio, su capacidad de adaptación.

  • Cambio mi motor de base de datos, de XXSql paso a NNSql.
    Debo cambiar mi clase Cliente.
  • Cambio la forma de crear la salida HTML
    Debo cambiar mi clase Cliente.
  • Agrego un reporte o modifico uno existente
    Debo cambiar mi clase Cliente.
  • Cambio la política para calcular la presencia en el mercado
    Debo cambiar mi clase Cliente.
Esto evidentemente es malo, existen distintos eventos cuya consecuencia es un cambio en la clase Cliente.
Si vemos un poco mas allá de nuestras narices notaremos que además esto implicará cambios en aquellos artefactos que recurren a la clase Cliente para resolver alguna colaboración.
Bueno el problema es que nuestra clase Cliente tiene muchas responsabilidades, incluso algunas que exceden claramente sus responsabilidades naturales, me refiero a las responsabilidades de Cliente en su contexto de negocio.
Se dice entonces que Cliente es poco cohesiva, sabe hacer más de lo que necesita, maneja temas en los cuales no es experto.

Posiblemente esa falta de cohesión nos lleve a otro problema, para mi es una regla que se cumple con rigor matemático,acoplamiento.

Un cambio en Cliente requerirá cambios en quienes consumen la clase Cliente, los cambios se propagan en nuestro diseño, el impacto de un cambio es alto, afecta a varios artefactos.

Pero, volvamos a nuestro principio de OOD, Object Oriented Design, Responsabilidad única.

Este principio ataca el problema descripto, su enunciado dice:

No debe existir más de una razón para cambiar una clase.

En nuestro escenario Cliente debería ser algo parecido a la siguiente figura:
Que sucede entonces con aquellos metodos que ya no existen en Cliente?, bueno será nuestro trabajo buscar quienes tienen la responsabilidad de resolver esas cuestiones. Lo importante aquí es que Cliente atienda sus responsabilidades directas, aquellas en las que es experto.

También es destacable que deberá relacionarse, u otras clases deberán relacionarse con ella, para resolver las cuestiones en las que Cliente no es el experto, pero requieren de su colaboración.

Eso nos lleva a otros principios que ayudarán a manejar las colaboraciones en forma desacoplada.



2. OCP - Open/Closed Principle (Principio Abierto / Cerrado)



Enunciado formal: "Entidades de Software (clases, módulos, funciones, etc) deberían ser abiertas para la extensión y cerradas para la modificación"


Traducido sería: el diseño que incluye nuestra clase, una vez concluida su implementación, no debería cambiar, porque si lo hace, podría generar un efecto en cadena sobre todas las clases que la usan. Pero se puede extender al permitir seguir agregando clases clientes con solo implementar la interfaz y sin tener que cambiar el código de implementación de la clase Impresora.


Abierto / cerrado 

Volvamos ahora a nuestra nueva clase Cliente, en el punto anterior mejoramos su cohesión eliminando algunos métodos, todos sabemos que alguien deberá encargarse entonces de asumir la responsabilidad de implementar esa funcionalidad.

Una posible solución para lo relacionado con la persistencia podría ser la siguiente:

Muy bien otra vez contamos con unas clases muy bonitas, las responsabilidades ahora parecen estar asignadas correctamente, y de hecho lo están.


Propongamos un cambio en el requerimiento y veamos.

Nuestra clase ClienteDB recurre a un susbsistemas de APIs específicas de XXSql. Ahora nos piden que debemos armar una implementación para que la base de datos sea ZZSql.


Nuevamente un cambio tiene impacto directo un cambio en el sistema de base de datos puede requerir un cambio en Ventas. Por caracter transitivo ventas ha quedado acoplado la API de XXSql.

Problema planteado, que nos dice el principio Abierto/Cerrado?
Los artefactos software deben ser abiertos para su extensión, pero cerrados ante una modificación.

En resumidas cuentas lo que quiere decir esto es que un cambio en el entorno de un artefacto no debería implicar un cambio en el artefacto. Esto no solo es válido para clases, se aplica también a métodos y cualquier otro artefacto software.

La aplicación del principio a nuestro problema podría ser agregar una interface o una clase abstracta que sea bien conocida por Ventas, ClienteDB debería implementar la interface o heredar de la clase abstracta.

















En el diagrama se puede apreciar la implementación para una cuestión más terrenal, mockobjects y test unitarios.


3. LSP - Liskov Substitution Principle (Principio de Sustitución de Liskov)



Enunciado formal: "Subtipos deben ser sustituibles por sus clases bases"





Vamos a aprovechar la capacidad de extensión que nos brindan los lenguajes OO, estamos frente a nuestra clase Cliente, con algunos cambios ya que los requerimientos del sistema han cambiado con el transcurso del tiempo y ahora un nuevo requerimiento nos exige considerar Clientes presenciales y Clientes virtuales.
Hacemos OOP, Object Oriented Poragramming, contamos con los beneficios de la herencia, heredemos de Cliente.
La funcionalidad nueva esta relacionada con la obtención de la autorización de una transacción comercial. 

























El experto en autorización requiere que el cliente se identifique, pero el ClienteVirtual implementa el metodo Identificarse() disparando una Exception. Su lógica de negocio no provee un mecanismo de identificación.
El método Obtener entonces deberá tener un tratamiento especial para ClienteVirtual.

Posiblemente el programador haga algo así:

if( typeof... )
//Tratamiento para ClienteVirtual
else
//Tratamiento para Cliente

El problema entonces es que CentroAutorización ya no puede tratar a ClienteVirtual como Cliente, debe conocer las características de la sub clase porque esta altera el comportamiento de la clase Cliente. ( Comportamiento, no implementación de comportamiento).

La solución en este caso es revisar eol diseño, posiblemente ClienteVirtual no este en la línea de herencia de Cliente, tal como pensamos en principio.

No atender estas cuestiones hace que nuestro diseño sea críptico, que los programadores no puedan confiar en la extensión de las clases y deban conocer el comportamiento de de cada una de ellas.

Bueno, para evitar esto debemos respetar el principio de sustitución. El mismo expresa:

Toda clase debe poder ser reemplazada por cualquiera de sus subclases

La aplicación de este principio garantiza de alguna manera el éxito en la aplicación de los principios de Responsabilidad única y Abierto / cerrado.

4. DIP - Dependency Inversion Principle (Principio de Inversión de Dependencias) 



Enunciado formal: "los clientes tienden a ser propietarios de las interfaces y aquellos que ofrecen los servicios las implementan" 


Inversión de dependencia



Modelamos, sea en papel, en UML, en nuestra mente, como sea, lo hacemos. Creamos artefactos, clases por lo general, y relacionamos esos artefactos unos con otros.



Cuando hacemos esto, relacionar artefactos, establecemos dependencia entre ellos. Un artefacto deberá conocer a otro. El artefacto B requiere un artefacto del tipo C y otro del tipo D.

Vamos a implementar un pequeño modulo de registro de eventos para tener un ejemplo concreto de como nos afectan las dependencias en un modelo.

Nuestro módulo de registro incluirá unas pocas clases, veamos un diagrama:


Lo primero que se aprecia es la asignación correcta de responsabilidades, hemos asimilados los principios OOD vistos hasta ahora. :)


Por supuesto siempre existe un contexto, ese contexto nos dará un marco para poder determinar problemas potenciales.
Si miramos el diagrama tenemos una violación potencial al principio Abierto / Cerrado.
Este modulo tiene como fin ser incluido en cualquier aplicación que desarrollemos y su objetivo es poder registrar información en algún dispositivo de salida.
Un ejemplo sería registrar errores en tiempo de ejecución, inicios de sesión por parte de los usuarios de un sistema, lo que creamos necesario.
Ese es mi contexto, puedo decir que mis mensajes serán muy uniformes, esos mensajes forman parte de mi dominio, son un concepto bien conocido, no existen grandes posibilidades de cambio en el corto plazo. Esto es una definición, no una estimación.
Por otra parte esa misma definición me habla de algún dispositivo de salida, allí la cosa es mas abierta, deberé de alguna manera estar preparado al cambio.
Volviendo al diagrama ahora puedo señalar algunas cuestiones:
  1. La clase LogHelper depende de Message
  2. La clase LogHelper depende de TextFile
El primer caso, teniendo en cuenta el contexto, la definición del negocio, esa dependencia no me preocupa. Alguien podría señalar que produce acoplamiento, en mi contexto no lo consideraré como tal. ( No hacer esto podría aportar complejidad innecesaria al modelo, una buena práctica es mantener la simplicidad. )

El segundo caso es más complejo, mi definición habla de algún dispositivo de salida, mi primer dispositivo es TextFile, cambiar o agregar algún otro dispositivo de salida implicará cambios profundos en LogHelper.

Este último problema va más allá del acoplamiento, nuestro modelo esta acoplado y además es rígido.

El principio de Inversión de dependencia nos ayuda a eliminar o acotar este tipo de problemas, que nos dice el principio?

Los módulos de nivel superior no deben depender de módulos de bajo nivel.
Ambos deben depender de abstracciones.
Los detalles deben depender de abstracciones y no lo contrario.
Veamos ahora algunos cambios en el diagrama que reflejen la aplicación del principio.

LogHelper ya no depende de TextFile, lo hace de OutPutProvider, la notación itálica nos indica que es una clase abstracta.
Hemos logrado que nuestro modulo de registro no sea tan rígido, será mucho más simple lograr su reutilización.

Quiero resaltar un concepto, en la definición del principio hablamos de Módulo de Nivel Superior.

Estos son menos propensos al cambio, son los que expresan nuestro negocio, representan el dominio del problema, su mención no es casual.

En cada Nivel atenderemos un Negocio determinado, aplicar Inversión de dependencia implica conocer los límites, el borde de cada nivel.

5. ISP - Interface Segregation Principle (Principio de Segregación de Interfaces)

Enunciado formal: "Clientes no deberían depender de métodos que no utilizan"



Existen situaciones en las que una misma clase será consumida por distintos clientes, agentes que solo necesitan conocer un conjunto acotado de responsabilidades de esa clase. Sin embargo esas clases siguen representando un concepto único en el modelo.

Es una situación ambigua, la clase sigue siendo cohesiva y quienes la consumen manejan un concepto acotado de la misma en el dominio.

Supongamos una clase Cliente, nuestra clase es consumida por agentes que están interesados en distintos aspectos:
Estos atributos parecen estar directamente vinculados con las responsabilidades de Cliente, no hemos violado ningún principio, nuestra clase es cohesiva.
En estos términos veamos ahora como afecta esto a los artefactos consumidores de Cliente.
  1. Despacho
    Solo necesita conocer el Domicilio
  2. BuzonEletronico
    Solo necesita cono cer la dirección electrónica.
Si vamos un poco mas allá nos damos cuenta también que estos artefactos que consumen la clase Cliente manejan conceptos que parciales respecto a la clase que consumen.
Un cambio en Cliente, implica cambios profundos nuevamente, la reutilización de Despacho y BuzonElectronico se ve seriamente limitada, y la lista continúa....
Algo entonces esta fuera de lugar, veamos que nos dice el principio de segregación de interface:
Los clientes no deben ser forzados a depender de interfaces que no utilizan.
Apliquemos el principio, creemos interfaces acotadas que serán consumidas por BuzonElectronico y por Despacho, Cliente ahora implementará esas interfaces.
Tenemos ahora un modelo mas elegante, mas cohesivo, poco acoplado.
Conclusiones:
Los principios de diseño nos permiten adelantarnos a los problemas, son conceptos que debemos manejar en forma natural, debemos integrarlos a nuestra forma de pensar al modelar o implementar aplicaciones orientadas a objeto.
La cuestión no termina aquí, es el comienzo, sobre estos principios se construyen muchos conceptos teóricos mas avanzados, se construyen patrones, etc.




la "Ley de Deméter"Habla sólo con tus amigos inmediatos. Traduciendo el enunciado formal
Un método M de un objeto O solo debería invocar métodos:
  • suyos
  • de sus parámetros
  • objetos que cree o instancie
  • objetos miembros de la clase (atributos)
Así se consigue que la dependencia de la estructura entre las clases no vaya arrastrando más de un nivel. Eso si, provoca algún nivel de indirección más.

el principio del “punto de control individual”.

 el cambio puede realizarse en un único punto del código. Nos limitamos a modificar el procedimiento:
public class StandardOutReporter {
public static void report (String msg) {
System.out.println (msg + “a” + nueva Fecha());
}
}
Matthias Felleisen llama a esto el principio del “punto de control individual”. En este caso, el mecanismo nos resulta familiar: ya que se denominó abstracción por parametrización, porque cada llamada al procedimiento:
StandardOutReporter.report (“Comenzando descarga”);
es una instanciación de la descripción genérica, con el parámetro msg ligado a un valor especial.


No hay comentarios:

Publicar un comentario

escribe tu opinion: