Arquetipos Maven

Introducción

Un arquetipo Maven es un toolkit que define la plantilla de un proyecto Maven. Los arquetipos Maven proporcionan a los desarrolladores Java los medios para generar versiones parametrizadas de la plantilla del proyecto de manera estandarizada.

Catalyst proporciona arquetipos Maven predefinidos para crear funciones Serverless de los tipos Basic I/O y Advanced I/O. Estos arquetipos se listarán desde el Repositorio Central de Maven. Con estos arquetipos, simplemente puedes proporcionar valores de entrada con los detalles de la función, y estos crearán e inicializarán la función en la estructura estándar e incluirán las dependencias requeridas en el directorio del proyecto Maven. Puedes agregar múltiples funciones de esta manera en directorios POM individuales.

Debes recordar los siguientes puntos sobre la creación de funciones con los arquetipos Maven:

• Cuando inicializas una función desde el CLI, se te requerirá inicializar el proyecto primero o agregar la función en un directorio de proyecto de Catalyst existente. En el caso de Maven, no podrás inicializar un proyecto por separado. Puedes crear la función directamente.

• La función que crees con un arquetipo se creará en la carpeta de destino que selecciones, como se explica en la siguiente sección.

• Puedes asociar una función que crees con el arquetipo a un proyecto existente de tu cuenta remota configurando su Project ID en el archivo de configuración Maven pom.xml que se discute en una sección posterior. También necesitarás agregar el Org ID de tu organización de Catalyst en este archivo.

• No podrás crear funciones de ningún otro tipo además de Basic I/O y Advanced I/O, ni de ningún otro stack, ni el componente client a través de las herramientas Maven. Necesitarás utilizar el CLI para inicializar estos recursos en tu entorno local.

Crear una función Basic I/O o Advanced I/O con los arquetipos

En este documento de ayuda, cubrimos los pasos para trabajar con las herramientas Maven de Catalyst usando el ejemplo del IDE VS Code. Algunos detalles pueden variar según el IDE que uses.

Puedes crear una función Basic I/O o Advanced I/O de la siguiente manera:

1. Crea un nuevo proyecto Maven en tu IDE. Dependiendo del IDE que uses, los pasos pueden variar. También puedes convertir un proyecto existente a Maven, según tu IDE.

   Para VS Code, haz clic en el ícono + bajo Maven para crear un nuevo proyecto Maven.

2. Escribe “com.zoho.catalyst” en la barra de búsqueda de arquetipos. Selecciona uno de los siguientes según el tipo de función que desees crear:

• catalyst-archetype-basicio: Para crear una función Basic I/O
• catalyst-archetype-advancedio: Para crear una función Advanced I/O con Catalyst SDK
• catalyst-archetype-advancedio-basic: Para crear una función Advanced I/O sin Catalyst SDK

3. Selecciona la versión del arquetipo que elijas. Se recomienda seleccionar la versión más reciente.

4. Ingresa un group ID para el proyecto. Este ID identifica de forma única tu proyecto Maven. Puedes presionar Enter para completarlo con el valor predeterminado.

5. Ingresa un artifact ID para el proyecto. Este es el nombre del JAR sin versión. Puedes presionar Enter para completarlo con el valor predeterminado.

6. Selecciona una carpeta de destino para guardar tu proyecto Maven.

7. Se te solicitarán algunas entradas en la terminal. Presiona Enter después de cada entrada. También puedes presionar directamente Enter sin ingresar un valor para enviar el valor predeterminado.

   • Versión del SNAPSHOT del archivo JAR de salida
   • Nombre del paquete Maven
   • El appName o el nombre de referencia de Catalyst de la función Java
   • Nombre de la clase principal de la función
   • El project ID del proyecto con el que se asociará esta función
   • El org ID de tu organización de Catalyst a la que pertenece el proyecto

8. Confirma la configuración de propiedades de tu proyecto Maven ingresando “Y” y presionando Enter.

La función se creará en tu proyecto Maven con la estructura de directorios como se muestra a continuación.

Cuando inicializas una función Java desde el CLI, la función se crea con el archivo de configuración de proyecto catalyst.json en la raíz del proyecto, los archivos JAR del Catalyst Java SDK en la raíz de la función, así como con otras dependencias del proyecto. Crear una función usando un arquetipo Maven de Catalyst no incluirá los archivos del Java SDK ni ninguna de las dependencias del proyecto en estos directorios.

El directorio de la función contendrá en cambio los directorios de origen y destino por separado, y además incluirá pom.xml específico del entorno Maven. El archivo principal de la función Java también se creará con el código predeterminado según el tipo de función, y el archivo catalyst-config.json se creará y configurará automáticamente.