feat: implement asset information serialisation #163
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| package org.eclipse.digitaltwin.aas4j.v3.dataformat.json; | ||
|
|
||
| import com.fasterxml.jackson.annotation.JsonInclude; | ||
| import com.fasterxml.jackson.databind.DeserializationFeature; | ||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||
| import com.fasterxml.jackson.databind.SerializationFeature; | ||
| import com.fasterxml.jackson.databind.json.JsonMapper; | ||
| import com.fasterxml.jackson.databind.module.SimpleAbstractTypeResolver; | ||
| import com.fasterxml.jackson.databind.module.SimpleModule; | ||
| import org.eclipse.digitaltwin.aas4j.v3.dataformat.core.deserialization.EnumDeserializer; | ||
| import org.eclipse.digitaltwin.aas4j.v3.dataformat.core.serialization.EnumSerializer; | ||
| import org.eclipse.digitaltwin.aas4j.v3.dataformat.core.util.ReflectionHelper; | ||
|
|
||
| /** | ||
| * This class contains the initialization code used by the JsonSerializer and JsonDeserializer. It also contains a | ||
| * factory method, that is very useful to be used in SpringBoot environment, to automate the serialization. Here is a | ||
| * sample code: | ||
| * <pre> | ||
| * {@code @Configuration} | ||
| * public class JacksonConfig { | ||
| * {@code @Bean} | ||
| * {@code @Primary} | ||
| * public ObjectMapper objectMapper() { | ||
| * return ObjectMapperFactory.createMapper(); | ||
| * } | ||
| * </pre> | ||
| * Having such JacksonConfig class in your SpringBoot web application, the framework will always use the created mapper | ||
| * for serialization and deserialization, and you don't need to carry about it anymore. | ||
| */ | ||
| public class ObjectMapperFactory { | ||
| private ObjectMapperFactory() {} | ||
|
|
||
| /** | ||
| * The factory method to create the object mapper for serialization/deserialization of AAS objects. | ||
| * @return the configured object mapper. According to the Jackson documentation the ObjectMapper class is | ||
| * thread-safe. | ||
| * | ||
| * The returned object mapper can be used directly for AAS serialization/deserialization, or you can use the utility | ||
| * JsonSerializer and JsonDeserializer wrapper classes. | ||
| */ | ||
| public static ObjectMapper createMapper() { | ||
| return createMapper(null); | ||
| } | ||
|
|
||
| /** | ||
| * A package-private method used by JsonDeserializer wrapper class. It is needed only to support its | ||
| * useImplementation method, which require modification of the type resolver. | ||
| * @param typeResolver The type resolver used for deserialization. | ||
| * @return the configured object mapper. According to the Jackson documentation the ObjectMapper class is | ||
| * thread-safe. | ||
| */ | ||
| static ObjectMapper createMapper(SimpleAbstractTypeResolver typeResolver) { | ||
| ObjectMapper mapper = JsonMapper.builder() | ||
| .enable(SerializationFeature.INDENT_OUTPUT) | ||
| .enable(DeserializationFeature.ACCEPT_SINGLE_VALUE_AS_ARRAY) | ||
| .disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES) | ||
| .serializationInclusion(JsonInclude.Include.NON_NULL) | ||
| .serializationInclusion(JsonInclude.Include.NON_EMPTY) | ||
| .annotationIntrospector(new ReflectionAnnotationIntrospector()) | ||
| .addModule(buildEnumModule()) | ||
| .addModule(buildTypeResolverModule(typeResolver)) | ||
| .build(); | ||
| ReflectionHelper.JSON_MIXINS.entrySet().forEach(x -> mapper.addMixIn(x.getKey(), x.getValue())); | ||
| return mapper; | ||
| } | ||
|
|
||
| /** | ||
| * A package-private method, to create a type resolver, which is used for serialization/deserialization of AAS | ||
| * object. | ||
| * @return the type resolver. | ||
| */ | ||
| static SimpleAbstractTypeResolver createTypeResolver() { | ||
| SimpleAbstractTypeResolver typeResolver = new SimpleAbstractTypeResolver(); | ||
| ReflectionHelper.DEFAULT_IMPLEMENTATIONS | ||
| .stream() | ||
| .forEach(x -> typeResolver.addMapping(x.getInterfaceType(), x.getImplementationType())); | ||
| return typeResolver; | ||
| } | ||
|
|
||
| private static SimpleModule buildTypeResolverModule(SimpleAbstractTypeResolver typeResolver) { | ||
| final SimpleModule module = new SimpleModule(); | ||
| if(typeResolver == null) { | ||
| typeResolver = createTypeResolver(); | ||
| } | ||
| module.setAbstractTypes(typeResolver); | ||
| return module; | ||
| } | ||
|
|
||
| private static SimpleModule buildEnumModule() { | ||
| SimpleModule module = new SimpleModule(); | ||
| ReflectionHelper.ENUMS.forEach(x -> { | ||
| module.addDeserializer(x, new EnumDeserializer<>(x)); | ||
| module.addSerializer(x, new EnumSerializer()); | ||
| }); | ||
| return module; | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In my opinion the ObjectMapper created by this class can fully replace the JsonSerializer and JsonDeserializer.