「初学者商城」- 添加日志（新功能）

Love The Way You Lie 2023-06-28 15:27 40阅读 0赞

# 1. 前言 #

--------------------

在众多日志框架中选择了`Log4j 2`。

主要就是用来记录日志，而且是有规则的，可配置的。

# 2. 源码 #

--------------------

完整项目地址：[接口][Link 1]，[后台][Link 2]，[部署][Link 3]

v1.1 标签地址：[接口][Link 4]，[后台][Link 5]，[部署][Link 6]

v1.1 下载地址：接口 [zip][]，[tar.gz][]。后台 [zip][zip 1]，[tar.gz][tar.gz 1]。部署 [zip][zip 2]，[tar.gz][tar.gz 2]。

**注：对于标签的说明[「初学者商城」- 写在最前面 \#5.1][- _ _5.1]**

# 3. 接口 #

--------------------

**注：查看更改内容：[添加日志][Link 7]**

## 3.1 .gitignore ##

### Others ###
    .DS_Store
    logs/

*  提交代码时排除生成的日志目录

## 3.2 osc-commons/pom.xml ##

<dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-log4j2</artifactId>
            </dependency>

*  公用工程中加入了`Log4j 2`依赖

## 3.3 …base-core/…/log4j2.xml ##

<?xml version="1.0" encoding="UTF-8"?>
    
    
    
    <configuration status="INFO" monitorInterval="30">
    
        
        <properties>
            
            <property name="LOG_HOME">logs</property>
            
            <property name="SERVER_NAME">base-service</property>
        </properties>
    
        
        <appenders>
            
            <Console name="console" target="SYSTEM_OUT">
                
                <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss,SSS} %highlight{%-5p []} - %highlight{%logger{36}} - %m%n" />
            </Console>
    
            
            <RollingFile name="rollingFileError"
                         fileName="${LOG_HOME}/${SERVER_NAME}/${SERVER_NAME}-error.log"
                         filePattern="${LOG_HOME}/${SERVER_NAME}-bak/${SERVER_NAME}-error.%d{yyyy-MM-dd}.%i.log">
                
                <PatternLayout pattern="%date{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %level [%C{36}.%M] - %msg%n" />
                <Policies>
                    
                    <SizeBasedTriggeringPolicy size="10MB" />
                </Policies>
                <Filters>
                    
                    <ThresholdFilter level="ERROR" onMatch="ACCEPT" onMismatch="DENY" />
                </Filters>
                <DefaultRolloverStrategy>
                    
                    <Delete basePath="${LOG_HOME}" maxDepth="2">
                        <IfFileName glob="*/*.log" />
                        <IfLastModified age="180d" />
                    </Delete>
                </DefaultRolloverStrategy>
            </RollingFile>
    
            
            <RollingFile name="rollingFileInfoAndWarn"
                         fileName="${LOG_HOME}/${SERVER_NAME}/${SERVER_NAME}-info.log"
                         filePattern="${LOG_HOME}/${SERVER_NAME}-bak/${SERVER_NAME}-info.%d{yyyy-MM-dd}.%i.log">
                
                <PatternLayout pattern="%date{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %level [%C{36}.%M:%L] - %msg%xEx%n" />
                <Policies>
                    
                    <SizeBasedTriggeringPolicy size="10MB" />
                </Policies>
                <Filters>
                    
                    <ThresholdFilter level="WARN" onMatch="DENY" onMismatch="NEUTRAL" />
                    <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY" />
                </Filters>
            </RollingFile>
    
            
            <RollingRandomAccessFile name="allLog"
                                     fileName="${LOG_HOME}/${SERVER_NAME}/${SERVER_NAME}.log"
                                     filePattern="${LOG_HOME}/${SERVER_NAME}-bak/${SERVER_NAME}.%d{yyyyMMddHHmmss}.log">
                
                <PatternLayout pattern="%d{yyyy.MM.dd HH:mm:ss.SSS} [%thread] %level [%C{36}.%M:%L] - %msg%xEx%n" />
                <Policies>
                    
                    <SizeBasedTriggeringPolicy size="10MB" />
                </Policies>
            </RollingRandomAccessFile>
        </appenders>
    
        
        <loggers>
            
            <logger name="io.lettuce" level="INFO" />
            <logger name="io.netty" level="INFO" />
            <logger name="org.springframework" level="INFO"></logger>
            <logger name="org.mybatis" level="INFO"></logger>
            <logger name="org.mongodb" level="INFO" />
            <logger name="org.flywaydb" level="INFO" />
            <logger name="io.swagger" level="INFO" />
            <logger name="org.springframework.kafka" level="INFO" />
            <logger name="org.apache.kafka" level="ERROR" />
            <logger name="org.apache.ibatis" level="INFO" />
            <logger name="com.netflix" level="INFO" />
            <logger name="springfox" level="ERROR" />
            <logger name="org.springframework.web" level="INFO" />
            <logger name="org.springframework.web.servlet.handler" level="INFO" />
            <logger name="org.apache.http" level="INFO" />
    
            
            <root level="DEBUG">
                <AppenderRef ref="console" />
                <AppenderRef ref="rollingFileError" />
                <AppenderRef ref="rollingFileInfoAndWarn" />
                <AppenderRef ref="allLog" />
            </root>
        </loggers>
    
    </configuration>

