Кодеки

Codec — это система для простой сериализации объектов Java, входящая в библиотеку DataFixerUpper (DFU) от Mojang, которая включена в Minecraft. В контексте разработки модов они могут использоваться в качестве альтернативы GSON и Jankson при чтении и записи пользовательских JSON-файлов и их значение со временем растёт, поскольку Mojang переписывает множество старого кода с использованием Codec.

Кодеки используются вместе с другим API из DFU — DynamicOps. Кодек определяет структуру объекта, в то время как динамические операции (dynamic ops) используются для определения формата, в который и из которого происходит сериализация, например JSON или NBT. Это означает, что любой кодек может быть использован с любыми динамическими операциями и наоборот, что обеспечивает большую гибкость.

Использование кодеков

Сериализация и десериализация

Основное использование кодека — это сериализация и десериализация объектов в определённый формат и из него.

Поскольку для некоторых стандартных классов уже определены кодеки, мы можем использовать их в качестве примера. Mojang также предоставила нам два класса динамических операций по умолчанию: JsonOps и NbtOps, которые охватывают большинство случаев использования.

Итак, допустим, мы хотим сериализовать BlockPos в JSON и обратно. Для этого мы можем использовать кодек, статически хранящийся в BlockPos.CODEC, используя такие его методы как Codec#encodeStart и Codec#parse.

java

BlockPos pos = new BlockPos(1, 2, 3);

// Сериализуем BlockPos в JsonElement
DataResult<JsonElement> result = BlockPos.CODEC.encodeStart(JsonOps.INSTANCE, pos);

Когда мы используем кодек, возвращаемые данные будут в виде DataResult. Это оболочка, которая может означать как успешное, так и неудачное выполнение. Мы можем пойти разными путями: если нам просто нужно наше сериализованное значение, DataResult#result просто вернёт Optional, содержащий наше значение, в то время как DataResult#resultOrPartial также позволяет нам добавить обработку ошибок, которые могли бы произойти в процессе. Последнее особенно полезно для своих ресурсов для наборов данных, где мы хотим журналировать ошибки без создания проблем в других местах.

Итак, теперь возьмём сериализованное нами значение и превратим его обратно в BlockPos:

java

// При реальном написании мода вам, конечно, нужно правильно обрабатывать пустые Optionals
JsonElement json = result.resultOrPartial(LOGGER::error).orElseThrow();

// Здесь у нас есть наше JSON-значение, которое должно соответствовать `[1, 2, 3]`,
// так как это формат, используемый кодеком BlockPos.
LOGGER.info("Serialized BlockPos: {}", json);

// Теперь десериализуем JsonElement обратно в BlockPos
DataResult<BlockPos> result = BlockPos.CODEC.parse(JsonOps.INSTANCE, json);

// Снова просто получаем наше значение из результата
BlockPos pos = result.resultOrPartial(LOGGER::error).orElseThrow();

// И мы видим, что успешно сериализовали и десериализовали наш BlockPos!
LOGGER.info("Десериализованный BlockPos: {}", pos);

Встроенные кодеки

Как упоминалось ранее, Mojang уже определила кодеки для нескольких стандартных и Java-классов, включая, но не ограничиваясь, BlockPos, BlockState, ItemStack, ResourceLocation, Component и шаблоны (Pattern) регулярных выражений. Кодеки для собственных классов Mojang обычно можно найти в статических полях с именем CODEC в самом классе, в то время как большинство других кодеков содержатся в классе Codecs. Также следует отметить, что все стандартные реестры содержат метод byNameCodec(). Например, вы можете использовать BuiltInRegistries.BLOCK.byNameCodec(), чтобы получить Codec<Block>, который сериализует идентификатор блока и обратно.

Сам API Codec также содержит некоторые кодеки для примитивных типов, такие как Codec.INT и Codec.STRING. Они доступны как статические поля в классе Codec и обычно используются как основа для более сложных кодеков, как объясняется ниже.

Сборка кодеков

