SpringBoot整合Slf4j+logback日志框架并自定义日志颜色

先上效果图

第一步：pom.xml 增加依赖

    <properties>
        <java.version>1.8</java.version>
         <!-- 添加slf4j的jar包时如果报错，先确定版本，
            版本要和项目maven的slf4j-log4j12 版本保持一致，不然pom.xml会报错-->
        <slf4j.version>1.7.26</slf4j.version>
    </properties>

    <dependencies>
       
       
        <!-- 添加slf4j的jar包时如果报错，先确定版本，版本要和项目maven的slf4j-log4j12 版本保持一致-->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>${slf4j.version}</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>jcl-over-slf4j</artifactId>
            <version>${slf4j.version}</version>
        </dependency>
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-core</artifactId>
            <version>1.2.3</version>
        </dependency>
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.2.3</version>
        </dependency>

       <!--@Data 注解要先引入lombok 不用get\set 简化代码-->
        <!--
        @Log4j/@Slf4j   ： 注在类上，提供对应的 Logger 对象，变量名为 log
        @Data ： 注在类上，提供类的get、set、equals、hashCode、canEqual、toString方法
        @AllArgsConstructor ： 注在类上，提供类的全参构造
        @NoArgsConstructor ： 注在类上，提供类的无参构造
        @Setter ： 注在属性上，提供 set 方法
        @Getter ： 注在属性上，提供 get 方法
        @EqualsAndHashCode ：    注在类上，提供对应的 equals 和 hashCode 方法
        @Data 不支持多种参数构造器的重载，虽然省去了手动创建getter/setter方法的麻烦，
        但大大降低了源代码的可读性和完整性，降低了阅读源代码的舒适度
        -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        
    </dependencies>

第二步： 创建日志颜色类：

mport ch.qos.logback.classic.Level;
import ch.qos.logback.classic.spi.ILoggingEvent;
import ch.qos.logback.core.pattern.color.ANSIConstants;
import ch.qos.logback.core.pattern.color.ForegroundCompositeConverterBase;
public class LogbackColorful extends ForegroundCompositeConverterBase<ILoggingEvent> {

    @Override
    protected String getForegroundColorCode(ILoggingEvent event) {
        Level level = event.getLevel();
        switch (level.toInt()) {
            //ERROR等级为红色
            case Level.ERROR_INT:
                return ANSIConstants.RED_FG;
            //WARN等级为黄色
            case Level.WARN_INT:
                return ANSIConstants.YELLOW_FG;
            //INFO等级为蓝色
            case Level.INFO_INT:
                return ANSIConstants.BLUE_FG;
            //DEBUG等级为绿色
            case Level.DEBUG_INT:
                return ANSIConstants.GREEN_FG;
            //其他为默认颜色
            default:
                return ANSIConstants.DEFAULT_FG;
        }
    }
}

