org.springframework.http.server.reactive.ServletHttpHandlerAdapter Maven / Gradle / Ivy
/*
* 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.http.server.reactive;
import java.io.IOException;
import java.net.URISyntaxException;
import java.util.Collection;
import java.util.concurrent.atomic.AtomicBoolean;
import jakarta.servlet.AsyncContext;
import jakarta.servlet.AsyncEvent;
import jakarta.servlet.AsyncListener;
import jakarta.servlet.DispatcherType;
import jakarta.servlet.Servlet;
import jakarta.servlet.ServletConfig;
import jakarta.servlet.ServletException;
import jakarta.servlet.ServletRegistration;
import jakarta.servlet.ServletRequest;
import jakarta.servlet.ServletResponse;
import jakarta.servlet.http.HttpServlet;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.apache.commons.logging.Log;
import org.reactivestreams.Subscriber;
import org.reactivestreams.Subscription;
import org.springframework.core.io.buffer.DataBufferFactory;
import org.springframework.core.io.buffer.DefaultDataBufferFactory;
import org.springframework.http.HttpLogging;
import org.springframework.http.HttpMethod;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
/**
* Adapt {@link HttpHandler} to an {@link HttpServlet} using Servlet Async support
* and Servlet non-blocking I/O.
*
* @author Arjen Poutsma
* @author Rossen Stoyanchev
* @since 5.0
* @see org.springframework.web.server.adapter.AbstractReactiveWebInitializer
*/
public class ServletHttpHandlerAdapter implements Servlet {
private static final Log logger = HttpLogging.forLogName(ServletHttpHandlerAdapter.class);
private static final int DEFAULT_BUFFER_SIZE = 8192;
private static final String WRITE_ERROR_ATTRIBUTE_NAME = ServletHttpHandlerAdapter.class.getName() + ".ERROR";
private final HttpHandler httpHandler;
private int bufferSize = DEFAULT_BUFFER_SIZE;
@Nullable
private String servletPath;
private DataBufferFactory dataBufferFactory = DefaultDataBufferFactory.sharedInstance;
public ServletHttpHandlerAdapter(HttpHandler httpHandler) {
Assert.notNull(httpHandler, "HttpHandler must not be null");
this.httpHandler = httpHandler;
}
/**
* Set the size of the input buffer used for reading in bytes.
* By default this is set to 8192.
*/
public void setBufferSize(int bufferSize) {
Assert.isTrue(bufferSize > 0, "Buffer size must be larger than zero");
this.bufferSize = bufferSize;
}
/**
* Return the configured input buffer size.
*/
public int getBufferSize() {
return this.bufferSize;
}
/**
* Return the Servlet path under which the Servlet is deployed by checking
* the Servlet registration from {@link #init(ServletConfig)}.
* @return the path, or an empty string if the Servlet is deployed without
* a prefix (i.e. "/" or "/*"), or {@code null} if this method is invoked
* before the {@link #init(ServletConfig)} Servlet container callback.
*/
@Nullable
public String getServletPath() {
return this.servletPath;
}
public void setDataBufferFactory(DataBufferFactory dataBufferFactory) {
Assert.notNull(dataBufferFactory, "DataBufferFactory must not be null");
this.dataBufferFactory = dataBufferFactory;
}
public DataBufferFactory getDataBufferFactory() {
return this.dataBufferFactory;
}
// Servlet methods...
@Override
public void init(ServletConfig config) {
this.servletPath = getServletPath(config);
}
private String getServletPath(ServletConfig config) {
String name = config.getServletName();
ServletRegistration registration = config.getServletContext().getServletRegistration(name);
if (registration == null) {
throw new IllegalStateException("ServletRegistration not found for Servlet '" + name + "'");
}
Collection mappings = registration.getMappings();
if (mappings.size() == 1) {
String mapping = mappings.iterator().next();
if (mapping.equals("/")) {
return "";
}
if (mapping.endsWith("/*")) {
String path = mapping.substring(0, mapping.length() - 2);
if (!path.isEmpty() && logger.isDebugEnabled()) {
logger.debug("Found servlet mapping prefix '" + path + "' for '" + name + "'");
}
return path;
}
}
throw new IllegalArgumentException("Expected a single Servlet mapping: " +
"either the default Servlet mapping (i.e. '/'), " +
"or a path based mapping (e.g. '/*', '/foo/*'). " +
"Actual mappings: " + mappings + " for Servlet '" + name + "'");
}
@Override
public void service(ServletRequest request, ServletResponse response) throws ServletException, IOException {
// Check for existing error attribute first
if (DispatcherType.ASYNC == request.getDispatcherType()) {
Throwable ex = (Throwable) request.getAttribute(WRITE_ERROR_ATTRIBUTE_NAME);
throw new ServletException("Failed to create response content", ex);
}
// Start async before Read/WriteListener registration
AsyncContext asyncContext = request.startAsync();
asyncContext.setTimeout(-1);
ServletServerHttpRequest httpRequest;
AsyncListener requestListener;
String logPrefix;
try {
httpRequest = createRequest(((HttpServletRequest) request), asyncContext);
requestListener = httpRequest.getAsyncListener();
logPrefix = httpRequest.getLogPrefix();
}
catch (URISyntaxException ex) {
if (logger.isDebugEnabled()) {
logger.debug("Failed to get request URL: " + ex.getMessage());
}
((HttpServletResponse) response).setStatus(400);
asyncContext.complete();
return;
}
ServerHttpResponse httpResponse = createResponse(((HttpServletResponse) response), asyncContext, httpRequest);
AsyncListener responseListener = ((ServletServerHttpResponse) httpResponse).getAsyncListener();
if (httpRequest.getMethod() == HttpMethod.HEAD) {
httpResponse = new HttpHeadResponseDecorator(httpResponse);
}
AtomicBoolean completionFlag = new AtomicBoolean();
HandlerResultSubscriber subscriber = new HandlerResultSubscriber(asyncContext, completionFlag, logPrefix);
asyncContext.addListener(new HttpHandlerAsyncListener(
requestListener, responseListener, subscriber, completionFlag, logPrefix));
this.httpHandler.handle(httpRequest, httpResponse).subscribe(subscriber);
}
protected ServletServerHttpRequest createRequest(HttpServletRequest request, AsyncContext context)
throws IOException, URISyntaxException {
Assert.state(this.servletPath != null, "Servlet path is not initialized");
return new ServletServerHttpRequest(
request, context, this.servletPath, getDataBufferFactory(), getBufferSize());
}
protected ServletServerHttpResponse createResponse(HttpServletResponse response,
AsyncContext context, ServletServerHttpRequest request) throws IOException {
return new ServletServerHttpResponse(response, context, getDataBufferFactory(), getBufferSize(), request);
}
@Override
public String getServletInfo() {
return "";
}
@Override
@Nullable
public ServletConfig getServletConfig() {
return null;
}
@Override
public void destroy() {
}
private static void runIfAsyncNotComplete(AsyncContext asyncContext, AtomicBoolean isCompleted, Runnable task) {
try {
if (asyncContext.getRequest().isAsyncStarted() && isCompleted.compareAndSet(false, true)) {
task.run();
}
}
catch (IllegalStateException ex) {
// Ignore: AsyncContext recycled and should not be used
// e.g. TIMEOUT_LISTENER (above) may have completed the AsyncContext
}
}
/**
* AsyncListener to complete the {@link AsyncContext} in case of error or
* timeout notifications from the container
* Additional {@link AsyncListener}s are registered in
* {@link ServletServerHttpRequest} to signal onError/onComplete to the
* request body Subscriber, and in {@link ServletServerHttpResponse} to
* cancel the write Publisher and signal onError/onComplete downstream to
* the writing result Subscriber.
*/
private static class HttpHandlerAsyncListener implements AsyncListener {
private final AsyncListener requestAsyncListener;
private final AsyncListener responseAsyncListener;
// We cannot have AsyncListener and HandlerResultSubscriber until WildFly 12+:
// https://issues.jboss.org/browse/WFLY-8515
private final Runnable handlerDisposeTask;
private final AtomicBoolean completionFlag;
private final String logPrefix;
public HttpHandlerAsyncListener(
AsyncListener requestAsyncListener, AsyncListener responseAsyncListener,
Runnable handlerDisposeTask, AtomicBoolean completionFlag, String logPrefix) {
this.requestAsyncListener = requestAsyncListener;
this.responseAsyncListener = responseAsyncListener;
this.handlerDisposeTask = handlerDisposeTask;
this.completionFlag = completionFlag;
this.logPrefix = logPrefix;
}
@Override
public void onTimeout(AsyncEvent event) {
// Should never happen since we call asyncContext.setTimeout(-1)
if (logger.isDebugEnabled()) {
logger.debug(this.logPrefix + "AsyncEvent onTimeout");
}
delegateTimeout(this.requestAsyncListener, event);
delegateTimeout(this.responseAsyncListener, event);
handleTimeoutOrError(event);
}
@Override
public void onError(AsyncEvent event) {
Throwable ex = event.getThrowable();
if (logger.isDebugEnabled()) {
logger.debug(this.logPrefix + "AsyncEvent onError: " + (ex != null ? ex : ""));
}
delegateError(this.requestAsyncListener, event);
delegateError(this.responseAsyncListener, event);
handleTimeoutOrError(event);
}
@Override
public void onComplete(AsyncEvent event) {
delegateComplete(this.requestAsyncListener, event);
delegateComplete(this.responseAsyncListener, event);
}
private static void delegateTimeout(AsyncListener listener, AsyncEvent event) {
try {
listener.onTimeout(event);
}
catch (Exception ex) {
// Ignore
}
}
private static void delegateError(AsyncListener listener, AsyncEvent event) {
try {
listener.onError(event);
}
catch (Exception ex) {
// Ignore
}
}
private static void delegateComplete(AsyncListener listener, AsyncEvent event) {
try {
listener.onComplete(event);
}
catch (Exception ex) {
// Ignore
}
}
private void handleTimeoutOrError(AsyncEvent event) {
AsyncContext context = event.getAsyncContext();
runIfAsyncNotComplete(context, this.completionFlag, () -> {
try {
this.handlerDisposeTask.run();
}
finally {
context.complete();
}
});
}
@Override
public void onStartAsync(AsyncEvent event) {
// no-op
}
}
private static class HandlerResultSubscriber implements Subscriber, Runnable {
private final AsyncContext asyncContext;
private final AtomicBoolean completionFlag;
private final String logPrefix;
@Nullable
private volatile Subscription subscription;
public HandlerResultSubscriber(
AsyncContext asyncContext, AtomicBoolean completionFlag, String logPrefix) {
this.asyncContext = asyncContext;
this.completionFlag = completionFlag;
this.logPrefix = logPrefix;
}
@Override
public void onSubscribe(Subscription subscription) {
this.subscription = subscription;
subscription.request(Long.MAX_VALUE);
}
@Override
public void onNext(Void aVoid) {
// no-op
}
@Override
public void onError(Throwable ex) {
if (logger.isTraceEnabled()) {
logger.trace(this.logPrefix + "onError: " + ex);
}
runIfAsyncNotComplete(this.asyncContext, this.completionFlag, () -> {
if (this.asyncContext.getResponse().isCommitted()) {
logger.trace(this.logPrefix + "Dispatch to container, to raise the error on servlet thread");
this.asyncContext.getRequest().setAttribute(WRITE_ERROR_ATTRIBUTE_NAME, ex);
this.asyncContext.dispatch();
}
else {
try {
logger.trace(this.logPrefix + "Setting ServletResponse status to 500 Server Error");
this.asyncContext.getResponse().resetBuffer();
((HttpServletResponse) this.asyncContext.getResponse()).setStatus(500);
}
finally {
this.asyncContext.complete();
}
}
});
}
@Override
public void onComplete() {
if (logger.isTraceEnabled()) {
logger.trace(this.logPrefix + "onComplete");
}
runIfAsyncNotComplete(this.asyncContext, this.completionFlag, this.asyncContext::complete);
}
@Override
public void run() {
Subscription s = this.subscription;
if (s != null) {
s.cancel();
}
}
}
}