SuperSocket 中的日誌功能

中文（中國） Toggle Dropdown

v1.6 Toggle Dropdown

關鍵字: 日誌, 日誌接口, Log4Net, 自定義日誌, 擴展日誌, 企業庫日誌php

SuperSocket 中的日誌系統

當 SuperSocket boostrap 啓動時，日誌系統將會自動啓動。因此你無須建立本身的日誌工具，最好直接使用SuperSocket內置的日誌功能。服務器

SuperSocket 默認使用log4net做爲第三方日誌框架。因此若是你熟悉log4net，你就能很是容易的使用和自定義SuperSocket的日誌功能。app

SuperSocket 還提供了基本的 log4net 配置文件 log4net.config/log4net.unix.config，你須要把它放到程序運行目錄的子目錄"Config"。這個 log4net 配置定義了多個 loggers 和 appenders 將全部日誌分類輸出到 "Logs"目錄下的四個文件：框架

info.log
debug.log
err.log
perf.log

你也能夠根據你本身的須要定製這個配置文件。socket

因爲SuperSocket項目對log4net的弱引用，log4net.dll不會自動輸出到你的項目，因此你須要手動引用log4net。（請務必使用SuperSocket提供的log4net版本）ide

日誌接口

SuperSocket的日誌功能很是簡單，你幾乎能夠在任何地方都能記錄日誌。 AppServer 和 AppSession 都有Logger屬性，你能夠直接用它來記錄日誌。工具

如下代碼演示了日誌接口的使用：ui

A -spa

/// <summary>
/// PolicyServer base class
/// </summary>
public abstract class PolicyServer : AppServer<PolicySession, BinaryRequestInfo>
{
    ......

    /// <summary>
    /// Setups the specified root config.
    /// </summary>
    /// <param name="rootConfig">The root config.</param>
    /// <param name="config">The config.</param>
    /// <returns></returns>
    protected override bool Setup(IRootConfig rootConfig, IServerConfig config)
    {
        m_PolicyFile = config.Options.GetValue("policyFile");

        if (string.IsNullOrEmpty(m_PolicyFile))
        {
            if(Logger.IsErrorEnabled)
                Logger.Error("Configuration option policyFile is required!");
            return false;
        }

        return true;
    }

    ......
}

B -.net

public class RemoteProcessSession : AppSession<RemoteProcessSession>
{
     protected override void HandleUnknownRequest(StringRequestInfo requestInfo)
    {
        Logger.Error("Unknow request");
    }
}

擴展你的 Logger

SuperSocket 容許你自定義你的 Logger。例如，你若是想要把你的業務操做日誌保存到一個獨立的地方，你僅須要在log4net配置文件中添加一個新的 logger 併爲這個 logger 設置相應的 appender（假設你默認使用log4net）：

<appender name="myBusinessAppender">
    <!--Your appender details-->
</appender>
<logger name="MyBusiness" additivity="false">
  <level value="ALL" />
  <appender-ref ref="myBusinessAppender" />
</logger>

而後在代碼中建立這個logger實例：

var myLogger = server.LogFactory.GetLog("MyBusiness");

使用除 log4net 以外的日誌框架

SuperSocket 支持你經過接口實現本身的log factory：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace SuperSocket.SocketBase.Logging
{
    /// <summary>
        /// LogFactory Interface
    /// </summary>
    public interface ILogFactory
    {
        /// <summary>
        /// Gets the log by name.
        /// </summary>
        /// <param name="name">The name.</param>
        /// <returns></returns>
        ILog GetLog(string name);
    }
}

接口 ILogFactory 和 ILog 定義在 SuperSocket 之中。

在你實現你你本身的 log factory以後，你須要在配置文件中啓用它：

<superSocket logFactory="ConsoleLogFactory">
    <servers>
      <server name="EchoServer" serverTypeName="EchoService">
        <listeners>
          <add ip="Any" port="80" />
        </listeners>
      </server>
    </servers>
    <serverTypes>
      <add name="EchoService"
           type="SuperSocket.QuickStart.EchoService.EchoServer, SuperSocket.QuickStart.EchoService" />
    </serverTypes>
    <logFactories>
      <add name="ConsoleLogFactory"
           type="SuperSocket.SocketBase.Logging.ConsoleLogFactory, SuperSocket.SocketBase" />
    </logFactories>
  </superSocket>

在 SuperSocket 擴展項目之中，已經有一個使用 Enterprise Library Logging Application Block 的 SuperSocket LogFactory實現： http://supersocketext.codeplex.com/