spring-kafka JsonSerde 源码

spring-kafka JsonSerde 代码

文件路径：/spring-kafka/src/main/java/org/springframework/kafka/support/serializer/JsonSerde.java

/*
 * Copyright 2017-2022 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.kafka.support.serializer;

import java.util.Map;

import org.apache.kafka.common.serialization.Serde;

import org.springframework.core.ResolvableType;
import org.springframework.kafka.support.JacksonUtils;
import org.springframework.kafka.support.mapping.Jackson2JavaTypeMapper;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;

import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.JavaType;
import com.fasterxml.jackson.databind.ObjectMapper;

/**
 * A {@link org.apache.kafka.common.serialization.Serde} that provides serialization and
 * deserialization in JSON format.
 * <p>
 * The implementation delegates to underlying {@link JsonSerializer} and
 * {@link JsonDeserializer} implementations.
 *
 * @param <T> target class for serialization/deserialization
 *
 * @author Marius Bogoevici
 * @author Elliot Kennedy
 * @author Gary Russell
 * @author Ivan Ponomarev
 *
 * @since 1.1.5
 */
public class JsonSerde<T> implements Serde<T> {

	private final JsonSerializer<T> jsonSerializer;

	private final JsonDeserializer<T> jsonDeserializer;

	public JsonSerde() {
		this((JavaType) null, JacksonUtils.enhancedObjectMapper());
	}

	public JsonSerde(@Nullable Class<? super T> targetType) {
		this(targetType, JacksonUtils.enhancedObjectMapper());
	}

	public JsonSerde(@Nullable TypeReference<? super T> targetType) {
		this(targetType, JacksonUtils.enhancedObjectMapper());
	}

	public JsonSerde(@Nullable JavaType targetType) {
		this(targetType, JacksonUtils.enhancedObjectMapper());
	}

	public JsonSerde(ObjectMapper objectMapper) {
		this((JavaType) null, objectMapper);
	}

	public JsonSerde(@Nullable TypeReference<? super T> targetType, ObjectMapper objectMapper) {
		this(targetType == null ? null : objectMapper.constructType(targetType.getType()), objectMapper);
	}

	public JsonSerde(@Nullable Class<? super T> targetType, ObjectMapper objectMapper) {
		this(targetType == null ? null : objectMapper.constructType(targetType), objectMapper);
	}

	public JsonSerde(@Nullable JavaType targetTypeArg, @Nullable ObjectMapper objectMapperArg) {
		ObjectMapper objectMapper = objectMapperArg == null ? JacksonUtils.enhancedObjectMapper() : objectMapperArg;
		JavaType actualJavaType;
		if (targetTypeArg != null) {
			actualJavaType = targetTypeArg;
		}
		else {
			Class<?> resolvedGeneric = ResolvableType.forClass(getClass()).getSuperType().resolveGeneric(0);
			actualJavaType = resolvedGeneric != null ? objectMapper.constructType(resolvedGeneric) : null;
		}
		this.jsonSerializer = new JsonSerializer<>(actualJavaType, objectMapper);
		this.jsonDeserializer = new JsonDeserializer<>(actualJavaType, objectMapper);
	}

	public JsonSerde(JsonSerializer<T> jsonSerializer, JsonDeserializer<T> jsonDeserializer) {
		Assert.notNull(jsonSerializer, "'jsonSerializer' must not be null.");
		Assert.notNull(jsonDeserializer, "'jsonDeserializer' must not be null.");
		this.jsonSerializer = jsonSerializer;
		this.jsonDeserializer = jsonDeserializer;
	}

	@Override
	public void configure(Map<String, ?> configs, boolean isKey) {
		this.jsonSerializer.configure(configs, isKey);
		this.jsonDeserializer.configure(configs, isKey);
	}

	@Override
	public void close() {
		this.jsonSerializer.close();
		this.jsonDeserializer.close();
	}

