Spring Data JPA方法+ REST:枚举到整数转换

时间:2017-03-14 16:11:16

标签: java spring spring-boot spring-data-jpa spring-data-rest

我有一个终点:

/api/offers/search/findByType?type=X

其中X应该是Integer值(我的OfferType实例的序数值),而Spring认为XString并且将会应用其StringToEnumConverterFactoryStringToEnum转换器。

public interface OfferRepository extends PagingAndSortingRepository<Offer, Long> {

    List<Offer> findByType(@Param("type") OfferType type);

}

所以我编写了一个自定义Converter<Integer, OfferType>,它只是按给定的序号获取实例:

public class IntegerToOfferTypeConverter implements Converter<Integer, OfferType> {

    @Override
    public OfferType convert(Integer source) {
        return OfferType.class.getEnumConstants()[source];
    }

}

然后我使用Configuration

正确注册了它
@EnableWebMvc
@Configuration
@RequiredArgsConstructor
public class GlobalMVCConfiguration extends WebMvcConfigurerAdapter {

    @Override
    public void addFormatters(FormatterRegistry registry) {
        registry.addConverter(new IntegerToOfferTypeConverter());
    }

}

我预计所有对findByType?type=X的请求都会通过我的转换器,但他们没有。

有没有办法说明所有定义为请求参数的枚举都必须以Integer的形式提供?此外,还有什么方法可以在全球范围内说出来,而不仅仅是针对特定的枚举?

编辑:我在我的类路径中找到了IntegerToEnumConverterFactory,它可以满足我的所有需求。它已在DefaultConversionService注册,这是转换的默认服务。如何应用?

EDIT2:这是一件微不足道的事情,我想知道是否有财产可以转换枚举转换。

EDIT3:我在Converter<String, OfferType>获得String后试图写TypeDescriptor.forObject(value),但没有帮助。

EDIT4:我的问题是我将自定义转换器注册放入MVC配置(WebMvcConfigurerAdapter addFormatters)而不是REST存储库({{1}与RepositoryRestConfigurerAdapter)。

1 个答案:

答案 0 :(得分:4)

Spring将查询参数解析为字符串。我相信它始终使用Converter<String, ?>转换器将查询参数转换为存储库方法参数。它使用增强型转换器服务,因为它注册its own converters,例如Converter<Entity, Resource>

因此,您必须创建Converter<String, OfferType>,例如:

@Component
public class StringToOfferTypeConverter implements Converter<String, OfferType> {

    @Override
    public OfferType convert(String source) {
        return OfferType.class.getEnumConstants()[Integer.valueOf(source)];
    }
}

然后在扩展RepositoryRestConfigurerAdapter的类中配置此转换器供Spring Data REST使用:

@Configuration
public class ConverterConfiguration extends RepositoryRestConfigurerAdapter {

    @Autowired
    StringToOfferTypeConverter converter;

    @Override
    public void configureConversionService(ConfigurableConversionService conversionService) {
        conversionService.addConverter(converter);
        super.configureConversionService(conversionService);
    }
}

我尝试将其添加到the basic tutorial,为Person类添加了一个简单的枚举:

public enum OfferType {
    ONE, TWO;
}


@Entity
public class Person {

    @Id
    @GeneratedValue(strategy = GenerationType.AUTO)
    private long id;

    private OfferType type;


    public OfferType getType() {
        return type;
    }

    public void setType(OfferType type) {
        this.type = type;
    }
}

当我打电话时:

  

http://localhost:8080/people/search/findByType?type=1

我得到的结果没有错误:

{
  "_embedded" : {
    "people" : [ ]
  },
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/people/search/findByType?type=1"
    }
  }
}

要实现全局枚举转换器,您必须使用以下方法创建工厂并在配置中注册它:conversionService.addConverterFactory()。以下代码是经过修改的example from the documentation

public class StringToEnumFactory implements ConverterFactory<String, Enum> {

    public <T extends Enum> Converter<String, T> getConverter(Class<T> targetType) {
        return new StringToEnum(targetType);
    }

    private final class StringToEnum<T extends Enum> implements Converter<String, T> {

        private Class<T> enumType;

        public StringToEnum(Class<T> enumType) {
            this.enumType = enumType;
        }

        public T convert(String source) {
            Integer index = Integer.valueOf(source);
            return enumType.getEnumConstants()[index];
        }
    }
}