หนังสือ
Kotlin
บทที่ 5. ปฏิบัติการเขียนโค้ดที่ดี
การบันทึกล็อก

Kotlin:
การบันทึกล็อก

วิธีทำ:

ใน Kotlin การบันทึกสามารถทำได้โดยใช้ฟังก์ชัน println() สำหรับกรณีง่ายๆ หรือใช้ไลบรารีที่ซับซ้อนกว่าเช่น SLF4J กับ Logback หรือ Log4j สำหรับความต้องการที่ซับซ้อนขึ้น

ต่อไปนี้คือตัวอย่างพื้นฐานในการใช้ println():

fun main() {
    println("Simple log message: Application started.")
    // ... บางลอจิกแอปพลิเคชั่นที่นี่ ...
    try {
        // จำลองข้อผิดพลาด
        throw Exception("Simulated error")
    } catch (e: Exception) {
        println("Error log message: " + e.message)
    }
}

ผลลัพธ์:

Simple log message: Application started.
Error log message: Simulated error

และนี่คือส่วนของโค้ดที่ใช้ SLF4J กับ Logback ที่ได้มีการตั้งค่าแล้ว:

import org.slf4j.LoggerFactory

private val logger = LoggerFactory.getLogger("MyAppLogger")

fun main() {
    logger.info("Structured log message: App launched.")
    // ... บางลอจิกแอปพลิเคชั่นที่นี่ ...
    try {
        // จำลองข้อผิดพลาด
        throw Exception("Simulated error")
    } catch (e: Exception) {
        logger.error("Structured error log: ", e)
    }
}

หลังจากการตั้งค่า Logback อย่างเหมาะสม ผลลัพธ์ที่ได้จะถูกจัดรูปแบบและอาจจะปรากฏออกมาเหมือนนี้เมื่อเขียนลงในไฟล์ log:

[INFO] - 2023-03-29 14:15:42 - MyAppLogger - Structured log message: App launched.
[ERROR] - 2023-03-29 14:15:43 - MyAppLogger - Structured error log: 
java.lang.Exception: Simulated error
   at com.myapp.Main.main(Main.kt:10)

ลงรายละเอียด

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

ก่อนที่ Kotlin จะเป็นที่นิยม นักพัฒนา Java ใช้ไลบรารีอย่าง Log4j และต่อมาคือ SLF4J อย่างแพร่หลาย ซึ่งได้สร้างแรงบันดาลใจให้กับการปฏิบัติที่คล้ายคลึงกันใน Kotlin โดยใช้ประโยชน์จากการทำงานร่วมกันของไลบรารี Kotlin กับ Java SLF4J ทำหน้าที่เป็นชั้นครอบงำ อนุญาตให้การใช้งานการบันทึกจริงสามารถเปลี่ยนแปลงได้—โดยปกติ Logback หรือ Log4j2 จะเป็นตัวเลือกที่ต้องการ

Kotlin ยังอนุญาตให้มีการแก้ปัญหาการบันทึกหลายแพลตฟอร์มที่ทำงานได้ทั้งใน JVM, JavaScript และ Native เช่น ผ่านกลไก expect/actual ซึ่งซ่อนการดำเนินการเฉพาะแพลตฟอร์มไว้

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

คุณสมบัติอื่นๆ ทั่วไปของกรอบการทำงานการบันทึกขั้นสูง ได้แก่:

  • ระดับการบันทึก (DEBUG, INFO, WARN, ERROR ฯลฯ) เพื่อจำแนกความเร่งด่วนของข้อความบันทึก
  • ผลลัพธ์ไปยังตัวรับอย่างต่างๆ เช่น คอนโซล ไฟล์ ฐานข้อมูล หรือบริการเครือข่าย
  • การหมุนไฟล์ล็อกและนโยบายการรักษาอัตโนมัติ
  • การติดตามการกระจายสำหรับสถาปัตยกรรมไมโครเซอร์วิส
  • การบันทึกแบบมีโครงสร้างโดยใช้รูปแบบเช่น JSON ซึ่งสามารถประสานงานได้ดีกับระบบวิเคราะห์ล็อก

เครื่องมือเหล่านี้และคุณสมบัตินั้นสำคัญสำหรับการรักษาระบบที่เชื่อถือได้ สามารถสังเกตได้ โดยเฉพาะในสภาพแวดล้อมที่ซับซ้อน กระจายหรือมีการขยายขนาดสูง

ดูเพิ่มเติม

สำหรับการเรียนรู้เพิ่มเติมและข้อมูลเชิงลึกเกี่ยวกับการบันทึกใน Kotlin ตรวจสอบที่:

การจัดการกับข้อผิดพลาดการจัดระเบียบโค้ดเข้าไปในฟังก์ชัน