domingo, octubre 12, 2014

VFP: La Interfaz, las reglas de negocio y los Datos - Cómo separarlos y por qué

Por: Fernando D. Bozzo

Actualizaciones:
03/06/2015 - Agregada nueva sección de Posibles mejoras al modelo propuesto
04/06/2015 - Agregada nueva sección sobre ¿y el control de errores?

Cuando se quiere actualizar alguna propiedad de un control, como Enabled, ReadOnly, BackColor, ForeColor u otra, dependiendo del valor de uno o más controles, normalmente los programadores hacen esas actualizaciones desde los mismos controles.

Por ejemplo, si tenemos un form donde se debe activar el botón cmdImprimir solamente si se pone un código (txtCodArticulo) y un valor (txtValor), muchos harán algo como esto:


Ejemplo 1:

Form1.txtCodArt.Valid
IF NOT EMPTY(this.value) AND NOT EMPTY(thisform.txtValor.value)
  THISFORM.cmdImprimir.Enabled = .T.
ELSE
  THISFORM.cmdImprimir.Enabled = .F.
ENDIF

Form1.txtValor.Valid
IF NOT EMPTY(this.value) AND NOT EMPTY(thisform.txtCodArt.value)
  THISFORM.cmdImprimir.Enabled = .T.
ELSE
  THISFORM.cmdImprimir.Enabled = .F.
ENDIF

Form1.Activate
IF NOT EMPTY(thisform.txtCodArt.value) AND NOT EMPTY(thisform.txtValor.value)
  THISFORM.cmdImprimir.Enabled = .T.
ELSE
  THISFORM.cmdImprimir.Enabled = .F.
ENDIF



¿Qué problema hay con el código de arriba, si al final funciona?

El problema es que no importa solamente que "funcione", sino que además el código sea fácil de mantener, de modificar, de ampliar y de contemplar nuevos casos posibles, como veremos luego.

Aunque en un principio pueda parecer que lo de "copiar/pegar/adaptar" es mucho más fácil y rápido, luego, al tener que modificar todo lo "copiado/pegado/adaptado" no lo será, y cada vez será más difícil, lo que nos dejará con "Código Spaguetti", que se llama a esos bloques de código dispersos por ahí, duplicados y difíciles de mantener.



¿Y cómo lograr todo eso a la vez? ¿No será muy complicado?

Evalúenlo ustedes mismos, y comparen lo de arriba del ejemplo 1 con esto:


Ejemplo 2:

Form1.txtCodArt.Valid
THISFORM.EvaluarEstadosDeHabilitacion()

Form1.txtValor.Valid
THISFORM.EvaluarEstadosDeHabilitacion()

Form1.Activate
THISFORM.EvaluarEstadosDeHabilitacion()

Form1.EvaluarEstadosDeHabilitacion
IF NOT EMPTY(thisform.txtCodArt.value) AND NOT EMPTY(thisform.txtValor.value)
  THISFORM.cmdImprimir.Enabled = .T.
ELSE
  THISFORM.cmdImprimir.Enabled = .F.
ENDIF



Demostración rápida del coste de mantenimiento:

Si en el Ejemplo 1 hubiera que agregar una condición más para activar el botón cmdImprimir, habría que modificar los 3 métodos y además volver a copiar y adaptar el código de uno de ellos para el nuevo control que interviene en esa condición, lo que nos deja con ¡4 versiones distintas de código que hacen lo mismo!

En el Ejemplo 2, agregar esa condición implica solo 2 cambios: el primero es poner THISFORM.EvaluarEstadosDeHabilitacion() en el nuevo control, y el segundo es agregar la condición en el método EvaluarEstadosDeHabilitacion.

¿Y si hubiera que agregar 50 controles más? Con el Ejemplo 1 esa tarea podría llevar toda la tarde y con una posibilidad de error muy alta, mientras que con el Ejemplo 2 sería cosa de 10 minutos máximo!


Ahora preguntémonos: ¿cómo es mejor, de la primera forma o de la segunda? La primera es una mala práctica y la segunda es una buena práctica porque encapsula la condición en un solo sitio, que es de lo que se trata al hacer cualquier programa o sistema, y eso que solamente hemos hablado de algo tan simple como un Enabled.



Técnicas de encapsulación - Trabajo en N capas


Si trabajamos en capas (negocio, datos, Interfaz) o con separación de responsabilidades, el Ejemplo 2 de antes se puede hacer de una forma parecida, que requiere algo más de código y de diseño, pero que al final también tiene más ventajas.

Una de las primeras separaciones que conviene hacer es la de los datos y la interfaz. En FoxPro tenemos tan arraigada esta mezcla interfaz+datos, que muy pocos se la cuestionan. Me refiero a no usar el ControlSource de los controles, o a usarlo apuntando a propiedades del mismo form, como se hace habitualmente.


