Обработка исключений играет важную роль в управлении приложением и в работе пользователей. Если все сделано правильно, то техническое обслуживание станет проще и использование пользователями перейдет на более высокий уровень. Если нет, то это может быть катастрофой.

Сколько раз вы видели сообщение об ошибке, которая не имеет никакого смысла или, по крайней мере обеспечивает некоторую полезную информацию, а еще лучше - сколько раз вы видели известный экран с ошибкой с сообщением исключения и полную трассировку на желтом фоне? Я бы ответил: “Слишком много раз”. Вот почему, между прочим, некоторые мои коллеги были очень заинтересованы в технике обработки исключений и практических решений.

Цель данной статьи дать показать, что обработка исключений с точки зрения пользователя и с точки зрения людей, которые поддерживают приложения, и показать лучшие решения, как осуществлять полезные обработки ошибок в веб-приложениях ASP.NET. Эта статья относится к моим предыдущим статьям CSS Message Boxes for different message types и Create MessageBox user control using ASP.NET and CSS, эти две статьи описывают, как показывать удобные пользователю сообщений.

1. Какая информация должна быть представлена пользователю?

Как я уже говорил раньше, бессмысленные сообщения об ошибках будут сбивать с толку пользователей. Не имея никаких сообщений об ошибках и разрешение приложению остановится вызовет желание никогда не кликать на ссылку, которая указывает на ваше приложение. :) Сообщения типа "Произошла ошибка" или "System.InvalidOperationException: свойство ConnectionString не инициализировано" ничего не значат для конечного пользователя. На случай, когда не знаешь, что точно произошло, должна быть сохранена информация о том, что нужно делать дальше.

Цель полезной обработки исключений, дать понять пользователям , что что-то пошло не так и что дальше они могут использовать приложения, даже если произошла ошибка.

Таким образом, как минимум что вы должны сделать, так это показать пользователю простую страницу с ошибкой. Она должна показать основную информацию о том, что произошло и то, что пользователь может делать дальше. Например, вы можете показать общее сообщение об ошибке и кнопку "Назад", которая может отправить пользователя на предыдущую страницу.

Это минимум того, что вы можете сделать. Кроме того, вы можете предоставить пользователю значимый набор сообщений, которые будут объяснять:

1. что случилось
2. что будет затронуты
3. что пользователь отсюда может делать
4. и никакой ценной информации поддержки

Делая это, вы устраняете путаницы у пользователей и позволяете им реагировать надлежащим образом. Изображение ниже показывает пример хорошо продуманного экрана ошибки.

Давайте посмотрим, что нужно еще.

2. Сохранение исключений в логи.

В целях обеспечения успешного обслуживания приложения вы должны записывать исключения в логи. Самое важное для людей, которые поддерживают веб-приложения является журнал исключений. Этот журнал сохраняет подробную информацию о проблемах, которые произошли и предоставляет разработчикам с полезную информацию для исправления этих проблем.

Какую информацию следует хранить в журнал исключений?

Прежде всего, нужно сохранить как можно больше информации, которую вы можете получить из исключений. Это подразумивает дату и время, текст исключения, его тип и трассировка стека.

Можно, однако, журнал дополнительной информации, например, проверки подлинности или информация об анонимном пользователе. В Exception Management Architecture Guide на MSDN приводится перечень возможной информации, которая может быть сохранена:

Чем больше информации вы сохраните в журнал, тем легче будет для разработчиков определить причину ошибки и её исправить.

Где должен хранится журнал исключений?

Вы можете записывать исключения туда, куда хотите: текстовый файл, XML файл или в базу данных. Я всегда использую базы данных, поскольку это позволяет мне легко отслеживать журнал и помечать исключения, которые решены. Если исключение не может быть сохранено в базу данных, из-за проблем с подключением, то можно использовать использован XML файл.

Самый простой способ сделать это, надо иметь ExceptionLog таблицу в базе данных и создать свой собственный провайдер журнала исключений.

Этот провайдер может быть одним классом, который будет содержать три метода: LogException - что будет парсить исключения и сохранять всю информацию в таблице, ResolveException - будет удалять исключение из журнала и GetExceptions, который вернет список нерешенных исключений.

Это легкий и простой способ для выявления и исправления ошибок в живом приложении.

3. Как реализовать полезную обработку исключений?

Во-первых, вы должны рассматривать как исключения будут пойманы. Если вы строите многоуровневое приложений, то вам придется ловить исключения среднего уровня классов, и генерировать новые, свои собственые исключения с полезной информацией для клиента.

