点击或拖拽改变大小

LogNetSingle 类

单日志文件对象,所有的日志信息的记录都会写入一个文件里面去。文件名指定为空的时候,自动不存储文件。
Single log file object, all log information records will be written to a file. When the file name is specified as empty, the file is not stored automatically.
继承层次
SystemObject
  HslCommunication.LogNetLogNetBase
    HslCommunication.LogNetLogNetSingle

命名空间:  HslCommunication.LogNet
程序集:  HslCommunication (在 HslCommunication.dll 中) 版本:12.0.2.0 (12.0.2.0)
语法
public class LogNetSingle : LogNetBase, 
	ILogNet, IDisposable

LogNetSingle 类型公开以下成员。

构造函数
  名称说明
公共方法LogNetSingle
实例化一个单文件日志的对象,如果日志的路径为空,那么就不存储数据,只触发BeforeSaveToFile事件
Instantiate a single file log object. If the log path is empty, then no data is stored and only the BeforeSaveToFile event is triggered.
Top
属性
  名称说明
公共属性ConsoleOutput
获取或设置当前的日志信息在存储的时候是否在控制台进行输出,默认不输出。
Gets or sets whether the current log information is output on the console when it is stored. It is not output by default.
(继承自 LogNetBase。)
公共属性HourDeviation
获取或设置当前日志时间的小时偏差信息,用来解决某些情况下时区设置异常导致记录时间一直不正确的问题,默认为 0,也就是不处理。可以为正数,也可以为负数。
Obtain or set the hourly deviation information of the current log time to solve the problem that the recording time has been incorrect due to abnormal time zone setting in some cases, and the default is 0, that is, it is not processed. Can be positive or negative.
(继承自 LogNetBase。)
公共属性LogNetStatistics
获取或设置当前的日志记录统计信息,如果你需要统计最近30天的日志,就需要对其实例化,详细参照LogStatistics
Get or set the current log record statistics. If you need to count the logs of the last 30 days, you need to instantiate it. For details, please refer to LogStatistics
(继承自 LogNetBase。)
公共属性LogSaveMode
日志存储模式,1:单文件,2:按大小存储,3:按时间存储
Log storage mode, 1: single file, 2: storage by size, 3: storage by time
(继承自 LogNetBase。)
公共属性LogStxAsciiCode
获取或设置在记录文件日志的时候,是否记录不可见字符STX(也即是ASCII字符集的0x02)。默认为 True, 也即是记录这个字符,在日志分析的时候,可以更加方便的分析。
Gets or sets whether to record the invisible character STX (that is, 0x02 of the ASCII character set) when recording the file log. The default is True, that is, this character is recorded, which can be analyzed more conveniently during log analysis.
(继承自 LogNetBase。)
公共属性LogThreadID
获取或设置是否记录线程ID的数据信息,默认为 True,表示记录,否则,需要设置为 False
Get or set whether to record the data information of the thread ID, the default is True, which means record, otherwise, it needs to be set to False
(继承自 LogNetBase。)
Top
方法
  名称说明
公共方法ClearLog
单日志文件允许清空日志内容
Single log file allows clearing log contents
公共方法Dispose (继承自 LogNetBase。)
受保护的方法Dispose(Boolean)
释放资源
(继承自 LogNetBase。)
公共方法Equals (继承自 Object。)
公共方法FiltrateKeyword
过滤掉指定的关键字的日志,该信息不存储,但仍然触发BeforeSaveToFile事件
Filter out the logs of the specified keywords, the information is not stored, but the BeforeSaveToFile event is still triggered
(继承自 LogNetBase。)
受保护的方法Finalize (继承自 Object。)
公共方法GetAllSavedLog
获取单日志文件的所有保存记录
Get all saved records of a single log file
公共方法GetExistLogFileNames
获取所有的日志文件数组,对于单日志文件来说就只有一个
Get all log file arrays, only one for a single log file
受保护的方法GetFileSaveName (重写 LogNetBaseGetFileSaveName.)
公共方法GetHashCode (继承自 Object。)
公共方法GetType (继承自 Object。)
受保护的方法MemberwiseClone (继承自 Object。)
受保护的方法OnWriteCompleted
当写入文件完成的时候触发,这时候已经释放了文件的句柄了。
Triggered when writing to the file is complete, and the file handle has been released.
(继承自 LogNetBase。)
公共方法RecordMessage
通过指定消息等级,关键字,日志信息进行消息记录
Record messages by specifying message level, keywords, and log information
(继承自 LogNetBase。)
公共方法RemoveFiltrate
移除过滤的关键字存储
Remove filtered keyword storage
(继承自 LogNetBase。)
公共方法SetMessageDegree
设置日志的存储等级,高于该等级的才会被存储
Set the storage level of the logs. Only the logs above this level will be stored.
(继承自 LogNetBase。)
公共方法ToString (重写 LogNetBaseToString.)
公共方法WriteAnyString
写入任意字符串
Write arbitrary string
(继承自 LogNetBase。)
公共方法WriteDebug(String)
写入一条调试日志
Write a debug log
(继承自 LogNetBase。)
公共方法WriteDebug(String, String)
写入一条带关键字的调试日志
Write a debug log with keywords
(继承自 LogNetBase。)
公共方法WriteDescrition
写入一条解释性的信息,不属于消息等级控制的范畴
Write an explanatory message that is not part of message level control
(继承自 LogNetBase。)
公共方法WriteError(String)
写入一条错误日志
Write an error log
(继承自 LogNetBase。)
公共方法WriteError(String, String)
写入一条带关键字的错误日志
Write an error log with keywords
(继承自 LogNetBase。)
公共方法WriteException(String, Exception)
写入一条带关键字的异常信息
Write an exception log with keywords
(继承自 LogNetBase。)
公共方法WriteException(String, String, Exception)
写入一条带关键字和描述信息的异常信息
Write an exception log with keywords and text
(继承自 LogNetBase。)
公共方法WriteFatal(String)
写入一条致命日志
Write an fatal log
(继承自 LogNetBase。)
公共方法WriteFatal(String, String)
写入一条带关键字的致命日志
Write an fatal log with keywords
(继承自 LogNetBase。)
公共方法WriteInfo(String)
写入一条普通日志
Write an infomation log
(继承自 LogNetBase。)
公共方法WriteInfo(String, String)
写入一条带关键字的普通日志
Write an information log with keywords
(继承自 LogNetBase。)
公共方法WriteNewLine
写入一行换行符
Write a newline
(继承自 LogNetBase。)
公共方法WriteWarn(String)
写入一条警告日志
Write an warn log
(继承自 LogNetBase。)
公共方法WriteWarn(String, String)
写入一条带关键字的警告日志
Write an warn log with keywords
(继承自 LogNetBase。)
Top
事件
  名称说明
