-
Notifications
You must be signed in to change notification settings - Fork 923
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Provide a way to invoke Thrift service impls from `BlockingTaskExecut…
…or` (#5619) Related issue: #4917 Motivation: There's currently no way to make Thrift services run from the `BlockingTaskExecutor`. Modifications: - Added `useBlockingTaskExecutor` property - Added `ThriftCallServiceBuilder` to build `ThriftCallService` fluently - `ThriftCallService` now calls the service implementation from the `BlockingTaskExecutor` if configured so. Result: - Closes #4917 - User can now specify whether to invoke the service implementation from the `BlockingTaskExecutor` for Thrift services. --------- Co-authored-by: Trustin Lee <[email protected]>
- Loading branch information
1 parent
071a342
commit 52114ed
Showing
5 changed files
with
430 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
153 changes: 153 additions & 0 deletions
153
...thrift0.13/src/main/java/com/linecorp/armeria/server/thrift/ThriftCallServiceBuilder.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,153 @@ | ||
| /* | ||
| * Copyright 2024 LINE Corporation | ||
| * | ||
| * LINE Corporation licenses this file to you under the Apache License, | ||
| * version 2.0 (the "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at: | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT | ||
| * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the | ||
| * License for the specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| package com.linecorp.armeria.server.thrift; | ||
|
|
||
| import static com.google.common.base.Preconditions.checkArgument; | ||
| import static com.google.common.collect.ImmutableMap.toImmutableMap; | ||
| import static java.util.Objects.requireNonNull; | ||
|
|
||
| import java.util.Map; | ||
| import java.util.concurrent.Executors; | ||
|
|
||
| import com.google.common.collect.ImmutableListMultimap; | ||
|
|
||
| import com.linecorp.armeria.common.annotation.UnstableApi; | ||
|
|
||
| /** | ||
| * A fluent builder to build an instance of {@link ThriftCallService}. | ||
| * | ||
| * <h2>Example</h2> | ||
| * <pre>{@code | ||
| * ThriftCallService service = ThriftCallService | ||
| * .builder() | ||
| * .addService(defaultServiceImpl) // Adds a service | ||
| * .addService("foo", fooServiceImpl) // Adds a service with a key | ||
| * .addService("foobar", fooServiceImpl) // Adds multiple services to the same key | ||
| * .addService("foobar", barServiceImpl) | ||
| * // Adds multiple services at once | ||
| * .addServices("foobarOnce", fooServiceImpl, barServiceImpl) | ||
| * // Adds multiple services by list | ||
| * .addServices("foobarList", ImmutableList.of(fooServiceImpl, barServiceImpl)) | ||
| * // Adds multiple services by map | ||
| * .addServices(ImmutableMap.of("fooMap", fooServiceImpl, "barMap", barServiceImpl)) | ||
| * // Adds multiple services by map | ||
| * .addServices(ImmutableMap.of("fooIterableMap", | ||
| * ImmutableList.of(fooServiceImpl, barServiceImpl))) | ||
| * .build(); | ||
| * }</pre> | ||
| * | ||
| * @see ThriftCallService | ||
| */ | ||
| @UnstableApi | ||
| public final class ThriftCallServiceBuilder { | ||
| private final ImmutableListMultimap.Builder<String, Object> servicesBuilder = | ||
| ImmutableListMultimap.builder(); | ||
|
|
||
| private boolean useBlockingTaskExecutor; | ||
|
|
||
| ThriftCallServiceBuilder() {} | ||
|
|
||
| /** | ||
| * Adds a service for {@link ThriftServiceEntry}. | ||
| */ | ||
| public ThriftCallServiceBuilder addService(Object service) { | ||
| requireNonNull(service, "service"); | ||
| servicesBuilder.put("", service); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Adds a service with a key for {@link ThriftServiceEntry}. | ||
| */ | ||
| public ThriftCallServiceBuilder addService(String key, Object service) { | ||
| requireNonNull(key, "key"); | ||
| requireNonNull(service, "service"); | ||
| servicesBuilder.put(key, service); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Adds a service for {@link ThriftServiceEntry}. | ||
| */ | ||
| public ThriftCallServiceBuilder addServices(Object... services) { | ||
| requireNonNull(services, "services"); | ||
| checkArgument(services.length != 0, "service should not be empty"); | ||
| servicesBuilder.putAll("", services); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Adds a service with a key for {@link ThriftServiceEntry}. | ||
| */ | ||
| public ThriftCallServiceBuilder addServices(String key, Object... services) { | ||
| requireNonNull(key, "key"); | ||
| requireNonNull(services, "service"); | ||
| checkArgument(services.length != 0, "service should not be empty"); | ||
| servicesBuilder.putAll(key, services); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Adds services with key by iterable for {@link ThriftServiceEntry}. | ||
| */ | ||
| public ThriftCallServiceBuilder addServices(String key, Iterable<?> services) { | ||
| requireNonNull(key, "key"); | ||
| requireNonNull(services, "services"); | ||
| checkArgument(services.iterator().hasNext(), "service should not be empty"); | ||
| servicesBuilder.putAll(key, services); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Adds multiple services by map for {@link ThriftServiceEntry}. | ||
| */ | ||
| public ThriftCallServiceBuilder addServices(Map<String, ?> services) { | ||
| requireNonNull(services, "services"); | ||
| checkArgument(!services.isEmpty(), "service should not be empty"); | ||
|
|
||
| services.forEach((k, v) -> { | ||
| if (v instanceof Iterable<?>) { | ||
| servicesBuilder.putAll(k, (Iterable<?>) v); | ||
| } else { | ||
| servicesBuilder.put(k, v); | ||
| } | ||
| }); | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Sets whether the service executes service methods using the blocking executor. By default, service | ||
| * methods are executed directly on the event loop for implementing fully asynchronous services. If your | ||
| * service uses blocking logic, you should either execute such logic in a separate thread using something | ||
| * like {@link Executors#newCachedThreadPool()} or enable this setting. | ||
| */ | ||
| public ThriftCallServiceBuilder useBlockingTaskExecutor(boolean useBlockingTaskExecutor) { | ||
| this.useBlockingTaskExecutor = useBlockingTaskExecutor; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Builds a new instance of {@link ThriftCallService}. | ||
| */ | ||
| public ThriftCallService build() { | ||
| return new ThriftCallService( | ||
| servicesBuilder.build().asMap().entrySet().stream().collect( | ||
| toImmutableMap(Map.Entry::getKey, ThriftServiceEntry::new)), | ||
| useBlockingTaskExecutor | ||
| ); | ||
| } | ||
| } |
Oops, something went wrong.