wcfria,[Silverlight入门系列]使用WCF Ria Service和Log4net在服务器端记录异常日志/ExceptionLog

本文系Mainz在博客园的原创（http://www.cnblogs.com/mainz/），若您在银光中国（SilverlightChina）或其它网站看到本文，请注意是转载，文中很多链接已经丢失。言归正传，今天谈下在Silverlight中如何进行异常处理，用WCF Ria Service在服务器端记录异常日志，后台用log4net组件处理logging，前台给用户弹出一个友好的框，用户也可以在客户端保存异常log到本地，就这么点内容。废话不说，开始了！

1. 后台实现Wcf Ria service + log4net记录异常日志
在SilverlightApplication1.Web项目添加一个空的Domain Service，名字叫LoggingService，里面加一个写一个Invoke的方法。注意这个DomainService需要加[Invoke]属性标明这不是一个Entity相关的操作。详细解释请参考MSDN这个页面。
Domain Service 1 [EnableClientAccess()] 2 public class LoggingService : DomainService 3 { 4 [Invoke] 5 public void LogException(string message, string stackTrace) 6 { 7 Logger.LogException(message, stackTrace); 8 } 9 }

2. 后台加个Logger静态类用log4net写log
Logger 1 using log4net; 2 3 public class Logger 4 { 5 static ILog log = log4net.LogManager.GetLogger(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType); 6 7 public static void LogException(string message, string stackTrace) 8 { 9 log.Debug(string.Format("Exception occured: {0}, stack trace: {1}", message, stackTrace)); 10 } 11 12 public static void LogInfo(string info) 13 { 14 log.Info(info); 15 } 16 }

3. 添加log4net的dll引用，web.config配置记录log的log4net部分
首先下载log4net，然后在SilverlightApplication1.Web项目添加log4net的dll引用，添加一个Global.asax，在Global.asax.cs里面添加以下代码来初始化log4net配置：
Global.asax.cs 1 protected void Application_Start(object sender, EventArgs e) 2 { 3 log4net.Config.XmlConfigurator.Configure(); 4 }

配置web.config的log4net部分 1 2 3

4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 23 24 25 26 27

4. 前台SilverlightApplication1调用Wcf Ria Service的Domain Context
刚才我们在SilverlightApplication1.Web项目添加了DomainService，编译之后会在有RiaLink的前台项目自动生成客户端代理Generated_Code\*.web.g.cs。如果你有很多WCF Ria Service Class Library，那么需要检查RiaLink，它们之间的对应关系。可以查看项目属性，见下图：

