Related Posts Plugin for WordPress, Blogger...

6-4 Log4Net In Photon Server

本章要來設定Photon Server的Log功能，如之前的文章中有向大家介紹如何觀看Log紀錄，今天要教大家如何在程式中使用Log4Net產生自己的紀錄，方便往後的Debug作業。

首先，專案必須引入兩個dll檔，ExitGames.Logging.Log4Net.dll與log4net.dll，如果有人不知道Photon提供的dll檔在哪，或是不知道該怎麼引入dll檔的話，請先看以前的文章唷。
6-2 Create A Photon Server Project And Import Library


引入完之後，我這邊直接從Photon提供的範例中，複製log4net的設定檔案，檔案位置在src-server/Mmo/Photon.MmoDemo.Server/log4net.config。

接著修改裡面的內容，主要是將Log的檔案名稱改成自己想要的名稱，在第五行的後面。

如下提供我的log4net.config內容：

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
<!--xml version="1.0" encoding="utf-8" ?-->
<log4net debug="false" update="Overwrite">
 
  <appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender">
    <file type="log4net.Util.PatternString" value="%property{Photon:ApplicationLogPath}\\NoliahFantasy.Server.log">
    <appendtofile value="true">
    <maximumfilesize value="5000KB">
    <maxsizerollbackups value="2">
    <layout type="log4net.Layout.PatternLayout">
      <conversionpattern value="%d [%t] %-5p %c - %m%n">
    </conversionpattern></layout>
  </maxsizerollbackups></maximumfilesize></appendtofile></file></appender>
 
  <appender name="ConsoleAppender" type="log4net.Appender.ConsoleAppender">
    <layout type="log4net.Layout.PatternLayout">
      <param name="ConversionPattern" value="%d [%t] %-5p %c - %m%n">
    </layout>
    <filter type="log4net.Filter.LevelRangeFilter">
      <levelmin value="DEBUG">
      <levelmax value="FATAL">
    </levelmax></levelmin></filter>
  </appender>
 
  <!-- logger -->
  <root>
    <level value="INFO">
    <!--<appender-ref ref="ConsoleAppender" />-->
    <appender-ref ref="RollingFileAppender">
  </appender-ref></level></root>
 
  <logger name="OperationData">
    <level value="INFO">
  </level></logger>
 
</log4net>

修改完以後，在專案的log4net.config點右鍵選擇Properties。

修改Copy to output directory的設定為Always copy，每次Build專案時都會將此設定檔複製到輸出資料夾。

接著撰寫程式碼，以下提供我的主類別與MyClinetPeer.cs的程式碼：
NoliahFantasyServer.cs：

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
using System;
using System.IO;
using Photon.SocketServer;
using ExitGames.Logging;
using ExitGames.Logging.Log4Net;
using log4net.Config;
 
namespace NoliahFantasyServer
{
    public class NoliahFantasyServer : ApplicationBase
    {
 
        private static readonly ILogger logger = LogManager.GetCurrentClassLogger();
        public NoliahFantasyServer()
        {
        }
 
        // 當Client端發出Request的時候
        protected override PeerBase CreatePeer(InitRequest initRequest)
        {
            return new MyClientPeer(initRequest);
        }
 
        // Server端啟動的時候初始化
        protected override void Setup()
        {
            LoggerInit();
        }
 
        // Server端關閉的時候
        protected override void TearDown()
        {
        }
 
        void LoggerInit()
        {
            // 日誌初始化
            log4net.GlobalContext.Properties["Photon:ApplicationLogPath"] =
                Path.Combine(this.ApplicationRootPath, "bin_Win64", "log");
            FileInfo loggerConfig = new FileInfo(Path.Combine(this.BinaryPath, "log4net.config"));
            if (loggerConfig.Exists)
            {
                // 設置使用log4net的Log功能
                LogManager.SetLoggerFactory(Log4NetLoggerFactory.Instance);
                // 讓log4net讀取config
                XmlConfigurator.ConfigureAndWatch(loggerConfig);
            }
            logger.Info("Setup Log4Net Compeleted!");
        }
    }
}

MyClientPeer.cs：

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
using System;
using Photon.SocketServer;
using PhotonHostRuntimeInterfaces;
 
