Microservice (CRUD)

Command: yo codedesignplus:microservice microservice --is-crud

Este comando se utiliza para crear la estructura base de un nuevo microservicio que sigue el patrón CRUD (Crear, Leer, Actualizar y Eliminar) de forma automatizada. Está diseñado para escenarios donde las operaciones principales son la gestión de datos persistentes.

Prerrequisitos

Instalar Node.js y npm instalados.
Instalar Yeoman (npm install -g yo).
Instalar el generador codedesignplus:microservice.

Conceptos Clave

CRUD: Es un acrónimo que se refiere a las cuatro operaciones básicas que se pueden realizar sobre datos persistentes: Create (Crear), Read (Leer), Update (Actualizar) y Delete (Eliminar). Los microservicios CRUD se centran en estas operaciones.
Microservicio: Es una unidad de software autónoma y pequeña que realiza una función específica. En el contexto de un microservicio CRUD, esta función se centra en la gestión de datos.
Arquetipo: El arquetipo base CodeDesignPlus.Net.Microservice para la creación de microservicios en .NET, proporcionando una estructura de proyecto bien definida y buenas prácticas.
Diseño Basado en Dominio (DDD): Aunque el enfoque principal es CRUD, los principios de DDD se aplican en la estructura del microservicio para la organización de la lógica de negocio.

Sintaxis del Comando

El comando yo codedesignplus:microservice microservice --is-crud tiene la siguiente sintaxis:

Bash
PowerShell

yo codedesignplus:microservice microservice \
    --organization "<organization_name>" \
    --microservice "<microservice_name>" \
    --description  "<microservice_description>" \
    --contact-name "<contact_name>" \
    --contact-email "<contact_email>" \
    --vault "<vault_name>" \
    --is-crud \
    --aggregate "<aggregate_name>" \
    --enable-grpc \
    --enable-async-worker

yo codedesignplus:microservice microservice `
    --organization "<organization_name>" `
    --microservice "<microservice_name>" `
    --description "<microservice_description>" `
    --contact-name "<contact_name>" `
    --contact-email "<contact_email>" `
    --vault "<vault_name>" `
    --is-crud `
    --aggregate "<aggregate_name>" `
    --enable-grpc `
    --enable-async-worker

`--organization`

Tipo: string
Obligatorio: Sí
Descripción: El nombre de la organización. Se utiliza para la organización del código y la gestión de los namespaces.

`--microservice`

Tipo: string
Obligatorio: Sí
Descripción: El nombre del microservicio que se va a crear.

`--description`

Tipo: string
Obligatorio: Sí
Descripción: Una descripción detallada del microservicio que proporciona un contexto claro sobre su propósito.

`--contact-name`

Tipo: string
Obligatorio: Sí
Descripción: Nombre de la persona de contacto responsable del microservicio.

`--contact-email`

Tipo: string
Obligatorio: Sí
Descripción: Email de contacto de la persona responsable.

`--vault`

Tipo: string
Obligatorio: Sí
Descripción: El nombre del vault para la gestión de secretos y configuraciones.

`--is-crud`

Tipo: boolean
Obligatorio: No
Descripción: Indica que el microservicio será un CRUD, generando la estructura básica para operaciones de gestión de datos.

`--aggregate`

Tipo: string
Obligatorio: No
Descripción: El nombre del agregado raíz del microservicio, esencial para la organización del dominio.

`--enable-grpc`

Tipo: boolean
Obligatorio: No
Descripción: Habilita la API gRPC para el microservicio, que ofrece un protocolo de comunicación de alto rendimiento.

`--enable-async-worker`

Tipo: boolean
Obligatorio: No
Descripción: Habilita un worker asíncrono para el manejo de eventos y tareas en segundo plano, mejorando la escalabilidad.

Ejemplos de Uso

Este ejemplo crea un microservicio CRUD llamado users para gestionar usuarios en la plataforma de la organización acme.

Bash
PowerShell

yo codedesignplus:microservice microservice \
    --organization "Acme" \
    --microservice "User" \
    --description "Microservicio para gestionar usuarios de la plataforma." \
    --contact-name "Jane Doe" \
    --contact-email "jane.doe@example.com" \
    --vault "vault-acme" \
    --is-crud \
    --aggregate "User" \
    --enable-grpc \
    --enable-async-worker

yo codedesignplus:microservice microservice `
    --organization "Acme" `
    --microservice "User" `
    --description "Microservicio para gestionar usuarios de la plataforma." `
    --contact-name "Jane Doe" `
    --contact-email "jane.doe@example.com" `
    --vault "vault-acme" `
    --is-crud `
    --aggregate "User" `
    --enable-grpc `
    --enable-async-worker

