log4多环境配置讲解

最新推荐文章于 2022-01-02 12:57:38 发布

原创最新推荐文章于 2022-01-02 12:57:38 发布 · 480 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#非spring boot #log4多环境配置

Java 专栏收录该内容

7 篇文章

订阅专栏

本文介绍如何在不同环境中配置Log4日志系统，通过Maven profiles和logback.xml结合使用，实现开发、测试和生产环境的日志差异化输出。

log4多环境的搭建需要将pom.xml文件中project->profiles部分和logback.xml文件中configuration->property的resource属性结合使用：

1.project->profiles负责定义打包时.properties文件的选择，.properties中负责声明logback.xml的相关配置变量。

2.configuration->property的resource负责指定logback.xml文件引用外部变量的来源文件路径。

pom.xml文件实例如下所示：

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

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.sangfor</groupId>
  <artifactId>elasticsearch-ssol</artifactId>
  <!-- 指定项目类型为jar -->
  <packaging>jar</packaging>
  <version>1.0</version>

  <name>elasticsearch-ssol</name>
  <!-- FIXME change it to the project's website -->
  <url>http://www.example.com</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    <!-- 编译时的编码 -->
    <maven.compiler.encoding>UTF-8</maven.compiler.encoding>
    <java.version>1.8</java.version>
    <maven.compiler.source>1.7</maven.compiler.source>
    <maven.compiler.target>1.7</maven.compiler.target>
  </properties>

  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.11</version>
      <scope>test</scope>
    </dependency>

    <!-- https://mvnrepository.com/artifact/ch.qos.logback/logback-core -->
    <dependency>
      <groupId>ch.qos.logback</groupId>
      <artifactId>logback-core</artifactId>
      <version>1.2.3</version>
    </dependency>

    <!-- https://mvnrepository.com/artifact/ch.qos.logback/logback-classic -->
    <dependency>
      <groupId>ch.qos.logback</groupId>
      <artifactId>logback-classic</artifactId>
      <version>1.2.3</version>
    </dependency>

    <!-- https://mvnrepository.com/artifact/org.slf4j/slf4j-api -->
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-api</artifactId>
      <version>1.7.25</version>
    </dependency>

    <!-- https://mvnrepository.com/artifact/com.google.code.gson/gson -->
    <dependency>
      <groupId>com.google.code.gson</groupId>
      <artifactId>gson</artifactId>
      <version>2.8.2</version>
    </dependency>

    <!-- https://mvnrepository.com/artifact/ch.qos.logback/logback-access -->
    <dependency>
      <groupId>ch.qos.logback</groupId>
      <artifactId>logback-access</artifactId>
      <version>1.2.3</version>
    </dependency>

    <!-- https://mvnrepository.com/artifact/org.elasticsearch.client/transport -->
    <dependency>
      <groupId>org.elasticsearch.client</groupId>
      <artifactId>transport</artifactId>
      <version>6.3.2</version>
    </dependency>

    <!-- https://mvnrepository.com/artifact/org.elasticsearch/elasticsearch -->
    <dependency>
      <groupId>org.elasticsearch</groupId>
      <artifactId>elasticsearch</artifactId>
      <version>6.3.2</version>
    </dependency>

  </dependencies>

  <profiles>
    <profile>
      <id>develop</id>
      <activation>
        <activeByDefault>true</activeByDefault>
      </activation>
      <properties>
        <env>develop</env>
        <!--<redis_host>127.0.0.1</redis_host>-->
      </properties>
    </profile>

    <profile>
      <id>test</id>
      <properties>
        <env>test</env>
      </properties>
    </profile>

    <profile>
      <id>online</id>
      <properties>
        <env>online</env>
      </properties>
    </profile>
  </profiles>

  <build>
    <finalName>${project.artifactId}</finalName>
    <filters>
      <filter>src/main/resources/properties/env/${env}.properties</filter>
    </filters>
    <resources>
      <resource>
        <directory>src/main/resources</directory>
        <filtering>true</filtering>
      </resource>
    </resources>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-clean-plugin</artifactId>
        <version>3.0.0</version>
      </plugin>
      <!-- see http://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_jar_packaging -->
      <plugin>
        <groupId>org.apache.maven.plu