Este es un caso de uso típico:

Form1.txtCodArt.Valid
IF EMPTY(this.value)
  MESSAGEBOX( "EL CÓDIGO DE ARTICULO NO PUEDE QUEDAR VACÍO" )
ENDIF

Form1.txtValor.Valid
IF EMPTY(this.value)
  MESSAGEBOX( "EL VALOR NO PUEDE QUEDAR VACÍO" )
ENDIF



El ControlSource de los controles conviene apuntarlo a propiedades de un objeto externo, de forma que ese objeto luego se puede reutilizar o incluso pasar como parámetro.


a) Creando un Objeto de negocio

Usando el primer ejemplo, nuestro objeto de negocio debería contener 2 propiedades, codArt y Valor:


*--  ARTICULO_BUS.PRG 
Define Class cl_articulo As Custom
   c_CodArt = ""
   n_Valor  = 0
EndDefine



b) Instanciando la clase de negocio en el form


En el form creamos una propiedad oBus y la cargamos con el objeto antes definido, agregándolo en el LOAD:


Form1.LOAD
THISFORM.oBus = NEWOBJECT( "cl_articulo", "articulo_bus.prg" )


c) Definiendo el nuevo ControlSource


Luego definimos los ControlSource de los controles en modo diseño:

txtCodArt.ControlSource = "thisform.oBus.c_CodArt"
txtValor.ControlSource = "thisform.oBus.n_Valor"



d) Referenciando los datos


Finalmente, modificamos el método del Ejemplo 2 para que no tome los valores directamente de los controles (nunca hay que tomar los datos de los controles!), sino de las propiedades del nuevo objeto:


Form1.EvaluarEstadosDeHabilitacion
LOCAL loBus As cl_articulo OF "articulo_bus.prg"
loBus = thisform.oBus

IF NOT EMPTY(loBus.c_CodArt) AND NOT EMPTY(loBus.n_Valor)
  THISFORM.cmdImprimir.Enabled = .T.
ELSE
  THISFORM.cmdImprimir.Enabled = .F.
ENDIF



e) Ampliando el uso del objeto de negocio: Validaciones


Supongamos que queremos agregar validaciones de datos, esas que normalmente se ponen en el VALID del control (como los ejemplos de más arriba), y que en ciertos casos terminan duplicándose o incluso cayendo en algo tan feo como teniendo que llamar desde un control al VALID de otros controles, o peor, un Valid llamando al InteractiveChange de otro control que a su vez llame al evento de otro control, y así sucesivamente...   Obviamente que eso no es una buena práctica, aunque sean muchos los que lo sigan haciendo.

Hay mejores formas y más limpias y fáciles de mantener para eso, como ser el poner esas validaciones en nuestro objeto de negocio:

*--  ARTICULO_BUS.PRG 
Define Class cl_articulo As Custom
   c_CodArt = ""
   n_Valor  = 0

   PROCEDURE EvaluarError_CodArt
      LOCAL lcCodError
      lcCodError = ""

      IF EMPTY(THIS.c_CodArt)
         lcCodError = "EL CÓDIGO DE ARTICULO NO PUEDE QUEDAR VACÍO"
      ENDIF

      RETURN lcCodError
   ENDPROC

   PROCEDURE EvaluarError_Valor
      LOCAL lcCodError
      lcCodError = ""

      IF EMPTY(THIS.n_Valor)
         lcCodError = "EL VALOR NO PUEDE QUEDAR VACÍO"
      ENDIF

      RETURN lcCodError
   ENDPROC

EndDefine

Nota: Como puede verse, las validaciones de negocio "devuelven" valores, cadenas o incluso arrays de valores, pero nunca muestran mensajes, ni siquiera de error, ya que eso es responsabilidad de la Interfaz (el form o sus controles)


Recuerden:

Al trabajar en capas, las validaciones no son responsabilidad de la Interfaz (pantallas), sino del Negocio, al igual que los cálculos y los procesos. En esta metodología de trabajo las pantallas solo deben contener el código necesario para la navegación, activación, desactivación o cualquier cosa específica de la Interfaz, y para el resto debe llamar a métodos de negocio.


Para usar estas validaciones, el formulario podría tener esto:

Form1.txtCodArt.Valid
THISFORM.EvaluarEstadosDeHabilitacion()
THISFORM.MostrarMensajeError( THIS.oBus.EvaluarError_CodArt() )

Form1.txtValor.Valid
THISFORM.EvaluarEstadosDeHabilitacion()
THISFORM.MostrarMensajesError( THIS.oBus.EvaluarError_Valor() )

Form1.MostrarMensajesError
LPARAMETERS tcMensajeError
IF NOT EMPTY(tcMensajeError)
   MESSAGEBOX( tcMensajeError )
