| 1 |
/*! |
| 2 |
@~chinese |
| 3 |
@ingroup dlog |
| 4 |
@file include/log/RollingFileAppender.h |
| 5 |
|
| 6 |
@class Dtk::Core::RollingFileAppender |
| 7 |
@brief RollingFileAppender类扩展了FileAppender,使日志文件在按照用户指定的频率进行滚动 |
| 8 |
@details |
| 9 |
该类是基于`Log4Qt.DailyRollingFileAppender`类[Log4Qt](http://log4qt.sourceforge.net/) |
| 10 |
并具有相同的日期模式格式<br> |
| 11 |
例如,如果fileName设置为`/foo/bar`,DatePattern设置为每日滚动('.yyy-MM-dd'.log'),在2022-05-28的午夜。 |
| 12 |
日志文件`/foo/bar.log`将被复制到`/foo/bar.2022-05-28.log`,2022-05-29的日志将在`/foo/bar`中继续,直到第二天滚动<br> |
| 13 |
logFilesLimit参数用于在滚动期间自动删除目录中最旧的日志文件。 |
| 14 |
(所以在任何时候,目录中都不会有超过logFilesLimit的最新日志文件存在) |
| 15 |
|
| 16 |
@enum Dtk::Core::RollingFileAppender::DatePattern |
| 17 |
@brief 日志频率 |
| 18 |
@var Dtk::Core::RollingFileAppender::DatePattern Dtk::Core::RollingFileAppender::MinutelyRollover |
| 19 |
@brief 每分钟的日期模式字符串是`.yyyy-MM-dd-hh-mm` |
| 20 |
@var Dtk::Core::RollingFileAppender::DatePattern Dtk::Core::RollingFileAppender::HourlyRollover |
| 21 |
@brief 每小时的日期模式字符串是 `.yyyy-MM-dd-hh` |
| 22 |
@var Dtk::Core::RollingFileAppender::DatePattern Dtk::Core::RollingFileAppender::HalfDailyRollover |
| 23 |
@brief 每半天的日期模式字符串是`.yyyy-MM-dd-a` |
| 24 |
@var Dtk::Core::RollingFileAppender::DatePattern Dtk::Core::RollingFileAppender::DailyRollover |
| 25 |
@brief 每天的日期模式字符串是`.yyyy-MM-dd` |
| 26 |
@var Dtk::Core::RollingFileAppender::DatePattern Dtk::Core::RollingFileAppender::WeeklyRollover |
| 27 |
@brief 每周的日期模式字符串是`.'yyyy-ww` |
| 28 |
@var Dtk::Core::RollingFileAppender::DatePattern Dtk::Core::RollingFileAppender::MonthlyRollover |
| 29 |
@brief 每月的日期模式字符串是`.yyyy-MM` |
| 30 |
|
| 31 |
@fn RollingFileAppender Dtk::Core::RollingFileAppender::RollingFileAppender() |
| 32 |
@brief 构造函数,默认限制日志文件个数是0,默认日志文件大小是1024*1024*20=20m |
| 33 |
|
| 34 |
@fn DatePattern Dtk::Core::RollingFileAppender::datePattern() |
| 35 |
@brief 返回当前的滚动更新频率 |
| 36 |
@sa RollingFileAppender::DatePattern |
| 37 |
|
| 38 |
@fn void Dtk::Core::RollingFileAppender::setDatePattern(DatePattern datePattern) |
| 39 |
@brief 设置日志滚动频率 |
| 40 |
@sa RollingFileAppender::DatePattern |
| 41 |
|
| 42 |
@fn void Dtk::Core::RollingFileAppender::setDatePattern(const QString &datePattern) |
| 43 |
@brief 此重载是为了方便使用,可以传入一个滚动频率字符串 |
| 44 |
@sa RollingFileAppender::DatePattern |
| 45 |
@sa RollingFileAppender::setDatePattern(DatePattern datePattern) |
| 46 |
|
| 47 |
@fn QString Dtk::Core::RollingFileAppender::datePatternString() |
| 48 |
@brief 以字符串形式,返回当前滚动频率 |
| 49 |
|
| 50 |
@fn void Dtk::Core::RollingFileAppender::setLogFilesLimit(int limit) |
| 51 |
@brief 设置日志文件数量上限,最旧的文件会被滚动覆盖 |
| 52 |
|
| 53 |
@fn int Dtk::Core::RollingFileAppender::logFilesLimit() |
| 54 |
@brief 返回设置的日志文件数量上限 |
| 55 |
@sa RollingFileAppender::setLogFilesLimit() |
| 56 |
|
| 57 |
@fn int Dtk::Core::RollingFileAppender::setLogSizeLimit(int qint64) |
| 58 |
@brief 设置日志文件单个文件大小上限 |
| 59 |
|
| 60 |
@fn qint64 Dtk::Core::RollingFileAppender::logSizeLimit() |
| 61 |
@brief 返回设置的日志文件单个文件大小上限 |
| 62 |
@sa RollingFileAppender::setLogSizeLimit(int qint64) |
| 63 |
|
| 64 |
*/ |