namespace NoliahFantasyServer
{
    public class MyClientPeer : ClientPeer
    {
        public MyClientPeer(InitRequest initRequest) : base(initRequest)
        {
        }
 
        // Client端斷開連結的時候
        protected override void OnDisconnect(DisconnectReason reasonCode, string reasonDetail)
        {
        }
 
        // 處理Client的Request請求
        protected override void OnOperationRequest(OperationRequest operationRequest, SendParameters sendParameters)
        {
        }
    }
}

寫好以後按下Build/Build All，專案就會開始編譯了。
 編譯完以後產生如下圖的資料，這些資料都需要複製到PhotonServer上交付執行。

上傳完畢，要給PhotonServer執行的程式都要在deploy底下，NoliahFantasy則是我自定義的Application名稱，然後統一放在bin的下面。

完成了以後還不能啟動，因為我們還沒有編輯PhotonServer.config檔案，由於設定檔的解說在前面的章節已詳細說明過了，不再贅述。下列提供我的設定原始碼：

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
<!--xml version="1.0" encoding="Windows-1252"?-->
<!--
 (c) 2015 by Exit Games GmbH, http://www.exitgames.com
 Photon server configuration file.
 For details see the photon-config.pdf.
 
 This file contains two configurations:
   
  "LoadBalancing"
    Loadbalanced setup for local development: A Master-server and a game-server.
    Starts the apps: Game, Master, CounterPublisher
    Listens: udp-port 5055, tcp-port: 4530, 843 and 943 
  
-->
 
