Конфигурация Logback на основе Springboot

SpringBoot будет использовать logback в качестве среды ведения журнала по умолчанию.При создании проекта Springboot вы можете напрямую проверить logback, затем вы можете напрямую использовать logback, что сохраняет шаг импорта зависимостей и может использовать logback напрямую.

Получение экземпляров журнала в проекте

Есть два способа получить экземпляр журнала в коде

Метод аннотации
Полагаясь на пакет lombok, используя аннотацию @Slf4j и напрямую используя экземпляр журнала.

Метод LoggerFactory
LoggerFactory.getLogger(Class> clazz); получить экземпляр

Затем мы можем вызвать метод там, где он нам нужен.

Настроить logback-spring.xml

На этот раз звонок. Нам нужно настроить xml файл нашего лога
Расположение файла xml находится в файле ресурсов на том же уровне, что и файл приложения Springboot.
Поскольку Springboot рекомендует формат файла logback-spring.xml, он может разрешать некоторые имена переменных в файле приложения в нескольких средах. Но файл журнала не может быть прочитан, поэтому мы устанавливаем имя файла logback-spring.xml

Ниже приведен файл logback-spring.xml, который я использую сам.

<?xml version="1.0" encoding="UTF-8" ?>

<!-- 级别从高到低 OFF 、 FATAL 、 ERROR 、 WARN 、 INFO 、 DEBUG 、 TRACE 、 ALL -->
<!-- 日志输出规则 根据当前ROOT 级别，日志输出时，级别高于root默认的级别时 会输出 -->
<!-- 以下 每个配置的 filter 是过滤掉输出文件里面，会出现高级别文件，依然出现低级别的日志信息，通过filter 过滤只记录本级别的日志 -->
<!-- scan 当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。 -->
<!-- scanPeriod 设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。 -->
<!-- debug 当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。 -->
<configuration scan="true" scanPeriod="60 seconds" debug="false">

    <!-- 动态日志级别 -->
    <jmxConfigurator/>

    <!-- 定义日志文件 输出位置 -->
    <property name="log.log_dir" value="logs"/>
    <property name="log.log_name" value="log"/>
    <!-- 日志最大的历史 30天 -->
    <property name="log.maxHistory" value="30"/>
    <property name="log.level" value="debug"/>
    <property name="log.maxSize" value="5MB" />

    <!-- ConsoleAppender 控制台输出日志 -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>
                <!-- 设置日志输出格式 -->
                <!-- 日期 [线程] [class类]-[日志级别] log内容 -->
                %blue(%d{yyyy-MM-dd HH:mm:ss,SSS}) [%cyan(%t)] [%yellow(%c)]-[%highlight(%p)] %m%n
            </pattern>
        </encoder>
    </appender>

    <!-- ERROR级别日志 -->
    <!-- 滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件 RollingFileAppender -->
    <appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 过滤器，只记录WARN级别的日志 -->
        <!-- 果日志级别等于配置级别，过滤器会根据onMath 和 onMismatch接收或拒绝日志。 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!-- 设置过滤级别 -->
            <level>ERROR</level>
            <!-- 用于配置符合过滤条件的操作 -->
            <onMatch>ACCEPT</onMatch>
            <!-- 用于配置不符合过滤条件的操作 -->
            <onMismatch>DENY</onMismatch>
        </filter>
        <!-- 最常用的滚动策略，它根据时间来制定滚动策略.既负责滚动也负责触发滚动 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <!--日志输出位置 可相对、和绝对路径 -->
            <fileNamePattern>
                ${log.log_dir}/error/%d{yyyy-MM-dd}/error_${log.log_name}-%i.log
            </fileNamePattern>
            <!-- 可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件,假设设置每个月滚动，且<maxHistory>是6，
            则只保存最近6个月的文件，删除之前的旧文件。注意，删除旧文件是，那些为了归档而创建的目录也会被删除 -->
            <maxHistory>${log.maxHistory}</maxHistory>
            <!--日志文件最大的大小-->
            <MaxFileSize>${log.maxSize}</MaxFileSize>
        </rollingPolicy>
        <encoder>
            <pattern>
                <!-- 设置日志输出格式 -->
                %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
            </pattern>
        </encoder>
    </appender>

    <!-- INFO级别日志 appender -->
    <appender name="INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>INFO</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>${log.log_dir}/info/%d{yyyy-MM-dd}/info_${log.log_name}-%i.log</fileNamePattern>
            <maxHistory>${log.maxHistory}</maxHistory>
            <MaxFileSize>${log.maxSize}</MaxFileSize>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] %logger - %msg%n</pattern>
        </encoder>
    </appender>


    <!-- DEBUG级别日志 appender -->
    <appender name="DEBUG" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>DEBUG</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>${log.log_dir}/debug/%d{yyyy-MM-dd}/debug_${log.log_name}-%i.log</fileNamePattern>
            <maxHistory>${log.maxHistory}</maxHistory>
            <MaxFileSize>${log.maxSize}</MaxFileSize>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] %logger - %msg%n</pattern>
        </encoder>
    </appender>

    <!--设置一个向上传递的appender,所有级别的日志都会输出-->
    <appender name="app" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>${log.log_dir}/app/%d{yyyy-MM-dd}/app_${log.log_name}-%i.log</fileNamePattern>
            <maxHistory>${log.maxHistory}</maxHistory>
            <MaxFileSize>${log.maxSize}</MaxFileSize>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level] %logger - %msg%n</pattern>
        </encoder>
    </appender>

    <!--name包下的类的日志输出-->
    <logger name="com.example.webtest.controller" additivity="true" level="DEBUG" >
        <appender-ref ref="ERROR" />
        <appender-ref ref="INFO" />
    </logger>

    <!-- root级别   DEBUG -->
    <root>
        <!-- 控制台输出 -->
        <appender-ref ref="CONSOLE"/>
        <!-- 不管什么包下的日志都输出文件 -->
        <!--<appender-ref ref="ERROR"/>-->
    </root>
