如何将Spring Converter仅用于某些控制器?

我有工作正常的c转换器:

public class StringToLongConverter implements Converter<String, Long> {
    @Override
    public Long convert(String source) {
        Long myDecodedValue = ...
        return myDecodedValue;
    }
}

在Web配置中,我有:

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

一切都很好,但它对所有控制器都有效,我只需要对某些控制器执行它。

//I need this controller to get myvalue from converter
@RequestMapping(value = "{myvalue}", method = RequestMethod.POST)
public ResponseEntity myvalue1(@PathVariable Long myvalue) {

    return new ResponseEntity<>(HttpStatus.OK);
}

//I need this controller to get myvalue without converter
@RequestMapping(value = "{myvalue}", method = RequestMethod.POST)
public ResponseEntity myvalue2(@PathVariable Long myvalue) {

    return new ResponseEntity<>(HttpStatus.OK);
}

我们是否可以指定哪些转换器或参数应该与自定义转换器一起使用,哪些不应该?


解决方案

一般来说,注册的Converter绑定输入源和输出目的地。在您的情况下<String, Long>。您使用的默认Spring转换器将在每个匹配源-目标对上应用转换。

要更好地控制何时应用转换,可以使用ConditionalGenericConverter。接口包含3个方法:

  • boolean matches(TypeDescriptor sourceType, TypeDescriptor targetType),以确定是否应应用转换

  • Set<ConvertiblePair> getConvertibleTypes()若要返回一组源-目标对,可以将转换应用于

  • Object convert(Object source, TypeDescriptor sourceType, TypeDescriptor targetType)进行实际转换的方法。

我已经设置了一个小的Spring项目来使用ConditionalGenericConverter

RequiresConversion.java:

// RequiresConversion is a custom annotation solely used in this example
// to annotate an attribute as "convertable"
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
public @interface RequiresConversion {
}

SomeConverter.java:

@Component
public class SomeConverter implements ConditionalGenericConverter {

    @Override
    public boolean matches(TypeDescriptor sourceType, TypeDescriptor targetType) {
        // Verify whether the annotation is present
        return targetType.getAnnotation(RequiresConversion.class) != null;
    }

    @Override
    public Set<ConvertiblePair> getConvertibleTypes() {
        return Collections.singleton(new ConvertiblePair(String.class, Long.class));
    }

    @Override
    public Object convert(Object source, TypeDescriptor sourceType, TypeDescriptor targetType) {
        // Conversion logic here
        // In this example it strips "value" from the source string
        String sourceValue = ((String) source).replace("value", "");
        return Long.valueOf(sourceValue);
    }
}

SomeController.java:

@RestController
public class SomeController {

    // The path variable used will be converted, resulting in the "value"-prefix 
    // being stripped in SomeConverter
    // Notice the custom '@RequiresConversion' annotation
    @GetMapping(value = "/test/{myvalue}")
    public ResponseEntity myvalue(@RequiresConversion @PathVariable Long myvalue) {
        return new ResponseEntity<>(HttpStatus.OK);
    }

    // As the @RequiresConversion annotation is not present,
    // the conversion is not applied to the @PathVariable
    @GetMapping(value = "/test2/{myvalue}")
    public ResponseEntity myvalue2(@PathVariable Long myvalue) {
        return new ResponseEntity<>(HttpStatus.OK);
    }
}

转换将在http://localhost:8080/test/value123进行,从而产生123长值。但是,由于第二个映射中不存在自定义批注@RequiresConversion,因此将跳过http://localhost:8080/test2/value123上的转换。

您还可以通过将批注重命名为SkipConversion并验证该批注是否在matches()方法中不存在来反转批注。

希望这能有所帮助!

相关文章