Liferay 7.4多项目Gradle循环依赖问题的解决办法

循环依赖是多模块开发中常见的问题，针对Liferay 7.4的OSGi环境，可通过以下几种方式解决：

1. 提取公共模块（最常用方案） #

把项目A和B中互相依赖的代码抽离成独立的公共模块C，让A和B都依赖C，彻底打破双向依赖链。

操作步骤：

• 创建新的Gradle模块（比如common-api），将A和B共享的类、接口、工具类等迁移到该模块中。
• 修改A和B的build.gradle，移除对彼此的依赖，改为依赖公共模块：

  // 项目A的build.gradle
  dependencies {
      implementation project(':common-api')
      // 移除原来的implementation project(':projectB')
  }
  
  // 项目B的build.gradle
  dependencies {
      implementation project(':common-api')
      // 移除原来的implementation project(':projectA')
  }
  

2. 基于OSGi服务解耦（适配Liferay环境） #

利用Liferay的OSGi服务注册与引用机制，让两个项目通过服务接口交互，而非直接依赖对方的实现类。

操作示例：

• 在公共模块（或其中一个项目）定义服务接口：

  public interface UserProcessor {
      String processUser(String userId);
  }
  

• 项目A实现该接口并注册为OSGi服务：

  import org.osgi.service.component.annotations.Component;
  
  @Component(service = UserProcessor.class)
  public class UserProcessorImpl implements UserProcessor {
      @Override
      public String processUser(String userId) {
          // 业务逻辑实现
          return "Processed: " + userId;
      }
  }
  

• 项目B通过@Reference注解引用该服务，无需直接依赖项目A：

  import org.osgi.service.component.annotations.Component;
  import org.osgi.service.component.annotations.Reference;
  
  @Component
  public class UserService {
      @Reference
      private UserProcessor userProcessor;
  
      public String handleUser(String userId) {
          return userProcessor.processUser(userId);
      }
  }
  

3. 重构代码消除不必要依赖 #

仔细梳理两个项目的依赖逻辑，确认是否真的需要双向依赖：

• 检查项目B是否只是用到了项目A的某个工具方法，可将该方法迁移到B自身或公共模块。
• 如果是业务流程上的双向调用，考虑调整流程为单向触发，比如通过Liferay的事件总线（EventBusUtil）实现异步交互：

  // 项目A发送事件
  EventBusUtil.post(new MyCustomEvent("data"));
  
  // 项目B监听事件
  @Component(
      property = {"event.topics=com/example/mycustomevent"},
      service = EventListener.class
  )
  public class MyEventListener implements EventListener<MyCustomEvent> {
      @Override
      public void receiveEvent(MyCustomEvent event) {
          // 处理事件逻辑
      }
  }
  

4. 谨慎使用依赖范围调整（应急方案） #

如果某些依赖仅在编译时需要，运行时可通过OSGi容器获取实例，可将implementation改为compileOnly临时规避构建错误，但此方法可能引发运行时类加载问题，需谨慎使用：

// 项目A的build.gradle
dependencies {
    compileOnly project(':projectB') // 仅编译时依赖
}

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