loading...
Cover image for Nodejs Design Pattern

Nodejs Design Pattern

damxipo profile image Damian Cipolat ・8 min read

Nodejs-Design-Pattern

"Este repositorio esta pensado para que sea más como un resumen de contenidos que alojar proyectos de codígo."

Pondre ejemplos base de cada patron y agregados por mi.

Lista de patrones:

La forma de escribir estos patrones de diseño no es igual que en JAVA y C#, pero la escencia es la misma, es es debido a que en este lenguaje predominan más los conceptos de la programación funcional que de la programación orientada a objetos.

Voy adaptar los ejemplos de codigo js del libro al estandar ES6.

Factory:

Una fabrica nos permite separarm la creación dew un objeto de su implementación, esencialmente, la fabrica encapsula la creación de una nueva instancia, dandonos más flexibilidad y control en la manera de que hacemos esto.

Un ejemplo base es el siguiente, para ver otros ir a factory.js:


class person{

    constructor(name,surname,age,sex){

      this.name = name;
      this.surname = surname;
      this.age = age;
      this.sex = sex;

    }

}

class personFactory{

   constructor(name,surname,age,sex){

      this.name    = null;
      this.surname = null;
      this.age = null;
      this.sex = null;

    }

    setName(name){
        this.name = name;
    }

    setSurname(surname){
        this.surname = surname;
    }

    setAge(age){
        this.age = age;
    }    

    setSex(sex){
        this.sex = sex;
    }

    build(){

        return new person(this.name,this.surname,this.age,this.sex);

    }

}

let fabrica = new personFactory();
fabrica.setName('Damián');
fabrica.setSurname('Cipolat');
fabrica.setAge(30);
fabrica.setSex('M');

let damian = fabrica.build();

console.log(damian);

Proxy:

Un proxy es un objeto que controla el acceso a otro llamado sujeto.
El proxy y el sujeto llamado tienen una interaz identica y estos nos permite trabajar trasparentemente con el,
intercerpta todas o algunas operaciones que se pretenden ejecutar al objeto sujeto.

Podemos considerar usar proxy para estos ejemplos:

  • Validación de datos: El proxy valida la entrada antes de enviarla al sujeto.
  • Seguridad: El proxy verifica que el cliente este autorizado a realizar una operación al sujeto antes de pasarselo.
  • Cache: El proxy mantiene una cache interna de las operaciones ejecutadas en el sujeto, la operación es ejecutada si no se encuentra en la cache.
  • Lazy initialization: Si la creación del sujeto es muy complicada, el proxy puede frenar esto solo cuando es necesario.
  • Logeo: El proxy intercepta la invocación a metodos del sujeto y graba los parametros de entrada y las salidas.
  • Objetos remotos: El proxy puede tomar el objeto que esta ubicado remotamente y lo hace aparecer como si fuera local.

Un ejemplo base es el siguiente, para ver otros ir a proxy.js:


class subject{

  hello(){
    return 'hello';
  }

  goodbye(){
    return 'Goodbye people!';
  }

}

class Proxy(subject){

  constructor(subject){
    this.subject = subject;
  }

  hello(){
    return this.subject.hello()+' world!';
  }

  goodbye(){
    return this.subject.goodbye();
  }

}

let tmpsubj = new subject();
let proxy   = new Proxy(tmpsubj);

console.log(proxy.hello());
console.log(proxy.goodbye());

Decorator:

Decorator es un patron estructural, consiste en aumentar dinamicamente el comportamiento de un objeto existente.
Es diferente de la herencia claisca, por que el comportamiento no es agregado a todos los objetos de la misma clase.

La implementación es muy similar al patron proxy, pero en lugar de mejorar o modificar el comportamiento de la interfaz existente del objeto, este incrementea con nuevas funcionaliodades.

Un ejemplo base es el siguiente, para ver otros ir a decorator.js:

class person(){

  hello(){
    return 'hello world';
  }

  greetings(){
    return 'greetings people';
  }

}

class personDecorator{

  constructor(component){
    this.component = component;
  }

  hello(){
    return this.component.hello();
  }

  greetings(){
    return this.component.greetings();
  }

  jump(){
    return this.component.hello() + this.component.greetings();
  }

}

let damian      = new person();
let decorPeople = new personDecorator(damian);

damian.hello();
damian.greetings();

console.log(damian.jump());

Adapter:

El patron adaptador nos permite acceder a la funcionalidad de un objeto que usa una interfaz diferente.
Como el nombre nos dice adapta al objeto que usa una interfaz distinta, para que podamos usarlo con una misma interfaz.

Un ejemplo base es el siguiente, para ver otros ir a adapter.js:

