Skip to content

Commit 2fb90cb

Browse files
poutsmapoutsma
committed
Support for byte-range requests in WebMvc.fn
This commit introduces support for byte-range requests in Servlet Functional endpoints. Closes gh-24562
1 parent c237338 commit 2fb90cb

File tree

2 files changed

+100
-9
lines changed

2 files changed

+100
-9
lines changed

‎spring-webmvc/src/main/java/org/springframework/web/servlet/function/DefaultEntityResponseBuilder.java

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2019 the original author or authors.
2+
* Copyright 2002-2020 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -41,9 +41,13 @@
4141
import org.reactivestreams.Subscription;
4242

4343
import org.springframework.core.ParameterizedTypeReference;
44+
import org.springframework.core.io.InputStreamResource;
45+
import org.springframework.core.io.Resource;
46+
import org.springframework.core.io.support.ResourceRegion;
4447
import org.springframework.http.CacheControl;
4548
import org.springframework.http.HttpHeaders;
4649
import org.springframework.http.HttpMethod;
50+
import org.springframework.http.HttpRange;
4751
import org.springframework.http.HttpStatus;
4852
import org.springframework.http.InvalidMediaTypeException;
4953
import org.springframework.http.MediaType;
@@ -70,6 +74,9 @@ final class DefaultEntityResponseBuilder<T> implements EntityResponse.Builder<T>
7074
private static final boolean reactiveStreamsPresent = ClassUtils.isPresent(
7175
"org.reactivestreams.Publisher", DefaultEntityResponseBuilder.class.getClassLoader());
7276

77+
private static final Type RESOURCE_REGION_LIST_TYPE =
78+
new ParameterizedTypeReference<List<ResourceRegion>>() { }.getType();
79+
7380

7481
private final T entity;
7582

@@ -245,6 +252,11 @@ public DefaultEntityResponse(int statusCode, HttpHeaders headers,
245252
this.entityType = entityType;
246253
}
247254

