com.esotericsoftware.kryo.serializers.RecordSerializer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of redisson-all Show documentation
Easy Redis Java client and Real-Time Data Platform. Valkey compatible. Sync/Async/RxJava3/Reactive API. Client side caching. Over 50 Redis based Java objects and services: JCache API, Apache Tomcat, Hibernate, Spring, Set, Multimap, SortedSet, Map, List, Queue, Deque, Semaphore, Lock, AtomicLong, Map Reduce, Bloom filter, Scheduler, RPC
There is a newer version: 3.40.2
Show newest version
/* Copyright (c) 2008-2023, Nathan Sweet
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following
 * conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
 * disclaimer in the documentation and/or other materials provided with the distribution.
 * - Neither the name of Esoteric Software nor the names of its contributors may be used to endorse or promote products derived
 * from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
 * SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */

package com.esotericsoftware.kryo.serializers;

import static com.esotericsoftware.minlog.Log.*;

import com.esotericsoftware.kryo.Kryo;
import com.esotericsoftware.kryo.KryoException;
import com.esotericsoftware.kryo.io.Input;
import com.esotericsoftware.kryo.io.Output;

import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
import java.util.Arrays;
import java.util.Comparator;

/** Serializer for record classes.
 * @author Julia Boes 
 * @author Chris Hegarty  */
public class RecordSerializer extends ImmutableSerializer {
	private static final Method IS_RECORD;
	private static final Method GET_RECORD_COMPONENTS;
	private static final Method GET_NAME;
	private static final Method GET_TYPE;

	static {
		Method isRecord;
		Method getRecordComponents;
		Method getName;
		Method getType;

		try {
			// reflective machinery required to access the record components
			// without a static dependency on Java SE 14 APIs
			Class c = Class.forName("java.lang.reflect.RecordComponent");
			isRecord = Class.class.getDeclaredMethod("isRecord");
			getRecordComponents = Class.class.getMethod("getRecordComponents");
			getName = c.getMethod("getName");
			getType = c.getMethod("getType");
		} catch (ClassNotFoundException | NoSuchMethodException e) {
			// pre-Java-14
			isRecord = null;
			getRecordComponents = null;
			getName = null;
			getType = null;
		}

		IS_RECORD = isRecord;
		GET_RECORD_COMPONENTS = getRecordComponents;
		GET_NAME = getName;
		GET_TYPE = getType;
	}

	private static final ClassValue> CONSTRUCTOR = new ClassValue>() {
		protected Constructor computeValue(Class clazz) {
			final RecordComponent[] components = recordComponents(clazz, Comparator.comparing(RecordComponent::index));
			return getCanonicalConstructor(clazz, components);
		}
	};
	private static final ClassValue RECORD_COMPONENTS = new ClassValue() {
		protected RecordComponent[] computeValue(Class type) {
			return recordComponents(type, Comparator.comparing(RecordComponent::name));
		}
	};

	private boolean fixedFieldTypes = false;

	/** @deprecated use {@link #RecordSerializer(Class) instead} */
	@Deprecated(forRemoval = true)
	public RecordSerializer() {
	}

	public RecordSerializer (Class clazz) {
		if (!isRecord(clazz)) throw new KryoException(clazz + " is not a record");
	}

	@Override
	public void write (Kryo kryo, Output output, T object) {
		for (RecordComponent rc : RECORD_COMPONENTS.get(object.getClass())) {
			final Class type = rc.type();
			final String name = rc.name();
			try {
				if (TRACE) trace("kryo", "Write property: " + name + " (" + type.getName() + ")");
				if (type.isPrimitive()) {
					kryo.writeObject(output, rc.getValue(object));
				} else {
					if (fixedFieldTypes || kryo.isFinal(type)) {
						kryo.writeObjectOrNull(output, rc.getValue(object), type);
					} else {
						kryo.writeClassAndObject(output, rc.getValue(object));
					}
				}
			} catch (KryoException ex) {
				ex.addTrace(name + " (" + type.getName() + ")");
				throw ex;
			} catch (Throwable t) {
				KryoException ex = new KryoException(t);
				ex.addTrace(name + " (" + type.getName() + ")");
				throw ex;
			}
		}
	}

	@Override
	public T read (Kryo kryo, Input input, Class type) {
		final RecordComponent[] components = RECORD_COMPONENTS.get(type);
		final Object[] values = new Object[components.length];
		for (int i = 0; i < components.length; i++) {
			final RecordComponent rc = components[i];
			final String name = rc.name();
			final Class rcType = rc.type();
			try {
				if (TRACE) trace("kryo", "Read property: " + name + " (" + type.getName() + ")");
				// Populate values in the order required by the canonical constructor
				if (rcType.isPrimitive()) {
					values[rc.index()] = kryo.readObject(input, rcType);
				} else {
					if (fixedFieldTypes || kryo.isFinal(rcType)) {
						values[rc.index()] = kryo.readObjectOrNull(input, rcType);
					} else {
						values[rc.index()] = kryo.readClassAndObject(input);
					}
				}
			} catch (KryoException ex) {
				ex.addTrace(name + " (" + type.getName() + ")");
				throw ex;
			} catch (Throwable t) {
				KryoException ex = new KryoException(t);
				ex.addTrace(name + " (" + type.getName() + ")");
				throw ex;
			}
		}
		return invokeCanonicalConstructor(type, values);
	}

