YMP在线手册

更新时间2022-04-11

日志概述使用示例

日志模块初始化参数, 将下列配置项按需添加到ymp-conf.properties文件中, 否则模块将使用默认配置进行初始化:

  #-------------------------------------
  # 日志模块初始化参数
  #-------------------------------------

  # 日志记录器配置文件，默认为${root}/cfgs/log4j.xml，变量${user.dir}的取值结果将受配置体系模块影响
  ymp.configs.log.config_file=

  # 日志文件输出路径，默认为${root}/logs/
  ymp.configs.log.output_dir=

  # 日志记录器默认名称，默认为default
  ymp.configs.log.logger_name=

  # 日志记录器接口实现类，默认为net.ymate.platform.log.impl.DefaultLogger
  ymp.configs.log.logger_class=

  # 默认日志记录器是否允许控制台输出，默认为false
  ymp.configs.log.allow_output_console=

注：需要注意config_file配置的log4j.xml文件是否存在，以及output_dir指定的输出路径是否正确有效，这两项配置会影响YMP框架启动时异常；

此外，建议在开发阶段将allow_output_console参数设置为true，这样可以通过控制台直接查看日志输出；

Log4J配置文件，内容如下：

    <?xml version="1.0" encoding="UTF-8"?>
    <Configuration>
        <Appenders>
            <RollingFile name="default" fileName="${sys:LOG_OUT_DIR}/default.log"
                         filePattern="${sys:LOG_OUT_DIR}/$${date:yyyy-MM}/default-%d{MM-dd-yyyy}-%i.log.gz">
                <PatternLayout pattern="%m %n" charset="UTF-8"/>
                <SizeBasedTriggeringPolicy size="500 MB"/>
            </RollingFile>
            <!--
            <RollingFile name="custom-logname" fileName="${sys:LOG_OUT_DIR}/custom-logname.log"
                         filePattern="${sys:LOG_OUT_DIR}/$${date:yyyy-MM}/custom-logname-%d{MM-dd-yyyy}-%i.log.gz">
                <PatternLayout pattern="%m %n" charset="UTF-8"/>
                <SizeBasedTriggeringPolicy size="500 MB"/>
            </RollingFile>
            -->
        </Appenders>
        <Loggers>
            <!--
            <Logger name="custom-logname" level="debug">
                <AppenderRef ref="custom-logname"/>
            </Logger>
            -->
            <!-- 配置记录器级别 -->
            <Root level="debug">
                <!-- 输出设置 -->
                <AppenderRef ref="default"/>
            </Root>
        </Loggers>
    </Configuration>

**注**：该文件应根据ymp.configs.log.config_file指定的位置，其内容请根据实际情况调整。

日志概述使用示例