Remove deprecated web APIs

See gh-33809
This commit is contained in:
rstoyanchev
2025-01-15 13:02:20 +00:00
parent 83c020eea5
commit 4920086225
38 changed files with 65 additions and 1305 deletions

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2024 the original author or authors.
* Copyright 2002-2025 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.
@@ -124,12 +124,6 @@ class DefaultServerRequest implements ServerRequest {
return HttpMethod.valueOf(servletRequest().getMethod());
}
@Override
@Deprecated
public String methodName() {
return servletRequest().getMethod();
}
@Override
public URI uri() {
return this.serverHttpRequest.getURI();

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2023 the original author or authors.
* Copyright 2002-2025 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.
@@ -251,12 +251,6 @@ class DefaultServerRequestBuilder implements ServerRequest.Builder {
return this.method;
}
@Override
@Deprecated
public String methodName() {
return this.method.name();
}
@Override
public MultiValueMap<String, Part> multipartData() throws IOException, ServletException {
return servletRequest().getParts().stream()

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2024 the original author or authors.
* Copyright 2002-2025 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.
@@ -1048,7 +1048,7 @@ public abstract class RequestPredicates {
@Override
public String toString() {
return "!" + this.delegate.toString();
return "!" + this.delegate;
}
}
@@ -1142,12 +1142,6 @@ public abstract class RequestPredicates {
return this.delegate.method();
}
@Override
@Deprecated
public String methodName() {
return this.delegate.methodName();
}
@Override
public URI uri() {
return this.delegate.uri();
@@ -1163,12 +1157,6 @@ public abstract class RequestPredicates {
return this.delegate.path();
}
@Override
@Deprecated
public PathContainer pathContainer() {
return this.delegate.pathContainer();
}
@Override
public RequestPath requestPath() {
return this.delegate.requestPath();
@@ -1383,11 +1371,5 @@ public abstract class RequestPredicates {
public String path() {
return this.requestPath.pathWithinApplication().value();
}
@Override
@Deprecated
public PathContainer pathContainer() {
return this.requestPath;
}
}
}

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2023 the original author or authors.
* Copyright 2002-2025 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.
@@ -43,7 +43,6 @@ import org.springframework.http.HttpMethod;
import org.springframework.http.HttpRange;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.server.PathContainer;
import org.springframework.http.server.RequestPath;
import org.springframework.util.Assert;
import org.springframework.util.CollectionUtils;
@@ -70,14 +69,6 @@ public interface ServerRequest {
*/
HttpMethod method();
/**
* Get the name of the HTTP method.
* @return the HTTP method as a String
* @deprecated in favor of {@link #method()}
*/
@Deprecated
String methodName();
/**
* Get the request URI.
*/
@@ -97,15 +88,6 @@ public interface ServerRequest {
return requestPath().pathWithinApplication().value();
}
/**
* Get the request path as a {@code PathContainer}.
* @deprecated as of 5.3, in favor on {@link #requestPath()}
*/
@Deprecated
default PathContainer pathContainer() {
return requestPath();
}
/**
* Get the request path as a {@code PathContainer}.
* @since 5.3

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2024 the original author or authors.
* Copyright 2002-2025 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.
@@ -23,7 +23,6 @@ import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
@@ -511,30 +510,12 @@ public abstract class AbstractHandlerMethodMapping<T> extends AbstractHandlerMap
*/
protected abstract @Nullable T getMappingForMethod(Method method, Class<?> handlerType);
/**
* Extract and return the URL paths contained in the supplied mapping.
* @deprecated as of 5.3 in favor of providing non-pattern mappings via
* {@link #getDirectPaths(Object)} instead
*/
@Deprecated
protected Set<String> getMappingPathPatterns(T mapping) {
return Collections.emptySet();
}
/**
* Return the request mapping paths that are not patterns.
* @since 5.3
*/
@SuppressWarnings("removal")
protected Set<String> getDirectPaths(T mapping) {
Set<String> urls = Collections.emptySet();
for (String path : getMappingPathPatterns(mapping)) {
if (!getPathMatcher().isPattern(path)) {
urls = (urls.isEmpty() ? new HashSet<>(1) : urls);
urls.add(path);
}
}
return urls;
return Collections.emptySet();
}
/**

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2024 the original author or authors.
* Copyright 2002-2025 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.
@@ -224,34 +224,6 @@ public final class MappedInterceptor implements HandlerInterceptor {
return false;
}
/**
* Determine if there is a match for the given lookup path.
* @param lookupPath the current request path
* @param pathMatcher a path matcher for path pattern matching
* @return {@code true} if the interceptor applies to the given request path
* @deprecated as of 5.3 in favor of {@link #matches(HttpServletRequest)}
*/
@Deprecated(since = "5.3")
public boolean matches(String lookupPath, PathMatcher pathMatcher) {
pathMatcher = (this.pathMatcher != defaultPathMatcher ? this.pathMatcher : pathMatcher);
if (!ObjectUtils.isEmpty(this.excludePatterns)) {
for (PatternAdapter adapter : this.excludePatterns) {
if (pathMatcher.match(adapter.getPatternString(), lookupPath)) {
return false;
}
}
}
if (ObjectUtils.isEmpty(this.includePatterns)) {
return true;
}
for (PatternAdapter adapter : this.includePatterns) {
if (pathMatcher.match(adapter.getPatternString(), lookupPath)) {
return true;
}
}
return false;
}
// HandlerInterceptor delegation

View File

@@ -122,25 +122,6 @@ public class CookieLocaleResolver extends AbstractLocaleContextResolver {
}
/**
* Set the name of cookie created by this resolver.
* @param cookieName the cookie name
* @deprecated as of 6.0 in favor of {@link #CookieLocaleResolver(String)}
*/
@Deprecated
public void setCookieName(String cookieName) {
Assert.notNull(cookieName, "cookieName must not be null");
this.cookie = ResponseCookie.from(cookieName)
.maxAge(this.cookie.getMaxAge())
.domain(this.cookie.getDomain())
.path(this.cookie.getPath())
.secure(this.cookie.isSecure())
.httpOnly(this.cookie.isHttpOnly())
.sameSite(this.cookie.getSameSite())
.build();
}
/**
* Set the cookie "Max-Age" attribute.
* <p>By default, this is set to -1 in which case the cookie persists until
@@ -153,15 +134,6 @@ public class CookieLocaleResolver extends AbstractLocaleContextResolver {
this.cookie = this.cookie.mutate().maxAge(cookieMaxAge).build();
}
/**
* Variant of {@link #setCookieMaxAge(Duration)} with a value in seconds.
* @deprecated as of 6.0 in favor of {@link #setCookieMaxAge(Duration)}
*/
@Deprecated
public void setCookieMaxAge(@Nullable Integer cookieMaxAge) {
setCookieMaxAge(Duration.ofSeconds((cookieMaxAge != null) ? cookieMaxAge : -1));
}
/**
* Set the cookie "Path" attribute.
* <p>By default, this is set to {@code "/"}.
@@ -411,36 +383,4 @@ public class CookieLocaleResolver extends AbstractLocaleContextResolver {
return (isLanguageTagCompliant() ? locale.toLanguageTag() : locale.toString());
}
/**
* Determine the default locale for the given request, called if no locale
* cookie has been found.
* <p>The default implementation returns the configured default locale, if any,
* and otherwise falls back to the request's {@code Accept-Language} header
* locale or the default locale for the server.
* @param request the request to resolve the locale for
* @return the default locale (never {@code null})
* @see #setDefaultLocale
* @see jakarta.servlet.http.HttpServletRequest#getLocale()
* @deprecated as of 6.0, in favor of {@link #setDefaultLocaleFunction(Function)}
*/
@Deprecated(since = "6.0")
protected Locale determineDefaultLocale(HttpServletRequest request) {
return this.defaultLocaleFunction.apply(request);
}
/**
* Determine the default time zone for the given request, called if no locale
* cookie has been found.
* <p>The default implementation returns the configured default time zone,
* if any, or {@code null} otherwise.
* @param request the request to resolve the time zone for
* @return the default time zone (or {@code null} if none defined)
* @see #setDefaultTimeZone
* @deprecated as of 6.0, in favor of {@link #setDefaultTimeZoneFunction(Function)}
*/
@Deprecated(since = "6.0")
protected @Nullable TimeZone determineDefaultTimeZone(HttpServletRequest request) {
return this.defaultTimeZoneFunction.apply(request);
}
}

View File

@@ -193,38 +193,4 @@ public class SessionLocaleResolver extends AbstractLocaleContextResolver {
WebUtils.setSessionAttribute(request, this.timeZoneAttributeName, timeZone);
}
/**
* Determine the default locale for the given request, called if no
* {@link Locale} session attribute has been found.
* <p>The default implementation returns the configured
* {@linkplain #setDefaultLocale(Locale) default locale}, if any, and otherwise
* falls back to the request's {@code Accept-Language} header locale or the
* default locale for the server.
* @param request the request to resolve the locale for
* @return the default locale (never {@code null})
* @see #setDefaultLocale
* @see jakarta.servlet.http.HttpServletRequest#getLocale()
* @deprecated as of 6.0, in favor of {@link #setDefaultLocaleFunction(Function)}
*/
@Deprecated(since = "6.0")
protected Locale determineDefaultLocale(HttpServletRequest request) {
return this.defaultLocaleFunction.apply(request);
}
/**
* Determine the default time zone for the given request, called if no
* {@link TimeZone} session attribute has been found.
* <p>The default implementation returns the configured default time zone,
* if any, or {@code null} otherwise.
* @param request the request to resolve the time zone for
* @return the default time zone (or {@code null} if none defined)
* @see #setDefaultTimeZone
* @deprecated as of 6.0, in favor of {@link #setDefaultTimeZoneFunction(Function)}
*/
@Deprecated(since = "6.0")
protected @Nullable TimeZone determineDefaultTimeZone(HttpServletRequest request) {
return this.defaultTimeZoneFunction.apply(request);
}
}

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2024 the original author or authors.
* Copyright 2002-2025 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.
@@ -85,15 +85,6 @@ public abstract class RequestMappingInfoHandlerMapping extends AbstractHandlerMe
}
/**
* Get the URL path patterns associated with the supplied {@link RequestMappingInfo}.
*/
@Override
@SuppressWarnings("deprecation")
protected Set<String> getMappingPathPatterns(RequestMappingInfo info) {
return info.getPatternValues();
}
@Override
protected Set<String> getDirectPaths(RequestMappingInfo info) {
return info.getDirectPaths();

View File

@@ -1,296 +0,0 @@
/*
* Copyright 2002-2020 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.web.servlet.view;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.MissingResourceException;
import java.util.ResourceBundle;
import org.jspecify.annotations.Nullable;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.core.Ordered;
import org.springframework.web.context.support.GenericWebApplicationContext;
import org.springframework.web.servlet.View;
/**
* A {@link org.springframework.web.servlet.ViewResolver} implementation that uses
* bean definitions in a {@link ResourceBundle}, specified by the bundle basename.
*
* <p>The bundle is typically defined in a properties file, located in the classpath.
* The default bundle basename is "views".
*
* <p>This {@code ViewResolver} supports localized view definitions, using the
* default support of {@link java.util.PropertyResourceBundle}. For example, the
* basename "views" will be resolved as class path resources "views_de_AT.properties",
* "views_de.properties", "views.properties" - for a given Locale "de_AT".
*
* <p>Note: This {@code ViewResolver} implements the {@link Ordered} interface
* in order to allow for flexible participation in {@code ViewResolver} chaining.
* For example, some special views could be defined via this {@code ViewResolver}
* (giving it 0 as "order" value), while all remaining views could be resolved by
* a {@link UrlBasedViewResolver}.
*
* @author Rod Johnson
* @author Juergen Hoeller
* @see java.util.ResourceBundle#getBundle
* @see java.util.PropertyResourceBundle
* @see UrlBasedViewResolver
* @see BeanNameViewResolver
* @deprecated as of 5.3, in favor of Spring's common view resolver variants
* and/or custom resolver implementations
*/
@Deprecated
public class ResourceBundleViewResolver extends AbstractCachingViewResolver
implements Ordered, InitializingBean, DisposableBean {
/** The default basename if no other basename is supplied. */
public static final String DEFAULT_BASENAME = "views";
private String[] basenames = new String[] {DEFAULT_BASENAME};
private ClassLoader bundleClassLoader = Thread.currentThread().getContextClassLoader();
private @Nullable String defaultParentView;
private Locale @Nullable [] localesToInitialize;
private int order = Ordered.LOWEST_PRECEDENCE; // default: same as non-Ordered
/* Locale -> BeanFactory */
private final Map<Locale, BeanFactory> localeCache = new HashMap<>();
/* List of ResourceBundle -> BeanFactory */
private final Map<List<ResourceBundle>, ConfigurableApplicationContext> bundleCache = new HashMap<>();
/**
* Set a single basename, following {@link java.util.ResourceBundle} conventions.
* The default is "views".
* <p>{@code ResourceBundle} supports different locale suffixes. For example,
* a base name of "views" might map to {@code ResourceBundle} files
* "views", "views_en_au" and "views_de".
* <p>Note that ResourceBundle names are effectively classpath locations: As a
* consequence, the JDK's standard ResourceBundle treats dots as package separators.
* This means that "test.theme" is effectively equivalent to "test/theme",
* just like it is for programmatic {@code java.util.ResourceBundle} usage.
* @see #setBasenames
* @see ResourceBundle#getBundle(String)
* @see ResourceBundle#getBundle(String, Locale)
*/
public void setBasename(String basename) {
setBasenames(basename);
}
/**
* Set an array of basenames, each following {@link java.util.ResourceBundle}
* conventions. The default is a single basename "views".
* <p>{@code ResourceBundle} supports different locale suffixes. For example,
* a base name of "views" might map to {@code ResourceBundle} files
* "views", "views_en_au" and "views_de".
* <p>The associated resource bundles will be checked sequentially when resolving
* a message code. Note that message definitions in a <i>previous</i> resource
* bundle will override ones in a later bundle, due to the sequential lookup.
* <p>Note that ResourceBundle names are effectively classpath locations: As a
* consequence, the JDK's standard ResourceBundle treats dots as package separators.
* This means that "test.theme" is effectively equivalent to "test/theme",
* just like it is for programmatic {@code java.util.ResourceBundle} usage.
* @see #setBasename
* @see ResourceBundle#getBundle(String)
* @see ResourceBundle#getBundle(String, Locale)
*/
public void setBasenames(String... basenames) {
this.basenames = basenames;
}
/**
* Set the {@link ClassLoader} to load resource bundles with.
* Default is the thread context {@code ClassLoader}.
*/
public void setBundleClassLoader(ClassLoader classLoader) {
this.bundleClassLoader = classLoader;
}
/**
* Return the {@link ClassLoader} to load resource bundles with.
* <p>Default is the specified bundle {@code ClassLoader},
* usually the thread context {@code ClassLoader}.
*/
protected ClassLoader getBundleClassLoader() {
return this.bundleClassLoader;
}
/**
* Set the default parent for views defined in the {@code ResourceBundle}.
* <p>This avoids repeated "yyy1.(parent)=xxx", "yyy2.(parent)=xxx" definitions
* in the bundle, especially if all defined views share the same parent.
* <p>The parent will typically define the view class and common attributes.
* Concrete views might simply consist of a URL definition then:
* a la "yyy1.url=/my.jsp", "yyy2.url=/your.jsp".
* <p>View definitions that define their own parent or carry their own
* class can still override this. Strictly speaking, the rule that a
* default parent setting does not apply to a bean definition that
* carries a class is there for backwards compatibility reasons.
* It still matches the typical use case.
*/
public void setDefaultParentView(String defaultParentView) {
this.defaultParentView = defaultParentView;
}
/**
* Specify Locales to initialize eagerly, rather than lazily when actually accessed.
* <p>Allows for pre-initialization of common Locales, eagerly checking
* the view configuration for those Locales.
*/
public void setLocalesToInitialize(Locale... localesToInitialize) {
this.localesToInitialize = localesToInitialize;
}
/**
* Specify the order value for this ViewResolver bean.
* <p>The default value is {@code Ordered.LOWEST_PRECEDENCE}, meaning non-ordered.
* @see org.springframework.core.Ordered#getOrder()
*/
public void setOrder(int order) {
this.order = order;
}
@Override
public int getOrder() {
return this.order;
}
/**
* Eagerly initialize Locales if necessary.
* @see #setLocalesToInitialize
*/
@Override
public void afterPropertiesSet() throws BeansException {
if (this.localesToInitialize != null) {
for (Locale locale : this.localesToInitialize) {
initFactory(locale);
}
}
}
@Override
protected @Nullable View loadView(String viewName, Locale locale) throws Exception {
BeanFactory factory = initFactory(locale);
try {
return factory.getBean(viewName, View.class);
}
catch (NoSuchBeanDefinitionException ex) {
// Allow for ViewResolver chaining...
return null;
}
}
/**
* Initialize the View {@link BeanFactory} from the {@code ResourceBundle},
* for the given {@link Locale locale}.
* <p>Synchronized because of access by parallel threads.
* @param locale the target {@code Locale}
* @return the View factory for the given Locale
* @throws BeansException in case of initialization errors
*/
protected synchronized BeanFactory initFactory(Locale locale) throws BeansException {
// Try to find cached factory for Locale:
// Have we already encountered that Locale before?
if (isCache()) {
BeanFactory cachedFactory = this.localeCache.get(locale);
if (cachedFactory != null) {
return cachedFactory;
}
}
// Build list of ResourceBundle references for Locale.
List<ResourceBundle> bundles = new ArrayList<>(this.basenames.length);
for (String basename : this.basenames) {
bundles.add(getBundle(basename, locale));
}
// Try to find cached factory for ResourceBundle list:
// even if Locale was different, same bundles might have been found.
if (isCache()) {
BeanFactory cachedFactory = this.bundleCache.get(bundles);
if (cachedFactory != null) {
this.localeCache.put(locale, cachedFactory);
return cachedFactory;
}
}
// Create child ApplicationContext for views.
GenericWebApplicationContext factory = new GenericWebApplicationContext();
factory.setParent(getApplicationContext());
factory.setServletContext(getServletContext());
// Load bean definitions from resource bundle.
org.springframework.beans.factory.support.PropertiesBeanDefinitionReader reader =
new org.springframework.beans.factory.support.PropertiesBeanDefinitionReader(factory);
reader.setDefaultParentBean(this.defaultParentView);
for (ResourceBundle bundle : bundles) {
reader.registerBeanDefinitions(bundle);
}
factory.refresh();
// Cache factory for both Locale and ResourceBundle list.
if (isCache()) {
this.localeCache.put(locale, factory);
this.bundleCache.put(bundles, factory);
}
return factory;
}
/**
* Obtain the resource bundle for the given basename and {@link Locale}.
* @param basename the basename to look for
* @param locale the {@code Locale} to look for
* @return the corresponding {@code ResourceBundle}
* @throws MissingResourceException if no matching bundle could be found
* @see ResourceBundle#getBundle(String, Locale, ClassLoader)
*/
protected ResourceBundle getBundle(String basename, Locale locale) throws MissingResourceException {
return ResourceBundle.getBundle(basename, locale, getBundleClassLoader());
}
/**
* Close the bundle View factories on context shutdown.
*/
@Override
public void destroy() throws BeansException {
for (ConfigurableApplicationContext factory : this.bundleCache.values()) {
factory.close();
}
this.localeCache.clear();
this.bundleCache.clear();
}
}

View File

@@ -1,179 +0,0 @@
/*
* Copyright 2002-2020 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.web.servlet.view;
import java.util.Locale;
import org.jspecify.annotations.Nullable;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
import org.springframework.beans.factory.xml.ResourceEntityResolver;
import org.springframework.beans.factory.xml.XmlBeanDefinitionReader;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.core.Ordered;
import org.springframework.core.io.Resource;
import org.springframework.web.context.support.GenericWebApplicationContext;
import org.springframework.web.servlet.View;
/**
* A {@link org.springframework.web.servlet.ViewResolver} implementation that uses
* bean definitions in a dedicated XML file for view definitions, specified by
* resource location. The file will typically be located in the WEB-INF directory;
* the default is "/WEB-INF/views.xml".
*
* <p>This {@code ViewResolver} does not support internationalization at the level
* of its definition resources. Consider {@link ResourceBundleViewResolver} if you
* need to apply different view resources per locale.
*
* <p>Note: This {@code ViewResolver} implements the {@link Ordered} interface
* in order to allow for flexible participation in {@code ViewResolver} chaining.
* For example, some special views could be defined via this {@code ViewResolver}
* (giving it 0 as "order" value), while all remaining views could be resolved by
* a {@link UrlBasedViewResolver}.
*
* @author Juergen Hoeller
* @since 18.06.2003
* @see org.springframework.context.ApplicationContext#getResource
* @see UrlBasedViewResolver
* @see BeanNameViewResolver
* @deprecated as of 5.3, in favor of Spring's common view resolver variants
* and/or custom resolver implementations
*/
@Deprecated
public class XmlViewResolver extends AbstractCachingViewResolver
implements Ordered, InitializingBean, DisposableBean {
/** Default if no other location is supplied. */
public static final String DEFAULT_LOCATION = "/WEB-INF/views.xml";
private @Nullable Resource location;
private @Nullable ConfigurableApplicationContext cachedFactory;
private int order = Ordered.LOWEST_PRECEDENCE; // default: same as non-Ordered
/**
* Set the location of the XML file that defines the view beans.
* <p>The default is "/WEB-INF/views.xml".
* @param location the location of the XML file.
*/
public void setLocation(Resource location) {
this.location = location;
}
/**
* Specify the order value for this ViewResolver bean.
* <p>The default value is {@code Ordered.LOWEST_PRECEDENCE}, meaning non-ordered.
* @see org.springframework.core.Ordered#getOrder()
*/
public void setOrder(int order) {
this.order = order;
}
@Override
public int getOrder() {
return this.order;
}
/**
* Pre-initialize the factory from the XML file.
* Only effective if caching is enabled.
*/
@Override
public void afterPropertiesSet() throws BeansException {
if (isCache()) {
initFactory();
}
}
/**
* This implementation returns just the view name,
* as XmlViewResolver doesn't support localized resolution.
*/
@Override
protected Object getCacheKey(String viewName, Locale locale) {
return viewName;
}
@Override
protected @Nullable View loadView(String viewName, Locale locale) throws BeansException {
BeanFactory factory = initFactory();
try {
return factory.getBean(viewName, View.class);
}
catch (NoSuchBeanDefinitionException ex) {
// Allow for ViewResolver chaining...
return null;
}
}
/**
* Initialize the view bean factory from the XML file.
* Synchronized because of access by parallel threads.
* @throws BeansException in case of initialization errors
*/
protected synchronized BeanFactory initFactory() throws BeansException {
if (this.cachedFactory != null) {
return this.cachedFactory;
}
ApplicationContext applicationContext = obtainApplicationContext();
Resource actualLocation = this.location;
if (actualLocation == null) {
actualLocation = applicationContext.getResource(DEFAULT_LOCATION);
}
// Create child ApplicationContext for views.
GenericWebApplicationContext factory = new GenericWebApplicationContext();
factory.setParent(applicationContext);
factory.setServletContext(getServletContext());
// Load XML resource with context-aware entity resolver.
XmlBeanDefinitionReader reader = new XmlBeanDefinitionReader(factory);
reader.setEnvironment(applicationContext.getEnvironment());
reader.setEntityResolver(new ResourceEntityResolver(applicationContext));
reader.loadBeanDefinitions(actualLocation);
factory.refresh();
if (isCache()) {
this.cachedFactory = factory;
}
return factory;
}
/**
* Close the view bean factory on context shutdown.
*/
@Override
public void destroy() throws BeansException {
if (this.cachedFactory != null) {
this.cachedFactory.close();
}
}
}

View File

@@ -64,6 +64,7 @@ import org.springframework.web.servlet.mvc.ParameterizableViewController;
import org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter;
import org.springframework.web.servlet.support.RequestContext;
import org.springframework.web.servlet.support.RequestContextUtils;
import org.springframework.web.servlet.view.InternalResourceView;
import org.springframework.web.servlet.view.InternalResourceViewResolver;
import org.springframework.web.util.WebUtils;
@@ -118,10 +119,7 @@ public class ComplexWebApplicationContext extends StaticWebApplicationContext {
registerSingleton("noviewController", NoViewController.class);
pvs = new MutablePropertyValues();
pvs.add("order", 0);
pvs.add("basename", "org.springframework.web.servlet.complexviews");
registerSingleton("viewResolver",
org.springframework.web.servlet.view.ResourceBundleViewResolver.class, pvs);
registerSingleton("viewResolver", TestViewResolver.class, pvs);
pvs = new MutablePropertyValues();
pvs.add("suffix", ".jsp");
@@ -511,6 +509,25 @@ public class ComplexWebApplicationContext extends StaticWebApplicationContext {
}
private static class TestViewResolver implements ViewResolver, Ordered {
@Override
public int getOrder() {
return 0;
}
@Override
public @Nullable View resolveViewName(String viewName, Locale locale) throws Exception {
if (viewName.equalsIgnoreCase("form")) {
InternalResourceView view = new InternalResourceView("myform.jsp");
view.setRequestContextAttribute("rc");
return view;
}
return null;
}
}
public static class TestApplicationListener implements ApplicationListener<RequestHandledEvent> {
public int counter = 0;

View File

@@ -24,7 +24,6 @@ import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.springframework.beans.BeansException;
import org.springframework.beans.MutablePropertyValues;
import org.springframework.web.context.support.StaticWebApplicationContext;
import org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping;
import org.springframework.web.servlet.i18n.AcceptHeaderLocaleResolver;
@@ -36,7 +35,6 @@ import org.springframework.web.servlet.view.InternalResourceViewResolver;
* @author Juergen Hoeller
* @since 21.05.2003
*/
@SuppressWarnings("deprecation")
public class SimpleWebApplicationContext extends StaticWebApplicationContext {
@Override
@@ -51,14 +49,11 @@ public class SimpleWebApplicationContext extends StaticWebApplicationContext {
registerSingleton("handlerMapping", BeanNameUrlHandlerMapping.class);
registerSingleton("viewResolver", InternalResourceViewResolver.class);
MutablePropertyValues pvs = new MutablePropertyValues();
pvs.add("location", "org/springframework/web/context/WEB-INF/sessionContext.xml");
registerSingleton("viewResolver2", org.springframework.web.servlet.view.XmlViewResolver.class, pvs);
super.refresh();
}
@SuppressWarnings("deprecation")
public static class LocaleChecker implements Controller, org.springframework.web.servlet.mvc.LastModified {
@Override

View File

@@ -316,6 +316,7 @@ public class MvcNamespaceTests {
doTestCustomValidator("mvc-config-custom-validator.xml");
}
@SuppressWarnings("removal")
private void doTestCustomValidator(String xml) throws Exception {
loadBeanDefinitions(xml);

View File

@@ -26,8 +26,8 @@ import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.core.Ordered;
import org.springframework.http.server.RequestPath;
import org.springframework.ui.ModelMap;
import org.springframework.util.AntPathMatcher;
import org.springframework.util.PathMatcher;
import org.springframework.web.context.request.WebRequest;
import org.springframework.web.context.request.WebRequestInterceptor;
@@ -37,6 +37,7 @@ import org.springframework.web.servlet.handler.WebRequestHandlerInterceptorAdapt
import org.springframework.web.servlet.i18n.LocaleChangeInterceptor;
import org.springframework.web.testfixture.servlet.MockHttpServletRequest;
import org.springframework.web.testfixture.servlet.MockHttpServletResponse;
import org.springframework.web.util.ServletRequestPathUtils;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.fail;
@@ -178,12 +179,13 @@ public class InterceptorRegistryTests {
}
private List<HandlerInterceptor> getInterceptorsForPath(String lookupPath) {
PathMatcher pathMatcher = new AntPathMatcher();
private List<HandlerInterceptor> getInterceptorsForPath(@Nullable String lookupPath) {
lookupPath = (lookupPath != null ? lookupPath : "");
this.request.setAttribute(ServletRequestPathUtils.PATH_ATTRIBUTE, RequestPath.parse(lookupPath, null));
List<HandlerInterceptor> result = new ArrayList<>();
for (Object interceptor : this.registry.getInterceptors()) {
if (interceptor instanceof MappedInterceptor mappedInterceptor) {
if (mappedInterceptor.matches(lookupPath, pathMatcher)) {
if (mappedInterceptor.matches(this.request)) {
result.add(mappedInterceptor.getInterceptor());
}
}

View File

@@ -117,12 +117,12 @@ class RequestMappingInfoHandlerMappingTests {
@PathPatternsParameterizedTest
void getMappingPathPatterns(TestRequestMappingInfoHandlerMapping mapping) {
void getDirectPaths(TestRequestMappingInfoHandlerMapping mapping) {
String[] patterns = {"/foo/*", "/foo", "/bar/*", "/bar"};
RequestMappingInfo info = mapping.createInfo(patterns);
Set<String> actual = mapping.getMappingPathPatterns(info);
Set<String> actual = mapping.getDirectPaths(info);
assertThat(actual).isEqualTo(new HashSet<>(Arrays.asList(patterns)));
assertThat(actual).containsExactly("/foo", "/bar");
}
@PathPatternsParameterizedTest

View File

@@ -69,6 +69,7 @@ import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.NoHandlerFoundException;
import org.springframework.web.servlet.mvc.support.DefaultHandlerExceptionResolver;
import org.springframework.web.servlet.resource.NoResourceFoundException;
import org.springframework.web.testfixture.http.MockHttpInputMessage;
import org.springframework.web.testfixture.servlet.MockHttpServletRequest;
import org.springframework.web.testfixture.servlet.MockHttpServletResponse;
import org.springframework.web.testfixture.servlet.MockServletConfig;
@@ -261,9 +262,8 @@ class ResponseEntityExceptionHandlerTests {
}
@Test
@SuppressWarnings("deprecation")
public void httpMessageNotReadable() {
testException(new HttpMessageNotReadableException("message"));
testException(new HttpMessageNotReadableException("message", new MockHttpInputMessage(new byte[0])));
}
@Test

View File

@@ -49,6 +49,7 @@ import org.springframework.web.servlet.HandlerExceptionResolver;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.NoHandlerFoundException;
import org.springframework.web.servlet.resource.NoResourceFoundException;
import org.springframework.web.testfixture.http.MockHttpInputMessage;
import org.springframework.web.testfixture.servlet.MockHttpServletRequest;
import org.springframework.web.testfixture.servlet.MockHttpServletResponse;
@@ -153,9 +154,8 @@ class DefaultHandlerExceptionResolverTests {
}
@Test
@SuppressWarnings("deprecation")
public void handleHttpMessageNotReadable() {
HttpMessageNotReadableException ex = new HttpMessageNotReadableException("foo");
HttpMessageNotReadableException ex = new HttpMessageNotReadableException("foo", new MockHttpInputMessage(new byte[0]));
ModelAndView mav = exceptionResolver.resolveException(request, response, null, ex);
assertThat(mav).as("No ModelAndView returned").isNotNull();
assertThat(mav.isEmpty()).as("No Empty ModelAndView returned").isTrue();

View File

@@ -1,29 +0,0 @@
/*
* Copyright 2002-2024 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.web.servlet.view;
/**
* @author Rod Johnson
*/
class ResourceBundleViewResolverNoCacheTests extends ResourceBundleViewResolverTests {
@Override
protected boolean getCache() {
return false;
}
}

View File

@@ -1,177 +0,0 @@
/*
* Copyright 2002-2024 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.web.servlet.view;
import java.util.Locale;
import java.util.Map;
import java.util.MissingResourceException;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.BeanIsAbstractException;
import org.springframework.core.io.Resource;
import org.springframework.web.context.support.ServletContextResource;
import org.springframework.web.context.support.StaticWebApplicationContext;
import org.springframework.web.servlet.View;
import org.springframework.web.testfixture.servlet.MockServletContext;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
import static org.junit.jupiter.api.Assumptions.assumeTrue;
/**
* @author Rod Johnson
* @author Juergen Hoeller
* @author Sam Brannen
*/
@SuppressWarnings("deprecation")
public class ResourceBundleViewResolverTests {
/** Comes from this package */
private static final String PROPS_FILE = "org.springframework.web.servlet.view.testviews";
private final ResourceBundleViewResolver rb = new ResourceBundleViewResolver();
private final StaticWebApplicationContext wac = new StaticWebApplicationContext();
@BeforeEach
void setUp() {
rb.setBasename(PROPS_FILE);
rb.setCache(getCache());
rb.setDefaultParentView("testParent");
wac.setServletContext(new MockServletContext());
wac.refresh();
// This will be propagated to views, so we need it.
rb.setApplicationContext(wac);
}
/**
* Not a constant: allows overrides.
* Controls whether to cache views.
*/
protected boolean getCache() {
return true;
}
@Test
void parentsAreAbstract() {
assertThatExceptionOfType(BeanIsAbstractException.class).isThrownBy(() ->
rb.resolveViewName("debug.Parent", Locale.ENGLISH));
assertThatExceptionOfType(BeanIsAbstractException.class).isThrownBy(() ->
rb.resolveViewName("testParent", Locale.ENGLISH));
}
@Test
void debugViewEnglish() throws Exception {
View v = rb.resolveViewName("debugView", Locale.ENGLISH);
assertThat(v).isInstanceOf(InternalResourceView.class);
InternalResourceView jv = (InternalResourceView) v;
assertThat(jv.getUrl()).as("debugView must have correct URL").isEqualTo("jsp/debug/debug.jsp");
Map<String, Object> m = jv.getStaticAttributes();
assertThat(m.size()).as("Must have 2 static attributes").isEqualTo(2);
assertThat(m.get("foo")).as("attribute foo").isEqualTo("bar");
assertThat(m.get("postcode")).as("attribute postcode").isEqualTo("SE10 9JY");
assertThat(jv.getContentType()).as("Correct default content type").isEqualTo(AbstractView.DEFAULT_CONTENT_TYPE);
}
@Test
void debugViewFrench() throws Exception {
View v = rb.resolveViewName("debugView", Locale.FRENCH);
assertThat(v).isInstanceOf(InternalResourceView.class);
InternalResourceView jv = (InternalResourceView) v;
assertThat(jv.getUrl()).as("French debugView must have correct URL").isEqualTo("jsp/debug/deboug.jsp");
assertThat(jv.getContentType()).as("Correct overridden (XML) content type").isEqualTo("text/xml;charset=ISO-8859-1");
}
@Test
void eagerInitialization() throws Exception {
ResourceBundleViewResolver rb = new ResourceBundleViewResolver();
rb.setBasename(PROPS_FILE);
rb.setCache(getCache());
rb.setDefaultParentView("testParent");
rb.setLocalesToInitialize(Locale.ENGLISH, Locale.FRENCH);
rb.setApplicationContext(wac);
View v = rb.resolveViewName("debugView", Locale.FRENCH);
assertThat(v).isInstanceOf(InternalResourceView.class);
InternalResourceView jv = (InternalResourceView) v;
assertThat(jv.getUrl()).as("French debugView must have correct URL").isEqualTo("jsp/debug/deboug.jsp");
assertThat(jv.getContentType()).as("Correct overridden (XML) content type").isEqualTo("text/xml;charset=ISO-8859-1");
}
@Test
void sameBundleOnlyCachedOnce() throws Exception {
assumeTrue(rb.isCache());
View v1 = rb.resolveViewName("debugView", Locale.ENGLISH);
View v2 = rb.resolveViewName("debugView", Locale.UK);
assertThat(v2).isSameAs(v1);
}
@Test
void noSuchViewEnglish() throws Exception {
assertThat(rb.resolveViewName("xxxxxxweorqiwuopeir", Locale.ENGLISH)).isNull();
}
@Test
void onSetContextCalledOnce() throws Exception {
TestView tv = (TestView) rb.resolveViewName("test", Locale.ENGLISH);
tv = (TestView) rb.resolveViewName("test", Locale.ENGLISH);
tv = (TestView) rb.resolveViewName("test", Locale.ENGLISH);
assertThat(tv.getBeanName()).as("test has correct name").isEqualTo("test");
assertThat(tv.initCount).as("test should have been initialized once, not ").isEqualTo(1);
}
@Test
void noSuchBasename() {
rb.setBasename("weoriwoierqupowiuer");
assertThatExceptionOfType(MissingResourceException.class).isThrownBy(() ->
rb.resolveViewName("debugView", Locale.ENGLISH));
}
static class TestView extends AbstractView {
public int initCount;
public void setLocation(Resource location) {
if (!(location instanceof ServletContextResource)) {
throw new IllegalArgumentException("Expecting ServletContextResource, not " + location.getClass().getName());
}
}
@Override
protected void renderMergedOutputModel(Map<String, Object> model, HttpServletRequest request,
HttpServletResponse response) {
}
@Override
protected void initApplicationContext() {
++initCount;
}
}
}

View File

@@ -34,9 +34,7 @@ import org.junit.jupiter.api.Test;
import org.springframework.beans.MutablePropertyValues;
import org.springframework.beans.PropertyValue;
import org.springframework.beans.factory.BeanDefinitionStoreException;
import org.springframework.beans.testfixture.beans.TestBean;
import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.Resource;
import org.springframework.web.context.support.ServletContextResource;
import org.springframework.web.context.support.StaticWebApplicationContext;
@@ -51,19 +49,16 @@ import org.springframework.web.testfixture.servlet.MockRequestDispatcher;
import org.springframework.web.testfixture.servlet.MockServletContext;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
/**
* Tests for {@link BeanNameViewResolver}, {@link UrlBasedViewResolver},
* {@link InternalResourceViewResolver}, {@link org.springframework.web.servlet.view.XmlViewResolver},
* and {@link AbstractCachingViewResolver}.
* {@link InternalResourceViewResolver}, and {@link AbstractCachingViewResolver}.
*
* @author Juergen Hoeller
* @author Chris Beams
* @author Sam Brannen
* @since 18.06.2003
*/
@SuppressWarnings("deprecation")
class ViewResolverTests {
private final StaticWebApplicationContext wac = new StaticWebApplicationContext();
@@ -396,80 +391,6 @@ class ViewResolverTests {
assertThat(lc.getResourceBundle().getString("code2")).isEqualTo("message2");
}
@Test
@SuppressWarnings("deprecation")
void xmlViewResolver() throws Exception {
this.wac.registerSingleton("testBean", TestBean.class);
this.wac.refresh();
TestBean testBean = (TestBean) this.wac.getBean("testBean");
org.springframework.web.servlet.view.XmlViewResolver vr = new org.springframework.web.servlet.view.XmlViewResolver();
vr.setLocation(new ClassPathResource("org/springframework/web/servlet/view/views.xml"));
vr.setApplicationContext(this.wac);
View view1 = vr.resolveViewName("example1", Locale.getDefault());
assertThat(TestView.class.equals(view1.getClass())).as("Correct view class").isTrue();
assertThat(((InternalResourceView) view1).getUrl()).as("Correct URL").isEqualTo("/example1.jsp");
View view2 = vr.resolveViewName("example2", Locale.getDefault());
assertThat(JstlView.class.equals(view2.getClass())).as("Correct view class").isTrue();
assertThat(((InternalResourceView) view2).getUrl()).as("Correct URL").isEqualTo("/example2new.jsp");
Map<String, Object> model = new HashMap<>();
TestBean tb = new TestBean();
model.put("tb", tb);
this.request.setAttribute(DispatcherServlet.WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.wac);
this.request.setAttribute(DispatcherServlet.LOCALE_RESOLVER_ATTRIBUTE, new AcceptHeaderLocaleResolver());
view1.render(model, this.request, this.response);
assertThat(tb.equals(this.request.getAttribute("tb"))).as("Correct tb attribute").isTrue();
assertThat(this.request.getAttribute("test1")).as("Correct test1 attribute").isEqualTo("testvalue1");
assertThat(testBean.equals(this.request.getAttribute("test2"))).as("Correct test2 attribute").isTrue();
this.request.clearAttributes();
this.request.setAttribute(DispatcherServlet.WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.wac);
this.request.setAttribute(DispatcherServlet.LOCALE_RESOLVER_ATTRIBUTE, new AcceptHeaderLocaleResolver());
view2.render(model, this.request, this.response);
assertThat(tb.equals(this.request.getAttribute("tb"))).as("Correct tb attribute").isTrue();
assertThat(this.request.getAttribute("test1")).as("Correct test1 attribute").isEqualTo("testvalue1");
assertThat(this.request.getAttribute("test2")).as("Correct test2 attribute").isEqualTo("testvalue2");
}
@Test
@SuppressWarnings("deprecation")
void xmlViewResolverDefaultLocation() {
StaticWebApplicationContext wac = new StaticWebApplicationContext() {
@Override
protected Resource getResourceByPath(String path) {
assertThat(path).as("Correct default location").isEqualTo(XmlViewResolver.DEFAULT_LOCATION);
return super.getResourceByPath(path);
}
};
wac.setServletContext(this.sc);
wac.refresh();
org.springframework.web.servlet.view.XmlViewResolver vr = new org.springframework.web.servlet.view.XmlViewResolver();
vr.setApplicationContext(wac);
assertThatExceptionOfType(BeanDefinitionStoreException.class).isThrownBy(vr::afterPropertiesSet);
}
@Test
@SuppressWarnings("deprecation")
void xmlViewResolverWithoutCache() {
StaticWebApplicationContext wac = new StaticWebApplicationContext() {
@Override
protected Resource getResourceByPath(String path) {
assertThat(path).as("Correct default location").isEqualTo(XmlViewResolver.DEFAULT_LOCATION);
return super.getResourceByPath(path);
}
};
wac.setServletContext(this.sc);
wac.refresh();
org.springframework.web.servlet.view.XmlViewResolver vr = new org.springframework.web.servlet.view.XmlViewResolver();
vr.setCache(false);
vr.setApplicationContext(wac);
assertThatExceptionOfType(BeanDefinitionStoreException.class).isThrownBy(() ->
vr.resolveViewName("example1", Locale.getDefault()));
}
@Test
void cacheRemoval() throws Exception {
this.wac.refresh();

View File

@@ -1,16 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN 2.0//EN" "https://www.springframework.org/dtd/spring-beans-2.0.dtd">
<beans>
<bean id="rob" class="org.springframework.beans.testfixture.beans.TestBean">
<property name="name" value="dummy"/>
<property name="age" value="-1"/>
</bean>
<bean id="rodProto" class="org.springframework.beans.testfixture.beans.TestBean" scope="prototype">
<property name="name" value="dummy"/>
<property name="age" value="-1"/>
</bean>
</beans>

View File

@@ -1,3 +0,0 @@
form.(class)=org.springframework.web.servlet.view.InternalResourceView
form.requestContextAttribute=rc
form.url=myform.jsp