logback.xml实例如下所示：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration>
<!-- 根节点<configuration>包含的属性:
	 scan:当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
	 scanPeriod:设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。
	 debug:当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。
	 <configuration>下面一共有2个属性(<contextName>,<property>)，3个子节点(<appender>,<root>,<loger>)
-->
<configuration>
    <property resource="properties/config.properties" />
    <!-- logger上下文，默认上下文名称为“default”,可以使用设置成其他名字，用于区分不同应用程序的记录 -->
    <contextName>SSOL</contextName>
    <!-- 控制台输出
        %d{HH: mm:ss.SSS}——日志输出时间
        %contextName——上下文
        %thread——输出日志的进程名字，这在Web应用以及异步任务处理中很有用
        %-5level——日志级别，并且使用5个字符靠左对齐
        %logger{36}——日志输出者的名字
        %msg——日志消息
        %n——平台的换行符 -->
    <property name="PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n"/>
    <!-- 研发环境文件输出,文件路径为F:\\JavaProject\\log -->
    <property name="DEVELOP_FILE_PATH" value="F:\\JavaProject\\log"/>
    <!-- 生产环境文件输出,文件路径为/data/SSOL/logs -->
    <property name="ONLINE_FILE_PATH" value="/data/SSOL/logs"/>

    <!-- 开发环境控制台 -->
    <!-- appender用来格式化日志输出节点，有俩个属性name和class，class用来指定哪种输出策略，常用就是控制台输出策略ch.qos.logback.core.ConsoleAppender和文件输出策略ch.qos.logback.core.rolling.RollingFileAppender -->
    <!-- ch.qos.logback.core.ConsoleAppender 控制台输出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <!-- ThresholdFilter为系统定义的拦截器，例如我们用ThresholdFilter来过滤掉ERROR级别以下的日志不输出到文件中。如果不用记得注释掉，不然你控制台会发现没日志 -->
        <!-- <filter class="ch.qos.logback.classic.filter.ThresholdFilter"> -->
        <!-- <level>ERROR</level> -->
        <!-- </filter> -->
        <!-- <encoder>表示对日志进行编码 -->
        <encoder>
            <pattern>${PATTERN}</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!-- 开发环境文件 -->
    <appender name="DEVELOP_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <File>${DEVELOP_FILE_PATH}</File>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <FileNamePattern>${DEVELOP_FILE_PATH}/%d{yyyy-MM-dd}-%i.log</FileNamePattern>
            <MaxHistory>90</MaxHistory>
            <TimeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <MaxFileSize>50MB</MaxFileSize>
            </TimeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>${PATTERN}</pattern>
        </layout>
    </appender>

    <!-- 生产环境 -->
    <appender name="ONLINE_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <File>${ONLINE_FILE_PATH}</File>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <FileNamePattern>${ONLINE_FILE_PATH}/%d{yyyy-MM-dd}-%i.log</FileNamePattern>
            <MaxHistory>90</MaxHistory>
            <TimeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <MaxFileSize>50MB</MaxFileSize>
            </TimeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>${PATTERN}</pattern>
        </layout>
    </appender>

    <root level="${logback.level}">
        <appender-ref ref="${logback.path}"/>
    </root>
</configuration>

config.properties实例如下所示：

logback.path=${logback_path}
logback.level=${logback_level}

test.properties、online.properties、develop.properties实例分别如下所示：

logback_path=DEVELOP_FILE
logback_level=DEBUG

logback_path=PROD_FILE
logback_level=INFOR

logback_path=STDOUT
#logback_path=DEVELOP_FILE
logback_level=DEBUG

resources目录级别如下：