Классы ES6 для моделей данных

Я пытаюсь использовать классы ES6 для создания моделей данных (из базы данных MySQL) в API, который я создаю. Я предпочитаю не использовать библиотеку ORM/ODM, так как это будет очень простой и простой API. Но я изо всех сил пытаюсь понять, как определить эти модели.

Мои объекты данных (это лишь некоторые упрощенные примеры):

КЛИЕНТ

Модель данных

id
name
groupId
status (enum of: active, suspended, closed)

Частные методы

_getState(status) {
    var state = (status  == 'active' ? 'good' : 'bad');
    return state;
}

Запросы

Я хочу иметь возможность:

  • findById: предоставление единственного customer.id, возврат данных для этого конкретного клиента, т.е. SELECT * FROM customers WHERE id =?

  • findByGroupId: Предоставление group.id возвращает данные для всех клиентов (в массиве объектов), принадлежащих к этой группе, то есть SELECT * FROM customers WHERE groupId =?

Полезная нагрузка

Для каждого объекта клиента я хочу вернуть JSON следующим образом:

findById(1); :

[{
    "id" : 1,
    "name" : "John Doe",
    "groupId" : 2,
    "status" : "active",
    "state" : "good"
}]

findByGroupId(2); :

[{
    "id" : 1,
    "name" : "John Doe",
    "groupId" : 2,
    "status" : "active",
    "state" : "good"
},
{
    "id" : 4,
    "name" : "Pete Smith",
    "groupId" : 2,
    "status" : "suspended",
    "state" : "bad"
}]

GROUP

Модель данных

id
title

Запросы

Я хочу иметь возможность:

  • findById: Предоставление единственной group.id возвращает данные для этой конкретной группы, то есть SELECT * FROM groups WHERE id =?

Полезная нагрузка

Для каждого объекта группы я хочу вернуть JSON следующим образом:

findById(2); :

{
    "id" : 2,
    "title" : "This is Group 2",
    "customers" : [{
        "id" : 1,
        "name" : "John Doe",
        "groupId" : 2,
        "status" : "active",
        "state" : "good"
    },
    {
        "id" : 4,
        "name" : "Pete Smith",
        "groupId" : 2,
        "status" : "suspended",
        "state" : "bad"
    }]
}

Требования:

  • Необходимо использовать классы ES6
  • Каждая модель в своем собственном файле (например, customer.js) для экспорта

Вопросов:

Мои главные вопросы:

  1. Где я могу определить структуру данных, включая поля, требующие преобразования данных, используя частные методы (например, _getState())
  2. Должны ли findById, findByGroupId и т.д. Определяться в рамках класса? Или, если это по отдельным методам (в том же файле, что и класс), что бы создать экземпляр объекта?
  3. Как я должен рассматривать случай, когда один объект является дочерним по отношению к другому, например, возвращая объекты Customer, принадлежащие объекту Group, в виде массива объектов в группе findById?
  4. Где должны быть определены SQL-запросы, которые будут подключаться к БД? В getById, getByGroupId и т.д.?

ОБНОВИТЬ!!

Это то, что я придумал - (было бы здорово, если бы кто-то мог рассмотреть и прокомментировать):

Модель КЛИЕНТА

'use strict';

class Cust {
  constructor (custData) {
    this.id = custData.id;
    this.name = custData.name;
    this.groupId = custData.groupId;
    this.status = custData.status;
    this.state = this._getState(custData.status);
  }

  _getState(status) {
    let state = (status  == 'active' ? 'good' : 'bad');
    return state;
  }
}

exports.findById = ((id) => {
  return new Promise ((resolve, reject) => {
    let custData = 'do the MySQL query here';
    let cust = new Cust (custData);
    let Group = require(appDir + process.env.PATH_API + process.env.PATH_MODELS + 'group');
    Group.findById(cust.groupId).then(
      (group) => {
        cust.group = group;
        resolve (cust)
      },
      (err) => {
        resolve (cust);
      }
    );
  });
});

Модель GROUP

'use strict';

class Group {
  constructor (groupData) {
    this.id = groupData.id;
    this.title = groupData.title;
  }
}

exports.findById = ((id) => {
  return new Promise ((resolve, reject) => {
    let groupData = 'do the MySQL query here';
    if (id != 2){
      reject('group - no go');
    };
    let group = new Group (groupData);
    resolve (group);
  });
});

