如何实现UAT与生产环境ServiceClient类的按需加载？

核心解决思路 #

你之前的问题根源在于编译期同时依赖两个包的ServiceClient导致冲突，要解决这个问题，核心是将客户端代码与具体环境的实现解耦：通过统一接口抽象业务逻辑，用工厂类在运行时根据类路径动态加载对应版本的实现，完全避免编译期的依赖冲突。

具体实现步骤 #

1. 抽象统一接口 #

先在公共包（比如com.common.environment）定义业务接口，让UAT和生产版本的客户端都实现这个接口（也可以让UAT版本继承生产版本以复用逻辑）：

// com.common.environment.ServiceClient
public interface ServiceClient {
    // 定义所有核心业务方法
    void executeServiceRequest();
}

生产环境实现：

// com.prod.environment.ProdServiceClient
import com.common.environment.ServiceClient;

public class ProdServiceClient implements ServiceClient {
    static {
        // 生产环境默认SSL配置（比如启用严格主机名验证）
        // ...
    }

    @Override
    public void executeServiceRequest() {
        // 生产环境业务逻辑实现
    }
}

UAT环境实现（继承生产版本复用逻辑，添加测试专属配置）：

// com.uat.environment.UatServiceClient
import com.common.environment.ServiceClient;
import com.prod.environment.ProdServiceClient;

public class UatServiceClient extends ProdServiceClient {
    static {
        // UAT环境禁用SSL主机名验证的专属逻辑
        System.setProperty("jdk.internal.httpclient.disableHostnameVerification", "true");
        // 其他测试环境专属配置...
    }
}

2. 实现动态加载的工厂类 #

通过反射机制在运行时检测UAT类是否存在，自动选择加载对应版本，完全避免编译期依赖：

// com.common.environment.ServiceClientFactory
public class ServiceClientFactory {
    private static final String UAT_CLIENT_CLASS = "com.uat.environment.UatServiceClient";
    private static final String PROD_CLIENT_CLASS = "com.prod.environment.ProdServiceClient";

    // 单例优化：缓存已实例化的客户端
    private static ServiceClient clientInstance;

    public static ServiceClient getInstance() {
        if (clientInstance != null) {
            return clientInstance;
        }

        try {
            // 优先尝试加载UAT版本
            Class<?> uatClass = Class.forName(UAT_CLIENT_CLASS);
            clientInstance = (ServiceClient) uatClass.getDeclaredConstructor().newInstance();
        } catch (ClassNotFoundException e) {
            // UAT类不存在，加载生产版本
            try {
                Class<?> prodClass = Class.forName(PROD_CLIENT_CLASS);
                clientInstance = (ServiceClient) prodClass.getDeclaredConstructor().newInstance();
            } catch (Exception ex) {
                throw new RuntimeException("初始化ServiceClient失败", ex);
            }
        } catch (Exception e) {
            throw new RuntimeException("初始化UAT ServiceClient失败", e);
        }
        return clientInstance;
    }
}

3. Maven打包配置调整 #

用Maven Profile分别控制生产和UAT包的内容，确保生产包不包含UAT代码：

<!-- pom.xml -->
<profiles>
    <!-- 生产环境Profile，默认激活 -->
    <profile>
        <id>prod</id>
        <activation>
            <activeByDefault>true</activeByDefault>
        </activation>
        <build>
            <finalName>service_prod</finalName>
            <plugins>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-jar-plugin</artifactId>
                    <configuration>
                        <!-- 排除UAT包下的所有代码 -->
                        <excludes>
                            <exclude>com/uat/environment/**</exclude>
                        </excludes>
                    </configuration>
                </plugin>
            </plugins>
        </build>
    </profile>

    <!-- UAT环境Profile -->
    <profile>
        <id>uat</id>
        <build>
            <finalName>service_uat</finalName>
            <!-- 打包时包含所有代码（公共接口、生产实现、UAT实现） -->
        </build>
    </profile>
</profiles>

打包命令：

• 生产包：mvn clean package -Pprod
• UAT包：mvn clean package -Puat

4. 客户端代码调用 #

客户端只需要依赖公共接口和工厂类，完全不需要直接引用UAT或生产的实现类：

import com.common.environment.ServiceClient;
import com.common.environment.ServiceClientFactory;

public class BusinessClient {
    public static void main(String[] args) {
        ServiceClient client = ServiceClientFactory.getInstance();
        client.executeServiceRequest();
    }
}

额外优化建议 #

• 配置解耦：把UAT/生产类名放到配置文件（比如application.properties），避免硬编码在工厂类中。
• Spring环境适配：如果是Spring项目，可以用@ConditionalOnClass注解实现条件Bean加载，更符合Spring生态：

  @Configuration
  public class ServiceClientConfig {
      @Bean
      @ConditionalOnClass(name = "com.uat.environment.UatServiceClient")
      public ServiceClient uatServiceClient() {
          return new UatServiceClient();
      }
  
      @Bean
      @ConditionalOnMissingClass(name = "com.uat.environment.UatServiceClient")
      public ServiceClient prodServiceClient() {
          return new ProdServiceClient();
      }
  }
  

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