	@Override
	public JsonSerializer<T> serializer() {
		return this.jsonSerializer;
	}

	@Override
	public JsonDeserializer<T> deserializer() {
		return this.jsonDeserializer;
	}

	/**
	 * Copies this serde with same configuration, except new target type is used.
	 * @param newTargetType type reference forced for serialization, and used as default for deserialization, not null
	 * @param <X> new deserialization result type and serialization source type
	 * @return new instance of serde with type changes
	 * @since 2.6
	 */
	public <X> JsonSerde<X> copyWithType(Class<? super X> newTargetType) {
		return new JsonSerde<>(this.jsonSerializer.copyWithType(newTargetType),
			this.jsonDeserializer.copyWithType(newTargetType));
	}

	/**
	 * Copies this serde with same configuration, except new target type reference is used.
	 * @param newTargetType type reference forced for serialization, and used as default for deserialization, not null
	 * @param <X> new deserialization result type and serialization source type
	 * @return new instance of serde with type changes
	 * @since 2.6
	 */
	public <X> JsonSerde<X> copyWithType(TypeReference<? super X> newTargetType) {
		return new JsonSerde<>(this.jsonSerializer.copyWithType(newTargetType),
			this.jsonDeserializer.copyWithType(newTargetType));
	}

	/**
	 * Copies this serde with same configuration, except new target java type is used.
	 * @param newTargetType java type forced for serialization, and used as default for deserialization, not null
	 * @param <X> new deserialization result type and serialization source type
	 * @return new instance of serde with type changes
	 * @since 2.6
	 */
	public <X> JsonSerde<X> copyWithType(JavaType newTargetType) {
		return new JsonSerde<>(this.jsonSerializer.copyWithType(newTargetType),
			this.jsonDeserializer.copyWithType(newTargetType));
	}

	// Fluent API

	/**
	 * Designate this Serde for serializing/deserializing keys (default is values).
	 * @return the serde.
	 * @since 2.3
	 */
	public JsonSerde<T> forKeys() {
		this.jsonSerializer.forKeys();
		this.jsonDeserializer.forKeys();
		return this;
	}

	/**
	 * Configure the serializer to not add type information.
	 * @return the serde.
	 * @since 2.3
	 */
	public JsonSerde<T> noTypeInfo() {
		this.jsonSerializer.noTypeInfo();
		return this;
	}

	/**
	 * Don't remove type information headers after deserialization.
	 * @return the serde.
	 * @since 2.3
	 */
	public JsonSerde<T> dontRemoveTypeHeaders() {
		this.jsonDeserializer.dontRemoveTypeHeaders();
		return this;
	}

	/**
	 * Ignore type information headers and use the configured target class.
	 * @return the serde.
	 * @since 2.3
	 */
	public JsonSerde<T> ignoreTypeHeaders() {
		this.jsonDeserializer.ignoreTypeHeaders();
		return this;
	}

	/**
	 * Use the supplied {@link Jackson2JavaTypeMapper}.
	 * @param mapper the mapper.
	 * @return the serde.
	 * @since 2.3
	 */
	public JsonSerde<T> typeMapper(Jackson2JavaTypeMapper mapper) {
		this.jsonSerializer.setTypeMapper(mapper);
		this.jsonDeserializer.setTypeMapper(mapper);
		return this;
	}

}

相关信息

spring-kafka 源码目录

相关文章

spring-kafka DelegatingByTopicDeserializer 源码

spring-kafka DelegatingByTopicSerialization 源码

spring-kafka DelegatingByTopicSerializer 源码

spring-kafka DelegatingByTypeSerializer 源码

spring-kafka DelegatingDeserializer 源码

spring-kafka DelegatingSerializer 源码

spring-kafka DeserializationException 源码

spring-kafka ErrorHandlingDeserializer 源码

spring-kafka FailedDeserializationInfo 源码

spring-kafka JsonDeserializer 源码