Gestión de errores

El manejo de errores es el proceso de anticipar y responder a los errores que puedan ocurrir en su aplicación. 4D soporta de forma completa la detección y notificación de errores en tiempo de ejecución, así como el análisis de sus condiciones.

La gestión de errores responde a dos necesidades principales:

• descubrir y corregir posibles errores y fallos en el código durante la fase de desarrollo,
• detectar y recuperar errores inesperados en las aplicaciones desplegadas; en particular, puede sustituir los diálogos de error del sistema (disco lleno, archivo perdido, etc.) por su propia interfaz.

Básicamente, hay dos maneras de manejar los errores en 4D. Puede:

• instalar un método de gestión de errores, o
• utilice una palabra clave Try()](#tryexpression) o una [estructura Try/Catch antes de piezas de código que llaman a una función, método o expresión que pueden arrojar un error.

Buenas prácticas

Es muy recomendable instalar un método global de gestión de errores en 4D Server, para todo el código que se ejecute en el servidor. Cuando 4D Server no se ejecuta headless (es decir, se lanza con su ventana de administración), este método evitaría que se mostraran cajas de diálogo inesperadas en la máquina servidor. En modo sin interfaz, los errores se registran en el archivo 4DDebugLog para su posterior análisis.

Error o estado

Muchas funciones de clase 4D, como entity.save() o transporter.send(), devuelven un objeto status. Este objeto se utiliza para almacenar errores "predecibles" en el contexto de ejecución, por ejemplo, una contraseña no válida, una entidad bloqueada, etc., que no detienen la ejecución del programa. Esta categoría de errores puede ser manejada por el código habitual.

Otros errores "imprevisibles" son el error de escritura en el disco, el fallo de la red o, en general, cualquier interrupción inesperada. Esta categoría de errores genera excepciones y debe gestionarse mediante un método de gestión de errores o una palabra clave Try().

Instalación de un método de gestión de errores

En 4D, todos los errores pueden ser detectados y manejados por métodos proyecto específicos, llamados métodos de gestión de errores (o métodos de intercepción de errores).

Una vez instalados, los manejadores de errores son llamados automáticamente en modo interpretado o compilado en caso de error en la aplicación 4D o en uno de sus componentes. Se puede llamar a un manejador de errores diferente en función del contexto de ejecución (ver abajo).

Para instalar un método proyecto de gestión de errores, basta con llamar al comando ON ERR CALL con el nombre del método proyecto y (opcionalmente) el álcance como parámetros. Por ejemplo:

ON ERR CALL("IO_Errors";ek local) //Instala un método local de gestión de errores

Para dejar de interceptar los errores en un contexto de ejecución y devolver la mano, llame ON ERR CALL con una cadena vacía:

ON ERR CALL("";ek local) //devuelve el control al proceso local

El comando Method called on error le permite conocer el nombre del método instalado por ON ERR CALL para el proceso actual. Es particularmente útil en el contexto de código genérico porque permite cambiar temporalmente y luego restaurar el método de captura de error:

 $methCurrent:=Method called on error(ek local)
 ON ERR CALL("NewMethod";ek local)
  //Si no se puede abrir el documento, se genera un error
 $ref:=Open document("MyDocument")
  //Reinstalación del método anterior
 ON ERR CALL($methCurrent;ek local)

Alcance y componentes

Se puede definir un método de gestión de errores para diferentes contextos de ejecución:

• para el proceso actual- sólo se llamará a un gestor de errores local para los errores ocurridos en el proceso actual del proyecto actual,
• para toda la aplicación- se llamará a un gestor de errores global para todos los errores que se produzcan en el contexto de ejecución de la aplicación del proyecto actual,
• desde los componentes- este manejador de errores se define en un proyecto local y será llamado para todos los errores que ocurran en los componentes cuando no hayan sido ya interceptados por un manejador de componentes.

Ejemplos:

ON ERR CALL("IO_Errors";ek local) //Instala un método de gestión de errores local 
ON ERR CALL("globalHandler";ek global) //Instala un método de gestión de errores global 
ON ERR CALL("componentHandler";ek errors from components) //Instala un método de gestión de errores para los componentes

Puede instalar un gestor de errores global que servirá como "fallback" y gestores de errores locales específicos para determinados procesos. Un gestor de errores global también es útil en el servidor para evitar diálogos de error en el servidor cuando se ejecuta con interfaz.

Se puede definir un único método de captura de errores para toda la aplicación o diferentes métodos por módulo de aplicación. Sin embargo, sólo se puede instalar un método por contexto de ejecución y por proyecto.

Cuando se produce un error, sólo se llama a un método, como se describe en el siguiente diagrama:

Manejo de errores e el método

Dentro de un método de gestión de errores personalizado, tiene acceso a varios datos que le ayudarán a identificar el error:

• las variables sistema dedicadas:

  • Error (entero largo): código de error
  • Error method(texto): nombre del método que ha provocado el error
  • Error line (entero largo): número de línea del método que ha provocado el error
  • Error formula (texto): fórmula del código 4D (texto bruto) que está en el origen del error.

info

4D mantiene automáticamente una serie de variables denominadas variables sistema, que responden a diferentes necesidades.

• el comando Last errors que devuelve una colección de la pila actual de errores ocurridos en la aplicación 4D. También puede utilizar el comando GET LAST ERROR STACK que devuelve la misma información que los arrays.
• el comando Get call chain que devuelve una colección de objetos que describen cada paso de la cadena de llamadas a métodos dentro del proceso actual.

Ejemplo

He aquí un sistema de gestión de errores sencillo:

//instalar el método de gestión de errores
 ON ERR CALL("errorMethod")
 //... ejecutar el código
 ON ERR CALL("") //giving control back to 4D

// método proyecto errorMethod
 If (Error#1006) //este no es una interrupción del usuario
    ALERT("El error "+String(Error)+" ocurrido". El código en cuestión es: \""+Error formula+"\"")
  End if

Utilizar un método de gestión de errores vacío

Si desea principalmente que la caja de diálogo de error estándar esté oculta, puede instalar un método de gestión de errores vacío. La variable sistema Error puede ser probada en cualquier método, es decir, fuera del método de gestión de errores:

ON ERR CALL("emptyMethod") //emptyMethod existe pero está vacío
$doc:=Open document( "myFile.txt")
If (Error=-43)
	ALERT("Archivo no encontrado.")
End if
ON ERR CALL("")

Try(expression)

La sentencia Try(expression) permite probar una expresión de una sola línea en su contexto de ejecución real (incluyendo, en particular, los valores de las variables locales) e interceptar los errores que arroje para que no se muestre el diálogo de erro El uso de Try(expression) ofrece una manera fácil de manejar casos de error simples con un número muy bajo de líneas de código, y sin requerir un método de gestión de errores.

nota

Si desea probar un código más complejo que una expresión de una sola línea, puede considerar la posibilidad de utilizar una estructura Try/Catch.

La sintaxis formal de la declaración Try(expresión) es:

Try (expression) : any | Undefined

expresion puede ser toda expresión válida.

Si se produce un error durante su ejecución, se intercepta y no se muestra ningún diálogo de error, si un método de gestión de errores fue instalado o no antes de la llamada a Try(). Si expression devuelve un valor, Try() devuelve el último valor evaluado, en caso contrario devuelve Define.

Puede manejar los errores utilizando el comando Last errors. Si expression arroja un error dentro de una pila de llamadas Try(), el flujo de ejecución se detiene y devuelve a la última ejecución Try() (la primera encontrada de nuevo en la pila de llamadas).

nota

Si un método de gestión de errores es instalado por expression, es llamado en caso de error.

Ejemplos

1. Quiere mostrar el contenido de un archivo si el archivo se puede abrir sin errores y si su contenido se puede leer. Puede escribir:

var $text : Text
var $file : 4D.File := File("/RESOURCES/myFile.txt")
var $fileHandle : 4D.FileHandle := Try($file.open())
If ($fileHandle # Null)
  $text:=Try($fileHandle.readText()) || "Error al leer el archivo"
End if

2. Quiere manejar el error de dividir por cero. En este caso, se desea devolver 0 y lanzar un error:

function divide( $p1: real; $p2: real)-> $result: real
  if ($p2=0)
     $result:=0 //sólo por claridad (0 es el valor por defecto para reales)
     throw(-12345; "División por cero")
  else
    $result:=$p1/$p2
  end if

function test()
  $result:=Try(divide($p1;$p2))
  If (Last errors # null)
    ALERT("Error")
  End if

3. Desea gestionar tanto los errores previsibles como los no previsibles>:

var $e:=ds.Employee.new()
$e.name:="Smith"
$status:=Try($e.save()) //Capturar errores predecibles y no predecibles
If ($status.success)
   ALERT( "Success")
Else
   ALERT( "Error: "+JSON Stringify($status.errors))
End if

Try...Catch...End try

La estructura Try...Catch...End try permite probar el código de un bloque en su contexto de ejecución real (incluyendo, en particular, los valores de las variables locales) e interceptar los errores que lanza para que no se muestre el diálogo de error d

A diferencia de la palabra clave Try(expression) que evalúa una expresión de una sola línea, la estructura Try...Catch...End try permite evaluar cualquier bloque de código, desde el más simple al más complejo, sin necesidad de un método de gestión de Además, el bloque Catch puede utilizarse para gestionar el error de forma personalizada.

La sintaxis formal de la estructura Try...Catch...End try es:

Try 
	statement(s) // Código a evaluar
Catch
	statement(s) // Código a ejecutar en caso de error
End try

El código entre las palabras clave Try y Catch se ejecuta en primer lugar, luego el flujo depende del error o errores encontrados durante esta ejecución.

• Si no se lanza ningún error, la ejecución del código continúa después de la palabra clave correspondiente End try. El código situado entre las palabras clave Catch y End try no se ejecuta.
• Si la ejecución del bloque de código arroja un error no diferido **, el flujo de ejecución se detiene y ejecuta el bloque de código correspondiente Catch.
• If the code block calls a method that throws a deferred error, the execution flow jumps directly to the corresponding Catch code block.
• If a deferred error is directly thrown from the Try block, the execution flow continues until the end of the Try block and does not execute the corresponding Catch block.

nota

Si se lanza un error diferido fuera del bloque Try, la ejecución del código continúa hasta el final del método o función.

info

Para más información sobre errores diferidos y no diferidos, por favor consulte la descripción del comando throw.

En el bloque de código Catch, puede gestionar los errores utilizando los comandos estándar de gestión de errores. La función Last errors contiene la colección de los últimos errores. En este bloque de código puede declarar un método de gestión de errores, en cuyo caso se llama en caso de error (de lo contrario se muestra el diálogo de error de 4D).

nota

Si se instala un método de gestión de errores en el código colocado entre las palabras clave Try y Catch, se llama en caso de error.

Ejemplo

La combinación de transacciones y estructuras Try...Catch...End try permite escribir código seguro para funciones críticas.

Function createInvoice($customer : cs.customerEntity; $items : Collection; $invoiceRef : Text) : cs.invoiceEntity
	var $newInvoice : cs.invoiceEntity
	var $newInvoiceLine : cs.invoiceLineEntity
	var $item : Object
	ds.startTransaction()
	Try
		$newInvoice:=This.new()
		$newInvoice.customer:=$customer
		$newInvoice.invoiceRef:=$invoiceRef
		For each ($item; $items)
			$newInvoiceLine:=ds.invoiceLine.new()
			$newInvoiceLine.item:=$item.item
			$newInvoiceLine.amount:=$item.amount
			$newInvoiceLine.invoice:=$newInvoice
			//llamar a otras funciones específicas para validar la línea de factura
			$newInvoiceLine.save()
		End for each 
		$newInvoice.save()
		ds.validateTransaction()
	Catch
		ds.cancelTransaction()
		ds.logErrors(Last errors)
		$newInvoice:=Null
	End try
	return $newInvoice