Ensure CharacterEncodingFilter is ordered highest

Update HttpEncodingAutoConfiguration to ensure that the
CharacterEncodingFilter is ordered above any HiddenHttpMethodFilter.

Fixes gh-2148
This commit is contained in:
Phillip Webb
2014-12-15 04:52:10 -08:00
parent 6806689c08
commit 4293b7b797
3 changed files with 78 additions and 5 deletions

View File

@@ -22,10 +22,9 @@ import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.boot.context.web.OrderedCharacterEncodingFilter;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.web.filter.CharacterEncodingFilter;
/**
@@ -45,10 +44,9 @@ public class HttpEncodingAutoConfiguration {
private HttpEncodingProperties httpEncodingProperties;
@Bean
@Order(Ordered.HIGHEST_PRECEDENCE)
@ConditionalOnMissingBean
@ConditionalOnMissingBean(CharacterEncodingFilter.class)
public CharacterEncodingFilter characterEncodingFilter() {
CharacterEncodingFilter filter = new CharacterEncodingFilter();
CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
filter.setEncoding(this.httpEncodingProperties.getCharset().name());
filter.setForceEncoding(this.httpEncodingProperties.isForce());
return filter;

View File

@@ -16,6 +16,11 @@
package org.springframework.boot.autoconfigure.web;
import java.util.ArrayList;
import java.util.List;
import javax.servlet.Filter;
import org.junit.After;
import org.junit.Rule;
import org.junit.Test;
@@ -26,9 +31,13 @@ import org.springframework.boot.test.EnvironmentTestUtils;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.annotation.AnnotationAwareOrderComparator;
import org.springframework.web.filter.CharacterEncodingFilter;
import org.springframework.web.filter.HiddenHttpMethodFilter;
import static org.hamcrest.Matchers.instanceOf;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertThat;
/**
* Tests for {@link HttpEncodingAutoConfiguration}
@@ -82,6 +91,16 @@ public class HttpEncodingAutoConfigurationTests {
assertCharacterEncodingFilter(filter, "US-ASCII", false);
}
@Test
public void filterIsOrderedHighest() throws Exception {
load(OrderedConfiguration.class);
List<Filter> beans = new ArrayList<Filter>(this.context.getBeansOfType(
Filter.class).values());
AnnotationAwareOrderComparator.sort(beans);
assertThat(beans.get(0), instanceOf(CharacterEncodingFilter.class));
assertThat(beans.get(1), instanceOf(HiddenHttpMethodFilter.class));
}
private void assertCharacterEncodingFilter(CharacterEncodingFilter actual,
String encoding, boolean forceEncoding) {
DirectFieldAccessor accessor = new DirectFieldAccessor(actual);
@@ -122,4 +141,14 @@ public class HttpEncodingAutoConfigurationTests {
}
@Configuration
static class OrderedConfiguration {
@Bean
public HiddenHttpMethodFilter hiddenHttpMethodFilter() {
return new HiddenHttpMethodFilter();
}
}
}

View File

@@ -0,0 +1,46 @@
/*
* Copyright 2012-2014 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
*
* http://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.boot.context.web;
import org.springframework.core.Ordered;
import org.springframework.web.filter.CharacterEncodingFilter;
/**
* {@link CharacterEncodingFilter} that also implements {@link Ordered}.
*
* @author Phillip Webb
* @since 1.2.1
*/
public class OrderedCharacterEncodingFilter extends CharacterEncodingFilter implements
Ordered {
private int order = Ordered.HIGHEST_PRECEDENCE;
@Override
public int getOrder() {
return this.order;
}
/**
* Set the order for this filter.
* @param order the order to set
*/
public void setOrder(int order) {
this.order = order;
}
}