如何强制Mono-repo内微服务仅可导入公共代码禁止互相引用

要实现「服务仅可导入公共common目录代码、禁止跨服务互相导入」的规则，按落地成本、拦截时机的优先级，可选择以下方案，推荐组合使用实现多层管控：

方案1：ESLint开发期强校验（首推，覆盖本地开发全流程） #

开发阶段直接在IDE层抛错，从写代码环节就阻断非法导入，改造成本极低。

• 优先用专门做边界管控的eslint-plugin-boundaries，配置简洁、适配各种路径别名场景：
  1. 安装依赖：npm i -D eslint-plugin-boundaries
  2. 在项目ESLint配置文件中添加如下规则：

  module.exports = {
    plugins: ['boundaries'],
    settings: {
      'boundaries/elements': [
        { type: 'common', pattern: 'common/**/*' },
        { type: 'service', pattern: 'service*/**/*' } // 自动匹配service1、service2等所有服务目录
      ]
    },
    rules: {
      'boundaries/no-import': ['error', {
        // 所有服务目录下的代码，禁止导入其他服务目录的内容
        'from': 'service',
        'disallow': ['service']
      }]
    }
  }
  

  配置完成后，只要服务目录下的文件引入其他服务的代码，ESLint会直接报错误，导入common目录代码不受任何限制。
• 如果不想新增插件依赖，也可以用eslint-plugin-import自带的no-restricted-imports规则实现，只需把所有跨服务的路径匹配规则补全即可：

  module.exports = {
    plugins: ['import'],
    rules: {
      'import/no-restricted-paths': ['error', {
        zones: [
          {
            target: './service1/**/*',
            from: './service2/**/*',
            message: '禁止跨服务导入代码，公共逻辑请抽取到common目录'
          },
          // 其余服务的拦截规则按相同格式补充即可
        ]
      }]
    }
  }
  

方案2：TypeScript原生路径校验（TS项目专属） #

如果项目全量使用TypeScript，可以直接通过TS配置实现拦截，不需要额外依赖ESLint规则：

1. 根目录tsconfig仅配置@common/*的全局路径映射，不给任何服务目录配置全局可访问的路径别名
2. 为每个服务单独创建专属tsconfig配置，include字段仅包含当前服务目录、common目录的文件，不引入其他服务目录的内容
   配置完成后，TS编译器会自动识别非法导入，IDE中也不会给出其他服务目录的代码提示，从输入环节就减少误导入的可能。

方案3：CI/CD阶段兜底校验 #

为了避免开发者本地跳过ESLint校验提交非法代码，可以在CI流水线增加一层兜底扫描，用简单的Node脚本遍历所有服务文件的导入语句，识别到跨服务导入直接阻断流水线。参考实现逻辑：

const fs = require('fs');
const path = require('path');

// 扫描根目录下所有服务文件夹
const serviceList = fs.readdirSync(process.cwd())
  .filter(name => name.startsWith('service') && fs.statSync(name).isDirectory());

// 递归遍历目录取所有js/ts文件的逻辑可按需实现
function scanFiles(dir) { /* 省略实现 */ }

serviceList.forEach(currentService => {
  const allFiles = scanFiles(path.join(process.cwd(), currentService));
  allFiles.forEach(file => {
    const content = fs.readFileSync(file, 'utf-8');
    const importReg = /import\s+.*?from\s+['"]([^'"]+)['"]/g;
    let match;
    while((match = importReg.exec(content)) !== null) {
      const importPath = match[1];
      const invalidImport = serviceList.some(target => {
        return target !== currentService && 
          (importPath.startsWith(`../${target}`) || importPath.startsWith(`@/${target}`))
      });
      if (invalidImport) {
        console.error(`校验不通过：${file} 存在非法跨服务导入 -> ${importPath}`);
        process.exit(1);
      }
    }
  })
});

补充说明：不推荐用Lerna实现该场景管控，Lerna核心定位是多npm包的版本管理与发布，对于不需要对外发版的业务服务来说配置冗余、灵活度不足，上述三个方案组合使用完全可以满足管控需求，改造成本远低于Lerna适配成本。

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