//Interfaz antigua
class shipping{
  request(zipStart, zipEnd, weight)=>{        
        return "$49.75";
  }
}

//Interfaz nueva.
class AdvancedShipping() {
    login(credentials){ /* ... */ };
    setStart(start){ /* ... */ };
    setDestination(destination) { /* ... */ };
    calculate(weight) { return "$39.50"; };
}

//Adaptador 
class ShippingAdapter(credentials) {

  constructor(){
    this.shipping = new AdvancedShipping();  
    this.shipping.login(credentials);
  }

  request(zipStart, zipEnd, weight) {    
    this.shipping.setStart(zipStart);
    this.shipping.setDestination(zipEnd);

    return this.shipping.calculate(weight);
  }

}

let credentials = {token: "30a8-6ee1"};
let adapter     = new ShippingAdapter(credentials);
let cost        = adapter.request("78701", "10010", "2 lbs"); 

console.log(cost);

Strategy:

El patron strategy permite encapsular un algoritmo en una clase, los cuales tienen la misma interfaz y son
intercambiables según la situacion. Podemos definir una familia de algormitmos encapsulados en un objeto.

Un ejemplo base es el siguiente, para ver otros ir a strategy.js:


class alumnHard{

  constructor(){
    this.iq = 90;
    this.studyPower = 100;
  }

  studyStat(){
    return this.iq+this.studyPower;
  }

}

class alumnLazy{
  constructor(){
    this.iq = 20;
    this.studyPower = 50;
    this.funLevelr  = 90;
  }

  studyStat(){
    return (this.iq+this.studyPower)-this.funLevel;
  }
}

class test{  
  constructor(){
    this.alumn = null;
  }

  setAlumn(alumn){
    this.alumn = alumn;
  }

  make(){
    this.alumn.study();
  }
}

let mathTest = new test();

mathTest.setAlumn(new alumnLazy());
mathTest.make();

mathTest.setAlumn(new alumnHard());
mathTest.make();

State:

El patron state es una variacón del patron strategy, donde los cambios dependen del estado y hay un algoritmo encapsulado
que es usando en cada estado.

Un ejemplo base es el siguiente, para ver otros ir a state.js:

const OfflineState = require('./offlineState');
const OnlineState  = require('./onlineState');

const FailsafeSocket =(options)=>{ 
   this.options = options;
   this.queue = [];
   this.currentState = null;
   this.socket = null;
   this.states = {
   offline: new OfflineState(this),
   online: new OnlineState(this)
   }

  this.changeState('offline');

}

FailsafeSocket.prototype.changeState = (state)=>{

 console.log('Activating state: ' + state);
 this.currentState = this.states[state];
 this.currentState.activate();
}

FailsafeSocket.prototype.send = (data)=>{
 this.currentState.send(data);
}

exports default (options)=>{
  return new FailsafeSocket(options);
}

Template:

El patron template consiste en definir una clase abstracta que representa el esquelete de un algoritmo donde alguno
de sus pasos no son definidos, las subclases que lo hereden implementaran estos pasos sin definir.

Un ejemplo base es el siguiente, para ver otros ir a template.js:

var fs = require('fs');
var objectPath = require('object-path');

class ConfigTemplate{

  read(file)=>{
   console.log('Deserializing from ' + file);
   this.data = this._deserialize(fs.readFileSync(file, 'utf-8'));
  }

  save(file){
   console.log('Serializing to ' + file);
   fs.writeFileSync(file, this._serialize(this.data));    
  }

  get(path){
    return objectPath.get(this.data, path);
  }

  set(path, value){
    return objectPath.set(this.data, path, value);   
  }

  _serialize(){
    throw new Error('_serialize() must be implemented');   
  }

  _deserialize(){
     throw new Error('_deserialize() must be implemented');
 }

}

export default ConfigTemplate;

Middleware:

El patron consiste en definir una lista de funciones, en las que se define un pipe, en que la salida de una función es la entrada de la siguiente.

Un ejemplo base es el siguiente, para ver otros ir a middleware.js:

class product{
  constructor(country,price,type){
    this.country = country;
    this.prices  = price;
    this.type    = type;
  }
}

const totalTax = 0;

const taxOrigin = (product) =>{

  if (product.country=='ARG')
    totalTax += 100;
  else
    totalTax += 300;

}

const taxPrices = (product) =>{

  if (product.prices>100)
    totalTax += 80;
  else
    totalTax += 200;

}

const taxType = (product)=>{

  if (product.type=='ELECTRO')
    totalTax += 80;

  if (product.type=='FOOD')
    totalTax += 280;

  if (product.type=='DRINKS')
    totalTax += 580;

}

let articles = [new product('ARG',100,'ELECTRO'),
                new product('USA',400,'FOOD'),
                new product('EUA',40,'DRINKS')];

