FasterXML / FasterXML/jackson-docs

Possible useful name pattern for PTH documentation

Ouverte
#10 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
Aucune donnée de langage
Étoiles
760
Forks
113
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

This is not a solution for every use case, in large part because the Reflections scan can take some time, but it's a pattern that may be generally applicable enough to describe in the documentation:

- Define an annotation for the subtypes, and meta-annotate with `@JsonTypeName`:
```
@JsonTypeName
@Target({ElementType.ANNOTATION_TYPE, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface FoocorpJsonType {
}
```

- Use `@FoocorpJsonType` on all subtypes to be registered with the mapper:
```
@FoocorpJsonType
public class ConcreteMessage extends AbstractMessage {}
```

- In a suitable location (such as a `@PostConstruct` method on a Spring configuration class, or wherever the `ObjectMapper` is built), use the `org.reflections:reflections` package and this magic spell:
```
Reflections reflections = new Reflections(
ConfigurationBuilder.build("com.foocorp.base.package")
);

mapper.registerSubtypes(reflections.getTypesAnnotatedWith(FoocorpJsonType.class).toArray(new Class[0]));
```

This will scan the classpath (limited for performance) for types annotated with the custom annotation and register them all with the mapper so they can be deserialized when seen.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.