LokiJS 集合转换(Collection Transforms)完全指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00788/article/details/148465324

LokiJS 集合转换(Collection Transforms)完全指南

LokiJS javascript embeddable / in-memory database 项目地址: https://gitcode.com/gh_mirrors/lo/LokiJS

什么是集合转换

集合转换(Collection Transforms)是 LokiJS 提供的一种强大功能，它允许将一系列查询操作链(Resultset chain)转换为可序列化的对象定义。这种数据定义可以被命名并随集合一起保存在数据库中。

简单来说，集合转换就像是为你的数据查询和处理流程创建了一个"配方"，这个配方可以被保存、复用，甚至在不同环境中传递。

为什么需要集合转换

集合转换在以下场景中特别有用：

开发数据库工具：构建操作 LokiJS 数据库的工具时，转换提供了标准化的操作方式
创建命名查询：类似于传统数据库中的"存储过程"，可以封装复杂查询逻辑
数据转换：为数据提取或导出准备特定格式的数据
元数据扩展：可以在转换中添加自定义元信息，构建更复杂的应用逻辑

转换步骤类型详解

集合转换由一系列有序的步骤对象组成，每个步骤代表一种特定的操作。LokiJS 支持以下类型的转换步骤：

| 步骤类型 | 描述 | 适用场景 | |---------|------|---------| | find | 基础查询操作 | 根据条件筛选文档 | | where | 使用函数过滤 | 复杂条件筛选 | | simplesort | 单属性排序 | 简单排序需求 | | compoundsort | 多属性组合排序 | 复杂排序需求 | | sort | 自定义排序 | 完全控制排序逻辑 | | limit | 限制结果数量 | 分页或限制输出 | | offset | 跳过指定数量结果 | 分页实现 | | update | 批量更新文档 | 数据批量修改 | | remove | 批量删除文档 | 数据清理 | | map | 数据映射转换 | 数据格式转换 | | mapReduce | MapReduce操作 | 数据聚合统计 | | eqJoin | 集合关联 | 多集合数据关联 |

基本使用示例

简单转换创建

// 创建一个查找特定所有者的转换
var ownerFilterTransform = [
  {
    type: 'find',
    value: {
      'owner': 'odin'
    }
  }
];

// 将转换添加到集合并命名
userCollection.addTransform('OwnerFilter', ownerFilterTransform);

// 使用命名转换
var results = userCollection.chain('OwnerFilter').data();

// 或者直接使用转换对象
var results = userCollection.chain(ownerFilterTransform).data();

参数化转换

转换支持参数化，使查询更加灵活：

var parameterizedTransform = [
  {
    type: 'find',
    value: {
      'owner': '[%lktxp]OwnerName'  // 参数占位符
    }
  }
];

// 执行时传入参数
var params = { OwnerName: 'odin' };
var results = userCollection.chain(parameterizedTransform, params).data();

高级转换技巧

多步骤转换

转换可以包含多个步骤，按顺序执行：

var multiStepTransform = [
  {
    type: 'find',
    value: {
      owner: { '$eq': '[%lktxp]customOwner' }
    }
  },
  {
    type: 'where',
    value: '[%lktxp]customFilter'
  },
  {
    type: 'limit',
    value: '[%lktxp]customLimit'
  }
];

function myFilter(obj) {
  return obj.name.includes("nir");
}

var params = {
  customOwner: 'odin',
  customFilter: myFilter,
  customLimit: 100
};

var results = users.chain(multiStepTransform, params).data();

特殊步骤类型

某些复杂操作需要特定的步骤属性：

// 排序步骤
var sortStep = {
  type: 'simplesort',
  property: 'name',
  desc: true
};

// MapReduce步骤
var mapReduceStep = {
  type: 'mapReduce',
  mapFunction: myMap,
  reduceFunction: myReduce
};

// 关联步骤
var joinStep = {
  type: 'eqJoin',
  joinData: joinCollection,
  leftJoinKey: 'userId',
  rightJoinKey: 'id',
  mapFun: joinMapper
};

动态视图(DynamicView)中的转换

转换可以与动态视图结合使用，实现高效的数据提取：

var db = new loki('testdb');
var coll = db.addCollection('documents');
var dynamicView = coll.addDynamicView('allDocuments');

// 创建分页转换
var pagingTransform = [
  {
    type: 'offset',
    value: '[%lktxp]pageStart'
  },
  {
    type: 'limit',
    value: '[%lktxp]pageSize'
  }
];
coll.addTransform('paging', pagingTransform);

// 使用转换从动态视图中提取分页数据
var page2 = dynamicView.branchResultset('paging', { 
  pageStart: 10, 
  pageSize: 10 
}).data();

自定义元数据扩展

转换结构支持添加自定义元数据，适合构建复杂应用：

var transformWithMeta = [
  {
    type: 'meta',
    author: 'admin',
    description: '筛选活跃用户',
    created: '2023-01-01',
    params: [
      { name: 'minLogin', type: 'number', desc: '最小登录次数' }
    ]
  },
  {
    type: 'find',
    value: {
      loginCount: { '$gte': '[%lktxp]minLogin' }
    },
    stepDescription: '筛选登录次数达标的用户'
  }
];