ENDIF



Posibles mejoras en el esquema de validaciones


La forma de validar anterior puede ser útil cuando se quiere que los mensajes sean invasivos y bloqueantes, como se ha hecho por muchos años, pero puede resultar muy molesto hacerlo así en un formulario donde se quiere que el usuario tenga la mayor libertad posible para navegar por los controles sin que le vayan apareciendo mensajes a cada paso.

Para este caso, donde se quiere que el usuario vea los errores cuando realmente quiera verlos, hay varias alternativas.


Alternativa 1 - Mostrar mensajes en un panel especial


La idea es dejar un espacio reservado para el mensaje de error actual, por ejemplo un editbox en la parte inferior del form, de 2 ó 3 líneas de altura, donde el usuario pueda siempre ir viendo los mensajes a medida que recorre los controles. Para actualizar esa zona especial se podría adaptar el método MostrarMensajesError del ejemplo anterior, por ejemplo así:

Form1.MostrarMensajesError
LPARAMETERS tcMensajeError
IF EMPTY(tcMensajeError)
   THISFORM.edtMensajes.VALUE = ""
ELSE
   THISFORM.edtMensajes.VALUE = tcMensajeError
ENDIF

Observen lo simple que fue adaptar este método centralizado de evaluación de mensajes para cambiarle la implementación de cómo mostrar los mensajes, sin haber tenido que tocar ni un control.

Un ejemplo de este tipo de validación:




Alternativa 2 - Mostrar una ventana independiente de mensajes


En este caso la idea es que el usuario pueda ver todos los mensajes de validación juntos en una ventana separada o dentro del form y mostrados en formato tabular, por ejemplo con un grid o un ListBox.

Para ello, podríamos poner un botón "Ver Validaciones" en el form, cuyo evento click tenga esto:

Form1.cmdVerValidaciones.Click
THISFORM.oBus.ObtenerValidaciones(@laMensajes)
DO FORM MostrarMensajes WITH laMensajes


Y el form podría mostrarlos de forma similar a esto:




Alternativa 3 - Mensajes de validación en un proceso masivo


En el caso de un proceso en lotes, o masivo, donde no se muestran mensajes, sino que se loguean para posterior análisis, se podría usar el método oBus.ObtenerValidaciones() desde un proceso externo, y guardar esos mensajes en una tabla o archivo log, y esto sería posible gracias a haber separado la parte negocio en una clase independiente del form que se puede instanciar sin necesidad del form.



f) La parte que falta: Los Datos


En la programación tradicional de FoxPro, la Interfaz y el Negocio están mezclados, y los Datos no iban a ser la excepción, ya que cualquier consulta de datos se suele hacer en la misma Interfaz, similar a esta forma:

Form1.cmdObtenerArticulos.Click

*-- Recupero los datos
SELECT * FROM ARTICULOS ;
   WHERE CodArt = THISFORM.txtCodArt.Value ;
   INTO CURSOR c_Arts

*-- Asigno los datos
THISFORM.txtValor.Value = c_Arts.Valor
THISFORM.txtDescrip.Value = c_Arts.Descrip

*-- Proceso los datos
(código que hace varias cosas con los datos recuperados)


Cuando se separan responsabilidades y se trabaja con capas, nunca se debe hacer un acceso a datos (Select, Update, Insert, etc) directamente desde la Interfaz, sino que se debe hacer desde una clase externa para acceso a datos, por ejemplo así:

*--  ARTICULO_DB.PRG 
Define Class cl_articulo As Custom

  PROCEDURE DevolverDatosArticulo
    LPARAMETERS tcCodArt, taDatosArt
    USE ARTICULOS AGAIN SHARED NOUPDATE ALIAS _ART IN 0
    SELECT * FROM _ART ;
       WHERE CodArt = tcCodArt ;
       INTO ARRAY taDatosArt
    USE IN (SELECT("_ART"))
    RETURN _TALLY
  ENDPROC

EndDefine

Nota: No incluí control de errores ni apertura/cierre de tablas para simplificar.


Y esta clase de datos es usada por el negocio, de esta forma:

*--  ARTICULO_BUS.PRG 
Define Class cl_articulo As Custom
   c_CodArt = ""
   n_Valor  = 0
   o_DB     = NULL

   PROCEDURE ProcesarDatos
      LOCAL laDatosArt(1,1)
      THIS.o_DB = NEWOBJECT( "cl_articulo", "ARTICULO_DB.PRG" )
      THIS.o_DB.DevolverDatosArticulo( @laDatosArt )
      THIS.c_CodArt = laDatosArt(1,1)
      THIS.c_Valor  = laDatosArt(1,2)


      *-- Proceso los datos
      (código que hace varias cosas con los datos recuperados)
   ENDPROC

EndDefine


