แก้ไขปัญหา Minecraft Config Crash: แก้ปัญหา “ไม่สามารถรับค่า Config ได้ก่อนที่จะโหลดเสร็จ”

เพื่อแก้ไขปัญหา Minecraft config crash ให้หยุดอ่านค่าคอนฟิกจาก Forge จนกว่า Forge จะโหลดคอนฟิกที่ตรงกันเสร็จ ลงทะเบียนคอนฟิกนั้นForgeConfigSpecในตัวสร้างม็อดของคุณ จากนั้นอ่านค่าจากคอนฟิกนั้นModConfigEvent.LoadingหรือModConfigEvent.Reloadingจากฟังก์ชันเรียกกลับ (callback) หากคุณกำลังติดตั้งม็อดของคนอื่น โปรดอัปเดตหรือแยกม็อดที่ระบุในรายงานข้อผิดพลาด การแก้ไขโค้ดเป็นความรับผิดชอบของผู้เขียนม็อดนั้น

ข้อความดังกล่าวมักจะเขียนในลักษณะนี้IllegalStateException: Cannot get config value before config is loadedมันชี้ไปที่การอ่านค่าคอนฟิกก่อนกำหนด แต่รายละเอียดของ stack trace และ loader นั้นมีความสำคัญ ตัวอย่าง Forge ด้านล่างเขียนขึ้นสำหรับรูปแบบ API ของ Forge 1.20.1 ห้ามคัดลอกไปวางใน NeoForge หรือโปรเจ็กต์ Fabric โดยไม่แก้ไข

ข้อผิดพลาด IllegalStateException ในการตั้งค่า Minecraft หมายความว่าอย่างไร

Forge อนุญาตให้ม็อดประกาศตัวแปร `A` ForgeConfigSpecและจัดการการโหลดค่าจากไฟล์การกำหนดค่า `A` ConfigValueคือการอ้างอิงถึงการตั้งค่า การเรียกใช้ ` A` .get()จะขอค่าที่โหลดมาแล้ว หากการอ่านเกิดขึ้นก่อนที่ Forge จะแนบและโหลดการกำหนดค่าที่เหมาะสม Forge จะโยนข้อยกเว้น`IllegalStateException`แทนที่จะส่งคืนค่า

ฟิลด์คงที่ที่เก็บค่าของConfigValueตัวเองนั้นไม่ได้เป็นปัญหาโดยอัตโนมัติ รูปแบบที่เสี่ยงคือการประเมินค่าMY_SETTING.get()ในขณะที่คลาสกำลังเริ่มต้น ในคอนสตรัคเตอร์ที่ทำงานเร็วเกินไป หรือจากโค้ดที่ถูกเรียกใช้ก่อนการโหลดการตั้งค่า ค่าที่แคชไว้อาจล้าสมัยหลังจากโหลดไฟล์ใหม่ เว้นแต่ว่าม็อดจะจัดการเหตุการณ์การโหลดใหม่นั้น

แก้ปัญหาโปรแกรม Forge ขัดข้องใน 4 ขั้นตอน

ขั้นตอนที่ 1: ค้นหาว่าม็อดใดอ่านค่าเร็วเกินไป

เปิดไฟล์รายงานข้อผิดพลาดล่าสุดlatest.logหรือไฟล์รายงานข้อผิดพลาดทั่วไป แล้วหาบรรทัดแรกIllegalStateExceptionอ่านไล่ลงมาตาม stack trace จนกว่าจะออกจากคลาสการกำหนดค่าของ Forge และเข้าสู่แพ็คเกจม็อด เฟรมแรกที่เป็นของม็อดนั้นมักจะระบุตำแหน่งที่เรียกใช้ฟังก์ชัน บันทึกเวอร์ชันของ Minecraft, Forge และม็อด รวมถึงระบุด้วยว่าข้อผิดพลาดเกิดขึ้นบนไคลเอ็นต์ เซิร์ฟเวอร์เฉพาะ การโหลดโลก หรือการโหลดซ้ำ

หากคุณเป็นผู้เล่น ให้คัดลอกโปรไฟล์ของคุณก่อน อัปเดตม็อดที่ระบุชื่อและส่วนประกอบที่จำเป็นให้เป็นเวอร์ชันที่สร้างขึ้นสำหรับ Minecraft และ Forge เวอร์ชันเดียวกัน หากยังคงเกิดข้อผิดพลาด ให้ปิดใช้งานเฉพาะม็อดที่สงสัยในโปรไฟล์ที่คัดลอกมาเพื่อยืนยันสาเหตุ จากนั้นส่งบันทึกทั้งหมดและเวอร์ชันที่แน่นอนให้กับผู้สร้างม็อดนั้น หลีกเลี่ยงการลบไฟล์การกำหนดค่าทั้งหมด: การทำเช่นนั้นอาจลบการตั้งค่าโดยไม่แก้ไขการเรียกใช้โค้ดในขั้นต้น