Теперь, когда мы увидели, как использовать кодеки, давайте посмотрим, как мы можем собрать свои собственные. Предположим, у нас есть следующий класс, и мы хотим десериализовать его экземпляры из JSON-файлов:

java

public class CoolBeansClass {

    private final int beansAmount;
    private final Item beanType;
    private final List<BlockPos> beanPositions;

    public CoolBeansClass(int beansAmount, Item beanType, List<BlockPos> beanPositions) {...}

    public int getBeansAmount() { return this.beansAmount; }
    public Item getBeanType() { return this.beanType; }
    public List<BlockPos> getBeanPositions() { return this.beanPositions; }
}

Соответствующий JSON-файл может выглядеть примерно так:

json

{
  "beans_amount": 5,
  "bean_type": "beanmod:mythical_beans",
  "bean_positions": [
    [1, 2, 3],
    [4, 5, 6]
  ]
}

Мы можем создать кодек для этого класса, объединив несколько меньших кодеков в один большой. В данном случае нам понадобится по одному кодеку для каждого поля:

Codec<Integer>
Codec<Item>
Codec<List<BlockPos>>

Мы можем получить первый из упомянутых ранее примитивных кодеков в классе Codec, а именно Codec.INT. Второй можно получить из реестра BuiltInRegistries.ITEM, который имеет метод byNameCodec(), возвращающий Codec<Item>. У нас нет стандартного кодека для List<BlockPos>, но мы можем создать его из BlockPos.CODEC.

Списки

Метод Codec#listOf можно использовать для создания версии кодека для списка любого типа:

java

Codec<List<BlockPos>> listCodec = BlockPos.CODEC.listOf();

Следует отметить, что кодеки, созданные таким образом, всегда будут десериализоваться в ImmutableList. Если вам нужна изменяемая (mutable) коллекция, вы можете воспользоваться xmap для преобразования её при десериализации.

Объединение кодеков для классов, похожих на Record

Теперь, когда у нас есть отдельные кодеки для каждого поля, мы можем объединить их в один кодек для нашего класса, используя RecordCodecBuilder. Это предполагает, что наш класс имеет конструктор, содержащий каждое поле, которое мы хотим сериализовать, и что для каждого поля есть соответствующий метод доступа (геттер). Это делает его идеальным для использования вместе с записями (records), но он также может быть использован с обычными классами.

Давайте посмотрим, как создать кодек для нашего CoolBeansClass:

java

public static final Codec<CoolBeansClass> CODEC = RecordCodecBuilder.create(instance -> instance.group(
    Codec.INT.fieldOf("beans_amount").forGetter(CoolBeansClass::getBeansAmount),
    BuiltInRegistries.ITEM.byNameCodec().fieldOf("bean_type").forGetter(CoolBeansClass::getBeanType),
    BlockPos.CODEC.listOf().fieldOf("bean_positions").forGetter(CoolBeansClass::getBeanPositions)
    // Здесь можно объявить до 16 полей
).apply(instance, CoolBeansClass::new));

Каждая строка в группе указывает кодек, имя поля и метод доступа. Вызов Codec#fieldOf используется для преобразования кодека в MapCodec, а forGetter указывает метод, используемый для получения значения поля из экземпляра класса. Между тем, вызов apply указывает конструктор, используемый для создания новых экземпляров. Обратите внимание, что порядок полей в группе должен совпадать с порядком аргументов в конструкторе.

Вы также можете использовать Codec#optionalFieldOf в этом контексте, чтобы сделать поле необязательным, как объясняется в разделе «Необязательные поля».

MapCodec, не путать с Codec<Map>

Вызов Codec#fieldOf преобразует Codec<T> в MapCodec<T>, который является вариантом, но не прямой реализацией Codec<T>. MapCodec, как следует из названия, гарантированно сериализуется в карту «ключ-значение» или её эквивалент в используемых DynamicOps. Некоторые функции могут требовать именно MapCodec вместо обычного кодека.

Этот способ создания MapCodec по сути оборачивает значение исходного кодека внутри карты, используя указанное имя поля в качестве ключа. Например, Codec<BlockPos>, когда сериализуется в JSON, выглядел бы так:

