Java Academy · Pelajaran

Mengkonfigurasi Logback

Penambah, corak dan tahap

Pelajaran 4 daripada 413 langkah

Mengkonfigurasi Logback ialah pelajaran Java Academy percuma di CoddyKit. Ini ialah pelajaran 4 daripada 4. Anda boleh membaca keseluruhan pelajaran di bawah secara percuma — kemudian berlatih secara praktikal dalam pelayar menggunakan penyunting kod terbina dalam dan tutor kecerdasan buatan 24/7. Pelajaran ini merupakan sebahagian daripada laluan pembelajaran Java Academy, dan kemajuan anda disegerakkan merentas web serta aplikasi CoddyKit. Kursus Java Academy merangkumi sejumlah 4 pelajaran.

Apakah Logback?

Logback ialah sistem belakang SLF4J yang popular, ditulis oleh pengarang yang sama seperti Log4j. Logback menjalankan pengelogan sebenar yang diterangkan oleh panggilan SLF4J.

Anda mengkonfigurasikannya menggunakan fail bernama logback.xml pada laluan kelas, biasanya di bawah src/main/resources.

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class Main {
    private static final Logger log = LoggerFactory.getLogger(Main.class);
    public static void main(String[] args) {
        log.info("Logback reads logback.xml at startup");
    }
}

Tiga Komponen Asas

Konfigurasi Logback mempunyai tiga konsep teras:

  • Logger: sumber peristiwa log bernama, dengan suatu tahap.
  • Penyalur: destinasi (konsol, fail).
  • Pengekod/Tataletak: memformatkan peristiwa menjadi teks.
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class Main {
    private static final Logger log = LoggerFactory.getLogger(Main.class);
    public static void main(String[] args) {
        log.info("logger -> appender -> encoder -> output");
    }
}

Penyalur Konsol

Konfigurasi paling ringkas menghantar semuanya ke konsol. Corak pengekod mengawal format baris.

XML ini berada dalam logback.xml, bukan dalam kod Java Anda.

<configuration>
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
      <pattern>%d{HH:mm:ss.SSS} %-5level %logger{36} - %msg%n</pattern>
    </encoder>
  </appender>
  <root level="info">
    <appender-ref ref="STDOUT" />
  </root>
</configuration>

Memahami Corak

Perkataan penukaran corak bermula dengan %:

  • %d cap masa, %level tahap tersebut.
  • %logger nama Logger, %thread Thread.
  • %msg mesej Anda, %n baris baharu.

%-5level menambah ruang di sebelah kiri tahap sehingga lebarnya 5.

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class Main {
    private static final Logger log = LoggerFactory.getLogger(Main.class);
    public static void main(String[] args) {
        // Output rendered by pattern: time LEVEL logger - message
        log.info("hello");
    }
}

Logger Akar dan Tahap

Elemen <root> menetapkan tahap lalai untuk keseluruhan aplikasi serta penyalur yang digunakan untuk menulis.

Menetapkan level="info" bermaksud INFO, WARN dan ERROR dikeluarkan; DEBUG dan TRACE disekat.

<configuration>
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <encoder><pattern>%-5level %logger - %msg%n</pattern></encoder>
  </appender>
  <root level="warn">
    <appender-ref ref="STDOUT" />
  </root>
</configuration>

Tahap Mengikut Pakej

Tambahkan elemen <logger> untuk menggantikan tahap bagi sesuatu pakej. Ini membolehkan Anda mengaktifkan DEBUG untuk kod sendiri sambil memastikan pustaka kekal senyap.

<configuration>
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <encoder><pattern>%-5level %logger - %msg%n</pattern></encoder>
  </appender>
  <logger name="com.example.app" level="debug" />
  <root level="info">
    <appender-ref ref="STDOUT" />
  </root>
</configuration>

Penyalur Fail Bergilir

Untuk produksi, Anda biasanya menulis ke fail yang bertukar setiap hari atau mengikut saiz supaya catatan tidak berkembang tanpa had.

RollingFileAppender dengan dasar berasaskan masa mencipta satu fail sehari dan menyimpan sejarah yang terhad.

<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  <file>logs/app.log</file>
  <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    <fileNamePattern>logs/app.%d{yyyy-MM-dd}.log</fileNamePattern>
    <maxHistory>30</maxHistory>
  </rollingPolicy>
  <encoder>
    <pattern>%d %-5level [%thread] %logger{36} - %msg%n</pattern>
  </encoder>
</appender>

Berbilang Penyalur Serentak

Logger akar boleh merujuk kepada beberapa penyalur, jadi catatan dihantar ke konsol dan fail secara serentak.

<configuration>
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <encoder><pattern>%-5level %msg%n</pattern></encoder>
  </appender>
  <appender name="FILE" class="ch.qos.logback.core.FileAppender">
    <file>logs/app.log</file>
    <encoder><pattern>%d %-5level %msg%n</pattern></encoder>
  </appender>
  <root level="info">
    <appender-ref ref="STDOUT" />
    <appender-ref ref="FILE" />
  </root>
</configuration>

Mencetak MDC

Untuk menyertakan konteks MDC seperti id permintaan pada setiap baris, tambahkan %X{key} pada corak.