El código original del form, solo haría esta llamada:

Form1.cmdObtenerArticulos.Click
THISFORM.oBus.ProcesarDatos()

Nota: Es aquí, en la Interfaz, donde deben mostrarse los errores de los métodos invocados.



[Nuevo. 03/06/2015>>]

Posibles mejoras al modelo propuesto


El modelo propuesto es una versión muy simplificada de una arquitectura en capas, y obviamente hay mucho espacio para la mejora.

A continuación dejo algunas ideas de una estructura de aplicación basada en un objeto público (oApp) que contiene la misma clase de artículos de antes, pero dentro de una estructura más versátil. Dentro de oApp se podrá tener a las demás clases de negocio, para ser accedidas como oApp.oArticulo.oDatos u oApp.oCliente.oDatos, y para poder realizar tareas como oApp.oArticulo.ListarStock() u oApp.oCliente.DevolverSaldo()

En el programa principal (ej: Main.prg), es donde realizamos la configuración inicial de la aplicación (comandos SET, PATH, cambio de directorio, etc) y donde instanciamos el objeto oApp:


*-- MAIN.PRG
PUBLIC oApp
oApp = NewObject("cl_app_bus", "APP_BUS.PRG")
oApp.CargarNegocio()


Y podemos definir la clase cl_app de esta forma:

*-- APP_BUS.PRG
Define Class cl_app_bus AS Custom
  oArticulo = Null

  PROCEDURE cargarNegocio
    THIS.oArticulo = NewObject("cl_articulo_bus", "articulo_bus.prg")
  ENDPROC
EndDefine


En vez de usar directamente propiedades del objeto oBus para los datos, sería mejor usar una propiedad oDatos inicializada a NULL y luego guardar en ella un objeto de tipo Empty con las propiedades que se correspondan con los campos a tratar, de forma uqe luego el ControlSource de los controles del form apunten a ella, de la forma: oApp.oArticulo.oDatos.cod_Art

Para crear este objeto, se podría hacer un método de la clase de acceso a datos que lo devuelva, junto a otros métodos para su tratamiento de guardado y recuperación, por ejemplo:



*-- ARTICULO_DB.PRG
DEFINE CLASS cl_articulo_db AS Custom

  PROCEDURE DevolverDatosArticulo
    LPARAMETERS tcCodArt, taDatosArt
    LOCAL lnSelect
    lnSelect = SELECT()
    USE ARTICULOS AGAIN SHARED NOUPDATE ALIAS _ART IN 0
    SELECT * FROM _ART ;
       WHERE CodArt = tcCodArt ;
       INTO ARRAY taDatosArt
    USE IN (SELECT("_ART"))
    SELECT (lnSelect)
    RETURN _TALLY
  ENDPROC

  PROCEDURE devolverObjetoDatosVacio
    LOCAL loReg
    loReg = CreateObject("Empty")
    AddProperty(loReg, "c_CodArt", "")
    AddProperty(loReg, "n_Valor", 0)
    RETURN loReg
  ENDPROC

  PROCEDURE guardarDatos(toDatos)
    LOCAL lnSelect
    lnSelect = SELECT()
    SELECT 0
    USE ARTICULOS SHARED AGAIN ALIAS _ART ORDER c_CodArt
    IF SEEK(toDatos.c_CodArt) THEN
      GATHER MEMO NAME toDatos
    ELSE
      INSERT INTO _ART FROM NAME toDatos
    ENDIF
    USE IN (SELECT("_ART"))
    SELECT (lnSelect)
  ENDPROC

  PROCEDURE recuperarDatos(tcCodArt)
    LOCAL loDatos, lnSelect
    lnSelect = SELECT()
    loDatos = NULL
    SELECT 0
    USE ARTICULOS SHARED AGAIN NOUPDATE ALIAS _ART ORDER c_CodArt
    IF SEEK(toDatos.c_CodArt) THEN
      SCATTER MEMO NAME loDatos
    ENDIF
    USE IN (SELECT("_ART"))
    SELECT (lnSelect)
  ENDPROC

ENDDEFINE




Pero como no se puede acceder directamente a la clase de acceso a datos, sino por medio de la clase de negocio, también agregamos los métodos en la clase de negocio de Articulos:


*--  ARTICULO_BUS.PRG 
Define Class cl_articulo_bus As Custom
  o_DB    = Null
  oDatos  = Null

  PROCEDURE Init
    THIS.o_DB = NEWOBJECT( "cl_articulo_db", "ARTICULO_DB.PRG" )
    THIS.cargarObjetoDatosVacio() && objeto inicial vacío
  ENDPROC

  PROCEDURE devolverObjetoDatosVacio
     RETURN THIS.o_DB.devolverObjetoDatosVacio()
  ENDPROC

  PROCEDURE cargarObjetoDatosVacio
     THIS.oDatos = THIS.devolverObjetoDatosVacio()
  ENDPROC

  PROCEDURE guardarDatos
     THIS.o_DB.guardarDatos(THIS.oDatos)
  ENDPROC

  PROCEDURE recuperarDatos(tcCodArt)
     THIS.oDatos = THIS.o_DB.recuperarDatos(tcCodArt)
  ENDPROC

  PROCEDURE DevolverDatosArticulo
    LPARAMETERS tcCodArt, taDatosArt
    RETURN THIS.o_DB.devolverDatosArticulo(tcCodArt, taDatosArt)
  ENDPROC

EndDefine


Como se ve, la arquitectura de objetos que elijan les permite poder relacionarlos y usarlos de forma autodocumentada, si se diseña bien.

Hay muchas formas de estructurar los objetos de negocio y de armar la estructura de una aplicación, y lo anterior solo pretende dar algunas ideas de algunas posibilidades.

Algo importante a recordar es no encasillarse en una única solución, si la solución que se usa no se puede aplicar el tipo de problema que se quiere resolver, simplemente se cambia la solución.
[<<]



[Nuevo. 04/06/2015>>]

¿Y el control de errores?


No lo puse en los ejemplos para mantenerlos lo más simples y entendibles posible, además del espacio que ocupa poner más código, pero vamos a dedicarle un apartado a esto, que es fundamental en toda aplicación, y que debe hacerse mientras se programa, nunca al final.

Algunos usarán el antiguo método del ON ERROR, porque es cómodo, se escribe una sola vez y sirve para toda la aplicación, lo que lo hace tentador, pero la realidad es que ese método no es suficiente cuando se quiere controlar la recolección de basura o ciertas condiciones en un sistema, ya que deja muy pocas alternativas de gestión y salida, y es que si no se liberan bien las referencias de objeto, se pueden quedar enganchadas (si es se vinculan de forma cruzada) y esto puede causar que no se pueda salir de la aplicación.

Hay una mezcla de pereza y miedo a controlar los errores, y muchas veces se peca de demasiado optimismo pensando de que todo es correcto y está todo pensado, pero los imprevistos existen, y los errores le ocurren incluso a los mejores.

La mejor estrategia, es contar con los errores como una parte normal del desarrollo y usarlos a nuestro favor, para generar información de diagnóstico que nos permitan identificarlos y corregirlos lo antes posible.

¿Cuántas veces ven en los foros a personas que piden ayuda por un error que le da su aplicación y que no saben cómo o dónde buscarlo? Eso pasa porque no se gestionan los errores. En el mejor caso algunos ponen una rutina genérica y en el peor no ponen nada y dejan que FoxPro muestre el conocido mensaje para "Continuar, Cancelar, Reintentar", lo que es bochornoso y muy peligroso también, ya que el usuario puede elegir algo que no debe poder elegir.

En nuestro caso vamos a ver un ejemplo aplicado al método DevolverDatosArticulo(), y que servirá de ejemplo para los demás.

*-- ARTICULO_DB.PRG
<resto del código excluido por comodidad>

  PROCEDURE DevolverDatosArticulo
    LPARAMETERS tcCodArt, taDatosArt

    TRY
      LOCAL loEx as Exception, lnSelect
      lnSelect = SELECT()
      USE ARTICULOS AGAIN SHARED NOUPDATE ALIAS _ART IN 0
      SELECT * FROM _ART ;
        WHERE CodArt = tcCodArt ;
        INTO ARRAY taDatosArt

    CATCH TO loEx
      IF EMPTY(loEx.UserValue) AND _VFP.StartMode=0 THEN
        SET STEP ON
      ENDIF 

      loEx.UserValue = loEx.UserValue + "tcCodArt=" ;
        + TRANSFORM(tcCodArt) + CHR(13) + CHR(13)

      THROW

    FINALLY
      USE IN (SELECT("_ART")) 
      SELECT (lnSelect)
    ENDTRY

    RETURN _TALLY
  ENDPROC

<resto del código excluido por comodidad>


El código anterior sería la implementación completa de la funcionalidad con control de errores, en gris está el código previo para que se pueda contrastar con el código agregado.

Como este método realiza tratamiento de datos, al inicio se guarda el área de trabajo en la que se estaba, luego se abre la tabla en modo compartido y de sólo-lectura con un alias temporal (_ART) y se hace la consulta.

Si todo va bien, se ejecuta el FINALLY donde se cierra el alias temporal y se restaura el área de trabajo original.

Ahora, si hay un error, viene la parte interesante:

- Se verifica si en UserValue hay algo (inicialmente está vacío) y si estamos en modo Desarrollo (StartMode=0), en cuyo caso se abre la ventana del depurador para que podamos ver in-situ el origen del problema.