CUSTOMER Controller (где экземпляр модели клиента)

'use strict';

var Cust = require(appDir + process.env.PATH_API + process.env.PATH_MODELS + 'cust');

class CustController {
  constructor () {
  }

  getCust (req, res) {
    Cust.findById(req.params.id).then(
      (cust) => {
        res(cust);
      },
      (err) => {
        res(err);
      }
    )
  }
}

module.exports = CustController;

Кажется, это работает хорошо, и я смог использовать Class, Promise и let сделать его более дружественным к ES6.

Поэтому я хотел бы получить некоторый вклад в мой подход. Кроме того, я правильно использую export и required функции в этом контексте?

Ответы

Ответ 1

Вот еще один подход,

Где я могу определить структуру данных, включая поля, требующие преобразования данных, используя частные методы (например, _getState())

Вы должны определить эти поля, отношения в вашем классе модели, расширяющие верхнюю модель. Пример:

class Group extends Model {
    attributes() {
        return {
            id: {
                type: 'integer',
                primary: true
            },
            title: {
                type: 'string'
            }
        };
    }

    relationships() {
        return {
            'Customer': {
                type: 'hasMany',
                foreignKey: 'groupId'
            }
        };
    }
}

Должны ли findById, findByGroupId и т.д. Определяться в рамках класса? Или, если это по отдельным методам (в том же файле, что и класс), что бы создать экземпляр объекта?

Вместо использования многих функций findByAttribute(attr) в примере модели:

static findByAttribute(attr) {
    return new Promise((resolve, reject) => {
        var query = this._convertObjectToQueriesArray(attr);
        query = query.join(" and ");
        let records = 'SELECT * from ${this.getResourceName()} where ${query}';
        var result = this.run(records);
        // Note: Only support 'equals' and 'and' operator
        if (!result) {
            reject('Could not found records');
        } else {
            var data = [];
            result.forEach(function(record) {
                data.push(new this(record));
            });
            resolve(data);
        }
    });
}

/**
 * Convert Object of key value to sql filters
 * 
 * @param  {Object} Ex: {id:1, name: "John"}
 * @return {Array of String} ['id=1', 'name=John']
 */
static _convertObjectToQueriesArray(attrs) {
    var queryArray = [];
    for (var key in attrs) {
        queryArray.push(key + " = " + attrs[key]);
    }
    return queryArray;
}

/**
 * Returns table name or resource name.
 * 
 * @return {String}
 */
static getResourceName() {
    if (this.resourceName) return this.resourceName();
    if (this.constructor.name == "Model") {
        throw new Error("Model is not initialized");
    }
    return this.constructor.name.toLowerCase();
}

Как я должен рассматривать случай, когда один объект является дочерним по отношению к другому, например, возвращая объекты Customer, принадлежащие объекту Group, в виде массива объектов в группе findById?

В случае отношений вы должны иметь такие методы, как findRelations, getRelatedRecords.

var customer1 = new Customer({ id: 1, groupId: 3});
customer1.getRelatedRecords('Group');

class Model {
 ...

  getRelatedRecords(reln) {
    var targetRelationship = this.relationships()[reln];
    if (!targetRelationship) {
        throw new Error("No relationship found.");
    }
    var primaryKey = this._getPrimaryKey();

    var relatedObject = eval(reln);
    var attr = {};
    if (targetRelationship.type == "hasOne") {
        console.log(this.values);
        attr[relatedObject.prototype._getPrimaryKey()] = this.values[targetRelationship.foreignKey];
    } else if (targetRelationship.type == "hasMany") {
        attr[targetRelationship.foreignKey] = this.values[this._getPrimaryKey()];
    }

    relatedObject.findByAttribute(attr).then(function(records) {
        // this.values[reln] = records;
    });
   }
 ...
}

Где должны быть определены SQL-запросы, которые будут подключаться к БД? В getById, getByGroupId и т.д.?

Это сложно, но поскольку вы хотите, чтобы ваше решение было простым, введите запросы внутри методов поиска. Идеальный сценарий будет состоять в том, чтобы иметь собственный класс QueryBuilder.

