Home > Articles > Programming > C#

Better Error Handling with the New Exception Filters in C# 6

  • Print
  • + Share This
The exception filters in C# 6 cut back on the cumbersome error-handling code commonplace to earlier releases. Of course, handling errors is part of the job, but new implementations in C# 6 can diminish the extra work. Bill Wagner, author of Effective C#: 50 Specific Ways to Improve Your C#, Second Edition, details the changes in the new release.
Like this article? We recommend

Exception filters have been added to C# 6 as part of the "co-evolution" strategy for C# and VB.NET. Exception filters have been present in VB.NET for several releases, and have also been available in F#. They're new for C# in version 6.

New Behaviors for Exception Filters

Exception filters now provide more general control over when an exception should be handled. In previous releases, the only way you could indicate to handle an exception was based on the type of exception. You caught all exceptions of a given type, including all exception classes derived from that given type. That syntax might not always cause limitations, but in several scenarios it resulted in more cumbersome error-handling code. Those scenarios are addressed by the exception filters in C# 6.

Using the new syntax for exception handlers is easy: Just add a when clause to a catch handler. If the expression following the when keyword evaluates to true, the catch block runs. If the expression following the when keyword evaluates to false, the exception continues to propagate:

try
{
    DoSomeWork();
} catch (SomeException e) when (passesFilter(e))
{
    // Handle errors....
}

The syntax for exception filters was revised as this release was being developed. The original syntax used if rather than when:

// Original syntax used 'if' instead of 'when'
try
{
    DoSomeWork();
} catch (SomeException e) if (passesFilter(e))
{
    // Handle errors....
}

This syntax was rejected because a little reformatting could make it look like a very different construct:

// Original syntax caused confusion
try
{
    DoSomeWork();
} catch (SomeException e)
    if (passesFilter(e))
    {
        // Handle errors....
    }

With that reformatting, developers could easily misread an exception filter as an if clause inside a catch block. To avoid that confusion, the keyword was changed from if to when.

Exceptions and Call Stacks

The syntax for exception filters doesn't indicate that anything new and interesting is happening, but there's quite a bit of difference in the underlying implementation. In terms of the logic, you could have achieved the same external behavior by using a catch clause containing the conditional logic of the exception filter. Whenever the exception filter returned false, you would rethrow the exception:

// Same logic, old-school C#:
try
{
    DoSomeWork();
}
catch (SomeException e)
{
    if (passesFilter(e))
    {
        // Handle errors....
    }
    else
    {
        throw;
    }
}

There are several advantages to the newer syntax. Using an exception filter, the exception is not caught and rethrown when the exception filter returns false. With this behavior, the original exception and all the call stack information will be preserved when your exception filters return false. If you used the classic syntax, the catch and rethrow interrupt that flow. When you use the throw statement with no arguments, the same exception is thrown, but the original information in the call stack has been modified. The catch clause has been executed, and then the exception is rethrown.

In a large production system, the older syntax can make finding and diagnosing errors much more difficult because you need to dig through more layers of exceptions to find the root cause of the problem. The newer exception filters are preferred in scenarios where an exception can be handled only based on other program states or conditions.

Scenarios for Exception Filters

The examples I've shown to this point provide a filter that returns true or false based on the properties of an exception. That's one of the core scenarios for exception filters. However, filters also can determine whether an exception should be processed based on any program state. For example, one use might be to retry a web request up to 10 times in case of a timeout failure:

var done = false;
do
{
    int failures = 0;
    try {
        var data = SimulatedWebRequest();
        workWith(data);
        done = true;
    } catch(TimeoutException e) when (failures++ < 10)
    {
        WriteLine("Timeout error: trying again");
    }
} while (!done);

You can expand on the idea above to create filters for any logical condition you need. The only restriction on the expression for an exception filter is that it must be synchronous: You cannot await an asynchronous task as part of an exception filter. Ideally, exception filter clauses also shouldn't be long-running (blocking) operations.

One common scenario for exception filters is to implement logging as a side-effect of an exception filter that always returns false. Let's update the first sample above to include logging:

try
{
    DoSomeWork();
}
catch (Exception e) when (logException(e)) { }
catch (SomeException e) when (passesFilter(e))
{
    // Handle errors....
}

There are three important points to note here:

  • The initial catch clause has an empty body. It never handles the exception.
  • The logException() method must always return false. Otherwise, your logging method would cause the empty catch clause to swallow the exception.
  • The catch clause for logging is above any catch clauses that might actually process the exception. This is true even though the logging catch clause is set to catch the most general exception class, System.Exception.

It's still true in C# 6 that once an exception has been handled by a catch clause, no catch clauses that follow will be executed. In previous versions of C#, we had to arrange our catch clauses carefully from the most specific exception classes to the most general. With the new exception filters in C# 6, we can have multiple catch clauses for the same exception class, with different conditions on the exception filters. We can also have scenarios like the one above, where the first catch clause catches a more general exception than a later clause would do. Because logException() would always return false, the other catch clauses are still examined in order. Care is still required; because the first catch clause whose exception filter returns true will process the exception, no catch clauses declared later will be entered.

This added flexibility can make it easier to write catch clauses for exceptions where some property or program variable determines the correct action.

There's one final scenario where I've found exception filters to be very valuable in debugging. If I can't track down the original cause of an exception because of multiple layers of catching, wrapping, and throwing, I still can ensure that an exception is not processed when I'm running an application with a debugger attached. If I add an exception filter to prevent catching exceptions when the debugger is attached, it's easier to find the root cause of an issue:

try
{
    DoSomeWork();
}
catch (Exception e) when (logException(e)) { }
catch (SomeException e) when (passesFilter(e) && !Debugger.IsAttached)
{
    // Handle errors....
}

The code above includes one more exception filter that tests for the presence of a debugger attached to the current process. If a debugger is present, the catch clause is not entered, and the exception continues to propagate. If I add this filter in enough places, eventually every exception causes the debugger to stop on an unhandled exception error. It's a rather large hammer to find issues, but it's a very effective hammer.

Some Initial Guidance on Exception Filters

I use exception filters less often than other new features in C# 6. However, when I need this feature, I truly appreciate it. Exception filters are most helpful when I'm trying to diagnose errors in a large system, where exception handling is difficult, and we have limited flexibility in writing the code that handles, processes, and reports errors.

Furthermore, we don't typically write exception handling everywhere in our code. One of the advantages of using exceptions to communicate errors is that not every method must handle all possible errors. Exceptions continue to propagate up the call stack until a handler is found. We'll only add new exception filters in those methods that are already handling exceptions.

The enhanced syntax in C# 6 exception filters provides greater functionality and flexibility in methods that report or process exceptions. In new projects, I make use of the logging idiom I showed earlier. I also use the debugger-attached trick when I just can't find the root cause of an exception. Overall, I believe the revised exception filters will be used less often than some of the other features I've profiled in this series of articles. However, I do believe that it will be very well appreciated when it is used.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020