Как работать с конфигами

Этот сайт лучше всего просматривать в современном браузере с включённым JavaScript.

Как работать с конфигами

admin

Во многих плагинах есть конфигурация. У некоторых это json, у вторых это hocon, у третьих что-то своё. На этот раз мы рассмотрим API для конфигов.

ConfigurationLoader - загрузчик конфигов.
В Sponge можно использовать 3 вида ConfigurationLoader:
1. Для HOCON (загрузчик по-умолчанию)
2. Для JSON
3. Для YAML

У нас есть несколько путей получения конфига по-умолчанию:
1. Ижекция стандартного ConfigurationLoader(самый легкий способ)
2. Ижекция Path стандартного конфига и ручное создание ConfigurationLoader
Второй способ рассмотрим в конце статьи.(Блок: "Ручное создание ConfigurationLoader")

Инжекция ConfigurationLoader и немного про аннотации для конфигов

Стандартный ConfigurationLoader можно получить через инжекцию.
Делается это так:

@Inject
@DefaultConfig(sharedRoot = false)
private ConfigurationLoader<CommentedConfigurationNode> localLoader;

Описание

1. @Inject - обозначает место для ижекции
2. @DefaultConfig(sharedRoot = false) - спецификатор. Эта аннотация нужна инжектору, чтобы он знал, что от него хотят.
В Sponge есть 2 спецификатора для конфигов. Это:
1. @DefaultConfig(boolean)
2. @ConfigDir(boolean)
Первый спецификатор нужен для того, чтобы инжектировать сам конфиг, вторая нужна только для того, чтобы инжектировать папку с конфигом.
sharedRoot = false обозначает то, что конфиг должен быть в директории от плагина.
Трудно понять? Давайте я приведу несколько простых примеров, Вам сразу станет понятно.

Примеры

@Inject
@DefaultConfig(sharedRoot = false)
private ConfigurationLoader<CommentedConfigurationNode> localLoader;

Произойдет инжекция загрузчика для конфига из директории config/{id_плагина}/{id_плагина}.conf

@Inject
@DefaultConfig(sharedRoot = true)
private ConfigurationLoader<CommentedConfigurationNode> sharedLoader;

Произойдет инжекция загрузчика для конфига из директории config/{id_плагина}.conf

@Inject
@DefaultConfig(sharedRoot = false)
private Path localConfig;

Произойдет инжекция Path для пути config/{id_плагина}/{id_плагина}.conf

@Inject
@DefaultConfig(sharedRoot = true)
private Path sharedConfig;

Произойдет инжекция Path для пути config/{id_плагина}.conf

@Inject
@ConfigDir(sharedRoot = false)
private Path localConfigDir;

Произойдет инжекция Path для пути config/{id_плагина}

@Inject
@ConfigDir(sharedRoot = true)
private Path sharedConfigDir;

Произойдет инжекция Path для пути config.
Примечание: инжекция Path не создает его на диске.

Как пользоваться ConfigurationLoader

Ну что же, получили мы ConfigurationLoader, что же дальше?
Всё просто! Нам нужно загрузить конфиг в память. Делается это с помощью метода load(). load() возвращает корневую ноду конфига.

CommentedConfigurationNode defaultWayNode = localLoader.load();

А вот с CommentedConfigurationNode можно работать как с простым деревом.
Давайте что-нибудь сделаем с CommentedConfigurationNode.

defaultWayNode.getNode("test", "node").setValue(true);

