创建和保存 config.yml 中遇到的问题

Sconosciuti

背景

由于忘记 YAML 的注释要用井号 ”#“，写配置文件的时候用了双斜杠”//“，意外发现了这个问题。

先上代码。(JDK 9.0.4, spigot-api-1.12.2-R0.1-SNAPSHOT-shaded.jar)

config.yml 错误的语法

// test
player-name: Steve

player:
  time:
    join: 6:00pm

Main.java 创建保存部分代码

private void createConfig() {
        try {
            if (!getDataFolder().exists()) {
                getLogger().info("Data folder not found, creating...");
                if(getDataFolder().mkdirs()) {
                    getLogger().info("Done.");
                } else {
                    getLogger().info("Failed.");
                }
            }

            File file = new File(getDataFolder(), "config.yml");

            if (!file.exists()) {
                getLogger().info("config.yml not found, creating...");
                //getConfig().options().copyDefaults();  //方法 A
                //saveDefaultConfig();  //方法 B
                saveResource("config.yml", true); //方法 C
                if(file.exists()) {
                    getLogger().info("Done.");
                } else {
                    getLogger().info("Failed.");
                }
            } else {
                getLogger().info("config.yml found, loading...");
            }

        } catch (Exception e) {
            e.printStackTrace();
            getLogger().info("夭寿了出 BUG 了！");
        }
    }

Joecrazy

Sconosciuti 参见四喵腐竹sama

Sconosciuti

事故现场

方法 A

saveDefaultConfig();

就一行，执行完后跳到下面判断是否创建成功。

编译完拖进去运行。
没有报错，创建插件对应的文件夹，创建 config.yml

方法 B

getConfig().options().copyDefaults();
saveDefaultConfig();

有报错，创建插件对应的文件夹，没有创建 config.yml

org.bukkit.configuration.InvalidConfigurationException: mapping values are not allowed here
 in 'string', line 3, column 12:
    player-name: Steve
......
......

方法 C

saveConfig();

有报错，创建插件对应的文件夹，创建空文件 config.yml

方法 D

saveResource("config.yml", false);

无报错，创建插件对应的文件夹，创建 config.yml

Orange_Sandwich

四喵要回归啦？？

Sconosciuti

问题来了

上面哪种方法才是生成保存配置文件的正确方式？
方法 B 为什么加了第一行就能检测到配置文件的语法错误？
方法 C 为什么会生成空文件？
方法 D 和方法 A 有什么区别？

ABCD 其实都是网上找来的，亲自跑了一遍。
尝试去看 Spigot 的 Javadoc，说明令人困惑……

huang

Sconosciuti

        config.options().copyDefaults(true);
        saveConfig();

这个保存的话，自己手动修改了配置文件后可以保存重载，方法C没有加载修改后的内容，每次加载插件生成新的config.yml
报错可能是添加的内容的格式不对？

saveResource("config.yml", false);

能保存的不局限于配置文件？
ummm, 相互学习，我也是新手XDDDDD

Sconosciuti

huang

试了下 copyDefaults 这个方法

getConfig().options().copyDefaults(true);
saveConfig();

如果填 false 或者不填，生成的文件只有注释没有内容……（不填默认值是 false）
不解，这样有什么意义么？

如果填 true，正常生成。

Javadoc - copyDefaults()

public boolean copyDefaults()

Checks if the Configuration should copy values from its default Configuration directly.
If this is true, all values in the default Configuration will be directly copied, 
making it impossible to distinguish between values that were set and values that are provided by default. As a result, ConfigurationSection.contains(java.lang.String) will always return the same value as ConfigurationSection.isSet(java.lang.String). The default value is false.

Returns:
Whether or not defaults are directly copied

如果值是 true，就复制默认配置文件的内容。嗯，理解起来没问题。
最后一行就无法理解了……

根据自己不断改代码运行的结果看，调用copyDefaults这个方法会复制默认的配置文件内容到内存，需要配合 saveConfig使用。没有 saveConfig的话，不会生成 config.yml 文件。

然后，回过头看自己的代码。
if 判断是否存在配置文件，不存在则生成；存在则输出config.yml found, loading...。
因此不存在的情况下，无需顾虑会不会覆盖已有的配置文件，直接一行

saveDefaultConfig();

即可。
嗯……应该没错吧?

Javadoc - saveDefaultConfig
看了眼文档，发现其实不做判断，直接暴力调用 saveDefaultConfig，现有的配置文件也不会被覆盖。
懒得做测试了……

This should fail silently if the config.yml already exists.

自问自答

取决于怎么写的代码
不知道……可能saveDefaultConfig 就是无脑保存吧
不知道……
不知道……

Der_Links

神仙聊天

Joecrazy

Der_Links 是的是的

BZLjjvv

表示我一个学过java和html的人都表示半懵逼...神仙聊天啊