json

[1, 2, 3]

Но при преобразовании в MapCodec<BlockPos> с помощью BlockPos.CODEC.fieldOf("pos") он будет выглядеть так:

json

{
  "pos": [1, 2, 3]
}

Хотя наиболее распространённое использование MapCodec — объединение с другими MapCodec для построения кодека для полного класса полей, как объясняется в разделе «Объединение кодеков для классов, похожих на Record» выше, они также могут быть преобразованы обратно в обычные кодеки с помощью MapCodec#codec, который сохранит то же поведение оборачивания их входного значения.

Необязательные поля

Codec#optionalFieldOf можно использовать для создания необязательного MapCodec. Это означает, что когда указанное поле отсутствует в контейнере при десериализации, оно будет десериализовано как пустой Optional или заданное значение по умолчанию.

java

// Без значения по умолчанию
MapCodec<Optional<BlockPos>> optionalCodec = BlockPos.CODEC.optionalFieldOf("pos");

// Со значением по умолчанию
MapCodec<BlockPos> optionalCodec = BlockPos.CODEC.optionalFieldOf("pos", BlockPos.ORIGIN);

Обратите внимание, что необязательные поля будут молча игнорировать любые ошибки, которые могут возникнуть при десериализации. Это означает, что если поле присутствует, но значение недопустимо, поле всегда будет десериализовано как значение по умолчанию.

Начиная с версии 1.20.2, сам Minecraft (не DFU!) предоставляет Codecs#createStrictOptionalFieldCodec, который вовсе не удаётся десериализовать, если значение поля недопустимо.

Константы, ограничения и композиция

Unit

Codec.unit можно использовать для создания кодека, который всегда десериализуется в постоянное значение, независимо от входных данных. При сериализации он ничего не будет делать.

java

Codec<Integer> theMeaningOfCodec = Codec.unit(42);

Числовые диапазоны

Codec.intRange и его аналоги, Codec.floatRange и Codec.doubleRange, можно использовать для создания кодека, который принимает только числовые значения в заданном включающем диапазоне. Это применяется как к сериализации, так и к десериализации.

java

// Не может быть больше 2
Codec<Integer> amountOfFriendsYouHave = Codec.intRange(0, 2);

Пары

Codec.pair объединяет два кодека, Codec<A> и Codec<B>, в Codec<Pair<A, B>>. Имейте в виду, что это работает правильно только с кодеками, которые сериализуются в определённое поле, такие как преобразованные MapCodec или record-кодеки. Полученный кодек будет сериализоваться в карту, объединяющую поля обоих используемых кодеков.

Например, запуск такого кода:

java

// Создаём два отдельных коробочных кодека
Codec<Integer> firstCodec = Codec.INT.fieldOf("i_am_number").codec();
Codec<Boolean> secondCodec = Codec.BOOL.fieldOf("this_statement_is_false").codec();

// Объединяем их в пару кодеков
Codec<Pair<Integer, Boolean>> pairCodec = Codec.pair(firstCodec, secondCodec);

// Используем её для сериализации данных
DataResult<JsonElement> result = pairCodec.encodeStart(JsonOps.INSTANCE, Pair.of(23, true));

Выведет следующий JSON:

json

{
  "i_am_number": 23,
  "this_statement_is_false": true
}

Either

Codec.either объединяет два кодека, Codec<A> и Codec<B>, в Codec<Either<A, B>>. Полученный кодек при десериализации попытается использовать первый кодек, и только если это не удастся, попытается использовать второй. Если второй также не справится, будет возвращена ошибка второго кодека.

Карты

Для обработки карт с произвольными ключами, таких как HashMap, можно использовать Codec.unboundedMap. Это возвращает Codec<Map<K, V>> для заданных Codec<K> и Codec<V>. Полученный кодек будет сериализоваться в объект JSON или любой эквивалент, доступный для текущих динамических операций.

Из-за ограничений JSON и NBT, используемый кодек ключа должен сериализоваться в строку. Это включает кодеки для типов, которые сами по себе не являются строками, но сериализуются в них, такие как ResourceLocation.CODEC. Смотрите пример ниже:

