Outils de désérialisation de paramétrage : désérialisation alternative et multiple

[indyteo]

Suite à une discussion passée au sujet des outils Jackson pour le paramétrage, voici 2 propositions relatives à l'implémentation technique de 2 de ces outils, ayant un impact sur leur utilisation dans le reste du code des paramètres.
Bien évidemment, les noms sont à discuter, ce n'est qu'une proposition de ce à quoi ça pourrait ressembler.

A) Désérialisation par "alternative"

En ce qui concerne la désérialisation par "alternative", c'est-à-dire essayer plusieurs types et prendre le 1er qui fonctionne, l'implémentation technique est assez triviale, mais on a 2 façons d'écrire la liste des alternatives sous forme d'annotation.

Dans les deux cas, on considère que SecondParams hérite de FirstParams, tandis que ThirdParams non (mais on dispose d'un convertisseur dans FirstParams pour le créer à partir d'un ThirdParams)
Dans ces exemples, l'annotation est placée au niveau du champ (donc pour affecter 1 désérialiseur spécifique), mais elle pourrait se trouver au niveau de la déclaration du type FirstParams (pour affecter tous ses usages).

Option A.1

@JsonDeserializeEither({
    @JsonDeserializeEither.Alternative(type = FirstParams.class), // Ou alors juste @JsonDeserializeEither.Alternative() pour dire "son propre type"
    @JsonDeserializeEither.Alternative(type = SecondParams.class),
    @JsonDeserializeEither.Alternative(type = ThirdParams.class, converter = FirstParams.FromThirdParamsConverter.class)
})
public FirstParams params;

Option A.2

@JsonDeserializeAlternative(type = FirstParams.class) // Ou alors juste @JsonDeserializeAlternative() pour dire "son propre type"
@JsonDeserializeAlternative(type = SecondParams.class)
@JsonDeserializeAlternative(type = ThirdParams.class, converter = FirstParams.FromThirdParamsConverter.class)
public FirstParams params;

B) Désérialisation multiple

Pour le fait de pouvoir désérialiser plusieurs objets à partir d'un même paramétrage, c'est-à-dire essayer plusieurs types et prendre tous ceux qui fonctionnent, on a 2 possibilités d'implémentation technique assez différentes. Chacune ont des implications très différentes sur l'usage dans les classes de paramétrage.

Option B.1

On considère que FirstParams, SecondParams et ThirdParams héritent tous de OurParams.
L'annotation ne peut être placée qu'au niveau d'un champ de type collection, et toutes les classes qu'on essaye de désérialiser doivent hériter d'une classe commune pour être stockées dans cette collection.

@JsonDeserializeMultiple({ // Potentiellement même questionnement que dans A) si on autorise l'usage d'un converter
    FirstParams.class,
    SecondParams.class,
    ThirdParams.class
})
public List<OurParams> params;

Option B.2

Aucun héritage spécifique n'est nécessaire.
L'annotation ne peut être placée qu'au niveau de la déclaration d'une classe, qui devient par la même occasion un wrapper (similaire à la logique qui a déjà été implémentée dans la PR #172).
En revanche, ça permet un contrôle fin sur les champs à désérialiser, avec des politiques adaptées à chacune.

@JsonWrapper(multiple = true) // Ou alors @JsonDeserializeMultiple, mais la logique est très similaire
public class OurParams {
    // Possibilité de renseigner des politiques de nullabilité, des valeurs par défaut...
    public FirstParams params1;
    public SecondParams params2;
    public ThirdParams params3;
}

// Plus loin, dans une classe de paramétrage...
public OurParams params;

[indyteo]

Pour ma part, je n'ai pas d'avis pour la A), les deux sont assez équivalents et tous les deux possibles sans trop de différence dans le code.

Pour la B) je préfère largement l'option 2 qui vient se factoriser avec le @JsonWrapper que je viens d'ajouter, et qui offre beaucoup plus de puissances et de contrôle sur ce qu'on peut faire globalement, avec juste comme coût le fait de devoir faire une classe (mais qui devrait probablement déjà exister dans notre logique de paramétrage)

[indyteo]

J'ai fait un prototype pour le B.2 : https://github.com/ignfab/minalac-generator/tree/indy/multi-params

C'est juste un POC (le code n'est pas fini ni nettoyé, et est actuellement très bourrin), mais ça marche. Je n'avais pas trop de cas réel sur lequel tester mais j'ai mis un exemple factice, et franchement une telle souplesse, ça donne envie de jouer avec !