第三步：在resources文件下创建logback.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--
scan：当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
scanPeriod：设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒当scan为true时，此属性生效。默认的时间间隔为1分钟。
debug：当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。
-->
<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <!--自定义颜色配置 此处converterClass引用的是日志颜色类的路径， 此匹配的是第二种控制台色彩输出方式-->
    <conversionRule conversionWord="customcolor" converterClass="com.fristapp.util.LogbackColorful"/>
    <!-- 定义日志的要保存的根目录 -->
    <property name="LOG_HOME" value="C:/logfile" />
    <!-- 定义日志文件名称 -->
    <property name="appName" value="fristapp_log"></property>
    <!-- ch.qos.logback.core.ConsoleAppender 表示控制台输出 -->
    <!-- 第一种控制台色彩输出方式：这种控制台输出不用方式不用去引用日志颜色类
         <appender name="CONSLOG" class="ch.qos.logback.core.ConsoleAppender">
            <encoder>
               <pattern>%red(%d{yyyy-MM-dd HH:mm:ss}) %green([%thread]) %highlight(%-5level) %boldMagenta(%logger) - %msg%n</pattern>
              <!--如果线上log日志出现中文乱码,下面这句有关编码设置的要删除或注释掉,原因不明-->
                 <charset>UTF-8</charset>
            </encoder>
        </appender>
    -->

    <!--第二种控制台色彩输出方式-->
    <appender name="CONSLOG" class="ch.qos.logback.core.ConsoleAppender">
        <!--
        日志输出格式：
            %d表示日期时间，
            %thread表示线程名，
            %-5level：级别从左显示5个字符宽度
            %logger{50} 表示logger名字最长50个字符，否则按照句点分割。
            %msg：日志消息，
            %n是换行符
        -->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern> %red(%d{yyyy-MM-dd HH:mm:ss.SSS}) %green([%thread]) %customcolor(%-5level) %boldMagenta(%logger) - %msg%n</pattern>
        </encoder>
         <!-- 如果线上log日志出现中文乱码,下面这句有关编码设置的要删除或注释掉,原因不明-->
         <charset>UTF-8</charset>
    </appender>
    <!-- 滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件   -->
    <!--该配置表示每天生成一个日志文件，保存30天的日志文件。-->
    <appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 指定日志文件的名称 -->
        <file>${LOG_HOME}/${appName}.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.zip</fileNamePattern>
            <MaxHistory>30</MaxHistory>
            <maxFileSize>50MB</maxFileSize>
            <totalSizeCap>2GB</totalSizeCap>
        </rollingPolicy>
        <!-- 日志输出格式： -->
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern>
        </layout>
    </appender>
    <!-- 开发、测试环境 -->
    <springProfile name="dev,test">
        <logger name="org.springframework.web" level="INFO"/>
        <logger name="org.springboot.sample" level="INFO" />
        <!-- com.fristapp是本项目的dao层的包，日志级别调成 DEBUG级别可以看到sql执行-->
        <logger name="com.fristapp" level="DEBUG" />
    </springProfile>

    <!-- 生产环境 -->
    <springProfile name="prod">
        <!--logger用来设置某一个包或者具体的某一个类的日志打印级别-->
        <!--name用来指定受此loger约束的某一个包或者具体的某一个类-->
        <logger name="org.springframework.web" level="ERROR"/>
        <logger name="org.springboot.sample" level="ERROR" />
        <!--com.fristapp 为项目类的全路径  日志级别调成 DEBUG级别可以看到sql执行-->
        <logger name="com.fristapp" level="ERROR" />
    </springProfile>


    <!-- level用来设置打印级别，大小写无关-->
    <root level="info">
        <!-- 控制台输出日志-->
        <appender-ref ref="CONSLOG" />
        <!-- 打印错误日志 每天-->
        <appender-ref ref="appLogAppender" />
    </root>
</configuration>

以上关于logback日志部分就就配置完了，

但是在配置的时候遇到Could NOT find resource [logback-test.xml]这个报错，我这里也记录下我的解决办法

就是把文件名改为logback-spring

扫描二维码关注公众号，回复： 9857323 查看本文章

下面我们说下如何使用@Slf4j 在控制台输出我们想要输出的语句

在pom中添加上面的所有依赖，很多教程里都只说添加lombok依赖就行了，其实不然。总共还需要slf4j以及它的实现，这里我选择了logback，其他的实现也是可以的。除此之外，还需要安装一个lombok插件

点击File-Settings-Plugins,在右侧搜索lombok

1、点击 Search in repositories

2、选中 Lombok

3、点击Inistall

4、关闭Browse Repositories窗口

5、点击Apply,再点击ok, 会出来一个弹窗，选中Restart 就可以了

效果图

延伸： 有关多环境下logback的配置

在后端开发中,应用程序在不同的环境可能会有不同的配置，例如数据库连接、日志级别等，开发，测试，生产每个环境可能配置都不一致。使用Spring Boot的Profile可以实现多场景下的配置切换，方便开发中进行测试和部署生产环境,用spring.profiles指定了一个值(开发为dev，测试为test，生产为prod)，该值表示该段配置应该用在哪个profile里面。(我这里只设置了开发、生成两个环境)

1、application.yml 

2、application-prod.yml

3、application-dev.yml

在前面的logback配置中能看到不同的环境下，日志的输出级别记录情况也不相同，开发测试环境下，日志的输出级别为DEBUG及以上，而在生产环境下日志的输出级别为error, 当然也可以根据自己项目需要灵活设置。至此，我的springboot项目已经将Slf4j+logback日志框架整合完毕，有不足的地方欢迎指出

                                                                                                                                            --------每天进步一点点