	/** Returns true if, and only if, the given class is a record class. */
	private boolean isRecord (Class type) {
		try {
			return (boolean)IS_RECORD.invoke(type);
		} catch (Throwable t) {
			throw new KryoException("Could not determine type (" + type + ")");
		}
	}

	/** A record component, which has a name, a type and an index. The latter is the index of the record components in the class
	 * file's record attribute, required to invoke the record's canonical constructor . */
	static final class RecordComponent {
		private final Class recordType;
		private final String name;
		private final Class type;
		private final int index;
		private final Method getter;

		RecordComponent (Class recordType, String name, Class type, int index) {
			this.recordType = recordType;
			this.name = name;
			this.type = type;
			this.index = index;

			try {
				getter = recordType.getDeclaredMethod(name);
				if (!getter.isAccessible()) {
					getter.setAccessible(true);
				}
			} catch (Exception t) {
				KryoException ex = new KryoException(t);
				ex.addTrace("Could not retrieve record component getter (" + recordType.getName() + ")");
				throw ex;
			}
		}

		String name () {
			return name;
		}

		Class type () {
			return type;
		}

		int index () {
			return index;
		}

		Object getValue (Object recordObject) {
			try {
				return getter.invoke(recordObject);
			} catch (Exception t) {
				KryoException ex = new KryoException(t);
				ex.addTrace("Could not retrieve record component value (" + recordType.getName() + ")");
				throw ex;
			}
		}
	}

	/** Returns an ordered array of the record components for the given record class. The order is imposed by the given comparator.
	 * If the given comparator is null, the order is that of the record components in the record attribute of the class file. */
	private static  RecordComponent[] recordComponents (Class type,
		Comparator comparator) {
		try {
			Object[] rawComponents = (Object[])GET_RECORD_COMPONENTS.invoke(type);
			RecordComponent[] recordComponents = new RecordComponent[rawComponents.length];
			for (int i = 0; i < rawComponents.length; i++) {
				final Object comp = rawComponents[i];
				recordComponents[i] = new RecordComponent(
					type,
					(String)GET_NAME.invoke(comp),
					(Class)GET_TYPE.invoke(comp), i);
			}
			if (comparator != null) Arrays.sort(recordComponents, comparator);
			return recordComponents;
		} catch (Throwable t) {
			KryoException ex = new KryoException(t);
			ex.addTrace("Could not retrieve record components (" + type.getName() + ")");
			throw ex;
		}
	}

	/** Invokes the canonical constructor of a record class with the given argument values. */
	private T invokeCanonicalConstructor (Class recordType, Object[] args) {
		try {
			return (T) CONSTRUCTOR.get(recordType).newInstance(args);
		} catch (Throwable t) {
			KryoException ex = new KryoException(t);
			ex.addTrace("Could not construct type (" + recordType.getName() + ")");
			throw ex;
		}
	}

	private static  Constructor getCanonicalConstructor (Class recordType, RecordComponent[] recordComponents) {
		try {
			Class[] paramTypes = Arrays.stream(recordComponents)
				.map(RecordComponent::type)
				.toArray(Class[]::new);
			return getCanonicalConstructor(recordType, paramTypes);
		} catch (Throwable t) {
			KryoException ex = new KryoException(t);
			ex.addTrace("Could not retrieve record canonical constructor (" + recordType.getName() + ")");
			throw ex;
		}
	}

	private static  Constructor getCanonicalConstructor (Class recordType, Class[] paramTypes)
		throws NoSuchMethodException {
		Constructor canonicalConstructor;
		try {
			canonicalConstructor = recordType.getConstructor(paramTypes);
			if (!canonicalConstructor.canAccess(null)) {
				canonicalConstructor.setAccessible(true);
			}
		} catch (Exception e) {
			canonicalConstructor = recordType.getDeclaredConstructor(paramTypes);
			canonicalConstructor.setAccessible(true);
		}
		return canonicalConstructor;
	}

	/** Tells the RecordSerializer that all field types are effectively final. This allows the serializer to be more efficient,
	 * since it knows field values will not be a subclass of their declared type. Default is false. */
	public void setFixedFieldTypes (boolean fixedFieldTypes) {
		this.fixedFieldTypes = fixedFieldTypes;
	}
}