Spring 3.0 MVC 绑定枚举区分大小写

Question

如果我在这样的 Spring 控制器中有一个 RequestMapping...

@RequestMapping(method = RequestMethod.GET, value = "{product}")
public ModelAndView getPage(@PathVariable Product product)

Product 是一个枚举。例如。产品.首页

当我请求页面时，mysite.com/home

我明白了

Unable to convert value "home" from type 'java.lang.String' to type 'domain.model.product.Product'; nested exception is java.lang.IllegalArgumentException: No enum const class domain.model.product.Product.home

有没有办法让枚举类型转换器理解小写的 home 实际上是 Home？

我想保持 url 不区分大小写，并且我的 Java 枚举使用标准大写字母。

谢谢

解决方案

public class ProductEnumConverter extends PropertyEditorSupport
{
    @Override public void setAsText(final String text) throws IllegalArgumentException
    {
        setValue(Product.valueOf(WordUtils.capitalizeFully(text.trim())));
    }
}

注册

<bean class="org.springframework.beans.factory.config.CustomEditorConfigurer">
        <property name="customEditors">
            <map>
                <entry key="domain.model.product.Product" value="domain.infrastructure.ProductEnumConverter"/>
            </map>
        </property>
    </bean>

添加到需要特殊转换的控制器

@InitBinder
public void initBinder(WebDataBinder binder)
{
    binder.registerCustomEditor(Product.class, new ProductEnumConverter());
} 

Answer 1

一般来说，您想创建一个新的 PropertyEditor 来为您进行规范化，然后像这样在 Controller 中注册它：

@InitBinder
 public void initBinder(WebDataBinder binder) {

  binder.registerCustomEditor(Product.class,
    new CaseInsensitivePropertyEditor());
 }

Answer 2

我想你必须implement a Custom PropertyEditor。

类似这样的：

public class ProductEditor extends PropertyEditorSupport{

    @Override
    public void setAsText(final String text){
        setValue(Product.valueOf(text.toUpperCase()));
    }

}

如何绑定请看GaryF's answer

如果您在枚举常量中使用小写字母（您可能不应该，但仍然如此），这是一个更宽容的版本：

@Override
public void setAsText(final String text){
    Product product = null;
    for(final Product candidate : Product.values()){
        if(candidate.name().equalsIgnoreCase(text)){
            product = candidate;
            break;
        }
    }
    setValue(product);
}

Answer 3

也可以创建一个通用转换器，它可以像这样与所有枚举一起工作：

public class CaseInsensitiveConverter<T extends Enum<T>> extends PropertyEditorSupport {

    private final Class<T> typeParameterClass;

    public CaseInsensitiveConverter(Class<T> typeParameterClass) {
        super();
        this.typeParameterClass = typeParameterClass;
    }

    @Override
    public void setAsText(final String text) throws IllegalArgumentException {
        String upper = text.toUpperCase(); // or something more robust
        T value = T.valueOf(typeParameterClass, upper);
        setValue(value);
    }
}

用法：

@InitBinder
public void initBinder(WebDataBinder binder) {
    binder.registerCustomEditor(MyEnum.class, new CaseInsensitiveConverter<>(MyEnum.class));
}

或者像 skaffman 解释的那样在全球范围内

Answer 4

在 Spring Boot 2 中，您可以使用 ApplicationConversionService。它提供了一些有用的转换器，尤其是org.springframework.boot.convert.StringToEnumIgnoringCaseConverterFactory - 负责将字符串值转换为枚举实例。这是我设法找到的最通用的（我们不需要为每个枚举创建单独的转换器/格式化程序）和最简单的解决方案。

import org.springframework.boot.convert.ApplicationConversionService;
import org.springframework.context.annotation.Configuration;
import org.springframework.format.FormatterRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class AppWebMvcConfigurer implements WebMvcConfigurer {
    @Override
    public void addFormatters(FormatterRegistry registry) {
        ApplicationConversionService.configure(registry);
    }
}

我知道问题是关于 Spring 3 的，但这是在 google 搜索 spring mvc enums case insensitive 短语时的第一个结果。

Answer 5

要添加到@GaryF 的答案并解决您对它的评论，您可以通过将全局自定义属性编辑器注入自定义AnnotationMethodHandlerAdapter 来声明它们。 Spring MVC 通常默认注册其中一个，但如果你选择，你可以给它一个特殊配置的，例如

<bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter">
  <property name="webBindingInitializer">
    <bean class="org.springframework.web.bind.support.ConfigurableWebBindingInitializer">
      <property name="propertyEditorRegistrars">
        <list>
          <bean class="com.xyz.MyPropertyEditorRegistrar"/>
        </list>
      </property>
    </bean>
  </property>
</bean>

MyPropertyEditorRegistrar 是PropertyEditorRegistrar 的一个实例，它反过来用Spring 注册自定义PropertyEditor 对象。

只需声明这一点就足够了。