简体   繁体   中英

In C#, are there any built-in exceptions I shouldn't use?

Are there any Exceptions defined in the .NET Framework that I shouldn't throw in my own code, or that it is bad practice to? Should I write my own?

You shouldn't throw any exception that is automatically thrown by the CLR due to user errors. For instance

  • StackOverflowException
  • NullReferenceException
  • AccessViolationException
  • etc ...

The reason being is to do so creates confusion for people calling your API. Users should be able to distinguish between actively thrown exceptions by an API and exceptions that are not actively thrown (thrown by CLR).

The reason is that at actively thrown exception generally represents a known state in an API. If I call an API and it throwns an ArgumentException, I have a reasonable expectation that the given object is in a good state. It recognized a potentially bad situation and actively accounted for it. On the other hand if it throwns a NullRefrenceException, that is an indication that the API encountered an unknown error and is now in an unreliable state.

Another lesser reason is that these exceptions behave differently when thrown by user code as opposed to the CLR. For instance it's possible to catch a StackOverflowException if thrown by user code, but not if it's thrown by the CLR.

EDIT Responding to Michael's comment

You also should not throw Exception, ApplicationException or SystemException directly. These exceptions types are too general to provide meaningful information to the code which calls your API. True you can put a very descriptive message into the message parameter. But it's not straight forward or maintainable to catch an exception based on a message. It's much better to catch it based on the type.

FxCop rule on this subject: http://msdn.microsoft.com/en-us/library/ms182338(VS.80).aspx

Most exception classes in the framework are not meant for reuse since they usually are crafted to signal some Framework specific error. Like those mentioned by @JaredPar , they are used by the framework to indicate certain states in the framework.

There are literally tens, maybe hundreds, exceptions in the framework, so IMO it is more useful to list those that we should use. At the top of my head, these are those I actively use:

For other error conditions in user code, best practice is to create your own exception classes.

@Michael There is actually one situation in which it is recommended to throw a NullReferenceException: If the first parameter (the "this" parameter) of an extension method is null. You need to do this in order that null variables behave as expected.

Microsoft was at one point telling programmers not to inherit directly from Exception, but instead to use ApplicationException as their base class. Not sure if that opinion still holds true, though...

And if a pre-defined exception already exists that covers your exact error condition (like "NullReferenceException", or "InvalidArgumentException" etc.) - by all means, throw those instead of re-inventing them inside your own code.

Marc

No one has posted a direct link to it, so here's the MSDN page with the complete list of Exception Do's and Don'ts

https://learn.microsoft.com/en-us/do.net/standard/design-guidelines/using-standard-exception-types

In terms of throwing the don'ts are...

  • System.Exception
  • ApplicationException
  • NullReferenceException
  • AccessViolationException
  • IndexOutOfRangeException
  • StackOverflowException
  • OutOfMemoryException
  • COMException
  • ExecutionEngineException
  • SEHException

It also has a list of don't catch and a recommendations on what exceptions you should throw

there are several exception already defined for you. Always try to use these Exceptions before roll your own

The online Design Guidelines for Exceptions contains the principle advice (see specifically this page).

The book "Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraries, 2nd Edition" has more details and more discussion on this topic.

The technical post webpages of this site follow the CC BY-SA 4.0 protocol. If you need to reprint, please indicate the site URL or the original address.Any question please contact:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM