CL.COMMON 1.0.8

Acerca de CL.COMMON

Ofrece una serie de funciones a modo de utilería las cuales nos permiten realizar flujos que son habituales en todos los proyectos, como mapeo de genéricos, logs entre otros.

¿Qué resuelve?

La creación repetitiva de código de uso común a través de los distintos proyectos de los clientes y que a su vez en cada implementación presentan la posibilidad de no replicar el código con exactitud generando errores.

Rutinas de Core

GetConfigKeyValue:System.Data.String

• System.Reflection.MethodBase _invoker:Usado para determinar que función ha llamado este método
• System.String _configKey: Nombre de la llave en el config

Usado para acceder a configuraciones del web.config.

Ejemplo:

// Obtiene la llave del Web.config llamanda 'spGetNameDbObjectApp'
System.String valor = CL.COMMON.Core.GetConfigKeyValue(System.Reflection.MethodBase.GetCurrentMethod(), "spGetNameDbObjectApp");

FileToBase64:System.String

• System.String _filePath: Ruta física del archivo

Usado para convertir un archivo en base64

Ejemplo:

// Convirtiendo un archivo a base64 System.String base64pdf = CL.COMMON.Core.FileToBase64("C:\mipdf.pdf");

GetExceptionMessage:System.String

• System.Exception _exception: Objeto con la excepción a mapear

Obiene el detalle de la excepción y la retorna en un System.String.

Ejemplo:

// Mapeando la excepcion a un System.String
System.String message = CL.COMMON.Core.GetExceptionMessage(exception)

InflateObject:T

T:new(): Objeto que va a ser llenado con el System.Data.DataTable

• System.Data.DataTable _dt: Origen de datos que van a ser cargados en T

Los registros de un query cargados en System.Data.DataTable serán cargados en el objeto de tipo T.

Ejemplo:

// Obtiene el modelo retornado por el datable
T oT = CL.COMMON.Core.InflateObject<T>(oDataTable);

InflateList:System.Collections.Generic.List<T>

T:new(): Objeto que va a ser llenado con el System.Data.DataTable

• System.Data.DataTable _dt: Origen de datos que van a ser cargados en T

Los registros de un query serán mapeados a una lista de tipo T.

Ejemplo:

// Convirtiendo los registros de un datable a una lista de tipo T.
System.Collections.Generic.List<T> tList = CL.COMMON.Core.InflateList<T>(oDataTable);

ParametersBuilder:System.Collections.Generic.List<System.String>

T:new(): Objeto que va a ser mapeado a un query.

U:CL.STRUCTURES.INTERFACES.ICLMaster: I

• System.String _invoker: Usado para determinar que métod ha invocado es función y podar dar el error respectivo en caso de...
• T _object: Objeto del cual se van a mapear las propieadas a una lista.
• System.String[] _toIgnore: Lista de propiedades a incluir/excluir según el tipo de inteface que indiquemos.

Convierte las propieades de un objeto a una lista de string.

// Convirtiendo las propiedades de un objeto a una lista.
System.String[] properties = CL.COMMON.Core.ParametersBuilder<T, V>(System.Reflection.MethodBase.GetCurrentMethod().Name, _object, _toIgnore)

Rutinas de LogManager

Esta funcionalidad requiere de ciertas configuraciones iniciales, como por ejemplo agregar una llave en el web.config con el nombre LogPath, para poder obtener la ruta donde se van a escribir los logs.
De manera opcional se puede escoger el intervalo de generación de archivos, por defecto es diario, pero puede ser cambiado agregando la propiedad SeriLogRollingInterval en en el webconfig. Posibles valores(Infinite, Year, Month, Day, Hour, Minute).

Enter:void

Agrega un enter los logs almacenados hasta el momento.

Ejemplo:

// Dando un enter
CL.COMMON.LogManager.Enter();

Record:void

• System.String _message: Mesage que será escrito un medio externo.

Agrega un mensaje contexto actual del log al final de este.

Tiene una sobre carga de un parámetro el cual nos permite indicar el nivel de tabs del mensaje recién registrado.

Ejemplo:

// Agregando un mensaje de saludo con un nivel de tab
CL.COMMON.LogManger.Record("Esto es un mensaje de prueba", CL.STRUCTURES.TabLevel.One);

Commit:void

• System.String _httpMethod: La idea es separlos por el verbo http, pero en caso de quere otra clasificacion solo mandarla en el System.String.
• System.String _user("service"): Usuario al que se le asignaran los logs, por defecto es service

Ejemplo

// Guardando los logs a un medio externo
// Recomendamos obtener estos parámetros del pipe actual
CL.COMMON.LogManager.Commit("GET", "eaguilar@clavisco.com");

Código completo de implementación

Este código debe ponerse en el controlador o el llamado de un servicio para que se haga el commit al final del proceso. Y ya podemos llamar a CL.COMMON.LogManger.Record en cualquier capa que ocupemos.
System.String endPoint = Request?.RequestUri?.AbsolutePath;
System.String queryParams = Request?.RequestUri?.Query;
// Esta serialización es opcional, porque solo aplica a los post
System.String model = JsonConvert.SerializeObject(userEmail);
try {
CL.COMMON.LogManager.Record("Probando mensaje en el try.");
}
catch(System.Exception exception) {
CL.COMMON.LogManger.Record(CL.COMMON.Core.GetExceptionMessage(exception));
}
finally {
// El objeto Request es obtenido en el controlador
CL.COMMON.LogManager.Enter();
// Guardar el model es opcional, porque solo aplica en post
CL.COMMON.LogManager.Record(model);
CL.COMMON.LogManager.Commit(Request?.Method.ToString(), System.String.Concat(endPoint,queryParams, " | " , Common.GetCurrentPipeEmail()));
}

Clavis Consultores ©