*  文件名通常为`log4j2.xml`，放在`resources`根目录中；文件名也可以是`.json`和`.jsn`结尾
 *  首先配置了日志输出路径
 *  其次定义输出内容，输出格式，输出方式，日志保存策略等
 *  最后指定了具体的类和包的日志级别

## 3.4 …log-core/…/log4j2.xml ##

...省略部分...
        
        <properties>
            
            <property name="LOG_HOME">logs</property>
            
            <property name="SERVER_NAME">log-service</property>
        </properties>
    ...省略部分...

*  仅仅只是日志输出路径中的父目录名称不一样

## 3.5 其它 ##

1.  依赖上的排除
2.  版本号的升级

# 4. 后台 #

--------------------

**注：标签同步**

# 5. 部署 #

--------------------

**注：查看更改内容：[添加日志][Link 8]**

## 5.1 docker-compose.yaml ##

volumes:
                - ./log/:/logs/

*  对应`接口`中的配置，把日志目录映射出来

## 5.2 其它 ##

expose:
                - "8000"

*  网关工程只暴露容器内端口，不映射到宿主机

# 6. 验证 #

--------------------

## 6.1 接口 ##

1.  下载`v1.1`标签的代码或者对照本篇博客更改`v1.0`标签的代码
2.  项目启动后，在项目根目录中就会出现`logs - base-service/log-service`等目录

## 6.2 后台 ##

**注：标签同步**

## 6.3 部署 ##

1.  下载`v1.1`标签的代码或者在`v1.0`标签的代码中添加和更改配置
2.  项目部署后，在日志目录中就会出现`base-service`以及`log-service`目录

# 7. 结语 #

--------------------

加入日志框架非常简单，而且低耦合，很`happy`。阿，快乐。

希望能够帮助到你

over

[Link 1]: https://github.com/intomylife/osc-api
[Link 2]: https://github.com/intomylife/osc-front
[Link 3]: https://github.com/intomylife/osc-build
[Link 4]: https://github.com/intomylife/osc-api/releases/tag/v1.1
[Link 5]: https://github.com/intomylife/osc-front/releases/tag/v1.1
[Link 6]: https://github.com/intomylife/osc-build/releases/tag/v1.1
[zip]: https://github.com/intomylife/osc-api/archive/v1.1.zip
[tar.gz]: https://github.com/intomylife/osc-api/archive/v1.1.tar.gz
[zip 1]: https://github.com/intomylife/osc-front/archive/v1.1.zip
[tar.gz 1]: https://github.com/intomylife/osc-front/archive/v1.1.tar.gz
[zip 2]: https://github.com/intomylife/osc-build/archive/v1.1.zip
[tar.gz 2]: https://github.com/intomylife/osc-build/archive/v1.1.tar.gz
[- _ _5.1]: https://intomylife.blog.csdn.net/article/details/103745935
[Link 7]: https://github.com/intomylife/osc-api/commit/2c003e9750ab651040f04096382b862fa6497f4b
[Link 8]: https://github.com/intomylife/osc-build/commit/c810a7d6d7b3c562cb419d650bbf89ce69a5e4c4