web-dev-qa-db-ja.com

Spring @RestControllerカスタムJSONデシリアライザー

一部のクラス（Role here）にカスタムJSONデシリアライザを使用したいのですが、機能しません。カスタムデシリアライザーは呼び出されません。

Spring Boot 1.2を使用しています。

デシリアライザ：

public class ModelDeserializer extends JsonDeserializer<Role> {

    @Override
    public Role deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException, JsonProcessingException {
        return null; // this is what should be called but it isn't
    }
}

コントローラ：

@RestController
public class RoleController {

    @RequestMapping(value = "/role", method = RequestMethod.POST)
    public Object createRole(Role role) {
        // ... this is called
    }
}

  1. @JsonDeserialize役割

    @JsonDeserialize(using = ModelDeserializer.class)
public class Role extends Model {

}

  2. Jackson2ObjectMapperBuilder bean in Java Config

    @Bean
public Jackson2ObjectMapperBuilder jacksonBuilder() {
    Jackson2ObjectMapperBuilder builder = new Jackson2ObjectMapperBuilder();
    builder.deserializerByType(Role.class, new ModelDeserializer());
    return builder;
}

何が悪いのですか？

[〜＃〜] edit [〜＃〜]おそらく@RestControllerは@Controller...

javaspringrestjacksonspring-boot
15
jakub.petr

まず、カスタムデシリアライザを追加するためにJackson2ObjectMapperBuilderをオーバーライドする必要はありません。このアプローチは、@JsonDeserializeアノテーションを追加できない場合に使用する必要があります。 @JsonDeserializeを使用するか、Jackson2ObjectMapperBuilderをオーバーライドする必要があります。

見逃されているのは@RequestBodyアノテーションです。

@RestController
public class JacksonCustomDesRestEndpoint {

    @RequestMapping(value = "/role", method = RequestMethod.POST, consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.APPLICATION_JSON_VALUE)
    @ResponseBody
    public Object createRole(@RequestBody Role role) {
        return role;
    }
}

@JsonDeserialize(using = RoleDeserializer.class)
public class Role {
    // ......
}

public class RoleDeserializer extends JsonDeserializer<Role> {
    @Override
    public Role deserialize(JsonParser jp, DeserializationContext ctxt) throws IOException, JsonProcessingException {
        // .................
        return something;
    }
}
22
Ilya Ovesnov

デフォルトのデシリアライザーを呼び出す前にJSON本体を変更する場合に役立つ、非常に興味深い別のソリューションもあります。そして、そのために追加のBeanを使用する必要があるとしましょう（@Autowireメカニズムを使用）

次のコントローラーがあるという状況を想像してみましょう。

@RequestMapping(value = "/order/product", method = POST)
public <T extends OrderProductInterface> RestGenericResponse orderProduct(@RequestBody @Valid T data) {
    orderService.orderProduct(data);
    return generateResponse();
}

OrderProductInterfaceは次のとおりです。

@JsonIgnoreProperties(ignoreUnknown = true)
@JsonSerialize(include = NON_EMPTY)
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, visible = true, property = "providerType")
@JsonSubTypes({
              @JsonSubTypes.Type(value = OrderProductForARequestData.class, name = "A")
          })
public interface OrderProductInterface{}

上記のコードは、フィールド化されたproviderTypeに基づく動的な逆シリアル化と、具体的な実装に基づく検証を提供します。よりよく理解するために、OrderProductForARequestDataは次のようなものになると考えてください。

public class OrderProductForARequestData implements OrderProductInterface {

    @NotBlank(message = "is mandatory field.")
    @Getter @Setter
    private String providerId;

    @NotBlank(message = "is mandatory field.")
    @Getter @Setter
    private String providerType;

    @NotBlank(message = "is mandatory field.")
    @Getter @Setter
    private String productToOrder;

}

そして、何とか初期化したいイメージを作りましょうproviderType（エンリッチ入力）デフォルトのデシリアライズが実行される前にOrderProductInterface。そのためには、@Configurationクラスを次のように変更するだけです。

//here can be any annotation which will enable MVC/Boot 
@Configuration
public class YourConfiguration{

    @Autowired
    private ObjectMapper mapper;

    @Autowired
    private ProviderService providerService;

    @Override
    public void setup() {
        super.setup();
        SimpleModule module = new SimpleModule();
        module.setDeserializerModifier(new BeanDeserializerModifier() {
            @Override
            public JsonDeserializer<?> modifyDeserializer(DeserializationConfig config, BeanDescription beanDesc, JsonDeserializer<?> deserializer) {

                if (beanDesc.getBeanClass() == OrderProductInterface.class) {
                    return new OrderProductInterfaceDeserializer(providerService, beanDesc);
                }
                return deserializer;
            }
        });

        mapper.registerModule(module);
    }

    public static class OrderProductInterfaceDeserializer extends AbstractDeserializer {

            private static final long serialVersionUID = 7923585097068641765L;

            private final ProviderService providerService;

            OrderProductInterfaceDeserializer(roviderService providerService, BeanDescription beanDescription) {
                super(beanDescription);
                this.providerService = providerService;
            }

            @Override
            public Object deserializeWithType(JsonParser p, DeserializationContext context, TypeDeserializer typeDeserializer) throws IOException {
                ObjectCodec oc = p.getCodec();
                JsonNode node = oc.readTree(p);

                //Let's image that we have some identifier for provider type and we want to detect it
                JsonNode tmp = node.get("providerId");
                Assert.notNull(tmp, "'providerId' is mandatory field");
                String providerId = tmp.textValue();
                Assert.hasText(providerId, "'providerId' can't be empty");

                // Modify node
                ((ObjectNode) node).put("providerType",providerService.getProvider(providerId));

                JsonFactory jsonFactory = new JsonFactory();
                JsonParser newParser = jsonFactory.createParser(node.toString());
                newParser.nextToken();

                return super.deserializeWithType(newParser, context, typeDeserializer);

           }

      }
}
0
Sergey Povisenko