- Luego se recoge el valor del parámetro tcCodArt y se guarda en la propiedad UserValue del objeto de errores, lo cuál es muy útil, porque los valores que pongamos irán dentro de este objeto de tipo Exception hasta su destino final, donde se mostrará si es un proceso interactivo con el usuario) o se logueará al disco (si es un proceso desatendido). Esto nos dará la pista de qué artículo se estaba consultando cuando ocurrió el error. Normalmente aquí se suelen poner los valores relevantes y específicos del método que nos puedan dar pistas claras del problema o que nos ayuden a poder reproducirlo (por eso lo de "diagnóstico" que comenté antes)

- A continuación relanzamos el error al nivel superior, que normalmente será el método de negocio que haya llamado a este, o el anterior si es que el método de negocio no tiene control de errores.

- Finalmente se ejecuta el Finally, que se ejecuta cuando se relanza el error como parte del funcionamiento de la estructura Try/Catch, donde se cierra la tabla temporal y se restaura el área de trabajo original.

Lo bueno del Finally es que se ejecuta siempre, tanto haya errores como no los haya, y esto permite realizar siempre la recolección de basura.


El método de negocio DevolverDatosArticulo() no tiene casi código, por lo que es casi imposible que ocurra un error aquí (salvo uno de sintaxis), y por lo tanto no tiene sentido agregarle control de errores, ya que no aporta nada al proceso:

  PROCEDURE DevolverDatosArticulo
    LPARAMETERS tcCodArt, taDatosArt
    RETURN THIS.o_DB.devolverDatosArticulo(tcCodArt, taDatosArt)
  ENDPROC



Finalmente tenemos la interfaz, que es desde donde se lanzó el proceso. Como es un método de consulta, vamos a asumir de que se lanzó desde un form de consulta con un botón cmdConsultar y un textbox txtCodArt en el que se indicó el artículo a consultar.

Queda por aclarar un pequeño punto, que es dónde se guarda el dato ingresado por el usuario en txtCodArt. Como ya comenté al inicio, no es buena idea tomar los datos directamente del Value de los controles, por lo que vamos a crear un objeto de datos nada más que para este form, y vamos a usarlo como "THISFORM.oDatos.c_CodArt" en el ControlSource del control txtCodArt:


DEFINE CLASS cl_form AS Form
  oDatos = NULL
  BindControls = .F.

  <resto del código excluido por comodidad>

  PROCEDURE Init
    THIS.oDatos = CREATEOBJECT("Empty")
    AddProperty( THIS.oDatos, "c_CodArt", "" )
    BindControls = .T.
  ENDPROC

  PROCEDURE cmdConsultar.Click
    LOCAL laDatosArt, loEx as Exception, lcMsg
    STORE "" TO lcMsg

    TRY
      oApp.oArticulo.devolverDatosArticulo( ;
        THISFORM.oDatos.c_cCodArt, @laDatosArt)
      ...hacer algo con laDatosArt

    CATCH TO loEx
      TEXT TO lcMsg ADDITIVE TEXTMERGE NOSHOW FLAGS 1+2 PRETEXT 1+2
        Error <<loEx.ErrorNo>>, <<loEx.Message>>
        Procedure <<loEx.Procedure>>, line <<loEx.LineNo>>
        Details <<loEx.Details>
        UserValue <<loEx.UserValue>>
      ENDTEXT

      MESSAGEBOX( lcMsg )

    FINALLY
      * Recolección de basura
    ENDTRY
  ENDPROC

ENDDEFINE


Nota: Esta definición de form está incompleta y solo incluí las partes importantes, que se pueden agregar o configurar en un form real o por código, similar a este.

Veamos, por partes, qué sucede aquí:

- Primero asumimos que txtCodArt.ControlSource = "THISFORM.oDatos.c_CodArt" y que la propiedad BindControls del form está en .F. en diseño (importante para que no de error por objeto oDatos inexistente)

- En el Init se crea el objeto oDatos del form y se le agrega la propiedad c_CodArt que se usará para la consulta, y como última instrucción se habilita el bindeo del ControlSource con BindControls = .T., cosa que cuando se carga el form ya está todo lo necesario inicializado

- Cuando se ingresa el código de artículo en txtCodArt, este se guarda en THISFORM.oDatos.c_CodArt y al pulsar el botón cmdConsultar se invoca a la consulta de Artículos del negocio, pasándole el código del artículo y recibiendo un array con los datos

- Si va todo bien, con el array luego se hace lo que se necesite, pero si ocurre un error en algún punto de todo el proceso, el mismo se irá relanzando desde donde ocurra hasta llegar aquí a la interfaz (lo que se conoce como "propagación del error"), donde finalmente se arma un mensaje para visualizar con los datos obtenidos y se muestra.