java

// Создаём кодек для карты идентификаторов к целым числам
Codec<Map<ResourceLocation, Integer>> mapCodec = Codec.unboundedMap(ResourceLocation.CODEC, Codec.INT);

// Используем его для сериализации данных
DataResult<JsonElement> result = mapCodec.encodeStart(JsonOps.INSTANCE, Map.of(
    ResourceLocation.fromNamespaceAndPath("example", "number"), 23,
    ResourceLocation.fromNamespaceAndPath("example", "the_cooler_number"), 42
));

Это выведет следующий JSON:

json

{
  "example:number": 23,
  "example:the_cooler_number": 42
}

Как вы можете видеть, это работает, потому что ResourceLocation.CODEC сериализуется непосредственно в строковое значение. Похожий эффект можно достичь для простых объектов, которые не сериализуются в строки, используя xmap и другие функции для их преобразования.

Взаимно преобразуемые типы

`xmap`

Предположим, у нас есть два класса, которые могут быть преобразованы друг в друга, но не имеют отношения наследования. Например, стандартные BlockPos и Vec3d. Если у нас есть кодек для одного, мы можем использовать Codec#xmap, чтобы создать кодек для другого, указав функцию преобразования для каждого направления.

BlockPos уже имеет кодек, но предположим, что его нет. Мы можем создать его, основываясь на кодеке для Vec3d, следующим образом:

java

Codec<BlockPos> blockPosCodec = Vec3d.CODEC.xmap(
    // Преобразование Vec3d в BlockPos
    vec -> new BlockPos(vec.x, vec.y, vec.z),
    // Преобразование BlockPos в Vec3d
    pos -> new Vec3d(pos.getX(), pos.getY(), pos.getZ())
);

// При преобразовании существующего класса (например, `X`)
// в ваш собственный класс (`Y`) таким образом, может быть полезно
// добавить методы `toX` и статический `fromX` в `Y` и использовать
// ссылки на методы в вашем вызове `xmap`.

flatComapMap, comapFlatMap и flatXMap

Codec#flatComapMap, Codec#comapFlatMap и flatXMap похожи на xmap, но они позволяют одной или обеим функциям преобразования возвращать DataResult. Это полезно на практике, потому что конкретный экземпляр объекта может быть не всегда допустим для преобразования.

Возьмём, например, стандартные идентификаторы (ResourceLocation). Хотя все идентификаторы можно превратить в строки, не все строки являются допустимыми идентификаторами, поэтому при неудачном преобразовании использование xmap приведёт к тому, что вы столкнётесь с некрасивыми исключениями. Из-за этого его встроенный кодек на самом деле является comapFlatMap на Codec.STRING, что хорошо иллюстрирует, как его использовать:

java

public class ResourceLocation {
    public static final Codec<ResourceLocation> CODEC = Codec.STRING.comapFlatMap(
        ResourceLocation::validate, ResourceLocation::toString
    );

    // ...

    public static DataResult<ResourceLocation> validate(String id) {
        try {
            return DataResult.success(ResourceLocation.fromNamespaceAndPath(id));
        } catch (InvalidResourceLocationException e) {
            return DataResult.error("Недопустимое местоположение ресурса: " + id + " " + e.getMessage());
        }
    }

    // ...
}

Хотя эти методы действительно полезны, их названия немного сбивают с толку, поэтому вот таблица, которая поможет вам запомнить, какой из них использовать:

Метод	A → B всегда допустимо?	B → A всегда допустимо?
`Codec<A>#xmap`	Да	Да
`Codec<A>#comapFlatMap`	Нет	Да
`Codec<A>#flatComapMap`	Да	Нет
`Codec<A>#flatXMap`	Нет	Нет

Диспетчер реестров

Codec#dispatch позволяет нам определить реестр кодеков и направлять к конкретному кодеку на основе значения поля в сериализованных данных. Это очень полезно при десериализации объектов, которые имеют разные поля в зависимости от их типа, но всё же представляют одно и то же.

