Curso introductorio a Raptor.js con Node.js

Curso introductorio a
Raptor.js

• Introducción al entorno Node.js
• Formato CommonJS
• Estructura de paquetes y NPM
• Marco de trabajo Raptor.js
• Objetivo características e instalación
• Estructura de un proyecto Raptor.js
• Estructura de componentes
Sumario

• Manifiesto de instalación de un componente
• Clase principal del componente
• Middlewares y controladores
• Inyector de dependencias
• Gestión de eventos del core
• Introducción al ejemplo TaxiNode
Sumario

Proyecto Raptor
Nace en junio de 2014, como una idea para
crear tecnologías base para el desarrollo de
aplicaciones web, siguiendo estándares de
seguridad y de optimizar los procesos de
desarrollo….

Colaboradores
William Amed
GDAI Las Tunas
Jorge Carmenate
Geocom SA
Uruguay
Jorge Miralles
Mercado Libre
Uruguay
Roberto García
UIC Las Tunas
Pedro Abreu
GDAI Las Tunas
Ricardo Suárez
Productor Adriano DJ
Cuba

“Node.js es una plataforma construida encima del entorno
de ejecución javascript de Chrome para fácilmente
construir rápidas, escalables aplicaciones de red. Node.js
usa un modelo de E/S no bloqueante dirigido por eventos
que lo hace ligero y eficiente, perfecto para aplicaciones
data-intensive en tiempo real”

Node fue galardonado en 2012 con el
premio “Tecnología del Año”
por la revista InfoWorld

• Orientado a eventos asíncronos
• No existen bloqueos de proceso
• Ideal para construir aplicaciones de red
escalables
• Utiliza la especificación EICMAScript
Características

El NPM (Node Package Manager) es el gestor
de paquetes oficial para Node.js y proporciona
las herramientas necesarias para la
instalación de paquetes en proyecto de
Node.js
Gestor de paquetes

Al instalar Node.js es instalado además el
gestor de paquetes NPM y ambos pueden
ser verificados en la terminal de nuestro
equipo
Instalación

Hola mundo
Archivo hola.js ----
console.log("Hola mundo Node.js")

Hola mundo
En la terminal especificaremos el comando:

Node soporta e implementa el sistema que CommonJS define
para la gestión de módulos, lo cual es importante no sólo a la
hora de organizar el código sino a la hora de asegurar que se
ejecuta sin interferir en el código de los demás módulos
aislándolos unos de otros de tal manera que no haya conflicto
entre, por ejemplo, funciones o variables con el mismo nombre.
A esto se le conoce como scope isolation.
Formato CommonJS

1. Uso de la función require() para indicar que queremos
emplear una determinada librería pasándole el
identificador de la librería (su nombre) como parámetro.
Formato CommonJS

2. La existencia de la variable exports dentro de los
módulos. Esta variable es un objeto que es el único modo
posible que tiene un módulo de hacer públicas funciones
y demás objetos, añadiéndolas a exports conforme se
ejecuta el código de dicho módulo.
Formato CommonJS

3. La definición dentro de un módulo de la variable
module. Esta variable es un objeto con la propiedad
obligatoria id que identifica unívocamente al módulo y por
tanto, se obtiene de él el exports que interese al
desarrollador.
Formato CommonJS

Archivo circulo.js ----
Ejemplo CommonJS
var PI = 3.14;
module.exports.area = function (r) {
return PI * r * r;
};
module.exports.circumference = function (r) {
return 2 * PI * r;
};

Archivo hola.js ----
Ejemplo CommonJS
var circulo=require("./circulo");
var area=circulo.area(50);
console.log("El area es:",area)

Estructura de paquete
Un paquete de Node es definido a través de un
archivo package.json, además contará
opcionalmente con un directorio node_modules
en caso de contener dependencias.

package.json
El archivo package.json describe al paquete a través
de un conjunto de directivas de instalación, se
especificará de forma obligatoria los atributos name
y version.
En el directorio actual puede ser creado un paquete de forma
interactiva a través del comando.
npm init

Archivo package.json ----
package.json
{
"name": "mipaquete",
"version": "1.0.1",
"description": "una descripción",
"main": "index.js",
"author": "Jhon Doe",
"license": "MIT",
"dependencies": {
"fs-extra": "1.2.2"
}
}

node_modules
El directorio node_modules lo
encontraremos con frecuencia en los
paquetes de Node, en este se ubicarán
todas las dependencias especificadas en el
archivo package.json.

Instalación de un paquete
Uno de los comandos más utilizados en el gestor de
paquetes es sin duda install, que proporciona una
forma rápida de instalación de paquetes desde el
repositorio npmregistry.
npm install fs-extra -g
npm install fs-extra --save

