spring-graphql SubscriptionExceptionResolverAdapter 源码

spring-graphql SubscriptionExceptionResolverAdapter 代码

文件路径：/spring-graphql/src/main/java/org/springframework/graphql/execution/SubscriptionExceptionResolverAdapter.java

/*
 * Copyright 2002-2022 the original author or authors.
 *
 * Licensed 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 org.springframework.graphql.execution;

import java.util.Collections;
import java.util.List;
import java.util.function.Function;

import graphql.GraphQLError;
import reactor.core.publisher.Mono;

import org.springframework.lang.Nullable;

/**
 * Adapter for {@link SubscriptionExceptionResolver} that pre-implements the
 * asynchronous contract and exposes the following synchronous protected methods:
 * <ul>
 * <li>{@link #resolveToSingleError}
 * <li>{@link #resolveToMultipleErrors}
 * </ul>
 *
 * <p>Applications may also use
 * {@link SubscriptionExceptionResolver#forSingleError(Function)} as a shortcut
 * for {@link #resolveToSingleError(Throwable)}.
 *
 * @author Mykyta Ivchenko
 * @author Rossen Stoyanchev
 * @since 1.0.1
 * @see SubscriptionExceptionResolver
 */
public abstract class SubscriptionExceptionResolverAdapter implements SubscriptionExceptionResolver {

    private boolean threadLocalContextAware;


    /**
     * Subclasses can set this to indicate that ThreadLocal context from the
     * transport handler (e.g. HTTP handler) should be restored when resolving
     * exceptions.
     * <p><strong>Note:</strong> This property is applicable only if transports
     * use ThreadLocal's' (e.g. Spring MVC) and if a {@link ThreadLocalAccessor}
     * is registered to extract ThreadLocal values of interest. There is no
     * impact from setting this property otherwise.
     * <p>By default this is set to "false" in which case there is no attempt
     * to propagate ThreadLocal context.
     * @param threadLocalContextAware whether this resolver needs access to
     * ThreadLocal context or not.
     */
    public void setThreadLocalContextAware(boolean threadLocalContextAware) {
        this.threadLocalContextAware = threadLocalContextAware;
    }

    /**
     * Whether ThreadLocal context needs to be restored for this resolver.
     */
    public boolean isThreadLocalContextAware() {
        return this.threadLocalContextAware;
    }


    @Override
    public final Mono<List<GraphQLError>> resolveException(Throwable exception) {
        if (!this.threadLocalContextAware) {
            return Mono.justOrEmpty(resolveToMultipleErrors(exception));
        }
        return Mono.deferContextual(contextView -> {
            List<GraphQLError> errors;
            try {
                ReactorContextManager.restoreThreadLocalValues(contextView);
                errors = resolveToMultipleErrors(exception);
            }
            finally {
                ReactorContextManager.resetThreadLocalValues(contextView);
            }
            return Mono.justOrEmpty(errors);
        });
    }

    /**
     * Override this method to resolve the Exception to multiple GraphQL errors.
     * @param exception the exception to resolve
     * @return the resolved errors or {@code null} if unresolved
     */
    @Nullable
    protected List<GraphQLError> resolveToMultipleErrors(Throwable exception) {
        GraphQLError error = resolveToSingleError(exception);
        return (error != null ? Collections.singletonList(error) : null);
    }

    /**
     * Override this method to resolve the Exception to a single GraphQL error.
     * @param exception the exception to resolve
     * @return the resolved error or {@code null} if unresolved
     */
    @Nullable
    protected GraphQLError resolveToSingleError(Throwable exception) {
        return null;
    }

}

相关信息

spring-graphql 源码目录

相关文章

spring-graphql AbstractGraphQlSourceBuilder 源码

spring-graphql BatchLoaderRegistry 源码

spring-graphql ClassNameTypeResolver 源码

spring-graphql CompositeSubscriptionExceptionResolver 源码

spring-graphql CompositeThreadLocalAccessor 源码

spring-graphql ContextDataFetcherDecorator 源码

spring-graphql DataFetcherExceptionResolver 源码

spring-graphql DataFetcherExceptionResolverAdapter 源码

spring-graphql DataLoaderRegistrar 源码

spring-graphql DefaultBatchLoaderRegistry 源码