Minecraft插件开发笔记——Config操作

插件开发笔记之Config

1.主要方法

插件在执行有关config的时候，主要需要以下几个方法

//以下方法中JavaPlugin类一般直接继承在插件主类，所以直接this即可

//获取config
JavaPlugin.getConfig();

//写入config(会覆盖本地的配置)
JavaPlugin.saveConfig;

//写入默认config(如果已有config.yml则不会覆盖)
JavaPlugin.saveDefaultConfig;

//载入配置文件到服务器内存
JavaPlugin.reload;

2.配置文件的姿势

一个配置文件由键值对构成，键是一个字符串。类似于一个多维数组

例如

key: value
one:
  two: value1
  three:
    - values2
    - values3
    - values4
  four: 
    five: value5
  *:
    six: value6
    seven: value7

访问时使用 a.b.c的方式来访问，如访问 “one.two”得值value1。需要注意在键的冒号后需要空格

3.一般姿势

在操作时一般在onEnable()方法中载入配置文件，需要检测是否存在什么的，或者直接saveDefaultConfig()也可以.一个典型的载入方法如下

public void LoadConfig(){
        if (!new File(getDataFolder()+File.separator+"config.yml").exists()){
            saveDefaultConfig();
            getLogger().severe("未发现config.yml，已保存初始设置");
        }try{
            reloadConfig();
            getLogger().info("已加载config");
        }catch (Exception e){
            getServer().getPluginManager().disablePlugin(this);
            getLogger().warning("无法加载config.yml，插件结束");
        }
    }

载入后，在需要的位置即可使用getConfig()调用

4.取得值

在需要的位置可从getConfig()取出配置文件的值。使用姿势如下

this.getConfig().getString(节点PathString)

如此取得的是String类型的值（yml中亦需要打引号）

同样可以使用不同的方法取得不同的返回值

getBoolean(String) 获取键对应的类型为boolean的值
getInt(String) 获取键对应的类型为 int 的值
getString(String) 获取键对应的类型为 String 的值
getList(String) 获取键对应的类型为 List 的值
getStringList(String)

5.设置值

使用插件可以更改配置文件中的值，很实用的姿态，而且很简单

this.getConfig().set("path", value);

即可搞定，其中的值可以为各种数据类型，boolean，int，string等都可以。

保存配置到硬盘就不会丢失了

saveConfig();

6.一个简单的学习例程源码

7.结语

只要肯学习，总是会学会的

作于6.20 18:17