ขั้นตอนที่ 2: กำหนดและลงทะเบียนข้อมูลจำเพาะของการกำหนดค่า

สร้างสเปคเพียงครั้งเดียว เก็บค่าอ็อบเจ็กต์ไว้ และลงทะเบียนสเปคเดียวกันนั้นจากตัวสร้างม็อด ตัวอย่างนี้กำหนดจำนวนเต็มที่มีขอบเขตในไฟล์การกำหนดค่าทั่วไป:

public final class MyModConfig {
    public static final ForgeConfigSpec SPEC;
    public static final ForgeConfigSpec.IntValue MAX_MOBS;

    static {
        ForgeConfigSpec.Builder builder = new ForgeConfigSpec.Builder();
        MAX_MOBS = builder.defineInRange("maxMobs", 10, 0, 100);
        SPEC = builder.build();
    }
}

public ExampleMod() {
    IEventBus modBus = FMLJavaModLoadingContext.get().getModEventBus();
    ModLoadingContext.get().registerConfig(ModConfig.Type.COMMON, MyModConfig.SPEC);
    modBus.addListener(this::onConfigLoading);
    modBus.addListener(this::onConfigReloading);
}

รักษารูปแบบการกำหนดค่าที่ประกาศไว้ให้ตรงกับตำแหน่งที่ควรอยู่ Forge แยกความแตกต่างระหว่างการ กำหนดค่า CLIENT, COMMON, และSERVERการกำหนดค่าเซิร์ฟเวอร์ของโลกไม่สามารถใช้แทนกันได้กับไฟล์ที่ใช้เฉพาะฝั่งไคลเอ็นต์

ขั้นตอนที่ 3: อ่านค่าจากเหตุการณ์การโหลดและการโหลดซ้ำที่ตรงกัน

ลงทะเบียนผู้รับฟังบนบัสเหตุการณ์ของม็อด และตรวจสอบข้อมูลจำเพาะของเหตุการณ์ก่อนอ่าน Forge ส่งเหตุการณ์การกำหนดค่าสำหรับไฟล์กำหนดค่าของม็อด ดังนั้นผู้รับฟังควรละเว้นเหตุการณ์สำหรับข้อมูลจำเพาะอื่นๆ รีเฟรชสแนปช็อตขณะทำงานเมื่อโหลดครั้งแรกและอีกครั้งเมื่อโหลดซ้ำ:

private static volatile int maxMobs = 10;

private void onConfigLoading(ModConfigEvent.Loading event) {
    updateIfOwned(event.getConfig());
}

private void onConfigReloading(ModConfigEvent.Reloading event) {
    updateIfOwned(event.getConfig());
}

private void updateIfOwned(ModConfig config) {
    if (config.getSpec() != MyModConfig.SPEC) return;
    maxMobs = MyModConfig.MAX_MOBS.get();
}

ใช้ค่ารันไทม์ที่แคชไว้ในตำแหน่งที่ฟีเจอร์ต้องการ แทนที่จะกระจายการอ่านค่าคอนฟิกผ่านตัวเริ่มต้นแบบคงที่ หากฟีเจอร์ใดสามารถทำงานได้ก่อนการโหลดคอนฟิก ให้เลื่อนการทำงานของฟีเจอร์นั้นออกไป หรือกำหนดค่าเริ่มต้นที่ปลอดภัยไว้ อย่าเรียกใช้ตัวติดตามคอนฟิกภายในของ Forge หรือบังคับโหลดด้วยตนเองเพื่อซ่อนข้อผิดพลาดด้านลำดับการทำงาน

ขั้นตอนที่ 4: ทดสอบเส้นทางการเริ่มต้นระบบเดียวกันกับที่ทำให้เกิดข้อผิดพลาด