</configuration>

Кратко о роли тегов конфигурации

свойство устанавливает глобальные свойства, на которые можно ссылаться в другом месте, используя ${key}
Приложение настраивает способ вывода журнала, путь сохранения времени и кодировку файла и т. д.

имя: это его собственная личность
класс: этот в основном выводит журналы на консоль с двумя ConsoleAppenders, а RollingFileAppender выводит записи журналов в файлы
фильтр: Сохранить в файл в соответствии с уровнем уровня журнала. Если он не соответствует требованиям к уровню, он не будет сохранен в файл. Например, error.log сохраняет только информацию журнала об ошибке.
RollingPolicy: политика, напечатанная в журнале, обычно называется SizeAndTimeBasedRollingPolicy. Когда время или размер файла журнала достигнуты, будет создан новый файл журнала.
fileNamePattern: путь сохранения файла журнала
регистратор используется для установки уровня печати журнала пакета или определенного класса

имя: используется для установки пути к пакету класса для печати
additivity: передавать ли информацию журнала корневому пользователю. Значение по умолчанию — true. Если изменить значение на false, информация журнала не будет передаваться корневому пользователю.
уровень: уровень журнала TRACE, DEBUG, INFO, WARN, ERROR, ALL и OFF
Здесь следует отметить: если установлен слишком высокий уровень, аддитивность меняется на false, если рут печатать лог на консоли, если уровень error, то информация об ошибке будет сохраняться в лог через logger первым при печати информации об ошибке, но аддитивность имеет значение false, чтобы не сообщать информацию журнала. Таким образом, пользователь root, не печатающий журнал ошибок в консоли, может создать иллюзию отсутствия ошибок. Поэтому постарайтесь не настраивать его так.
root также является элементом, но это корневой регистратор. Есть только один атрибут уровня, который должен был называться "root". И он печатает глобальный журнал

напиши в конце

Эта статья предназначена только для записи и обмена результатами вашей собственной конфигурации журнала обучения, чтобы другие небольшие партнеры могли при необходимости достичь ожидаемых результатов в соответствии со своими собственными изменениями.Если есть какие-либо ошибки, укажите. Спасибо!

Наконец, если у вас есть небольшой партнер, который хочет узнать больше о настройке логбэка, вы можете посмотреть на Kapok.Самая полная практика логбэка