255+
private static <T> boolean isResource(T entity) {
256+
return !(entity instanceof InputStreamResource) &&
257+
(entity instanceof Resource);
258+
}
259+
248260
@Override
249261
public T entity() {
250262
return this.entity;
@@ -267,13 +279,33 @@ protected void writeEntityWithMessageConverters(Object entity, HttpServletReques
267279
ServletServerHttpResponse serverResponse = new ServletServerHttpResponse(response);
268280
MediaType contentType = getContentType(response);
269281
Class<?> entityClass = entity.getClass();
282+
Type entityType = this.entityType;
283+
284+
if (entityClass != InputStreamResource.class && Resource.class.isAssignableFrom(entityClass)) {
285+
serverResponse.getHeaders().set(HttpHeaders.ACCEPT_RANGES, "bytes");
286+
String rangeHeader = request.getHeader(HttpHeaders.RANGE);
287+
if (rangeHeader != null) {
288+
Resource resource = (Resource) entity;
289+
try {
290+
List<HttpRange> httpRanges = HttpRange.parseRanges(rangeHeader);
291+
serverResponse.getServletResponse().setStatus(HttpStatus.PARTIAL_CONTENT.value());
292+
entity = HttpRange.toResourceRegions(httpRanges, resource);
293+
entityClass = entity.getClass();
294+
entityType = RESOURCE_REGION_LIST_TYPE;
295+
}
296+
catch (IllegalArgumentException ex) {
297+
serverResponse.getHeaders().set(HttpHeaders.CONTENT_RANGE, "bytes */" + resource.contentLength());
298+
serverResponse.getServletResponse().setStatus(HttpStatus.REQUESTED_RANGE_NOT_SATISFIABLE.value());
299+
}
300+
}
301+
}
270302

271303
for (HttpMessageConverter<?> messageConverter : context.messageConverters()) {
272304
if (messageConverter instanceof GenericHttpMessageConverter<?>) {
273305
GenericHttpMessageConverter<Object> genericMessageConverter =
274306
(GenericHttpMessageConverter<Object>) messageConverter;
275-
if (genericMessageConverter.canWrite(this.entityType, entityClass, contentType)) {
276-
genericMessageConverter.write(entity, this.entityType, contentType, serverResponse);
307+
if (genericMessageConverter.canWrite(entityType, entityClass, contentType)) {
308+
genericMessageConverter.write(entity, entityType, contentType, serverResponse);
277309
return;
278310
}
279311
}

‎spring-webmvc/src/test/java/org/springframework/web/servlet/function/ResourceHandlerFunctionTests.java

Lines changed: 65 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2019 the original author or authors.
2+
* Copyright 2002-2020 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -17,7 +17,9 @@
1717
package org.springframework.web.servlet.function;
1818

1919
import java.io.IOException;
20+
import java.io.InputStream;
2021
import java.nio.file.Files;
22+
import java.util.Arrays;
2123
import java.util.Collections;
2224
import java.util.EnumSet;
2325
import java.util.List;
@@ -29,11 +31,13 @@
2931

3032
import org.springframework.core.io.ClassPathResource;
3133
import org.springframework.core.io.Resource;
34+
import org.springframework.http.HttpHeaders;
3235
import org.springframework.http.HttpMethod;
3336
import org.springframework.http.HttpStatus;
3437
import org.springframework.http.MediaType;
3538
import org.springframework.http.converter.HttpMessageConverter;
3639
import org.springframework.http.converter.ResourceHttpMessageConverter;
40+
import org.springframework.http.converter.ResourceRegionHttpMessageConverter;
3741
import org.springframework.web.servlet.ModelAndView;
3842
import org.springframework.web.testfixture.servlet.MockHttpServletRequest;
3943
import org.springframework.web.testfixture.servlet.MockHttpServletResponse;
@@ -56,10 +60,11 @@ public class ResourceHandlerFunctionTests {
5660
@BeforeEach
5761
public void createContext() {
5862
this.messageConverter = new ResourceHttpMessageConverter();
63+
ResourceRegionHttpMessageConverter regionConverter = new ResourceRegionHttpMessageConverter();
5964
this.context = new ServerResponse.Context() {
6065
@Override
6166
public List<HttpMessageConverter<?>> messageConverters() {
62-
return Collections.singletonList(messageConverter);
67+
return Arrays.asList(messageConverter, regionConverter);
6368
}
6469

6570
};
@@ -73,8 +78,7 @@ public void get() throws IOException, ServletException {
7378

7479
ServerResponse response = this.handlerFunction.handle(request);
7580
assertThat(response.statusCode()).isEqualTo(HttpStatus.OK);
76-
boolean condition = response instanceof EntityResponse;
77-
assertThat(condition).isTrue();
81+
assertThat(response).isInstanceOf(EntityResponse.class);
7882
@SuppressWarnings("unchecked")
7983
EntityResponse<Resource> entityResponse = (EntityResponse<Resource>) response;
8084
assertThat(entityResponse.entity()).isEqualTo(this.resource);
@@ -91,15 +95,69 @@ public void get() throws IOException, ServletException {
9195
assertThat(servletResponse.getContentLength()).isEqualTo(this.resource.contentLength());
9296
}
9397

98+
@Test
99+
public void getRange() throws IOException, ServletException {
100+
MockHttpServletRequest servletRequest = new MockHttpServletRequest("GET", "/");
101+
servletRequest.addHeader("Range", "bytes=0-5");
102+
ServerRequest request = new DefaultServerRequest(servletRequest, Collections.singletonList(messageConverter));
103+
104+
ServerResponse response = this.handlerFunction.handle(request);
105+
assertThat(response.statusCode()).isEqualTo(HttpStatus.OK);
106+
assertThat(response).isInstanceOf(EntityResponse.class);
107+
@SuppressWarnings("unchecked")
108+
EntityResponse<Resource> entityResponse = (EntityResponse<Resource>) response;
109+
assertThat(entityResponse.entity()).isEqualTo(this.resource);
110+
111+
MockHttpServletResponse servletResponse = new MockHttpServletResponse();
112+
ModelAndView mav = response.writeTo(servletRequest, servletResponse, this.context);
113+
assertThat(mav).isNull();
114+
115+
assertThat(servletResponse.getStatus()).isEqualTo(206);
116+
byte[] expectedBytes = new byte[6];
117+
try (InputStream is = this.resource.getInputStream()) {
118+
is.read(expectedBytes);
119+
}
120+
byte[] actualBytes = servletResponse.getContentAsByteArray();
121+
assertThat(actualBytes).isEqualTo(expectedBytes);
122+
assertThat(servletResponse.getContentType()).isEqualTo(MediaType.TEXT_PLAIN_VALUE);
123+
assertThat(servletResponse.getContentLength()).isEqualTo(6);
124+
assertThat(servletResponse.getHeader(HttpHeaders.ACCEPT_RANGES)).isEqualTo("bytes");
125+
}
126+
127+
@Test
128+
public void getInvalidRange() throws IOException, ServletException {
129+
MockHttpServletRequest servletRequest = new MockHttpServletRequest("GET", "/");
130+
servletRequest.addHeader("Range", "bytes=0-10, 0-10, 0-10, 0-10, 0-10, 0-10");
131+
ServerRequest request = new DefaultServerRequest(servletRequest, Collections.singletonList(messageConverter));
132+
133+
ServerResponse response = this.handlerFunction.handle(request);
134+
assertThat(response.statusCode()).isEqualTo(HttpStatus.OK);
135+
assertThat(response).isInstanceOf(EntityResponse.class);
136+
@SuppressWarnings("unchecked")
137+
EntityResponse<Resource> entityResponse = (EntityResponse<Resource>) response;
138+
assertThat(entityResponse.entity()).isEqualTo(this.resource);
139+
140+
MockHttpServletResponse servletResponse = new MockHttpServletResponse();
141+
ModelAndView mav = response.writeTo(servletRequest, servletResponse, this.context);
142+
assertThat(mav).isNull();
143+
144+
assertThat(servletResponse.getStatus()).isEqualTo(416);
145+
byte[] expectedBytes = Files.readAllBytes(this.resource.getFile().toPath());
146+
byte[] actualBytes = servletResponse.getContentAsByteArray();
147+
assertThat(actualBytes).isEqualTo(expectedBytes);
148+
assertThat(servletResponse.getContentType()).isEqualTo(MediaType.TEXT_PLAIN_VALUE);
149+
assertThat(servletResponse.getContentLength()).isEqualTo(this.resource.contentLength());
150+
assertThat(servletResponse.getHeader(HttpHeaders.ACCEPT_RANGES)).isEqualTo("bytes");
151+
}
152+
94153
@Test
95154
public void head() throws IOException, ServletException {
96155
MockHttpServletRequest servletRequest = new MockHttpServletRequest("HEAD", "/");
97156
ServerRequest request = new DefaultServerRequest(servletRequest, Collections.singletonList(messageConverter));
98157

99158
ServerResponse response = this.handlerFunction.handle(request);
100159
assertThat(response.statusCode()).isEqualTo(HttpStatus.OK);
101-
boolean condition = response instanceof EntityResponse;
102-
assertThat(condition).isTrue();
160+
assertThat(response).isInstanceOf(EntityResponse.class);
103161
@SuppressWarnings("unchecked")
104162
EntityResponse<Resource> entityResponse = (EntityResponse<Resource>) response;
105163
assertThat(entityResponse.entity().getFilename()).isEqualTo(this.resource.getFilename());
@@ -136,4 +194,5 @@ public void options() throws ServletException, IOException {
136194
assertThat(actualBytes.length).isEqualTo(0);
137195
}
138196

197+
139198
}

0 commit comments

Comments
 (0)