数据模型的 ES6 类
Posted
技术标签:
【中文标题】数据模型的 ES6 类【英文标题】：ES6 Classes for Data Models 【发布时间】：2016-05-08 17:19:43 【问题描述】：我正在尝试使用 ES6 类在我正在构建的 API 中构建数据模型（来自 mysql 数据库）。我不喜欢使用 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"
]
组
数据模型
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）
问题：
我的主要问题是：
-
我应该在哪里定义数据结构，包括需要数据转换的字段，使用私有方法（例如
_getState()）
应该在类的范围内定义findById、findByGroupId等吗？或者，是否应该通过单独的方法（与类在同一个文件中）来实例化对象？
我应该如何处理一个对象是另一个对象的孩子的情况，例如将属于 Group 对象的 Customer 对象作为 Group 的 findById? 中的对象数组返回
应该在哪里定义将连接到数据库的 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);
);
);
);
集团模型
'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 控制器（客户模型被实例化的地方）
'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 功能？
【问题讨论】：
你在用什么？节点.js？什么是架构？客户端服务器？它是远程运行还是在浏览器中运行，还是只是一个从 bash 运行的脚本（如果它甚至在 linux 上）？ 这是一个hapi.js API 服务器。这个想法是拥有许多数据实体，每个实体都有自己的路由、模型和控制器。它将主要用于GET 请求。而且，由于它将是一组相当小的实体和端点，我不希望使用完整的 ORM。
看起来不错！我看到一些不太关心的领域。不过，您应该发布您的问题Code Review。这是此类问题的适当论坛。在这里，您可能会被标记
【参考方案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();
我应该如何处理一个对象是另一个对象的孩子的情况，例如将属于 Group 对象的 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等？
这很棘手，但由于您希望解决方案简单，请将查询放在您的 find 方法中。理想的情况是拥有自己的 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());【讨论】：
以上是关于数据模型的 ES6 类的主要内容，如果未能解决你的问题，请参考以下文章