Например, предположим, у нас есть абстрактный интерфейс Bean с двумя реализующими классами: StringyBean и CountingBean. Чтобы сериализовать их с помощью диспетчера реестров, нам понадобится несколько вещей:

Отдельные кодеки для каждого типа бобов (beans; как мы их назвали ранее);
Класс или запись BeanType<T extends Bean>, представляющий тип боба и способный возвращать кодек для него;
Функция в Bean для получения его BeanType<?>;
Карта или реестр для сопоставления идентификаторов с BeanType<?>;
Codec<BeanType<?>>, основанный на этом реестре. Если вы используете net.minecraft.registry.Registry, его можно легко создать с помощью Registry#byNameCodec.

Имея всё это, мы можем создать кодек диспетчера реестров для бобов:

java

// The abstract type we want to create a codec for
public interface Bean {
	// Now we can create a codec for bean types based on the previously created registry.
	Codec<Bean> BEAN_CODEC = BeanType.REGISTRY.byNameCodec()
			// And based on that, here's our registry dispatch codec for beans!
			// The first argument is the field name for the bean type.
			// When left out, it will default to "type".
			.dispatch("type", Bean::getType, BeanType::codec);

	BeanType<?> getType();
}

java

// A record to keep information relating to a specific
// subclass of Bean, in this case only holding a Codec.
public record BeanType<T extends Bean>(MapCodec<T> codec) {
	// Create a registry to map identifiers to bean types
	public static final Registry<BeanType<?>> REGISTRY = new MappedRegistry<>(
			ResourceKey.createRegistryKey(ResourceLocation.fromNamespaceAndPath("example", "bean_types")), Lifecycle.stable());
}

java

// An implementing class of Bean, with its own codec.
public class StringyBean implements Bean {
	public static final MapCodec<StringyBean> CODEC = RecordCodecBuilder.mapCodec(instance -> instance.group(
			Codec.STRING.fieldOf("stringy_string").forGetter(StringyBean::getStringyString)
	).apply(instance, StringyBean::new));

	private String stringyString;

	// It is important to be able to retrieve the
	// BeanType of a Bean from it's instance.
	@Override
	public BeanType<?> getType() {
		return BeanTypes.STRINGY_BEAN;
	}
}

java

// Another implementation
public class CountingBean implements Bean {
	public static final MapCodec<CountingBean> CODEC = RecordCodecBuilder.mapCodec(instance -> instance.group(
			Codec.INT.fieldOf("counting_number").forGetter(CountingBean::getCountingNumber)
	).apply(instance, CountingBean::new));

	private int countingNumber;

	@Override
	public BeanType<?> getType() {
		return BeanTypes.COUNTING_BEAN;
	}
}

java

// An empty class to hold static references to all BeanTypes
public class BeanTypes {
	// Make sure to register the bean types and leave them accessible to
	// the getType method in their respective subclasses.
	public static final BeanType<StringyBean> STRINGY_BEAN = register("stringy_bean", new BeanType<>(StringyBean.CODEC));
	public static final BeanType<CountingBean> COUNTING_BEAN = register("counting_bean", new BeanType<>(CountingBean.CODEC));

	public static <T extends Bean> BeanType<T> register(String id, BeanType<T> beanType) {
		return Registry.register(BeanType.REGISTRY, ResourceLocation.fromNamespaceAndPath("example", id), beanType);
	}
}

java

// Теперь мы можем создать кодек для типов бобов
// на основе ранее созданного реестра
Codec<BeanType<?>> beanTypeCodec = BeanType.REGISTRY.byNameCodec();

// И на основе этого, вот наш кодек диспетчера реестра для бобов!
// Первый аргумент — это имя поля для типа боба.
// Если его не указать, по умолчанию будет «type».
Codec<Bean> beanCodec = beanTypeCodec.dispatch("type", Bean::getType, BeanType::codec);

Наш новый кодек будет сериализовать наши бобы в JSON следующим образом, захватывая только поля, которые относятся к их конкретному типу:

json

{
  "type": "example:stringy_bean",
  "stringy_string": "Этот боб — строка!"
}