let functions = [taxOrigin,taxPrices,taxType];

articles.forEach((article)=>{

  functions.forEach((funcCalc)=>{
    totalTax += funcCalc(article);
  });

});

Command:

En su mayor definición genérica, podemos considerar un comando como cualquier objeto que encapsula todo el
información necesaria para realizar una acción en un momento posterior. Entonces, en lugar de invocar un método o una función directamente, creamos un objeto que representa la intención de realizar tal invocación; será responsabilidad de otro componente
materializar la intención, transformándola en una acción real.

Un ejemplo base es el siguiente, para ver otros ir a command.js:


const add=(x, y)=> { return x + y; }
const sub=(x, y)=> { return x - y; }
const mul=(x, y)=> { return x * y; }
const div=(x, y)=> { return x / y; }

const Command = (execute, undo, value)=> {
    this.execute = execute;
    this.undo = undo;
    this.value = value;
}

const AddCommand = (value)=>{
    return new Command(add, sub, value);
};

const SubCommand = (value)=>{
    return new Command(sub, add, value);
};

const MulCommand =  (value)=> {
    return new Command(mul, div, value);
};

const DivCommand =  (value)=> {
    return new Command(div, mul, value);
};

const Calculator = function () {
    let current = 0;
    let commands = [];

    const action=(command)=> {
        var name = command.execute.toString().substr(9, 3);
        return name.charAt(0).toUpperCase() + name.slice(1);
    }

    return {
        execute: function (command) {
            current = command.execute(current, command.value);
            commands.push(command);
            log.add(action(command) + ": " + command.value);
        },

        undo: function () {
            var command = commands.pop();
            current = command.undo(current, command.value);
            log.add("Undo " + action(command) + ": " + command.value);
        },

        getCurrentValue: function () {
            return current;
        }
    }
}



function run() {

    var calculator = new Calculator();

    calculator.execute(new AddCommand(100));
    calculator.execute(new SubCommand(24));
    calculator.execute(new MulCommand(6));
    calculator.execute(new DivCommand(2));

    calculator.undo();
    calculator.undo();

}

Singleton:

El Singleton es quizás el más sencillo de los patrones que se presentan en el catálogo del GoF (disponible en el libro Patrones de Diseño y analizado previamente en "Patrones y Antipatrones: una introducción"). Es también uno de los patrones más conocidos y utilizados. Su propósito es asegurar que sólo exista una instancia de una clase.

En nodejs los modulos pueden considerarse también como implementaciones del patron singleton.

Un ejemplo base es el siguiente, para ver otros ir a singleton.js:

exports = module.exports = (function () {

  var instance;

  function init() {
    return {

      extend: function extend(extension, obj){
        for (var key in extension){
          obj[key] = extension[key];
        }
      }
    };
  };

  return {

    getInstance: function () {
      if (!instance) {
        instance = init();
      }
      return instance;
    }
  };
})();

Universal:

En Node.js, sabemos perfectamente que los módulos CommonJS son los predeterminados
mecanismo para establecer dependencias entre componentes. La situación en
el espacio del navegador lamentablemente está mucho más fragmentado:

  • Es posible que tengamos un entorno sin ningún sistema de módulos, que significa que los globales son el mecanismo principal para acceder a otros módulos.

  • Es posible que tengamos un entorno basado en un Asincrónico Cargador de definición de módulo (AMD), como por ejemplo, RequireJS
    (http://requirejs.org)

  • Es posible que tengamoszun entorno que abstraiga el sistema del módulo CommonJS.

Afortunadamente, hay un conjunto de patrones llamado Universal Module Definition (UMD) que puede ayudarnos a abstraer nuestro código del sistema de módulos utilizado en el entorno.

Un ejemplo base es el siguiente, para ver otros ir a universal.js:

(function(root, factory) { //[1]
 if(typeof define === 'function' && define.amd) { //[2]
 define(['mustache'], factory);
 } else if(typeof module === 'object' && //[3]
 typeof module.exports === 'object') {
 var mustache = require('mustache');
 module.exports = factory(mustache);
 } else { //[4]
 root.UmdModule = factory(root.Mustache);
 }
}(this, function(mustache) { //[5]
 var template = '<h1>Hello <i>{{name}}</i></h1>';
 mustache.parse(template);

 return {
 sayHello:function(toWhom) {
 return mustache.render(template, {name: toWhom});
 }
 };
}));

Posted on Feb 28 by:

damxipo profile

Damian Cipolat

@damxipo

Hi, I'm from Argentina. I specialize in Nodejs and microservice technologies over AWS. Thanks for reading me XD

Discussion

markdown guide