Como se ve, no es nada difícil manejar la propagación del error, ya que desde fuera de la interfaz, lo único que hay que hacer es propagarlo, y solo en la interfaz hay que mostrarlo. También sería conveniente guardarlo en un archivo LOG en el momento que se produce.


Estas son algunas preguntas comunes que surgen sobre este tema (FAQ):

¿Cómo se puede identificar al error original de uno relanzado?

  Cuando se captura un error y se relanza, en todos los puntos intermedios en los que se relance, tendrá la misma información, pero si tomamos como costumbre siempre poner algún dato en la propiedad UserValue, aunque sea "." si no hay nada útil que agregar, podemos saber si se estamos evaluando el error original solo evaluando si UserValue está vacío, que lo estará solamente la primera vez.

¿Cómo se puede distinguir a un error de verdad de un error de usuario lanzado con ERROR "mensaje"?

  Los errores de usuario lanzados con ERROR "mensaje" tienen el código 1098, los errores de usuario lanzados con THROW "mensaje" tienen el código 2071.
[<<]



Ventajas de separar en capas


Como hemos visto, hacer esta separación entre Interfaz (los controles, el form, lo "visual"), Negocio (validaciones, cálculos, procesos) y Datos (consultas, eliminación, actualizaciones) permite poder hacer varias cosas que estando metidas en un form son difíciles o imposibles, por ejemplo:

  • Cuando un método necesita pasar datos a otro, puede pasarle directamente el objeto de negocio, dependiendo de dónde esté definido cada uno, y así evitar pasar datos individuales
  • Permite reutilizar las validaciones en otros forms u otras situaciones o procesos
  • Permite encapsular las validaciones, lo que hace que sean más fáciles de mantener
  • Permite encapsular los accesos a datos, lo que hace que sean más fáciles de mantener también
  • Hace que el código sea más específico y por lo tanto más reducido y fácil de entender
  • Permite usar Testeo Unitario automatizado, por ejemplo, con FoxUnit, lo que puede ahorrar muchas horas o incluso días de pruebas manuales y de regresión
  • La encapsulación favorece la reusabilidad del código, y más todavía cuanto mejor se parametrice
  • Permite poder trabajar en cada capa de forma independiente, hasta el punto de que cada capa la puede hacer un desarrollador distinto si se quiere, y reducir tiempos de desarrollo y pruebas
  • Incluso aunque se trabaje en solitario, las pruebas también se hacen más simples
  • La búsqueda de errores se simplifica, ya que al tener bloques de código más reducidos y especificos, se recorren de forma más rápida
  • Al separar la Interfaz de las validaciones, los cálculos, las consultas y demás, la Interfaz queda con lo mínimo y necesario para la navegación, lo que permitiría poder sustituirla por un nuevo diseño de Interfaz sin perjudicar ni perder ninguno de los procesos, y obviamente sin tener que copiar su código (salvo las llamadas a los procesos)


¿Cuántas capas existen?


Se llama N capas porque la cantidad de ellas que se usen dependerá del diseño y arquitectura que se quiera. Es muy importante no encasillarse en "3", ya que fácilmente pueder ser varias más, y para evitar ese encasillamiento es que también se habla de "separación de responsabilidades".

Tomemos por ejemplo una conexión a web-services: En este caso podríamos hablar de una nueva capa o responsabilidad que se encargue de todas las comunicaciones de este tipo.

Dentro de la capa de comunicaciones, se podrían tener sub-capas más específicas, como la antes comentada de web-services, o una de envío de mensajes o SMSs, etc.

Otro ejemplo: La impresión se puede considerar como otra capa, donde todo lo que tenga que ver con eso esté encapsulado en una o más librerías específicas, que pueden ser utilizadas desde donde sea necesario.

Como se podrán ir dando cuenta, a medida que vayan hilando más fino podrán ver que subyace la idea de "servicios" específicos con APIs que pueden ser reutilizados desde distintos puntos del sistema, incluso al extremo de poder ser tan reutilizables que sirvan para otros sistemas. Esa misma idea es la que hay detrás de "servicios" tan útiles y específicos como el portapapeles (clipboard), el servicio de Impresión, el servicio de mensajes del sistema, los servicios de red, etc.


Aunque no lleguen a ese punto, lo importante es que puedan ver el potencial de hacer componentes o servicios tan específicos que puedan ser utilizados desde cualquier programa, incluso no FoxPro.



Notas finales


La idea de este artículo es poder ver las diferencias entre una y otra forma de trabajar, la forma antigua ya tradicional de FoxPro donde se hace todo junto, y la otra que no es nada nueva y donde los resultados pueden ser mejor aprovechados bajo la filosofía de separar en componentes y responsabilidades, llevando la encapsulación del código a los niveles necesarios para permitir la reusabilidad y favorecer la mejor claridad del código.

