En esta sección se describen los principales elementos que conforman a un generador, utilizando la arquitectura de implementación kukulkan.
Antes de comenzar, se describe la nomenclatura utilizada para el nombrado de los diferentes componentes que se utilizan en la presente arquitectura de referencia, así como también se mostrarán los usos comunes y sus relaciones.
Cada nombre, referenciado aquí, está compuesto de dos partes a saber:
<Name> <LayerComponent>
en donde:
<Name>: es el nombre del componente que se desea instanciar y su definición dependerá del diseñador e implementador del componente.
<LayerComponent>: es el nombre que hace referencia a los componentes que conforman a una capa arquitectónica o subsistema. Este elemento no se puede modificar, se encuentra predefinido y es un estándar utilizado a lo largo de todo el desarrollo de componente. En cada capa se tendrá su propio nombrado y deberá de respetarse.
En lo que resta, nos enfocaremos en la definición de cada capa del componente, los elementos que la constituyen y los lineamientos a los que nos tendremos que apegarnos. Por simplicidad, se omite la extensión de los archivos a utilizar.
La arquitectura de un generador, estará dividida en dos niveles de representación de la misma: arquitectura lógica y arquitectura física. En lo que resta, nos vamos a enfocar en la descripción detallada de cada una de estas representaciones.
En esta vista, se exponen dos modelos para la representación de la arquitectura lógica del generador: modelo lógico del generador y modelo de plantillas del generador. Para ambas representaciones, se utilizará un diagrama de paquetes y clases, en el que se representarán los principales componentes que conforman al componente. La separación de la representación en dos modelos, es necesaria para enfatizar el modelo de plantillas que utiliza un generador y que está, se encuentra separa de la lógica que utiliza dichas plantillas.
La estructura del código para el generador, se representa en la siguiente imagen:
/plugin-resources.png
La estructura en dónde se guardan las plantillas de un generador, muestra en la siguiente imagen:
La arquitectura física del generador, se representa con una vista de carpetas, misma que representa la estructura de un proyecto estándar:
├───.mvn
│ └───wrapper
└───src
├───main
│ ├───java
│ │ └───mx
│ │ └───infotec
│ │ └───dads
│ │ └───kukulkan
│ │ └───shell
│ │ ├───commands
│ │ ├───config
│ │ ├───generator
│ │ ├───template
│ │ └───util
│ └───resources
│ └───templates
│ └───<templateNameRoot>
└───test
└───resources
A continuación se describe a cada una de las capas antes expuestas.
La capa comandos contiene la implementación de los comandos que se instrumentarán en el componente y qué serán utilizados a través de la shell de kukulkan. Kukulkan está inspirado en el marco de trabajo de Spring Shell. Para mayor información sobre la implementación de un comando, se puede consultar la documentación de Spring Shell(https://docs.spring.io/spring-shell/docs/current-SNAPSHOT/reference/htmlsingle).
Los principales elementos que están contenidos en esta capa son los siguientes:
- <Name>Command
- <Name>Args
El componente <Name>Command contiene toda la implementación de un comando y los argumentos que éste recibe están definidos y encapsulados dentro del componente <Name>Args.
A continuación, se describen los lineamientos a los que está sujeta esta capa: Lineamientos para el componente <Name>Command:
- deberá de ser decorada a través de la anotación
@ShellComponent - deberá de extender a la clase
mx.infotec.dads.kukulkan.shell.commands.AbstractCommand - deberá de tener una propiedad que le permita generar mensajes de log y deberá de ser de la siguiente manera: private static final Logger LOGGER = LoggerFactory.getLogger(Command.class);
- deberá de utilizar la clase “<Name>Generator” a través de la anotación de
@autowired. - deberá de tener al menos un método que implemente un comando.
- en caso de utilizar el componente Args, deberá der utilizado en el contexto de la definición del método.
Lineamientos para el componente <Name>Args:
- deberá de implementar a la interfaz “Serializable”.
- deberá de tener al menos la siguiente propiedad:
@Parameter
private List<String> parameters = new ArrayList<>();- deberá de sobre escribir el método
toString(), de tal manera que regrese información sobre los parámetros que éste contiene.
La capa commands contiene la implementación de un comando en el shell, utilizando el api de spring shell
En esta capa se deberán de agregar todas las clases de configuración utilizadas por spring-configuration
La capa generator contiene la implementación propia de un generador.
Los principales elementos que están contenidos en esta capa son los siguientes:
- <Name>Generator
- <Name>Context
A continuación, se describen los lineamientos a los que está sujeta esta capa:
- Deberá de ser decorada a través de la anotación
@GeneratorComponent - Deberá de extender a la clase
mx.infotec.dads.kukulkan.metamodel.generator.Generator - Deberá de tener una propiedad que le permita generar mensajes de log y deberá de ser de la siguiente manera:
private static final Logger LOGGER = LoggerFactory.getLogger(<Name>Generator.class);- deberá de extender a la clase
mx.infotec.dads.kukulkan.metamodel.context.BaseContext. - deberá de sobreescribir el método
toString()que regrese un texto representativo del elemento de contexto.
En esta capa se agregarán los componentes con
En esta capa se deberán de agregar todos los componetes que sean necesarios para manejar los archivos template.