Для передачи полезной информации клиенту (например, то, что пользователь может делать), вам придется создать специальный класс исключение, который наследуется от класса ApplicationException и добавить в него некоторые свойства. Если вы хотите отправить четыре значения, которые я упоминал раньше, то вам придется добавить еще четыре свойства у ваш класс. Вам также надо будет, переопределить конструктор класса ApplicationException и метод GetObjectData, для разрешения сериализации. Ниже пример пользовательского класса исключений, который назвем MyException.

public class MyException : ApplicationException {

#region Constructors

public MyException(string message): base(message)

{

}

public MyException(string message, Exception inner) : base(message, inner)
{

}

public MyException(string message, Exception inner,string _whatHappened
,string _whatHasBeenAffected
,string _whatActionsCanUserDo
,string _supportInformation): base(message, inner)
{
	whatHappened = _whatHappened;
	whatHasBeenAffected = _whatHasBeenAffected;
	whatActionsCanUserDo = _whatActionsCanUserDo;
	supportInformation = _supportInformation;
}
protected MyException(SerializationInfo info, StreamingContext context)
: base(info, context)
{
	whatHappened = info.GetString("whatHappened");
	whatHasBeenAffected = info.GetString("whatHasBeenAffected");
	whatActionsCanUserDo = info.GetString("whatActionsCanUserDo");
	supportInformation = info.GetString("supportInformation");
}
#endregion #region Methods
public override void GetObjectData(SerializationInfo info, StreamingContext context)
{
	info.AddValue("whatHasBeenAffected", whatHasBeenAffected, typeof(String));
	info.AddValue("whatActionsCanUserDo" ,whatActionsCanUserDo, typeof(String));
	info.AddValue("supportInformation", supportInformation, typeof(String));
	info.AddValue("whatHappened", whatHappened, typeof(String));
	base.GetObjectData(info, context);
}
#endregion #region Properties
private string whatHappened;
private string whatHasBeenAffected;
private string whatActionsCanUserDo;
private string supportInformation;
public string WhatHappened
{
	get { return whatHappened; }
	set { whatHappened = value; }
}
public string WhatHasBeenAffected
{
	get { return whatHasBeenAffected; }
	set { whatHasBeenAffected = value; }
}
public string WhatActionsCanUserDo
{
	get { return whatActionsCanUserDo; }
	set { whatActionsCanUserDo = value; }
}
public string SupportInformation
{
	get { return supportInformation; }
	set { supportInformation = value; }
}
#endregion
}

Поймать ошибки в представлении слоя может быть сделано на уровне приложения (глобальном) или на уровне страницы.

<customErrors mode="RemoteOnly" defaultRedirect="~/Error.aspx">
 <error statusCode="404" redirect="404.html"/> <error statusCode="500" redirect="500.html"/>
</customErrors>

void Application_Error(
object sender, EventArgs e) 
{
	// Get the last exception that has occurred 
	Exception ex = Server.GetLastError().GetBaseException();
	// You can perform logging here // Store it in the session
	Session["LastException"] = ex;
	// Redirect to Error page Server.Transfer("Error.aspx");
}

protected void Page_Load(object sender, EventArgs e)
{
if (Session != null)
{
if (Session["LastException"] != null)
{
	Exception ex = (Exception)Session["LastException"];

if (ex is MyException)
{
	MyException myex = (MyException)ex;
	lblWhatHappened.Text = myex.WhatHappened;
	lblWhatHasBeenAffected.Text = myex.WhatHasBeenAffected;
	lblWhatYouCanDo.Text = myex.WhatActionsCanUserDo;
	lblSupportInformation.Text = myex.SupportInformation;
}
}
}
}

protected void Page_Load(object sender, EventArgs e)
{ Page.Error += new System.EventHandler(Page_Error);


}
protected void Page_Error(Object sender, EventArgs e)
{
	Exception ex = Server.GetLastError();
	// You can perform logging here        
	// UPDATE 06.06.2008: You'll have to redirect to an error page here
	// strikethroughed code just won't work :)
	if (ex is MyException) 
	{
		MyException myex = (MyException)ex;
		lblWhatHappened.Text = myex.WhatHappened; 
		lblWhatHasBeenAffected.Text = myex.WhatHasBeenAffected;
		lblWhatYouCanDo.Text = myex.WhatActionsCanUserDo; 
		lblSupportInformation.Text = myex.SupportInformation;
	}
}

<asp:ScriptManager ID="ScriptManager1" runat="server" OnAsyncPostBackError="ScriptManager1_AsyncPostBackError" />

protected void ScriptManager1_AsyncPostBackError(object sender, AsyncPostBackErrorEventArgs e)
{
	// do whatever you need to do here
}