我们在App.xaml.cs里面处理UnhandledException：
App.xaml.cs 1 public App() 2 { 3 this.UnhandledException += this.Application_UnhandledException; 4 5 InitializeComponent(); 6 } 7 8 private void Application_UnhandledException(object sender, ApplicationUnhandledExceptionEventArgs e) 9 { 10 11 if (!Debugger.IsAttached) 12 { 13 14 //记录log到服务器：调用WCF Ria Service 15 LogExceptionToServer(e.ExceptionObject); 16 17 //弹出用户友好窗口 18 ShowUserFriendlyExceptionWindow(e.ExceptionObject); 19 20 e.Handled = true; 21 22 } 23 24 } 25 26 private void LogExceptionToServer(Exception e) 27 { 28 var logDomainContext = new LoggingContext(); 29 30 logDomainContext.LogException(e.Message, e.StackTrace, 31 invokeOperation => 32 { 33 if (invokeOperation.HasError) 34 { 35 //.... 36 } 37 },null); 38 } 39 40 private void ShowUserFriendlyExceptionWindow(Exception e) 41 { 42 var exceptionDialog = new ExceptionWindow(); 43 exceptionDialog.UserFriendlyException = e.Message; 44 exceptionDialog.DetailedException = e.ToString(); 45 exceptionDialog.Error = e; 46 exceptionDialog.Show(); 47 }

5. 发生未知异常显示用户友好的界面

如果发生异常显示用户友好的界面，可以保存异常到本地，这个ExceptionWindow的代码如下：
Exception ChildWindow 1 public partial class ExceptionWindow : ChildWindow 2 { 3 private Exception _exception; 4 5 public ExceptionWindow() 6 { 7 InitializeComponent(); 8 } 9 10 public string UserFriendlyException 11 { 12 get { return userFriendlyMessageTextBlock.Text; } 13 set 14 { 15 if (!String.IsNullOrEmpty(value) && value.Length > 65) 16 userFriendlyMessageTextBlock.Text = value.Substring(0, 65) + "..."; 17 else 18 userFriendlyMessageTextBlock.Text = value; 19 } 20 } 21 22 public string DetailedException 23 { 24 get { return detailedInforTextBox.Text; } 25 set { detailedInforTextBox.Text = value; } 26 } 27 28 public Exception Error 29 { 30 set { _exception = value; } 31 } 32 33 private void closeButton_Click(object sender, RoutedEventArgs e) 34 { 35 this.DialogResult = false; 36 } 37 38 private void saveLogButton_Click(object sender, RoutedEventArgs e) 39 { 40 SaveLogOnClientDisc(FormatMessage()); 41 } 42 43 private string FormatMessage() 44 { 45 string originalException = string.Empty; 46 47 if (_exception != null) 48 originalException = _exception.ToString(); 49 50 return string.Format("{0} - {1}\n\nDetailed Message:\n{2}\n\nOriginal Exception:\n{3}", 51 DateTime.Now.ToString(), 52 UserFriendlyException, 53 DetailedException, 54 originalException); 55 } 56 57 private void SaveLogOnClientDisc(string errorMessage) 58 { 59 var saveLogDialog = new SaveFileDialog(); 60 61 saveLogDialog.DefaultExt = ".log"; 62 saveLogDialog.Filter = "Text Files|*.txt|Log Files|*.log|All Files|*.*"; 63 saveLogDialog.FilterIndex = 2; 64 65 bool? dialogResult = saveLogDialog.ShowDialog(); 66 67 if (dialogResult == true) 68 { 69 try 70 { 71 var contents = Encoding.Unicode.GetBytes(errorMessage); 72 73 using (var fileStream = saveLogDialog.OpenFile()) 74 { 75 fileStream.Write(contents, 0, contents.Length); 76 fileStream.Close(); 77 MessageBox.Show("File successfully saved!"); 78 } 79 } 80 catch (Exception ex) 81 { 82 MessageBox.Show("Can't save file: " + ex.Message); 83 } 84 } 85 } 86 }

ExceptionWindow的xaml代码
Exception Window.xaml 1 8 9 10 11 12 13 14 15 21 22 23 29 30 31 32 33 34 35 36 37

6. 在WCF Ria Service内处理异常
在带Entity的Domain Service里面我们应该在OnError里面写服务端日志，方法同上：
OnError 1 [EnableClientAccess()] 2 public class DomainService1 : DomainService 3 { 4 public IEnumerable GetCustomers() 5 { 6 throw new ApplicationException("My exception"); 7 } 8 9 protected override void _disibledevent=>10 { 11 //Log exception errorInfo.Error 12 } 13 }

然后客户端应该这样捕捉Error：
Call Domain Service 1 customerDomainContext.Load(ds.GetCustomersQuery(), 2 loadOperation => 3 { 4 if (loadOperation.HasError) 5 { 6 MessageBox.Show(loadOperation.Error.Message); 7 loadOperation.MarkErrorAsHandled(); 8 } 9 } 10 ,null);

如果没有进行上述处理则会在UnhandledException会捕捉到。
7. 结束
为了安全性考虑，不要把敏感信息比如stackTrace从客户端传递到服务端（本文是示例）来记录log，否则黑客会xxxx。Silverlight异常处理方面，不知道大家有没有更好的方法实现 ？另：如果对Silverlight+Wcf Ria service+EF还不明白的，可以看博客园其他的博文。本人也有Silverlight系列文章可以一读。

Tags:  wcfria

延伸阅读

• 2011-9-6-- wcfria,WCF RIA 服务工具箱简介
• 2011-7-15-- wcfria,[译]WCF RIA Services中的集合（1）
• 2011-6-30-- wcfria,使用Entity Framework和WCF Ria Services开发SilverLight之5：客户端主外键联表查询
• 2011-6-30-- wcfria,Silverlight学习点滴之一——使用WCF RIA构建应用
• 2011-6-30-- wcfria,使用Entity Framework和WCF Ria Services开发SilverLight之6：查找指定字段
• 2011-7-5-- wcfria,使用Entity Framework和WCF Ria Services开发SilverLight之7：多个Domain Service间共享Poco实体
• 2011-6-13-- wcfria,使用Entity Framework和WCF Ria Services开发SilverLight之2：POCO
• 2010-12-9-- wcfria,Silverlight DataGrid使用WCF RIA Service实现Load-on-demand的数据加载
• 2011-5-14-- wcfria,WCF RIA Services - 超时
• 2011-1-31-- wcfria,WCF RIA Service + IIS 6: NotFound 错误