(Примечание: комментарий можно указать с помощью метода .setComment(String)
Что же произойдет? Давайте сохраним корневую ноду и посмотрим, что там появилось.

localLoader.save(defaultWayNode);

test {
    node=true
}

Уже неплохо, получить значение ноды из конфига можно так:

defaultWayNode.getNode("test", "node").getValue();

Если нода по пути test -> node не задана, то вернётся null.
Чтобы избежать этого, можно передать значение по-умолчанию. Делается это так:

defaultWayNode.getNode("test", "node").getValue(true);

Примечание: как сразу сохранять значения по-умолчанию я объясню в конце.(Блок: "Краткое описание ConfigurationOptions)

А если нам нужно сохранить и получить какой-то список?
Делается это вот так:

List<String> strings = new ArrayList<>();
strings.add("Sanya");
strings.add("Dima");
strings.add("Sergey");
strings.add("Sasha");
strings.add("Nastya");
strings.add("Olya");

defaultWayNode.getNode("names").setValue(strings);
localLoader.save(defaultWayNode); // Сохраняем в конфиг, лучше всего это делать во время выключения плагина
logger.info(String.valueOf(defaultWayNode.getNode("names").getList(TypeToken.of(String.class))));

В конфиге будет это

names=[
    Sanya,
    Dima,
    Sergey,
    Sasha,
    Nastya,
    Olya
]

В этом примере мы видим TypeToken. Для чего он? Он нужен для указания конкретного класса, если бы мы его не указали, мы бы получили не List<String>, а List<?>.

Рветесь в бой? Давайте сохраним зачарованныйItemStack:

Код

ItemStack sword = ItemStack.of(ItemTypes.DIAMOND_SWORD, 1);
EnchantmentData enchantmentData = sword.getOrCreate(EnchantmentData.class).get();
enchantmentData.addElement(ItemEnchantment.of(Enchantments.FIRE_ASPECT, 1));
enchantmentData.addElement(ItemEnchantment.of(Enchantments.SHARPNESS, 1000));
sword.offer(enchantmentData);

defaultWayNode.getNode("mySword").setValue(TypeToken.of(ItemStack.class), sword);

Давайте посмотри на конфиг:

Конфиг

mySword {
    ContentVersion=1
    Count=1
    ItemType="minecraft:diamond_sword"
    UnsafeDamage=0
    UnsafeData {
        ench=[
            {
                id=20
                lvl=1
            },
            {
                id=16
                lvl=1000
            }
        ]
    }
}

ench - массив с ID зачарвоаний.
ItemType - id предмета(не цифровой!)
Count - кол-во
ContentVersion - нужно для внутренних нужд(конвертация старых конфигов в новые)
UnsafeDamage - дамаг ItemStack.(в minecraft 1.13 будет удален)

Получить ItemStack можно так:

ItemStack mySword = defaultWayNode.getNode("mySword").getValue(TypeToken.of(ItemStack.class));

Всё это время примеры были простыми. А что если мы хотим сохранить POJO?(класс с какими-то данными)
Для этого есть 2 пути:

1. С помощью сериализатора

Что для этого надо?
1. Нужен сам класс
2. Сериализатор этого класса
3. Регистрация сериализатора

На помощь приходит метод load() загрузчика.
Этот метод может принимать ConfigurationOptions. В ConfigurationOptions можно задать наш сериализатор.

1. Представим, что у нас есть вот такой класс:

Класс

public class MyObject {
    private final String someString;
    private final int someInt;
    private final ItemStack someStack;

    public MyObject(String someString, int someInt, ItemStack someStack) {
        this.someString = someString;
        this.someInt = someInt;
        this.someStack = someStack;
    }

    public String getSomeString() {
        return someString;
    }

    public int getSomeInt() {
        return someInt;
    }

    public ItemStack getSomeStack() {
        return someStack;
    }
}

2. Напишем для него сериализатор:

Сериализатор

public class MyObjectSerializer implements TypeSerializer<MyObject> {
    @Override
    public MyObject deserialize(TypeToken<?> type, ConfigurationNode value) throws ObjectMappingException {
        String someString = value.getNode("someString").getString();
        int someInt = value.getNode("someInt").getInt();
        ItemStack someStack = value.getNode("someStack").getValue(TypeToken.of(ItemStack.class));
        return new MyObject(someString, someInt, someStack);
    }

    @Override
    public void serialize(TypeToken<?> type, MyObject obj, ConfigurationNode value) throws ObjectMappingException {
        value.getNode("someString").setValue(obj.getSomeString());
        value.getNode("someInt").setValue(obj.getSomeInt());
        value.getNode("someStack").setValue(TypeToken.of(ItemStack.class), obj.getSomeStack());
    }
}

3. Зарегистрируем сериализатор:

Регистрация

TypeSerializerCollection serializers = TypeSerializers.getDefaultSerializers().newChild();
serializers.registerType(TypeToken.of(MyObject.class), new MyObjectSerializer());
ConfigurationOptions opts = ConfigurationOptions.defaults().setSerializers(serializers);

CommentedConfigurationNode customSerializerNode = localLoader.load(opts);

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

Cохраним наш класс:

MyObject object = new MyObject("Какая-то строка", 7, sword);
customSerializerNode.getNode("mySimpleObject").setValue(TypeToken.of(MyObject.class), object);

Вот что появилось в конфиге:

Конфиг

mySword {
    ContentVersion=1
    Count=1
    ItemType="minecraft:diamond_sword"
    UnsafeDamage=0
    UnsafeData {
        ench=[
            {
                id=20
                lvl=1
            },
            {
                id=16
                lvl=1000
            }
        ]
    }
}

2. С помощью аннотаций

У данного метода есть один минус: инжекция невозможна без конструктора без аргументов.
1. Создадим класс:

Класс

@ConfigSerializable
public class MyEnhancedObject {
    @Setting
    private MyObject object;
    @Setting("myBestStack")
    private ItemStack stack;
    @Setting(comment = "Идентификатор игрока")
    private UUID someId;

    public MyEnhancedObject() {
    }

    public MyEnhancedObject(MyObject object, ItemStack stack, UUID someId) {
        this.object = object;
        this.stack = stack;
        this.someId = someId;
    }

    public MyObject getObject() {
        return object;
    }

    public ItemStack getStack() {
        return stack;
    }

    public UUID getSomeId() {
        return someId;
    }
}

@Setting - указывает ноду в конфиге.

Примеры

Нода с именем myNode

@Setting 
private String myNode

Нода с именем myCustomNode

@Setting("myCustomNode") 
private String myNode

Нода с именем someId и комментарием:

@Setting(comment = "Идентификатор игрока")
private UUID someId;

Нода с комментарием и именем playerId:

@Setting(value = "playerId", comment = "Идентификатор игрока")
private UUID someId;

@ConfigSerializable аннотация, указывающая на то, что это класс-конфиг.

Давайте протестируем:

ItemStack copy = sword.copy();
copy.offer(Keys.DISPLAY_NAME, Text.of("Супер-меч!"));

MyEnhancedObject meo = new MyEnhancedObject(mySimpleObject, copy, UUID.randomUUID());
node.getNode("proWayCoding").setValue(TypeToken.of(MyEnhancedObject.class), meo);

Получить объект:

MyEnhancedObject myEnhancedObject = node.getNode("proWayCoding").getValue(TypeToken.of(MyEnhancedObject.class));

Что в конфиге:

Конфиг

proWayCoding {
    myBestStack {
        ContentVersion=1
        Count=1
        ItemType="minecraft:diamond_sword"
        UnsafeDamage=0
        UnsafeData {
            display {
                Name="Супер-меч!"
            }
            ench=[
                {
                    id=20
                    lvl=1
                },
                {
                    id=16
                    lvl=1000
                }
            ]
        }
    }
    object {
        someInt=7
        someStack {
            ContentVersion=1
            Count=1
            ItemType="minecraft:diamond_sword"
            UnsafeDamage=0
            UnsafeData {
                ench=[
                    {
                        id=20
                        lvl=1
                    },
                    {
                        id=16
                        lvl=1000
                    }
                ]
            }
        }
        someString="Какая-то строка"
    }
    # Идентификатор игрока
    someId=d8cae836-e761-4343-b756-61130bef72f0
}

Ручное создание ConfigurationLoader

Всё, с конфигами почти закончили. Теперь разберем то, как можно использовать другие ConfigurationLoader.
Для json и yaml существуют свои загрузчики. Они возвращают точно такие же ноды, поэтому можно загрузить yaml, а сохранить уже hocon или наоборот.
Для создания своего загрузчика нам надо:
1. Path или URL(если загружать из jar)
К примеру:

YAMLConfigurationLoader loader = YAMLConfigurationLoader.builder().setPath(configPath).build();
ConfigurationNode root = loader.load();
root.getNode("myNode", "extra").setValue("testValue");

Для json есть GsonConfigurationLoader.

Кратное описание ConfigurationOptions

Так же я обещал показать, как сохранять значение по-умолчанию.
Представим, что конфиг еще не создан. Поэтому .getValue() вернёт null.
Чтобы этого избежать, можно передать значение по-умолчанию. К примеру вот так: .getValue("default"). При этом значение по-умолчанию в конфиге не сохранится, чтобы сохранялось, нужно настроить ConfigurationOptions во время загрузки ноды(load()).
Делается это вот так:

ConfigurationOptions options = ConfigurationOptions.defaults()
        .setShouldCopyDefaults(true);
CommentedConfigurationNode rootNode = localLoader.load(options);

Можно передать несколько опций, вот так:

ConfigurationOptions options = ConfigurationOptions.defaults()
        .setShouldCopyDefaults(true)
        .setSerializers(serializers)
        .setHeader("Заголовок");

В этом случае, значения по-умолчанию будут записаны в памяти, останется только сохранить корневую ноду.

localLoader.save(defaultWayNode);

На этом всё.
Исходники

demkom58

Найс

GreWeMa

Также добавлю для особо ленивых уже готовый класс для работы с HOCON конфигами (при наличии рук заменить HOCON на YAML/GSON - пара строчек).
Все что нужно это заменить YouPlugin на класс вашего плагина, добавить статик метод getInstance, а также методы getLogger & getConfigDirectory.
Также данный класс автоматически переносит "стандартные" данные из ваших конфигов.

Код

import ninja.leaping.configurate.ConfigurationNode;
import ninja.leaping.configurate.commented.CommentedConfigurationNode;
import ninja.leaping.configurate.hocon.HoconConfigurationLoader;
import ninja.leaping.configurate.loader.ConfigurationLoader;
import org.spongepowered.api.Sponge;

import java.io.File;
import java.net.URL;
import java.util.concurrent.TimeUnit;

public class ConfigManager {

    public static final int AUTO_SAVE_INTERVAL = 600;

    private YourPlugin instance;
    private String name;
    private File file;
    private ConfigurationLoader<CommentedConfigurationNode> loader;
    private ConfigurationNode node;

    public ConfigManager(YourPlugin instance, String name, boolean auto_save) {
        this.instance = instance;
        this.name = name;
        try {
            file = new File(instance.getConfigDirectory(), name);
            loader = HoconConfigurationLoader.builder().setFile(file).build();
            node = loader.load();
            if (!file.exists()) {
                file.createNewFile();
                URL defaultsURL = YourPlugin.class.getResource("/" + name);
                ConfigurationLoader<CommentedConfigurationNode> defaultsLoader =
                        HoconConfigurationLoader.builder().setURL(defaultsURL).build();
                ConfigurationNode defaultsNode = defaultsLoader.load();
                node.mergeValuesFrom(defaultsNode);
                Sponge.getScheduler().createTaskBuilder().delayTicks(1).execute(this::save).
                        submit(instance);
            }
            if (auto_save) {
                Sponge.getScheduler().createTaskBuilder().async().execute(this::save).
                        interval(AUTO_SAVE_INTERVAL, TimeUnit.SECONDS).submit(instance);
            }
        } catch (Exception e) {
            instance.getLogger().warn("Failed initialize config \"" + getName() + "\"!", e);
        }
    }

    public String getName() {
        return name;
    }

    public File getFile() {
        return file;
    }

    public ConfigurationLoader<CommentedConfigurationNode> getLoader() {
        return loader;
    }

    public ConfigurationNode getNode() {
        return node;
    }

    public ConfigurationNode getNode(Object... objects) {
        return node.getNode(objects);
    }

    public void save() {
        try {
            loader.save(node);
            instance.getLogger().info("Config \"" + name + "\" successfully saved!");
        } catch (Exception e) {
            instance.getLogger().warn("Fail saving config \"" + name + "\"!", e);
        }
    }

    public void reload() {
        try {
            node = loader.load();
            instance.getLogger().info("Config \"" + name + "\" successfully reloaded!");
        } catch (Exception e) {
            instance.getLogger().warn("Fail reloading config \"" + name + "\"!", e);
        }
    }
}

Russia9

GreWeMa Можете пояснить за что отвечает name и что должен возвращать getConfigDirectory?

SawFowl

Разницы работы с HOCON и YAML в коде я вообще не заметил, поддержка YAML достаточно убогая, костылить надо что бы боле менее удобно было писать под ним конфиг, иначе даже перенос строк нормально не сделать по человечески.

Prototype

Забей и юзай HOCON.

SawFowl

Prototype Да вот тоже так думаю, особенно если учесть что разницы в плане кода особо и нет.

SawFowl

У меня 2 вопроса возникло. Как сделать конфиг с кастомным именем? Например для локализации плагина.
И как проверить существование строки/ноды в конфиге? В баките для такой проверки есть метод isSet(String).

Prototype

SawFowl
вторая часть вопроса - node.isVirtual(...);

SawFowl

Prototype Пробовал, при отсутствии проверяемой ноды выкидывает ошибку в консоль. Хотел сделать для конфига защиту от дурака + проверка версии конфига. Проверка номера версии пашет норм, а вот с защитой от дурака не вышло. В любом случае спасибо, буду дальше ковыряться.

admin

SawFowl нужно инжектировать Path с помощью аннотации ConfigDir, потом создать вручную ConfigurationLoader нужного типа, по-умолчанию это HoconConfigurationLoader.

HoconConfigurationLoader.builder().setPath(injectedPath.resolve("myCustomConfig.conf")).build().load();

Если есть кастомные конфиги, то я не рекомендую использовать sharedRoot = true, ибо кто знает, может какой-нибудь плагин уже создал такой файл. Из-за этого могут быть баги в виде потери конфига каким-нибудь плагином.
Для проверки существования ноды, нужно использовать node.isVirtual().

SawFowl

Чувствую себя дураком, допустил глупейшую ошибку, когда использовал .isVirtual(), метод проверки конфига вообще не верно прописал. Вправил, пашет.
За инфу о создании конфига с кастомным именем отдельное спасибо.

SawFowl

Можно ли как-то выбрать рандомную строку из конфига? Допустим есть такой конфиг.

Message {
    "text 1",
    "text 2",
    "text 3",
    "text 4"
}

Количество строк может быть любым. Выбрать нужную корневую ноду не проблема, а вот как выбрать рандомное сообщение не понятно.

admin

SawFowl такой конфиг невозможен.

Message [
    "text 1",
    "text 2",
    "text 3",
    "text 4"
]

Вот такой возможен. Просто получаешь массив строк, способы получения случайного элемента из массива всем известны.

SawFowl

admin Благодарю, ну я как пример привел, согласен не удачно.

admin

Russia9 name - название конфига, getConfigDirectory должен вернуть Path с путём до директории с конфигами плагина.

@Inject 
@ConfigDir(sharedroot = false)
private Path configDir;

Типа такого.

JekaRUS

Config config = ConfigFactory.parseFile(new File(" ... "));
ConfigValue value = config.getValue("test");

ConfigValueType type = value.valueType();
if (type == ConfigValueType.BOOLEAN)
{
    // code
}

Этот код можно реализовать через HoconConfigurationLoader?

HoconConfigurationLoader loader = HoconConfigurationLoader.builder().setFile(new File(" ... ")).build();
CommentedConfigurationNode node = loader.load();
node. ..

admin

JekaRUS File -> Path. Старайся не использовать File.
Что твой код делает?

admin

У ConfigurationNode есть метод getValueType(), думаю, это то, что тебе нужно.

JekaRUS

admin Нет такого метода..

Следующая страница »