能否通过注解/声明式方式为RestClient指定ExecutorService？

MicroProfile Rest Client 规范本身并未提供直接的注解来指定异步调用所用的ExecutorService，但可以通过CDI扩展结合RestClientListener实现注解式配置，替代手动Builder实例化的方式，同时保留上下文传递能力。以下是具体实现方案：

方案一：自定义注解+RestClientListener实现 #

1. 定义自定义注解标记目标RestClient #

创建一个自定义注解，用来标记需要应用上下文包装ExecutorService的RestClient接口：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface ContextAwareExecutor {
    // 可添加属性扩展配置，比如指定ExecutorService的标识
}

修改你的IndexClient接口，添加该注解：

@RegisterRestClient(configKey="indexClient")
@RegisterProvider(value = DefaultMicroprofileRestClientExceptionMapper.class, priority = 50)
@ContextAwareExecutor // 标记需要上下文传递的ExecutorService
public interface IndexClient {
    // 你的异步方法定义
}

2. 实现RestClientListener注入并设置ExecutorService #

通过RestClientListener接口，在RestClient实例创建前拦截并设置自定义ExecutorService：

@ApplicationScoped
public class ContextExecutorListener implements RestClientListener {

    @Inject
    private ExecutorServiceSupplier threadPoolSupplier;

    @Override
    public void onNewClient(RestClientBuilder builder, Class<?> clientInterface) {
        // 检查当前客户端是否标记了自定义注解
        if (clientInterface.isAnnotationPresent(ContextAwareExecutor.class)) {
            // 获取已包装上下文的ExecutorService
            ExecutorService wrappedExecutor = threadPoolSupplier.get();
            // 设置到RestClientBuilder
            builder.executorService(wrappedExecutor);
        }
    }
}

3. 注入使用RestClient #

现在可以直接通过CDI注入IndexClient，容器会自动应用上述配置：

@Inject
@RestClient
private IndexClient indexClient;

方案二：结合MicroProfile Config实现灵活配置 #

如果需要通过外部配置文件指定不同的ExecutorService，可扩展上述方案：

1. 修改自定义注解添加配置属性 #

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface ContextAwareExecutor {
    // 配置key，用于关联外部配置和对应的ExecutorService
    String configKey() default "default.context.executor";
}

2. 实现带配置选择的RestClientListener #

@ApplicationScoped
public class ContextExecutorListener implements RestClientListener {

    @Inject
    private Instance<ExecutorService> executorInstance;

    @Override
    public void onNewClient(RestClientBuilder builder, Class<?> clientInterface) {
        ContextAwareExecutor annotation = clientInterface.getAnnotation(ContextAwareExecutor.class);
        if (annotation != null) {
            String executorKey = annotation.configKey();
            // 根据配置key获取对应的ExecutorService实例
            ExecutorService wrappedExecutor = executorInstance.select(new ExecutorQualifier(executorKey)).get();
            builder.executorService(wrappedExecutor);
        }
    }

    // 自定义限定符，用于区分不同ExecutorService实例
    @Qualifier
    @Target({ElementType.FIELD, ElementType.PARAMETER})
    @Retention(RetentionPolicy.RUNTIME)
    public @interface ExecutorQualifier {
        String value();
    }
}

3. 注册带限定符的ExecutorService #

将包装后的ExecutorService注册为CDI Bean，并用自定义限定符标记：

@ApplicationScoped
@ExecutorQualifier("index-client-executor")
public class IndexClientExecutorProvider implements Provider<ExecutorService> {

    @Inject
    private ExecutorServiceSupplier threadPoolSupplier;

    @Override
    public ExecutorService get() {
        return threadPoolSupplier.get();
    }
}

4. 配置文件关联 #

在application.properties中添加配置，关联RestClient和ExecutorService：

# 对应IndexClient注解中的configKey
indexClient.executor.config-key=index-client-executor

这样就能通过外部配置灵活切换不同的ExecutorService，同时保持注解式配置的简洁性。

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