<configuration>
 <!-- Multiple instances are supported. Each instance has its own node in the config file. -->
     
 <loadbalancing maxmessagesize="512000" maxqueueddataperpeer="512000" perpeermaxreliabledataintransit="51200" perpeertransmitratelimitkbsec="256" perpeertransmitrateperiodmilliseconds="200" minimumtimeout="5000" maximumtimeout="30000" displayname="LoadBalancing (MyCloud)">
 
  <!-- 0.0.0.0 opens listeners on all available IPs. Machines with multiple IPs should define the correct one here. -->
  <!-- Port 5055 is Photon's default for UDP connections. -->
  <udplisteners>
   <udplistener ipaddress="0.0.0.0" port="5055" overrideapplication="Master">
   </udplistener>
   <udplistener ipaddress="0.0.0.0" port="5056" overrideapplication="Game">
   </udplistener>
    
  </udplisteners>
   
  <!-- 0.0.0.0 opens listeners on all available IPs. Machines with multiple IPs should define the correct one here. --> 
  <tcplisteners>
   <!-- TCP listener for Game clients on Master application -->
   <tcplistener ipaddress="0.0.0.0" port="4530" overrideapplication="Master" policyfile="Policy\assets\socket-policy.xml" inactivitytimeout="10000">
   </tcplistener>
    
   <tcplistener ipaddress="0.0.0.0" port="4531" overrideapplication="Game" policyfile="Policy\assets\socket-policy.xml" inactivitytimeout="10000">
   </tcplistener>
    
   <!-- DON'T EDIT THIS. TCP listener for GameServers on Master application -->
   <tcplistener ipaddress="0.0.0.0" port="4520">
   </tcplistener>
  </tcplisteners>
   
  <!-- Policy request listener for Unity and Flash (port 843) and Silverlight (port 943)  -->
  <policyfilelisteners>
    <!-- multiple Listeners allowed for different ports -->
    <policyfilelistener ipaddress="0.0.0.0" port="843" policyfile="Policy\assets\socket-policy.xml">
    </policyfilelistener>
    <policyfilelistener ipaddress="0.0.0.0" port="943" policyfile="Policy\assets\socket-policy-silverlight.xml">
    </policyfilelistener>
  </policyfilelisteners>
 
   
  <!-- WebSocket (and Flash-Fallback) compatible listener -->
  <websocketlisteners>
   <websocketlistener ipaddress="0.0.0.0" port="9090" disablenagle="true" inactivitytimeout="10000" overrideapplication="Master">
   </websocketlistener>
    
   <websocketlistener ipaddress="0.0.0.0" port="9091" disablenagle="true" inactivitytimeout="10000" overrideapplication="Game">
   </websocketlistener>
    
  </websocketlisteners>
 
  <!-- Defines the Photon Runtime Assembly to use. -->
  <runtime assembly="PhotonHostRuntime, Culture=neutral" type="PhotonHostRuntime.PhotonDomainManager" unhandledexceptionpolicy="Ignore">
  </runtime>
 
  <!-- Defines which applications are loaded on start and which of them is used by default. Make sure the default application is defined. -->
  <!-- Application-folders must be located in the same folder as the bin_win32 folders. The BaseDirectory must include a "bin" folder. -->
  <applications default="Master"> 
   <application name="Master" basedirectory="LoadBalancing\Master" assembly="Photon.LoadBalancing" type="Photon.LoadBalancing.MasterServer.MasterApplication" forceautorestart="true" watchfiles="dll;config" excludefiles="log4net.config">
   </application>
   <application name="Game" basedirectory="LoadBalancing\GameServer" assembly="Photon.LoadBalancing" type="Photon.LoadBalancing.GameServer.GameApplication" forceautorestart="true" watchfiles="dll;config" excludefiles="log4net.config">
   </application>
    
   <!-- CounterPublisher Application -->
   <application name="CounterPublisher" basedirectory="CounterPublisher" assembly="CounterPublisher" type="Photon.CounterPublisher.Application" forceautorestart="true" watchfiles="dll;config" excludefiles="log4net.config">
   </application>
  </applications>
 </loadbalancing>
  
  
  
 <!-- Instance settings -->
 <mmodemo maxmessagesize="512000" maxqueueddataperpeer="512000" perpeermaxreliabledataintransit="51200" perpeertransmitratelimitkbsec="256" perpeertransmitrateperiodmilliseconds="200" minimumtimeout="5000" maximumtimeout="30000" displayname="MMO Demo">
   
  <!-- 0.0.0.0 opens listeners on all available IPs. Machines with multiple IPs should define the correct one here. -->
  <!-- Port 5055 is Photon's default for UDP connections. -->
  <udplisteners>
   <udplistener ipaddress="0.0.0.0" port="5055" overrideapplication="MMoDemo">
   </udplistener>
  </udplisteners>
     
  <!-- 0.0.0.0 opens listeners on all available IPs. Machines with multiple IPs should define the correct one here. -->
  <!-- Port 4530 is Photon's default for TCP connecttions. -->
  <!-- A Policy application is defined in case that policy requests are sent to this listener (known bug of some some flash clients) -->
  <tcplisteners>
   <tcplistener ipaddress="0.0.0.0" port="4530" policyfile="Policy\assets\socket-policy.xml" inactivitytimeout="10000" overrideapplication="MMoDemo">
   </tcplistener>
  </tcplisteners>
 
  <!-- Policy request listener for Unity and Flash (port 843) and Silverlight (port 943)  -->
  <policyfilelisteners>
    <!-- multiple Listeners allowed for different ports -->
    <policyfilelistener ipaddress="0.0.0.0" port="843" policyfile="Policy\assets\socket-policy.xml" inactivitytimeout="10000">
    </policyfilelistener>
    <policyfilelistener ipaddress="0.0.0.0" port="943" policyfile="Policy\assets\socket-policy-silverlight.xml" inactivitytimeout="10000">
    </policyfilelistener>
  </policyfilelisteners>
 
  <!-- WebSocket (and Flash-Fallback) compatible listener -->
  <websocketlisteners>
   <websocketlistener ipaddress="0.0.0.0" port="9090" disablenagle="true" inactivitytimeout="10000" overrideapplication="MMoDemo">
   </websocketlistener>
  </websocketlisteners>
 
  <!-- Defines the Photon Runtime Assembly to use. -->
  <runtime assembly="PhotonHostRuntime, Culture=neutral" type="PhotonHostRuntime.PhotonDomainManager" unhandledexceptionpolicy="Ignore">
  </runtime>
     
 
  <!-- Defines which applications are loaded on start and which of them is used by default. Make sure the default application is defined. -->
  <!-- Application-folders must be located in the same folder as the bin_win32 folders. The BaseDirectory must include a "bin" folder. -->
  <applications default="MMoDemo">
   
   <!-- MMO Demo Application -->
   <application name="MMoDemo" basedirectory="MmoDemo" assembly="Photon.MmoDemo.Server" type="Photon.MmoDemo.Server.PhotonApplication" forceautorestart="true" watchfiles="dll;config" excludefiles="log4net.config">
   </application>
 
   <!-- CounterPublisher Application -->
   <application name="CounterPublisher" basedirectory="CounterPublisher" assembly="CounterPublisher" type="Photon.CounterPublisher.Application" forceautorestart="true" watchfiles="dll;config" excludefiles="log4net.config">
   </application>
 
  </applications>
 </mmodemo>
  
 <!-- Instance settings -->
 <noliahfantasyserver maxmessagesize="512000" maxqueueddataperpeer="512000" perpeermaxreliabledataintransit="51200" perpeertransmitratelimitkbsec="256" perpeertransmitrateperiodmilliseconds="200" minimumtimeout="5000" maximumtimeout="30000" displayname="NoliahFantasyServer">
  <!-- 0.0.0.0 opens listeners on all available IPs. Machines with multiple IPs should define the correct one here. -->
  <!-- Port 5055 is Photon's default for UDP connections. -->
  <udplisteners>
   <udplistener ipaddress="0.0.0.0" port="5055" overrideapplication="NoliahFantasyServer">
   </udplistener>
  </udplisteners>
     
  <!-- 0.0.0.0 opens listeners on all available IPs. Machines with multiple IPs should define the correct one here. -->
  <!-- Port 4530 is Photon's default for TCP connecttions. -->
  <!-- A Policy application is defined in case that policy requests are sent to this listener (known bug of some some flash clients) -->
  <tcplisteners>
   <tcplistener ipaddress="0.0.0.0" port="4530" policyfile="Policy\assets\socket-policy.xml" inactivitytimeout="10000" overrideapplication="NoliahFantasyServer">
   </tcplistener>
  </tcplisteners>
 
  <!-- Defines the Photon Runtime Assembly to use. -->
  <runtime assembly="PhotonHostRuntime, Culture=neutral" type="PhotonHostRuntime.PhotonDomainManager" unhandledexceptionpolicy="Ignore">
  </runtime>
     
 
  <!-- Defines which applications are loaded on start and which of them is used by default. Make sure the default application is defined. -->
  <!-- Application-folders must be located in the same folder as the bin_win32 folders. The BaseDirectory must include a "bin" folder. -->
  <applications default="NoliahFantasyServer">
   
   <!-- Application -->
   <application name="NoliahFantasyServer" basedirectory="NoliahFantasy" assembly="NoliahFantasy_PhotonServer" type="NoliahFantasyServer.NoliahFantasyServer" forceautorestart="true" watchfiles="dll;config" excludefiles="log4net.config">
   </application>
 
  </applications>
 </noliahfantasyserver>