Проверьте следующий полный код, решение не является полностью функциональным, но вы получите эту идею. Я также добавил переменную двигателя в модель, которую вы можете использовать для улучшения механизма выборки. Все другие дизайнерские идеи соответствуют вашему воображению :)

ПОЛНЫЙ КОД:

var config = {
  engine: 'db' // Ex: rest, db
};
class Model {

  constructor(values) {
    this.values = values;
    this.engine = config.engine;
  }

  toObj() {
    var data = {};
    for (var key in this.values) {
      if (this.values[key] instanceof Model) {
        data[key] = this.values[key].toObj();
      } else if (this.values[key] instanceof Array) {
        data[key] = this.values[key].map(x => x.toObj());
      } else {
        data[key] = this.values[key];
      }
    }
    return data;
  }

  static findByAttribute(attr) {
    return new Promise((resolve, reject) => {
      var query = this._convertObjectToQueriesArray(attr);
      query = query.join(" and ");
      let records = 'SELECT * from ${this.getResourceName()} where ${query}';
      var result = this.run(records);
      // Note: Only support 'equals' and 'and' operator
      if (!result) {
        reject('Could not found records');
      } else {
        var data = [];
        result.forEach(function(record) {
          data.push(new this(record));
        });
        resolve(data);
      }
    });
  }

  getRelatedRecords(reln) {
    var targetRelationship = this.relationships()[reln];
    if (!targetRelationship) {
      throw new Error("No relationship found.");
    }
    var primaryKey = this._getPrimaryKey();

    var relatedObject = eval(reln);
    var attr = {};
    if (targetRelationship.type == "hasOne") {
      console.log(this.values);
      attr[relatedObject.prototype._getPrimaryKey()] = this.values[targetRelationship.foreignKey];
    } else if (targetRelationship.type == "hasMany") {
      attr[targetRelationship.foreignKey] = this.values[this._getPrimaryKey()];
    }

    relatedObject.findByAttribute(attr).then(function(records) {
      // this.values[reln] = records;
    });
  }

  /**
   * Test function to show what queries are being ran.
   */
  static run(query) {
    console.log(query);
    return [];
  }

  _getPrimaryKey() {
    for (var key in this.attributes()) {
      if (this.attributes()[key].primary) {
        return key;
      }
    }
  }

  /**
   * Convert Object of key value to sql filters
   * 
   * @param  {Object} Ex: {id:1, name: "John"}
   * @return {Array of String} ['id=1', 'name=John']
   */
  static _convertObjectToQueriesArray(attrs) {
    var queryArray = [];
    for (var key in attrs) {
      queryArray.push(key + " = " + attrs[key]);
    }
    return queryArray;
  }

  /**
   * Returns table name or resource name.
   * 
   * @return {String}
   */
  static getResourceName() {
    if (this.resourceName) return this.resourceName();
    if (this.constructor.name == "Model") {
      throw new Error("Model is not initialized");
    }
    return this.constructor.name.toLowerCase();
  }
}

class Customer extends Model {
  attributes() {
    return {
      id: {
        type: 'integer',
        primary: true
      },
      name: {
        type: 'string'
      },
      groupId: {
        type: 'integer'
      },
      status: {
        type: 'string'
      },
      state: {
        type: 'string'
      }
    };
  }

  relationships() {
    return {
      'Group': {
        type: 'hasOne',
        foreignKey: 'groupId'
      }
    };
  }
}

class Group extends Model {
  attributes() {
    return {
      id: {
        type: 'integer',
        primary: true
      },
      title: {
        type: 'string'
      }
    };
  }

  relationships() {
    return {
      'Customer': {
        type: 'hasMany',
        foreignKey: 'groupId'
      }
    };
  }
}

var cust = new Customer({
  id: 1,
  groupId: 3
});
cust.getRelatedRecords('Group');

var group = new Group({
  id: 3,
  title: "Awesome Group"
});
group.getRelatedRecords('Customer');

var groupData = new Group({
  "id": 2,
  "title": "This is Group 2",
  "customers": [new Customer({
      "id": 1,
      "name": "John Doe",
      "groupId": 2,
      "status": "active",
      "state": "good"
    }),
    new Customer({
      "id": 4,
      "name": "Pete Smith",
      "groupId": 2,
      "status": "suspended",
      "state": "bad"
    })
  ]
});

console.log(groupData.toObj());