Instalación de un paquete
-g esta directiva instalará en forma global el
paquete especificado.
--save instalará el paquete especificado en
el directorio node_modules del paquete que
invoca la operación de instalación.

Tiene capacidad de manejar un alto número de conexiones y
procesar un enorme número de operaciones de Entrada/Salida
muy rápidamente.
• Interfaces ligeros REST/JSON
• Aplicaciones monopágina
• Datos por streaming
• Comunicación
Resumen

Es un framework full stack para el desarrollo
de aplicaciones web, incluye componentes
que garantizan un marco de abstracción para
la seguridad y utilitarios que siguen el principio
de desarrollo ágil con baja carga cognitiva.

A principios de 2018 se crea la rama para
Node.js denominada Raptor.js y que apuesta
por el futuro de las tecnologías en el
desarrollo web, la serie 1 de Raptor.js es
lanzada ese mismo año.

• Reducir la carga cognitiva y costos de desarrollo
• Garantizar los procesos y modelos de seguridad
establecidos
• Componentes de comunicación para aplicaciones en
tiempo real
• Soporte a modelos de alta concurrencia de eventos
Objetivo

Arquitectura orientada componentes
Características

Componente de seguridad, implementación de un MCA
basado en estructuras
Características
- autenticación, autorización y auditoria.
- Extensión del modelo de control de acceso
basado en roles hacia un enfoque
estructurado.
- Granularidad en la gestión de privilegios,
se crea el concepto acciones.

Componente biométrico de reconocimiento de usuarios
Características

Componentes utilitarios (producción-desarrollo)
Características

Características
Componentes utilitarios (producción-desarrollo)

Raptor.js está disponible como paquete en el
npm y para la creación de un proyecto es
necesario la instalación de la herramienta de
desarrollo raptor-cli que te asistirá para este
propósito.
Instalación
npm install raptor-cli -g

El cli de Raptor.js es una herramienta utilitaria de
consola para ambientes de desarrollo, permite la
creación de proyectos Raptor.js-v2 así como la
ejecución en modo de desarrollo de la aplicación.
Herramienta raptor-cli
rap -h
rap create <nombre>
//versión del cli
//crear proyecto
rap run //ejecutar proyecto

Un proyecto es la base donde se desarrolla nuestra
aplicación, consta de la configuración y los
componentes creados.
Nuevo proyecto Raptor.js
options.json
options.prod.json
package.json
//componentes del directorio src
//desarrollo
//producción

Estructura del proyecto
options.json
options.prod.json
package.json //descripción del componente y dependencias
//configuración de desarrollo
//configuración de producción
config
public
src
run.app.js
bootstrap.js
//componentes con nuestro código fuente
//entrada de desarrollo
//entrada al core al framework
//directorio público, recursos web para JS, CSS
//contiene la configuración del proyecto

{
"mode": "development",
"database": {
"state": "on",
"options": {
"port": 3306,
"dialect": "mysql",
"host": "127.0.0.1"
},
"api": true,
"password": "root",
"user": "root",
"name": "raptorjs"
},
"port": 4440,
"socketio":{…},
"language":{…},
"secret": "3dfa5h2g$ae946e2gdi5cb%g*1#$5e25",
"proyectName": "RaptorJS"
}
Configuración (options.json)
Modo en que corre el proyecto
Esta configuración es utilizada
por el componente orm y
configura la conexión para el
ORM Sequelize
Puerto en que escuchará el proyecto

{
"mode": "development",
"database": {…},
"port": 4440,
"socketio":{…},
"language":{…},
"proyectName": "RaptorJS"
}
Llave secreta para la generación
de tokens de seguridad
Determina si la tecnología socket.io
estará activa
Nombre del proyecto

{
"database": {…},
"port": 4440,
"socketio": {…},
"language": {…},
"proyectName": "RaptorJS",
"scopes":["@raptorjs","@micope"],
"publish":{
"bootstrap":"dist",
"jquery":""
},
"maxEventListeners":80
}
Escanea en node_modules
los scopes para encontrar
componentes Raptor.js
Expone a través de express
los paquetes de node_modules
especificados. Se publica bajo
el prefijo /public
Cantidad máxima de susbcripciones
que soportará el core de Raptor.js,
por defecto el valor es 80.

Componente Raptor.js
DefaultController.js
package.json
//plantillas Ejs del componente
//contiene los modelos de nuestro componente
//repositorios del componente
Controllers
Models
Repositories
manifest.json
index.js
//recursos públicos a ser expuestos por express
//clase principal del componente
//manifiesto de instalación
//contiene el archivo language.json
//ejemplo de controlador
i18n
Resources
Views
Los componentes están ubicados en el directorio src en un agrupador

