Bazel单仓项目IDEA误导跨服务同名类属哪方配置问题

这个问题不属于单一配置范畴，Bazel侧的依赖边界配置缺失是根因，IDEA Bazel插件的索引范围配置不当是直接触发原因，两边都需要调整。

对应你当前的项目结构 #

backend
|- jvm
    |- apps
        |- core-service
            |- api
               |- src
               |- BUILD.bazel
            |- app
               |- src
               |- BUILD.bazel
        |- post-service
            |- api
               |- src
               |- BUILD.bazel
            |- app
               |- src
               |- BUILD.bazel
        ...
    |- libs
        |-core
           |- src
           |- BUILD.bazel
        ...
    |- BUILD.bazel
|- .bazelproject
|- BUILD.bazel

出现「IDEA自动导错跨服务同名类、IDE无提示但Bazel构建失败」的现象，两边的问题点分别是：

Bazel侧问题 #

• 没有配置严格的目标可见性：大概率你根目录或者jvm/BUILD.bazel里把default_visibility设成了//visibility:public，或者各个服务的BUILD规则没显式指定visibility，导致所有服务的源码目标默认全局可见，等于从规则层面没有禁止跨服务随意依赖内部类，给IDE索引错误范围留了口子。
• 修正方式：
  • 所有服务的内部实现模块（比如各服务的app目录下的目标）统一设置visibility = ["//visibility:private"]，禁止其他服务直接依赖。
  • 仅对外暴露的api模块设置定向可见性，只允许指定的依赖方引用，不要直接设为公开。
  • 删掉全局范围的公开默认可见性配置，从Bazel构建层面直接卡死跨服务乱依赖的可能，就算IDEA导错了类，Bazel构建会直接报依赖不存在的错误，不会等到编译阶段才发现同名类冲突。

IDEA侧问题 #

• Bazel插件没有严格按照BUILD文件声明的依赖关系收缩索引范围，默认把整个仓库的Java源文件都纳入了自动导入候选，才会把不属于当前服务依赖的类推到自动导入列表里。
• 修正方式：
  • 检查项目根目录下的.bazelproject文件，不要在directories配置里把整个jvm目录全量加进去，只纳入当前活跃开发的目标关联路径。
  • 在Bazel插件设置里开启严格依赖校验模式，让IDE的代码补全、自动导入完全对齐BUILD文件里声明的deps列表，没有声明为依赖的目标下的类，直接不展示在导入候选里。
  • 每次修改BUILD规则后主动触发一次Bazel项目同步，保证IDE的依赖索引和Bazel实际的构建依赖图完全一致。

验证方法 #

先把post-service的app模块可见性改成私有，再同步IDEA项目，此时写代码时自动导入的候选列表里不会再出现post-service下的同名类，后续IDE报错和Bazel构建的行为会完全对齐，不会再出现两边表现不一致的问题。

不要为了临时过构建把错误导入的跨服务类加到当前模块的deps里，这会彻底打破服务间的依赖边界，后期整个monorepo的依赖关系会完全失控。

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