NestJS中RavenDB Map索引使用枚举的两类技术问题

场景背景 #

在NestJS项目中配合RavenDB使用时，核心类库@ply/core中定义了如下枚举：

export enum GroupType {
    Agent = "agent",
    System = "system"
}

在RavenDB的Map索引逻辑中导入并使用该枚举：

import { Models } from '@ply/core';
        
export class Agents_All extends AbstractJavaScriptMultiMapIndexCreationTask<AgentResult> {
    constructor() {
        super();
        this.map<IUser>(User, user => {
            if(user.groupType === Models.Enums.GroupType.Agent){
                // 索引逻辑
            }
        });
    }
}

问题与解答 #

Q1：如何在Map索引中使用枚举或常量？是否需要将其作为额外源导出到RavenDB，或是像函数一样导出枚举？ #

• 最稳妥的方式是直接使用枚举的原始值：比如直接写user.groupType === "agent"，绕开枚举引用的问题，避免序列化、命名空间带来的干扰。
• 如果想保留代码可读性，可以把枚举转换成常量对象，再将这个对象作为**额外源（Additional Source）**注册到RavenDB索引中：
  1. 在核心库导出常量对象：

     export const GroupTypeConst = {
         Agent: "agent",
         System: "system"
     } as const;
     

  2. 在索引类中通过additionalSources属性添加该常量的代码，或者直接在索引的JavaScript逻辑里定义这个常量，确保RavenDB的索引引擎能识别它。
• 不要直接引用TypeScript枚举的命名空间形式，因为RavenDB的JavaScript索引引擎运行在独立环境中，无法解析TypeScript编译后的模块命名空间。

Q2：为什么RavenDB会在枚举前添加项目命名空间前缀，将Models.Enums.GroupType.Agent转换为core_1.Models.Enums.GroupType.Agent？ #

这是TypeScript编译后的产物导致的：

• 当你从@ply/core导入模块时，TypeScript会给编译后的模块分配自动生成的命名空间前缀（比如core_1），用于在CommonJS模块系统中区分不同导入模块。
• RavenDB的索引处理你的TypeScript代码时，实际执行的是编译后的JavaScript代码，所以会直接显示这个编译生成的命名空间前缀。
• 由于RavenDB的索引运行环境无法识别这个本地编译生成的命名空间，这种引用方式会导致索引执行报错。

内容的提问来源于stack exchange，提问作者amir