Salida del comando en consola

Tras ejecutar el comando, se generará la estructura base del microservicio CRUD users en la organización acme, con la siguiente salida en consola:

Directorios y Archivos Generados

Si exploramos el microservicio con VS Code, veremos la estructura de directorios y archivos generados:

Explorador de Archivos
Árbol de Archivos

Resultados de la Ejecución

La ejecución de este comando con los parámetros proporcionados generará la estructura base de un microservicio CRUD en la organización acme con el nombre users. El microservicio estará listo para ser personalizado y ampliado según las necesidades del proyecto.

Pero para comprender mejor el impacto de cada una de las opciones, veamos los resultados de la ejecución del comando:

`--organization`

Flag: --organization "acme"

Este parámetro establece el nombre de la organización a nivel de la solución (.sln) y para cada uno de los proyectos (.csproj) generados.
El valor del parametro tambien se refleja en los namespaces de los proyectos generados.
Por ultimo, tambien se ve reflejado en cada uno de los archivos appsettings.json de los proyectos de infraestructura en la propiedad Business.

`--microservice`

Flag: --microservice "users"

Este parámetro establece el nombre del microservicio a nivel de la solución (.sln) y para cada uno de los proyectos (.csproj) generados.
El valor del parametro tambien se refleja en los namespaces de los proyectos generados.
Tambien es usado en los archivos appsettings.json de los proyectos de infraestructura en multiples propiedades.
El nombre del microservicio tambien se refleja en el archivo config.sh encargado de la configuración de Vault.

`--description`

Flag: --description "Microservicio para gestionar usuarios de la plataforma."

Este parámetro establece una descripción detallada del microservicio que se refleja en el archivo appsettings.json de los proyectos de infraestructura.

`--contact-name`

Flag: --contact-name "Jane Doe"

Este parámetro establece el nombre de la persona de contacto responsable del microservicio, que se refleja en el archivo appsettings.json de los proyectos de infraestructura.

`--contact-email`

Flag: --contact-email "jane.doe@example.com"

Este parámetro establece el email de contacto de la persona responsable del microservicio, que se refleja en el archivo appsettings.json de los proyectos de infraestructura.

`--vault`

Flag: --vault "vault-acme"

Este parámetro establece el nombre del vault para la gestión de secretos y configuraciones, que se refleja en el archivo config.sh encargado de la configuración de Vault.
El valor del parametro tambien se refleja en los archivos appsettings.json de los proyectos de infraestructura en la propiedad Vault.

`--is-crud`

Flag: --is-crud

Este flag indica que el microservicio será un CRUD, generando la estructura básica para operaciones de gestión de datos con base en el agregado raíz especificado.

A nivel de la capa de dominio, se generan los archivos (Domain Events and Repositories) necesarios para el agregado raíz user.
A nivel de la capa de aplicación, se generan los archivos (Commands, Queries and DTOs) necesarios para el agregado raíz user.
A nivel de la capa de infraestructura, se generan los archivos (Repositories) necesarios para el agregado raíz user.

`--aggregate`

Flag: --aggregate "user"

Este parámetro establece el nombre del agregado raíz del microservicio, que se refleja en los archivos generados en la capa de dominio.

`--enable-grpc`

Flag: --enable-grpc

Este flag habilita la API gRPC para el microservicio, generando el servicio con base en el agregado raíz user.

`--enable-async-worker`

Flag: --enable-async-worker

Este flag habilita un worker asíncrono para el manejo de eventos y tareas en segundo plano, mejorando la escalabilidad del microservicio.

Consideraciones Adicionales

Utilizar el flag --is-crud es crucial para generar un microservicio siguiendo el patrón CRUD.
Asegúrate de proporcionar una descripción clara para tu microservicio.
Define bien tu agregado raíz (--aggregate) para organizar adecuadamente tu dominio.
Considera habilitar gRPC y Workers (--enable-grpc, --enable-async-worker) según las necesidades de tu proyecto.
Comprender el impacto de cada parámetro te ayudará a personalizar, extender, solucionar problemas y mantener tu microservicio de forma efectiva.

Enlaces Relacionados

Conclusión

El comando yo codedesignplus:microservice microservice --is-crud proporciona una forma rápida y automatizada de generar la estructura de un microservicio CRUD listo para ser personalizado. Utiliza las opciones disponibles para adaptar el microservicio a las necesidades específicas de tu proyecto.