</configuration>


修改完以後，開啟Photon的控制中心，就會發現Photon instances中多出了我們定義的NoliahFantasyServer選項，選擇Start as application。假如在啟動Application時出了問題，有可能是你的PhotonServer.config檔案設定錯誤，請再檢查是否有哪個值設定的不對。

此時來到deploy/bin_Win64/log底下，會出現我自定義的NoliahFantasy.Server檔案，當程式邏輯有Bug時便能透過這個檔案進行測試。另外，還有一個類似名稱的檔案Photon-NoliahFantasyServer-20180505，這是Photon預設的啟動Application時的Log檔，如果在啟動時就出現問題的話，請看這個Log。

最後，我們的Log裡面有出現“Setup Log4Net Completed!”字樣，代表成功了。

留言

  1. Unknown2018年9月25日 下午6:43

    想請問一下，我在建置之後沒有出現PhotonHostRuntimeInterfaces.dll，請問有可能是我哪個部分做錯嗎？還是說我也可以直接從當初參考的地方直接拿來用？

    回覆刪除
    回覆
    1. ANONEKO2018年11月9日 晚上11:59

      應該可以唷～我的Visual Studio可能自動幫我輸出PhotonHostRuntimeInterfaces.dll到目的資料夾。檔案應該都是同一個。

      刪除

張貼留言