json

{
  "type": "example:counting_bean",
  "counting_number": 42
}

Рекурсивные кодеки

Иногда бывает полезно иметь кодек, который использует сам себя для декодирования определённых полей, например, при работе с некоторыми рекурсивными структурами данных. В стандартном коде это используется для объектов Component, которые могут хранить другие Component как дочерние. Такой кодек можно построить с помощью Codec#recursive.

Например, давайте попробуем сериализовать односвязный список. Этот способ представления списков состоит из набора узлов, которые хранят значение и ссылку на следующий узел в списке. Список представлен своим первым узлом, и обход списка осуществляется путём следования по следующему узлу, пока они не закончатся. Вот простая реализация узлов, которые хранят целые числа:

java

public record ListNode(int value, ListNode next) {}

Мы не можем создать кодек для этого обычными средствами, потому что какой кодек мы будем использовать для поля next? Нам нужен Codec<ListNode>, который мы как раз и пытаемся создать! Codec#recursive позволяет нам достичь этого, используя «волшебную» лямбду:

java

Codec<ListNode> codec = Codec.recursive(
  "ListNode", // имя для кодека
  selfCodec -> {
    // Здесь `selfCodec` представляет `Codec<ListNode>`, как если бы он уже был создан
    // Эта лямбда должна возвращать кодек, который мы хотим использовать, и который ссылается на себя через `selfCodec`
    return RecordCodecBuilder.create(instance ->
      instance.group(
        Codec.INT.fieldOf("value").forGetter(ListNode::value),
        // поле `next` будет обрабатываться рекурсивно с помощью `selfCodec`
        Codecs.createStrictOptionalFieldCodec(selfCodec, "next", null).forGetter(ListNode::next)
      ).apply(instance, ListNode::new)
    );
  }
);

Сериализованный ListNode может выглядеть так:

json

{
  "value": 2,
  "next": {
    "value": 3,
    "next": {
      "value": 5
    }
  }
}

Ссылки

Более полную документацию по кодекам и связанным API можно найти в неофициальной Java-документации DFU;
Общая структура этого руководства была сильно вдохновлена страницей о кодеках на Forge Community Wiki, более специфичным для Forge подходом к той же теме.

Блокировать сущности

Loom Gradle Plugin

Авторы страницы

Ссылки на файлы

Авторы страницы

Кодеки

Использование кодеков

Сериализация и десериализация

Встроенные кодеки

Сборка кодеков

Списки

Объединение кодеков для классов, похожих на Record

MapCodec, не путать с Codec<Map>

Необязательные поля

Константы, ограничения и композиция

Unit

Числовые диапазоны

Пары

Either

Карты

Взаимно преобразуемые типы

`xmap`

flatComapMap, comapFlatMap и flatXMap

Диспетчер реестров

Рекурсивные кодеки

Ссылки

Авторы страницы

Ссылки на файлы

Авторы страницы

Кодеки ​

Использование кодеков ​

Сериализация и десериализация ​

Встроенные кодеки ​

Сборка кодеков ​

Списки ​

Объединение кодеков для классов, похожих на Record ​

MapCodec, не путать с Codec&lt;Map&gt; ​

Необязательные поля ​

Константы, ограничения и композиция ​

Unit ​

Числовые диапазоны ​

Пары ​

Either ​

Карты ​

Взаимно преобразуемые типы ​

xmap ​

flatComapMap, comapFlatMap и flatXMap ​

Диспетчер реестров ​

Рекурсивные кодеки ​

Ссылки ​

Кодеки

Использование кодеков

Сериализация и десериализация

Встроенные кодеки

Сборка кодеков

Списки

Объединение кодеков для классов, похожих на Record

MapCodec, не путать с Codec<Map>

Необязательные поля

Константы, ограничения и композиция

Unit

Числовые диапазоны

Пары

Either

Карты

Взаимно преобразуемые типы

`xmap`

flatComapMap, comapFlatMap и flatXMap

Диспетчер реестров

Рекурсивные кодеки

Ссылки