เรียกใช้โปรแกรมไคลเอ็นต์สำหรับการพัฒนาของโปรเจ็กต์ จากนั้นทำซ้ำขั้นตอนที่ล้มเหลวในครั้งแรก เช่น โหลดโลก เริ่มเซิร์ฟเวอร์เฉพาะ หรือโหลดการตั้งค่าใหม่ ตรวจสอบให้แน่ใจว่ารายงานข้อผิดพลาดไม่มีข้อความแสดงข้อผิดพลาดเกี่ยวกับค่าการตั้งค่าเริ่มต้น และสแนปช็อตขณะทำงานมีการเปลี่ยนแปลงหลังจากโหลดใหม่อย่างถูกต้อง หากการตั้งค่าเป็นแบบเฉพาะเซิร์ฟเวอร์ ให้ทดสอบโลกของเซิร์ฟเวอร์เช่นเดียวกับไคลเอ็นต์ ใช้คำสั่งเรียกใช้ Gradle ที่มีให้โดย Forge MDK ของโปรเจ็กต์ของคุณ ชื่อของคำสั่งอาจแตกต่างกันไปตามการตั้งค่า

อีเวนต์วงจรชีวิตของ Forge เช่น การตั้งค่าทั่วไป ไม่สามารถใช้แทนการเรียกกลับสำหรับการโหลดคอนฟิกได้ บัสอีเวนต์ของม็อดจะรันอีเวนต์วงจรชีวิตหลายอย่างพร้อมกัน ดังนั้นการย้ายการอ่านไปยังตัวจัดการการตั้งค่าใดๆ ก็ตาม ไม่ได้ทำให้ลำดับการทำงานปลอดภัยขึ้นโดยอัตโนมัติ ให้ใช้อีเวนต์คอนฟิกที่ระบุไว้ในเอกสารสำหรับค่า และใช้การส่งต่อเธรดที่เหมาะสมเฉพาะเมื่อการดำเนินการนั้นต้องทำงานบนเธรดใดเธรดหนึ่งโดยเฉพาะเท่านั้น

หากโปรเจ็กต์ใช้ Fabric หรือ NeoForge

Fabric Loader ไม่ได้มีฟังก์ชัน callback ของ Forge หรือฟังก์ชัน callback ForgeConfigSpecทั่วไปConfigLoadingEventsม็อด Fabric มักใช้ไลบรารีการกำหนดค่าแยกต่างหากหรือตัวอ่านไฟล์ของตัวเอง ระบุการพึ่งพาเหล่านั้นจาก stack trace และทำตาม API การโหลดและการโหลดซ้ำของเวอร์ชันที่ตรงกัน ตรวจสอบให้แน่ใจว่าไลบรารีได้รับการเริ่มต้นแล้วก่อนที่ม็อดจะอ่านค่า จุดเริ่มต้นของ Fabric จะทำงานในช่วงต้นของการบูต ดังนั้นอย่าคิดว่าตัวเริ่มต้นหมายความว่าการกำหนดค่าของบุคคลที่สามทั้งหมดได้โหลดเสร็จแล้ว

หากพบข้อผิดพลาดที่มีชื่อแสดงอยู่ใน stack trace net.neoforgedให้ดูเอกสาร API ของ NeoForge เพื่อดูเวอร์ชัน Minecraft และ NeoForge ที่ถูกต้อง Forge และ NeoForge มีแนวคิดคล้ายกัน แต่ชื่อแพ็กเกจและ API ที่รองรับอาจแตกต่างกัน อย่าผสมโค้ดของทั้งสองแพลตฟอร์ม หรือเพิ่มฟังก์ชัน callback ที่คิดขึ้นเองเพื่อปิดเสียงข้อผิดพลาด

รายการตรวจสอบการป้องกันอย่างรวดเร็ว

• ลงทะเบียนข้อมูลจำเพาะของ Forge แต่ละรายการจากตัวสร้างม็อด
• ควรแยกการประกาศค่าคอนฟิกออกจากการเรียกใช้ฟังก์ชันที่ประเมินค่า.get().
• อ่านค่าหลังจากเหตุการณ์โหลดการกำหนดค่าที่ตรงกัน และรีเฟรชค่าที่แคชไว้เมื่อโหลดใหม่
• ตรวจสอบประเภทการกำหนดค่าให้ตรงกัน และทดสอบในฝั่งที่มีการโหลดจริง
• เมื่อมีการระบุชื่อม็อดอื่นในข้อความแสดงข้อผิดพลาด ให้รายงานบันทึกทั้งหมดและชุดเวอร์ชันที่เข้ากันได้ให้กับผู้สร้างม็อดนั้นด้วย

สำหรับรายละเอียดเฉพาะเวอร์ชัน โปรดดูคู่มือการกำหนดค่า Forge 1.20.1 เอกสารเกี่ยวกับวงจรชีวิตของ ม็อด และคู่มือ Event Bus ของ Forgeนักพัฒนา Fabric ควรเริ่มต้นด้วยเอกสาร Fabric Loaderแล้วจึงศึกษาไลบรารีการกำหนดค่าที่โครงการของตนใช้งาน