Kemudian, apa-apa nilai yang Anda masukkan ke dalam MDC akan dipaparkan secara automatik.

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.MDC;

public class Main {
    private static final Logger log = LoggerFactory.getLogger(Main.class);
    public static void main(String[] args) {
        MDC.put("requestId", "req-1234");
        // Pattern: %X{requestId} %-5level %msg%n
        log.info("handled");
        MDC.clear();
    }
}

Sifat Penambahan

Secara lalai, peristiwa Logger turut dihantar ke penyalur Logger induknya. Inilah sifat penambahan.

Jika Logger pakej mempunyai penyalurnya sendiri dan Anda tidak mahu hasil pendua, tetapkan additivity="false" padanya.

<configuration>
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <encoder><pattern>%-5level %logger - %msg%n</pattern></encoder>
  </appender>
  <logger name="com.example.audit" level="info" additivity="false">
    <appender-ref ref="STDOUT" />
  </logger>
  <root level="warn">
    <appender-ref ref="STDOUT" />
  </root>
</configuration>

Muat Semula Automatik dan Pemboleh Ubah

Logback boleh memuat semula konfigurasi secara berkala dengan <configuration scan="true">, yang berguna untuk menukar tahap tanpa memulakan semula aplikasi.

Anda juga boleh membaca sifat, seperti direktori catatan, dengan ruang letak ${LOG_DIR}.

<configuration scan="true" scanPeriod="30 seconds">
  <property name="LOG_DIR" value="logs" />
  <appender name="FILE" class="ch.qos.logback.core.FileAppender">
    <file>${LOG_DIR}/app.log</file>
    <encoder><pattern>%d %-5level %msg%n</pattern></encoder>
  </appender>
  <root level="info"><appender-ref ref="FILE" /></root>
</configuration>

Semakan Pantas

Uji pengetahuan Anda tentang konfigurasi Logback.

Imbas Kembali

Anda telah mempelajari cara mengkonfigurasi Logback:

  • Konfigurasi berada dalam logback.xml bersama Logger, penyalur dan pengekod.
  • Corak memformatkan baris dengan %d, %level, %msg dan %X{}.
  • RollingFileAppender memutarkan catatan; tetapkan tahap mengikut pakej dan sifat penambahan.
  • Aktifkan scan untuk konfigurasi semula secara langsung.

Anda telah menamatkan kursus pengelogan.

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class Main {
    private static final Logger log = LoggerFactory.getLogger(Main.class);
    public static void main(String[] args) {
        log.info("Logback configuration course complete");
    }
}
Percuma untuk bermula

Pelajari Java dengan tutor kecerdasan buatan — percuma

Tulis dan jalankan kod sebenar dalam pelayar anda, dapatkan bantuan segera daripada tutor kecerdasan buatan yang tersedia 24/7, dan sambung semula dari tempat anda berhenti di web atau dalam aplikasi.

Kursus
104
Pelajaran
374

Soalan Lazim

Adakah pelajaran “Mengkonfigurasi Logback” percuma?

Ya — teks penuh “Mengkonfigurasi Logback” boleh dibaca secara percuma di web ini. Untuk berlatih secara interaktif menggunakan penyunting kod terbina dalam dan tutor kecerdasan buatan 24/7, serta membuka kunci baki kursus Java Academy, tingkat taraf kepada CoddyKit PRO. Kursus Java Academy merangkumi sejumlah 4 pelajaran.

Apakah yang akan saya pelajari dalam “Mengkonfigurasi Logback”?

Penambah, corak dan tahap Anda berlatih Java Academy menggunakan kod praktikal yang dijalankan terus dalam pelayar, manakala tutor kecerdasan buatan 24/7 menjawab soalan anda semasa anda mengikuti pelajaran.

Adakah saya memerlukan pengalaman untuk memulakan Java Academy?

Tiada pengalaman terdahulu diperlukan. Pembelajaran Java Academy di CoddyKit disusun untuk pelajar daripada peringkat pemula hingga lanjutan, jadi anda boleh bermula di sini atau dari awal dan belajar mengikut kadar anda sendiri. Ini ialah pelajaran 4 daripada 4.

Berapa lamakah pelajaran “Mengkonfigurasi Logback” diambil?

Kebanyakan pelajaran CoddyKit mengambil masa kira-kira 5–10 minit. Setiap pelajaran ringkas dan interaktif, jadi anda boleh membuat kemajuan secara berterusan dan menyambung tepat dari tempat anda berhenti di web atau aplikasi.

Bolehkah saya menulis dan menjalankan kod dalam pelajaran Java Academy ini?

Ya. Setiap pelajaran Java Academy menyertakan penyunting kod terbina dalam, jadi anda boleh menulis dan menjalankan kod sebenar terus dalam pelayar serta menerima maklum balas kecerdasan buatan serta-merta — tanpa memerlukan persediaan setempat.

Semua pelajaran dalam kursus ini

  1. Mengapa Pengelogan Berstruktur
  2. Fasad SLF4J dan Pengelog
  3. Pengelogan Berparameter
  4. Mengkonfigurasi Logback
← Kembali ke Java Academy