Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Remove deprecated methods in HttpServiceProxyFactory

Browse Source
This commit is contained in:
rstoyanchev
2022-11-07 16:57:07 +00:00
parent a2ac764f9c
commit aeb35663d4
7 changed files with 72 additions and 595 deletions
Download Patch File Download Diff File Expand all files Collapse all files

328
spring-web/src/main/java/org/springframework/web/service/invoker/HttpServiceProxyFactory.java
View File

@@ -30,8 +30,6 @@ import org.aopalliance.intercept.MethodInvocation;
import org.springframework.aop.framework.ProxyFactory;
import org.springframework.aop.framework.ReflectiveMethodInvocation;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.context.EmbeddedValueResolverAware;
import org.springframework.core.MethodIntrospector;
import org.springframework.core.ReactiveAdapterRegistry;
import org.springframework.core.annotation.AnnotatedElementUtils;
@@ -46,130 +44,37 @@ import org.springframework.web.service.annotation.HttpExchange;
* Factory to create a client proxy from an HTTP service interface with
* {@link HttpExchange @HttpExchange} methods.
*
* <p>To create an instance, use static methods to obtain a {@link Builder Builder}.
* <p>To create an instance, use static methods to obtain a
* {@link Builder Builder}.
*
* @author Rossen Stoyanchev
* @since 6.0
* @see org.springframework.web.reactive.function.client.support.WebClientAdapter
*/
public final class HttpServiceProxyFactory implements InitializingBean, EmbeddedValueResolverAware {
public final class HttpServiceProxyFactory {
private final HttpClientAdapter clientAdapter;
private final List<HttpServiceArgumentResolver> argumentResolvers;
@Nullable
private final BuilderInitializedFactory builderInitializedFactory;
private final StringValueResolver embeddedValueResolver;
@Nullable
private final BeanStyleFactory beanStyleFactory;
private final ReactiveAdapterRegistry reactiveAdapterRegistry;
private final Duration blockTimeout;
/**
* Create an instance with the underlying HTTP client to use.
* @param clientAdapter an adapter for the client
* @deprecated in favor of using the Builder to initialize the
* HttpServiceProxyFactory instance.
*/
@Deprecated(since = "6.0.0-RC2", forRemoval = true)
public HttpServiceProxyFactory(HttpClientAdapter clientAdapter) {
this.beanStyleFactory = new BeanStyleFactory(clientAdapter);
this.builderInitializedFactory = null;
}
private HttpServiceProxyFactory(
HttpClientAdapter clientAdapter, List<HttpServiceArgumentResolver> argumentResolvers,
@Nullable StringValueResolver embeddedValueResolver,
ReactiveAdapterRegistry reactiveAdapterRegistry, Duration blockTimeout) {
this.beanStyleFactory = null;
this.builderInitializedFactory = new BuilderInitializedFactory(
clientAdapter, argumentResolvers, embeddedValueResolver, reactiveAdapterRegistry, blockTimeout);
}
/**
* Register a custom argument resolver, invoked ahead of default resolvers.
* @param resolver the resolver to add
* @deprecated in favor of using the Builder to initialize the
* HttpServiceProxyFactory instance.
*/
@Deprecated(since = "6.0.0-RC2", forRemoval = true)
public void addCustomArgumentResolver(HttpServiceArgumentResolver resolver) {
Assert.state(this.beanStyleFactory != null, "HttpServiceProxyFactory was created through the builder");
this.beanStyleFactory.addCustomArgumentResolver(resolver);
}
/**
* Set the custom argument resolvers to use, ahead of default resolvers.
* @param resolvers the resolvers to use
* @deprecated in favor of using the Builder to initialize the
* HttpServiceProxyFactory instance.
*/
@Deprecated(since = "6.0.0-RC2", forRemoval = true)
public void setCustomArgumentResolvers(List<HttpServiceArgumentResolver> resolvers) {
Assert.state(this.beanStyleFactory != null, "HttpServiceProxyFactory was created through the builder");
this.beanStyleFactory.setCustomArgumentResolvers(resolvers);
}
/**
* Set the {@link ConversionService} to use where input values need to
* be formatted as Strings.
* <p>By default this is {@link DefaultFormattingConversionService}.
* @deprecated in favor of using the Builder to initialize the
* HttpServiceProxyFactory instance.
*/
@Deprecated(since = "6.0.0-RC2", forRemoval = true)
public void setConversionService(ConversionService conversionService) {
Assert.state(this.beanStyleFactory != null, "HttpServiceProxyFactory was created through the builder");
this.beanStyleFactory.setConversionService(conversionService);
}
/**
* Set the StringValueResolver to use for resolving placeholders and
* expressions in {@link HttpExchange#url()}.
* @param resolver the resolver to use
* @deprecated in favor of using the Builder to initialize the
* HttpServiceProxyFactory instance.
*/
@Deprecated(since = "6.0.0-RC2", forRemoval = true)
@Override
public void setEmbeddedValueResolver(StringValueResolver resolver) {
if (this.beanStyleFactory != null) {
this.beanStyleFactory.setEmbeddedValueResolver(resolver);
}
}
/**
* Set the {@link ReactiveAdapterRegistry} to use to support different
* asynchronous types for HTTP service method return values.
* <p>By default this is {@link ReactiveAdapterRegistry#getSharedInstance()}.
* @deprecated in favor of using the Builder to initialize the
* HttpServiceProxyFactory instance.
*/
@Deprecated(since = "6.0.0-RC2", forRemoval = true)
public void setReactiveAdapterRegistry(ReactiveAdapterRegistry registry) {
Assert.state(this.beanStyleFactory != null, "HttpServiceProxyFactory was created through the builder");
this.beanStyleFactory.setReactiveAdapterRegistry(registry);
}
/**
* Configure how long to wait for a response for an HTTP service method
* with a synchronous (blocking) method signature.
* <p>By default this is 5 seconds.
* @param blockTimeout the timeout value
* @deprecated in favor of using the Builder to initialize the
* HttpServiceProxyFactory instance.
*/
@Deprecated(since = "6.0.0-RC2", forRemoval = true)
public void setBlockTimeout(Duration blockTimeout) {
Assert.state(this.beanStyleFactory != null, "HttpServiceProxyFactory was created through the builder");
this.beanStyleFactory.setBlockTimeout(blockTimeout);
}
@Override
@Deprecated
public void afterPropertiesSet() throws Exception {
if (this.beanStyleFactory != null) {
this.beanStyleFactory.afterPropertiesSet();
}
this.clientAdapter = clientAdapter;
this.argumentResolvers = argumentResolvers;
this.embeddedValueResolver = embeddedValueResolver;
this.reactiveAdapterRegistry = reactiveAdapterRegistry;
this.blockTimeout = blockTimeout;
}
@@ -181,28 +86,38 @@ public final class HttpServiceProxyFactory implements InitializingBean, Embedded
* @return the created proxy
*/
public <S> S createClient(Class<S> serviceType) {
if (this.builderInitializedFactory != null) {
return this.builderInitializedFactory.createClient(serviceType);
}
else if (this.beanStyleFactory != null) {
return this.beanStyleFactory.createClient(serviceType);
}
else {
throw new IllegalStateException("Expected Builder initialized or Bean-style delegate");
}
List<HttpServiceMethod> httpServiceMethods =
MethodIntrospector.selectMethods(serviceType, this::isExchangeMethod).stream()
.map(method -> createHttpServiceMethod(serviceType, method))
.toList();
return ProxyFactory.getProxy(serviceType, new HttpServiceMethodInterceptor(httpServiceMethods));
}
private boolean isExchangeMethod(Method method) {
return AnnotatedElementUtils.hasAnnotation(method, HttpExchange.class);
}
private <S> HttpServiceMethod createHttpServiceMethod(Class<S> serviceType, Method method) {
Assert.notNull(this.argumentResolvers,
"No argument resolvers: afterPropertiesSet was not called");
return new HttpServiceMethod(
method, serviceType, this.argumentResolvers, this.clientAdapter,
this.embeddedValueResolver, this.reactiveAdapterRegistry, this.blockTimeout);
}
/**
* Return an {@link HttpServiceProxyFactory} builder, initialized with the
* given client.
* Return a builder that's initialized with the given client.
*/
public static Builder builder(HttpClientAdapter clientAdapter) {
return new Builder().clientAdapter(clientAdapter);
}
/**
* Return an {@link HttpServiceProxyFactory} builder.
* Return an empty builder, with the client to be provided to builder.
*/
public static Builder builder() {
return new Builder();
@@ -365,173 +280,4 @@ public final class HttpServiceProxyFactory implements InitializingBean, Embedded
}
}
/**
* Temporary class until bean-style initialization is removed.
*/
private static final class BuilderInitializedFactory {
private final HttpClientAdapter clientAdapter;
private final List<HttpServiceArgumentResolver> argumentResolvers;
@Nullable
private final StringValueResolver embeddedValueResolver;
private final ReactiveAdapterRegistry reactiveAdapterRegistry;
private final Duration blockTimeout;
private BuilderInitializedFactory(
HttpClientAdapter clientAdapter, List<HttpServiceArgumentResolver> argumentResolvers,
@Nullable StringValueResolver embeddedValueResolver,
ReactiveAdapterRegistry reactiveAdapterRegistry, Duration blockTimeout) {
this.clientAdapter = clientAdapter;
this.argumentResolvers = argumentResolvers;
this.embeddedValueResolver = embeddedValueResolver;
this.reactiveAdapterRegistry = reactiveAdapterRegistry;
this.blockTimeout = blockTimeout;
}
public <S> S createClient(Class<S> serviceType) {
List<HttpServiceMethod> httpServiceMethods =
MethodIntrospector.selectMethods(serviceType, this::isExchangeMethod).stream()
.map(method -> createHttpServiceMethod(serviceType, method))
.toList();
return ProxyFactory.getProxy(serviceType, new HttpServiceMethodInterceptor(httpServiceMethods));
}
private boolean isExchangeMethod(Method method) {
return AnnotatedElementUtils.hasAnnotation(method, HttpExchange.class);
}
private <S> HttpServiceMethod createHttpServiceMethod(Class<S> serviceType, Method method) {
Assert.notNull(this.argumentResolvers,
"No argument resolvers: afterPropertiesSet was not called");
return new HttpServiceMethod(
method, serviceType, this.argumentResolvers, this.clientAdapter,
this.embeddedValueResolver, this.reactiveAdapterRegistry, this.blockTimeout);
}
}
/**
* Temporary class to support bean-style initialization during deprecation period.
*/
private static final class BeanStyleFactory implements InitializingBean, EmbeddedValueResolverAware {
private final HttpClientAdapter clientAdapter;
@Nullable
private List<HttpServiceArgumentResolver> customArgumentResolvers;
@Nullable
private List<HttpServiceArgumentResolver> argumentResolvers;
@Nullable
private ConversionService conversionService;
@Nullable
private StringValueResolver embeddedValueResolver;
private ReactiveAdapterRegistry reactiveAdapterRegistry = ReactiveAdapterRegistry.getSharedInstance();
private Duration blockTimeout = Duration.ofSeconds(5);
BeanStyleFactory(HttpClientAdapter clientAdapter) {
Assert.notNull(clientAdapter, "HttpClientAdapter is required");
this.clientAdapter = clientAdapter;
}
public void addCustomArgumentResolver(HttpServiceArgumentResolver resolver) {
if (this.customArgumentResolvers == null) {
this.customArgumentResolvers = new ArrayList<>();
}
this.customArgumentResolvers.add(resolver);
}
public void setCustomArgumentResolvers(List<HttpServiceArgumentResolver> resolvers) {
this.customArgumentResolvers = new ArrayList<>(resolvers);
}
public void setConversionService(ConversionService conversionService) {
this.conversionService = conversionService;
}
@Override
public void setEmbeddedValueResolver(StringValueResolver resolver) {
this.embeddedValueResolver = resolver;
}
public void setReactiveAdapterRegistry(ReactiveAdapterRegistry registry) {
this.reactiveAdapterRegistry = registry;
}
public void setBlockTimeout(Duration blockTimeout) {
this.blockTimeout = blockTimeout;
}
@Override
public void afterPropertiesSet() throws Exception {
this.conversionService = (this.conversionService != null ?
this.conversionService : new DefaultFormattingConversionService());
this.argumentResolvers = initArgumentResolvers(this.conversionService);
}
private List<HttpServiceArgumentResolver> initArgumentResolvers(ConversionService conversionService) {
List<HttpServiceArgumentResolver> resolvers = new ArrayList<>();
// Custom
if (this.customArgumentResolvers != null) {
resolvers.addAll(this.customArgumentResolvers);
}
// Annotation-based
resolvers.add(new RequestHeaderArgumentResolver(conversionService));
resolvers.add(new RequestBodyArgumentResolver(this.reactiveAdapterRegistry));
resolvers.add(new PathVariableArgumentResolver(conversionService));
resolvers.add(new RequestParamArgumentResolver(conversionService));
resolvers.add(new RequestPartArgumentResolver(this.reactiveAdapterRegistry));
resolvers.add(new CookieValueArgumentResolver(conversionService));
resolvers.add(new RequestAttributeArgumentResolver());
// Specific type
resolvers.add(new UrlArgumentResolver());
resolvers.add(new HttpMethodArgumentResolver());
return resolvers;
}
public <S> S createClient(Class<S> serviceType) {
List<HttpServiceMethod> httpServiceMethods =
MethodIntrospector.selectMethods(serviceType, this::isExchangeMethod).stream()
.map(method -> createHttpServiceMethod(serviceType, method))
.toList();
return ProxyFactory.getProxy(serviceType, new HttpServiceMethodInterceptor(httpServiceMethods));
}
private boolean isExchangeMethod(Method method) {
return AnnotatedElementUtils.hasAnnotation(method, HttpExchange.class);
}
private <S> HttpServiceMethod createHttpServiceMethod(Class<S> serviceType, Method method) {
Assert.notNull(this.argumentResolvers,
"No argument resolvers: afterPropertiesSet was not called");
return new HttpServiceMethod(
method, serviceType, this.argumentResolvers, this.clientAdapter,
this.embeddedValueResolver, this.reactiveAdapterRegistry, this.blockTimeout);
}
}
}