Manifiesto de instalación
{
"state": false,
"name": "TroodonNode",
"author":"William Amed - watamayo90@gmail.com",
"description":"Descripción del componente",
"version": "1.0.1",
"require":{
"RaptorNode":">=1.0.1"
}
}
Determina si el componente
estará activo
Nombre del componente, deberá
coincidir con el directorio que lo
contiene
El atributo require determina si este componente
dependerá en funcionamiento de otro
componente Raptor.js

'use strict';
/**
*
*
* @Route("/example")
*/
class exampleNode {
middleware(){
}
configure(R){
}
}
module.exports=exampleNode
Entrada principal index.js
Configurador de midlewares del
componente
Configura el componente en el
momento de su reconocimiento ante
el core de Raptor.js
Prefijo de ruta de este componente

Entrada principal index.js
El prefijo de ruta del componente sirve como forma de agrupación de
las rutas que se registren en este propio componente, si se establece
significa que todas las rutas declaradas en los controladores dentro
del componente tomarán como prefijo el establecido en esta clase.
Prefijo de ruta

Express y middlewares
Raptor.js utiliza Express como marco de aplicación web o marco de
servidor estándar para encargarse del manejo del direccionamiento
web y provee todas las funciones básicas del manejo del protocolo
http.
Express se basa en el patrón middleware para crear un stack que
encarga de interactuar con la petición actual.
Raptor.js configura todos estos conceptos por nosotros y solo
debemos preocuparnos de definir nuestros patrones de ruta.

middleware(express, router){
// Registro de un patrón de ruta directamente
// en el enrutador
router.all("/user/list",function(req,res,next){
res.send(“hola mundo”)
})
}
http://miproyecto.cu/user/list
Ruta definida
Responde “hola mundo”

middleware(express, router){
express.use(function(err,req,res,next){
/**
* Si se define el parámetro err
* el middleware es ejecutado cuando
* exista un error en los middlewares
* superiores del stack
*/
console.log(err)
})
}

Controladores
'use strict';
/**
* prefijo de ruta todas las definiciones en el controlador
*
*/
class MiControlador extends R.Controller {
configure() {
}
/**
*
* @Route("/holaruta",method="all")
*
*/
holaRuta(req, res, next) {
res.send('hola ruta')
}
}
module.exports = MiControlador;
Anotación Route define
un patrón de ruta
utilizado por express
Prefijo de ruta para todas
las acciones
Los parámetros req, res y
next con expuestos por
express

Controladores
'use strict';
/**
*
*
*/
class MiControlador extends R.Controller {
configure() {
}
/**
*
*
*/
holaRuta(req, res, next) {
}
}
module.exports = MiControlador;
http://localhost/example/holaruta

Inyector de dependencias
($injector)
Los objetos, clases y funciones utilitarias, son
registradas en el contenedor de dependencias del
inyector con el fin de hacerlos accesibles desde
cualquier parte de nuestra aplicación.
Su concepción estuvo basada en el popular inyector
propuesto por AngularJS aunque existen patrones bien
definidos sobre esta técnica.

($injector)
El core de Raptor.js configura el inyector a través del
objeto global $injector, significa que estará accesible
desde cualquier lugar y en cualquier momento de
ejecución del framework
var persona=new Persona();
$injector("ObjetoPersona",persona);

($injector)
Existen 2 formas fundamentales de consumir la instancia
registrada, directa y por inyección
Forma directa:
var persona=$injector("ObjetoPersona")
persona.nombre()

($injector)
Por inyección:
$injector.invoke(function(ObjetoPersona){
ObjetoPersona.nombre()
})
$injector.invokeLater(function(ObjetoPersona){
ObjetoPersona.nombre()
})