公共事件BeforeSaveToFile
存储之前引发的事件,允许额外的操作,比如打印控制台,存储数据库等等
Store previously raised events, allowing additional operations, such as print console, store database, etc.
(继承自 LogNetBase。)
Top
字段
  名称说明
受保护的字段m_fileSaveLock
文件存储的锁
(继承自 LogNetBase。)
Top
扩展方法
  名称说明
公共扩展器方法ToJsonString
获取当前对象的JSON格式表示的字符串。
Gets the string represented by the JSON format of the current object.
(由 HslExtension 定义。)
Top
备注
此日志实例化需要指定一个完整的文件路径,当需要记录日志的时候调用方法,会使得日志越来越大,对于写入的性能没有太大影响,但是会影响文件读取。
示例
单文件实例化
// 实例化一个日志后,就可以使用了
ILogNet logNet = new LogNetSingle( "D:\\123.txt" );
基本的使用
// 然后我们的代码就可以调用下面的方法来存储日志了,支持下面的5个等级的
logNet.WriteDebug( "Debug log test" );
logNet.WriteInfo( "Info log test" );
logNet.WriteWarn( "Warn log test" );
logNet.WriteError( "Error log test" );
logNet.WriteFatal( "Fatal log test" );

// 还有下面的几种额外的情况
logNet.WriteNewLine( );                       // 追加一行空行
logNet.WriteDescrition( "test" );             // 写入额外的注释的信息
logNet.WriteAnyString( "any string" );        // 写任意的数据,不受格式化影响

// 此处的5个等级有高低之分 debug < info < warn < error < fatal < all
// 如果我们需要屏蔽debug等级的话
logNet.SetMessageDegree( HslMessageDegree.INFO );

// 如果我们需要屏蔽debug及info等级的
logNet.SetMessageDegree( HslMessageDegree.WARN );

// 如果所有的日志在记录之前需要在控制台显示出来
logNet.BeforeSaveToFile += (object sender, HslEventArgs e) =>
{
    Console.WriteLine( e.HslMessage.ToString( ) );
};

// 带关键字的功能
logNet.WriteDebug( "A","Debug log test" );
logNet.WriteInfo( "B", "Info log test" );
logNet.WriteWarn( "C", "Warn log test" );
logNet.WriteError( "A", "Error log test" );
logNet.WriteFatal( "B", "Fatal log test" );

// 有了关键字之后,我们就可以根据关键字过滤了
logNet.FiltrateKeyword( "B" ); // 我们不需要B的关键字的日志
logNet.RemoveFiltrate( "B" );  // 重新需要B的关键字的日志

// 日志记录时默认获取当前系统的时间,如果需要在记录日志时,所有的时间往后加8小时,则可以这么设置(如果往前,就是负数)
logNet.HourDeviation = 8;
所有日志不存储
// 如果所有的日志在记录之前需要在控制台显示出来
logNet.BeforeSaveToFile += ( object sender, HslEventArgs e ) =>
{
    Console.WriteLine( e.HslMessage.ToString( ) );

    // 我们接下来举个例子,所有的日志都不存储文件
    e.HslMessage.Cancel = true;
};
仅存储ERROR等级
// 如果所有的日志在记录之前需要在控制台显示出来
logNet.BeforeSaveToFile += ( object sender, HslEventArgs e ) =>
{
    Console.WriteLine( e.HslMessage.ToString( ) );

    // 我们接下来举个例子,只有错误(ERROR)的等级才存储文件
    if (e.HslMessage.Degree != HslMessageDegree.ERROR)
    {
        // 这样的操作就导致,不是ERROR等级,全部不存储。但是不影响触发控制台输出
        e.HslMessage.Cancel = true;
    }
};
不指定路径
// 实例化一个日志后,如果不指定路径,那就不会存储文件,但仍然会触发BeforeSaveToFile事件
ILogNet logNet = new LogNetSingle( "" );

// 所有的日志在控制台显示出来
logNet.BeforeSaveToFile += ( object sender, HslEventArgs e ) =>
{
    Console.WriteLine( e.HslMessage.ToString( ) );
};
参见