LoopBack数据模型定义语言(LDL)完全指南

前言

LoopBack数据源Juggler中的模型定义语言(LDL)是定义数据模型的核心工具。本文将全面解析LDL的语法特性、使用场景和最佳实践，帮助开发者高效构建LoopBack应用的数据模型层。

什么是LDL

LDL(LoopBack Definition Language)是一种简洁的领域特定语言，用于在JavaScript或JSON中定义数据模型。它提供了：

1. 类型系统：支持基本数据类型和复杂类型
2. 模型继承：支持模型间的继承关系
3. 关系定义：支持多种模型关联方式
4. 数据约束：支持字段级验证规则
5. 数据映射：支持与底层数据源的映射配置

基础模型定义

简单JSON定义

{
    "id": "number",
    "firstName": "string",
    "lastName": "string"
}

这个模型定义了三个属性：

• id: 数字类型
• firstName: 字符串类型
• lastName: 字符串类型

JavaScript定义

var UserDefinition = {
    id: Number,
    firstName: String,
    lastName: String
}

JavaScript版本更为简洁，直接使用类型构造函数。

支持的基本类型

LDL支持以下基本类型：

• String/Text
• Number
• Boolean
• Array
• Object
• Date
• Buffer/Binary
• GeoPoint

类型名称不区分大小写，"Number"和"number"等效。

模型构造器创建

使用ModelBuilder将定义转换为可用的模型构造器：

var ModelBuilder = require('loopback-datasource-juggler').ModelBuilder;
var modelBuilder = new ModelBuilder();

var User = modelBuilder.define('User', {
    id: Number,
    firstName: String,
    lastName: String
});

var user = new User({id: 1, firstName: 'John', lastName: 'Smith'});

模型行为扩展

数据源注入方法

var DataSource = require('loopback-datasource-juggler').DataSource;
var ds = new DataSource('memory');

var User = ds.define('User', UserDefinition);

User.create({id: 1, firstName: 'John', lastName: 'Smith'}, function(err, user) {
    // CRUD操作
});

手动添加方法

// 静态方法
User.findByLastName = function(lastName, cb) {
    User.find({where: {lastName: lastName}}, cb);
};

// 实例方法
User.prototype.getFullName = function() {
    return this.firstName + ' ' + this.lastName;
};

高级模型配置

模型级选项

{
    "name": "User",
    "options": {
        "strict": true,       // 是否严格模式
        "idInjection": false, // 是否自动注入id
        "plural": "users"     // 复数形式
    },
    "properties": {...}
}

属性定义进阶

{
    "id": {
        "type": "number",
        "id": true,
        "doc": "用户ID"
    },
    "firstName": {
        "type": "string",
        "required": true,
        "oracle": {
            "column": "FIRST_NAME",
            "type": "VARCHAR(32)"
        }
    }
}

复合ID

var InventoryDefinition = {
    productId: {type: String, id: 1},
    locationId: {type: String, id: 2},
    qty: Number
}

模型关系

一对一关系 (belongsTo)

Order.belongsTo(Customer);
// 使用方式
order.customer(callback);

一对多关系 (hasMany)

Customer.hasMany(Order, {as: 'orders', foreignKey: 'customerId'});
// 使用方式
customer.orders(filter, callback);

多对多关系 (hasAndBelongsToMany)

User.hasAndBelongsToMany('groups', {model: Group, foreignKey: 'groupId'});
// 使用方式
user.groups(callback);

通过中间表的多对多 (hasMany through)

Physician.hasMany(Patient, {through: Appointment});
Patient.hasMany(Physician, {through: Appointment});

模型继承与混入

继承

var Customer = User.extend('customer', {
    accountId: String,
    vip: Boolean
});

混入

var TimeStamp = modelBuilder.define('TimeStamp', {
    created: Date,
    modified: Date
});
User.mixin(TimeStamp);

最佳实践

1. 命名规范：模型名使用单数形式，属性名使用小驼峰
2. 严格模式：生产环境建议启用严格模式
3. 文档注释：为重要属性添加doc描述
4. 关系设计：根据业务需求选择合适的关系类型
5. 类型选择：精确选择数据类型，如Date而非字符串存储时间

总结

LoopBack的模型定义语言提供了强大而灵活的方式来定义数据模型。通过本文的介绍，开发者可以掌握从基础模型定义到复杂关系配置的全套技能，为构建健壮的LoopBack应用打下坚实基础。