Resolución de dependencias
(clase principal del componente)
Raptor.js implementa internamente la resolución de
dependencias en los métodos configure y middleware
de la clase principal index del componente.
class exampleNode {
middleware(SecurityRegistry, Bio, ngPortalRegistry, router){
//Se pueden inyectar acá todas las dependencias
//registradas en el contenedor
router.post("/api/v2",function(){})
}

Resolución de dependencias
(Controladores)
Así como en cada acción de los controladores que
definan una ruta.
/**
* Pueden ser inyectadas las dependencias requeridas
* a continuación de req,res,next
*
*
*/
holaRuta(req, res, next, SecurityRegistry, Op, sequelize) {
/**
* Las inyecciones de dependecias Op, sequelize
* solo estarán disponibles si existe una conexión
* exitosa con
* una base de datos
*/
}

Dependencias por defecto
router: Referencia al enrutador de express
express: Referencia a la app express creada por Raptor.js
Events: Objeto para el registro de escuchas de eventos en
Raptor.js.
Options: Objeto que contiene la configuración establecida en
el archivo options.json.
Bundles: Objeto con la representación de todos los
componentes Raptor.js reconocidos por el core.

Gestión de eventos
El core de Raptor.js extiende de EventEmitter y permite la
subscripción a eventos lanzados por el core, a pesar de
esto es el objeto Events registrado en el contenedor de
dependencias el encargado de ofrecer una API para dicha
tarea.
Por regla general son utilizados en mayor parte en la
realización de introspección, cambio del comportamiento
por defecto del framework, inserción de middlewares en el
stack, etc.

Gestión de eventos
En el método configure de la clase principal de nuestro
componente podemos inyectar el objeto Events y
suscribirnos a eventos.
configure(R, Events){
Events.register({
'sendresponse':function(){
},
'session:config':function(){
}
})
}

Gestión de eventos
Teniendo en cuenta que el core de Raptor extiende de
EventEmitter podemos además enviar nuestros propios
eventos personalizados lanzados desde nuestros
componentes a través del uso de la función emit del core.
configure(R, Events){
Events.register({
'exampleNode.configured':function(param){
console.log(param)
}
})
R.emit("exampleNode.configured","hola mundo")
}

ViewPlugins
Permite la inyección de contenido en los hotpots
declarados en el sistema para determinados patrones de
ruta. Es un mecanismo útil en la realización de
introspección en la capa de presentación.
La funcionalidad de ViewPlugin puede ser encontrada
definida dentro del request de la petición actual, este
objeto contiene un grupo de funciones para el manejo de
este concepto.
req
.viewPlugin
.set('after_response_body','<script>alert("hola mundo")</script>')

Componentes utilitarios
@raptorjs/core, es el núcleo de la aplicación, contiene toda la
lógica arquitectónica del framework
@raptorjs/extjs, contiene las bibliotecas de extjs así como
herramientas para la compresión en tiempo real
@raptorjs/troodon, componente de seguridad, implementa los
procesos de seguridad
@raptorjs/bio, capa biométrica de reconocimiento de usuario
por patrón de tecleo
@raptorjs/orm, contiene la lógica de configuración del ORM
Sequelize

Componentes utilitarios
@raptorjs/ng-portal, implementa un portal basado en
AngularJS que puede ser configurado y utilizado como
portal de integración de funcionalidades

Ejemplo
Utilizaremos el ejemplo TaxiNode publicado en el blog
para crear un pequeño portal para visualizar nuestro
contenido

Ejemplo
http://localhost:4440/raptor

Ejemplo
Componente TaxiNode creado

Creando un ngPortal
configure(R, Events) {
}
Se añade el parámetro Events para
inyectar esta dependencia

Creando un ngPortal
Events.register({
})
}
Se invoca al método register para
crear una subscripción a eventos

Creando un ngPortal
Events.register({
'ioc:ngPortal.ready': $i.later(function() {
})
})
}
Escuchamos el evento de registro
en el contenedor de dependencias
para la clase ngPortal
$i es el atajo de $injector, later es el
atajo de invokeLater

Creando un ngPortal
Events.register({
'ioc:ngPortal.ready': $i.later(function(ngPortal,
ngPortalRegistry) {
})
})
}
Inyectamos la clase ngPortal y
ngPortalRegistry

Creando un ngPortal
Events.register({
ngPortalRegistry) {
var portal = new ngPortal('taxi');
})
})
}
Creamos un instancia de ngPortal

Creando un ngPortal
Events.register({
ngPortalRegistry) {
//Creamos una instancia de ngPortal
portal.config(function () {
this.viewPlugin('name', 'App Taxi')
})
})
Se configura un nombre en el punto
caliente name

Creando un ngPortal
Events.register({
ngPortalRegistry) {
//Creamos una instancia de ngPortal
portal.config(function () {
this.viewPlugin('name', 'App Taxi')
})
//Se adiciona en el registro el portal creado
ngPortalRegistry.set(portal);
})
Adicionamos el portal al registro
global de portales creados

Creando un ngPortal
http://localhost:4440/taxi/home

Curso introductorio a Raptor.js con Node.js

Más contenido relacionado

La actualidad más candente (19)

Similar a Curso introductorio a Raptor.js con Node.js (20)

Último (9)

Curso introductorio a Raptor.js con Node.js