Comparando los ejemplos de la programación tradicional en FoxPro del "todo junto" con los ejemplos separados en sus distintos componentes (visual, negocio y datos), creo que puede comprobarse que aunque lo segundo requiera algo más de código, realmente cada parte es muy específica y simple de entender.

Intenté que los ejemplos sean sencillos y no he incluido el control de errores para mantener los ejemplos cortos y fáciles de leer y de entender, ya que se asume que el control de errores forma parte integral de la programación y no algo separado.

De la misma forma, el Testing Unitario automatizado es una herramienta muy importante a la que se le puede sacar todavía mayor provecho cuando se usa esta metodología de trabajo, y que tampoco debiera ser considerada como algo aparte.

Si se habitúan a pensar de esta forma y a trabajar con esta metodología, de pronto se encontrarán con que comenzarán a tener varias posibilidades, soluciones e ideas que hasta ahora no habían podido ver.



Hasta la próxima! :D

Artículos Relacionados:
Unit Testing: Qué es y cómo se usa en VFP 9
Desmitificando el Control de Errores con Try/Catch
Guía de Buenas Prácticas de programación y recomendaciones

7 comentarios:

  1. Muy buen articulo Sr. Bozzo, lo felicito.

    Saludos

    ResponderEliminar
  2. Este es un ejemplo de Fernando para jerarquizar todas las clases para que sean accesibles desde cualquier lugar de la aplicacion. Gracias Fernando!!!


    *//////////////////////////////////// MAIN.PRG

    PUBLIC oApp
    oApp = NEWOBJECT( "cl_app", "app_bus.prg" )
    oApp.cargar_negocio()

    nPrecio = oApp.oArticulo.calcularPrecio("COD-ARTICULO")
    nEstado = oApp.oCliente.devolverEstado("COD-CLIENTE")


    *//////////////////////////////////// APP_BUS.PRG

    DEFINE CLASS cl_app AS Custom && clase APP

    oArticulo = NULL
    oCliente = NULL

    PROCEDURE cargar_negocio

    THIS.oArticulo = NEWOBJECT( "cl_articulo", "articulo_bus.prg" )
    THIS.oCliente = NEWOBJECT( "cl_cliente", "cliente_bus.prg" ) ENDPROC
    ENDDEFINE

    *//////////////////////////////////// ARTICULO_BUS.PRG

    DEFINE CLASS cl_articulo AS Custom && clase Articulo

    *Los métodos de "articulo"

    PROCEDURE calcularPrecio(tcCodigoarticulo)

    *Calculo del precio
    ENDPROC

    ENDDEFINE

    *//////////////////////////////////// CLIENTE_BUS.PRG

    DEFINE CLASS cl_cliente AS Custom && clase Cliente

    *Los métodos de "cliente"

    PROCEDURE devolverEstado(tcCodigoCliente)

    ENDPROC
    ENDDEFINE

    ResponderEliminar
  3. Gracias por tus aportes.
    Nunca se termina de aprender.

    ResponderEliminar
  4. Gracias Fernando a mi me pasa lo mismo con formularios grandes que tengo. Copiar y pegar. Tengo un Formulario de monitoreo de BUS, con 45 botones de colores reflejando cada asiento. Nunca he trabajado con CLASES, todo en el formulario. El bus tiene 3 status de colores, 1 = verde disponible, 2 = Rojo Oucpado 3 = Gray Reservado, ahora tengo que poner otro Status 4 = Azul, Vendido Internet. Tengo que modificar los 45 CASES que tengo por cada asiento.
    y si es bien complicado, quise hacer una solucion donde pudiera mandar por parametro el numero del asiento, y el status, y el codigo de color del SHAPE.
    saludos y gracias por tu aporte

    ResponderEliminar
  5. Gracias Fernando a mi me pasa lo mismo con formularios grandes que tengo. Copiar y pegar. Tengo un Formulario de monitoreo de BUS, con 45 botones de colores reflejando cada asiento. Nunca he trabajado con CLASES, todo en el formulario. El bus tiene 3 status de colores, 1 = verde disponible, 2 = Rojo Oucpado 3 = Gray Reservado, ahora tengo que poner otro Status 4 = Azul, Vendido Internet. Tengo que modificar los 45 CASES que tengo por cada asiento.
    y si es bien complicado, quise hacer una solucion donde pudiera mandar por parametro el numero del asiento, y el status, y el codigo de color del SHAPE.
    saludos y gracias por tu aporte

    ResponderEliminar
  6. Excelente trabajo, me ha ayudado mucho. Felicidades Fernando, continua así...

    ResponderEliminar
  7. Gracias Fernando, vino muy oportuno tu artículo cuando estoy a punto de iniciar un nuevo proyecto.

    ResponderEliminar