如何在NestJS共享库运行时检测调用它的微服务项目包名

我之前也遇到过类似的需求，给你几个可行的方案，按推荐程度排序：

方案1：让调用方主动传递服务名称（最简单可靠） #

这是最直接且无坑的方式，让每个微服务在调用共享库函数时，主动传入自己的服务名称——这个名称可以直接从微服务根目录的package.json中导入。

共享库代码： #

export const foo = (serviceName: string) => {
  console.log(`当前调用方微服务：${serviceName}`);
  // 你的业务逻辑
};

微服务调用代码： #

在每个微服务项目中，直接从自身的package.json导入name字段并传递：

import { foo } from 'your-shared-lib';
import { name as serviceName } from './package.json';

// 调用共享库函数
foo(serviceName);

优点：

• 实现简单，没有路径、文件读取等潜在问题
• 性能最优，不需要额外的IO操作
• 逻辑清晰，调用方明确自己要传递的信息

方案2：利用NestJS依赖注入配置服务名称（适合Nest生态） #

如果你的共享库是为NestJS项目设计的，可以利用Nest的DI系统，让微服务在初始化时将自身名称注册到共享库中，后续共享库的函数就能直接获取。

共享库代码： #

import { Injectable } from '@nestjs/common';

@Injectable()
export class SharedLibService {
  private callingServiceName?: string;

  // 让微服务调用此方法注册名称
  setCallingServiceName(name: string) {
    this.callingServiceName = name;
  }

  foo() {
    if (this.callingServiceName) {
      console.log(`当前调用方微服务：${this.callingServiceName}`);
    } else {
      console.warn('未配置调用方服务名称，请先调用setCallingServiceName');
    }
    // 你的业务逻辑
  }
}

微服务配置代码： #

在微服务的根模块中，注入共享库服务并设置名称：

import { Module } from '@nestjs/common';
import { SharedLibService } from 'your-shared-lib';
import { name as serviceName } from './package.json';

@Module({
  providers: [
    {
      provide: SharedLibService,
      useFactory: () => {
        const service = new SharedLibService();
        service.setCallingServiceName(serviceName);
        return service;
      },
    },
  ],
  exports: [SharedLibService], // 如果其他模块需要使用
})
export class AppModule {}

优点：

• 符合NestJS的设计理念，依赖注入更优雅
• 只需要配置一次，后续所有调用都无需重复传参

方案3：动态读取调用方的package.json（备选方案） #

如果不想让调用方做额外配置，可以尝试在共享库中动态定位并读取调用方的package.json文件。但这个方法需要处理路径问题，存在一定的不确定性。

共享库代码： #

import * as fs from 'fs';
import * as path from 'path';

// 工具函数：查找并返回调用方的package.json中的name字段
function getCallingServiceName(): string | null {
  // 尝试从进程工作目录读取（如果微服务从自身根目录启动）
  const cwdPackagePath = path.join(process.cwd(), 'package.json');
  if (fs.existsSync(cwdPackagePath)) {
    const pkg = JSON.parse(fs.readFileSync(cwdPackagePath, 'utf8'));
    return pkg.name;
  }

  // 如果工作目录不对，尝试从主模块路径向上查找package.json
  if (require.main) {
    let currentDir = path.dirname(require.main.filename);
    // 向上遍历直到找到根目录
    while (currentDir !== path.dirname(currentDir)) {
      const pkgPath = path.join(currentDir, 'package.json');
      if (fs.existsSync(pkgPath)) {
        const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf8'));
        return pkg.name;
      }
      currentDir = path.dirname(currentDir);
    }
  }

  return null;
}

export const foo = () => {
  const serviceName = getCallingServiceName();
  if (serviceName) {
    console.log(`当前调用方微服务：${serviceName}`);
  } else {
    console.warn('无法识别调用方微服务名称');
  }
  // 你的业务逻辑
};

注意事项：

• 如果微服务是通过ts-node、nest start等工具启动，require.main.filename可能指向编译后的JS文件路径，需要确保路径遍历逻辑能正确找到根目录的package.json
• 同步读取文件会有轻微的性能开销，建议缓存结果避免重复读取
• 如果共享库被打包成单个文件（比如用webpack），路径逻辑可能会失效

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