ChatGPT解决这个技术问题 Extra ChatGPT

Why catch and rethrow an exception in C#?

I'm looking at the article C# - Data Transfer Object on serializable DTOs.

The article includes this piece of code:

public static string SerializeDTO(DTO dto) {
    try {
        XmlSerializer xmlSer = new XmlSerializer(dto.GetType());
        StringWriter sWriter = new StringWriter();
        xmlSer.Serialize(sWriter, dto);
        return sWriter.ToString();
    }
    catch(Exception ex) {
        throw ex;
    }
}

The rest of the article looks sane and reasonable (to a noob), but that try-catch-throw throws a WtfException... Isn't this exactly equivalent to not handling exceptions at all?

Ergo:

public static string SerializeDTO(DTO dto) {
    XmlSerializer xmlSer = new XmlSerializer(dto.GetType());
    StringWriter sWriter = new StringWriter();
    xmlSer.Serialize(sWriter, dto);
    return sWriter.ToString();
}

Or am I missing something fundamental about error handling in C#? It's pretty much the same as Java (minus checked exceptions), isn't it? ... That is, they both refined C++.

The Stack Overflow question The difference between re-throwing parameter-less catch and not doing anything? seems to support my contention that try-catch-throw is-a no-op.

EDIT:

Just to summarise for anyone who finds this thread in future...

DO NOT

try {
    // Do stuff that might throw an exception
}
catch (Exception e) {
    throw e; // This destroys the strack trace information!
}

The stack trace information can be crucial to identifying the root cause of the problem!

DO

try {
    // Do stuff that might throw an exception
}
catch (SqlException e) {
    // Log it
    if (e.ErrorCode != NO_ROW_ERROR) { // filter out NoDataFound.
        // Do special cleanup, like maybe closing the "dirty" database connection.
        throw; // This preserves the stack trace
    }
}
catch (IOException e) {
    // Log it
    throw;
}
catch (Exception e) {
    // Log it
    throw new DAOException("Excrement occurred", e); // wrapped & chained exceptions (just like java).
}
finally {
    // Normal clean goes here (like closing open files).
}

Catch the more specific exceptions before the less specific ones (just like Java).

References:

MSDN - Exception Handling

MSDN - try-catch (C# Reference)

Good summary; extra points for including the finally block.
i would like to add that you can use the "throw;" to be even more helpful by adding the parameters that were sent to the method in the e.Data collection before the "throw;" statement
@MickTheWarMachineDesigner (and part-time painter). Huh? You're talking handling Microshite Suckwell (proabably 2005 onwards, for all I know) exceptions. I was talking about exception handling in general. And yes I've learned some since I posted this NEARLY FOUR YEARS AGO.... But yes, I confess that you have valid point, but me thinks you've missed the real point; if you get my drift? This question is about GENERALISED exception handling in C#; and more specifically about rethrowing exceptions... of ALL kinds. Cool?
Please consider moving the edit summary section in your question to its own answer. For why, see Editing self-answer out of question and Answer embedded in question.
Did anyone not notice the "Excrement occurred" part? it sounds like the code went for a poop!

R
Richard Szalay

First; the way that the code in the article does it is evil. throw ex will reset the call stack in the exception to the point where this throw statement is; losing the information about where the exception actually was created.

Second, if you just catch and re-throw like that, I see no added value, the code example above would be just as good (or, given the throw ex bit, even better) without the try-catch.

However, there are cases where you might want to catch and rethrow an exception. Logging could be one of them:

try 
{
    // code that may throw exceptions    
}
catch(Exception ex) 
{
    // add error logging here
    throw;
}

@Fredrick, just fyi (though you probably know) if you're not going to use that ex object, then there's no need to instantiate it.
@Eoin: If its not instantiated it'd be rather difficult to log it.
Yep, I think "evil" is about right... consider the case of null pointer exception thrown somewhere from a large body of code. The message is vanilla, without the stack trace you're left with "something was null somewhere". NOT good when production is dead; and you've NO minutes or less to work out the flamin' problem is, and dismiss or rectify it... Good exception handling is worth it's weight in gold.
Is that true for Java as well ... "throw" vs. "throw ex"?
@Jason, see this question. In Java, throw ex does not restart the stacktrace.
G
Geoff

Don't do this,

try 
{
...
}
catch(Exception ex)
{
   throw ex;
}

You'll lose the stack trace information...

Either do,

try { ... }
catch { throw; }

OR

try { ... }
catch (Exception ex)
{
    throw new Exception("My Custom Error Message", ex);
}

One of the reason you might want to rethrow is if you're handling different exceptions, for e.g.

try
{
   ...
}
catch(SQLException sex)
{
   //Do Custom Logging 
   //Don't throw exception - swallow it here
}
catch(OtherException oex)
{
   //Do something else
   throw new WrappedException("Other Exception occured");
}
catch
{
   System.Diagnostics.Debug.WriteLine("Eeep! an error, not to worry, will be handled higher up the call stack");
   throw; //Chuck everything else back up the stack
}

Why not just leave catch { throw } out altogether?
For some reason, the name of the SQLException bothers me.
That catch (Exception) { throw new Exception(...) } is something you should never, ever, ever do, simply because you're obfuscating the exception information and making exception filtering further up the call stack unnecessarily difficult. The only time you should catch one type of exception and throw another is when you are implementing an abstraction layer and you need to transform a provider-specific exception type (e.g. SqlException versus XmlException) into a more generic one (e.g. DataLoadingException).
I have a feeling that this code's WrappedException forgets the wrapping. Was it the author's intention to put the original exception in that constructor as InnerException?
Under MS convention, only two-letter acronyms should remain uppercase (IOException), longer acronyms should be PascalCased (SqlException). Unlike in Java (see SQLException). That's the reason probably why SQLException bothers you, @MichaelMyers.
A
Abel

C# (before C# 6) doesn't support CIL "filtered exceptions", which VB does, so in C# 1-5 one reason for re-throwing an exception is that you don't have enough information at the time of catch() to determine whether you wanted to actually catch the exception.

For example, in VB you can do

Try
 ..
Catch Ex As MyException When Ex.ErrorCode = 123
 .. 
End Try

...which would not handle MyExceptions with different ErrorCode values. In C# prior to v6, you would have to catch and re-throw the MyException if the ErrorCode was not 123:

try 
{
   ...
}
catch(MyException ex)
{
    if (ex.ErrorCode != 123) throw;
    ...
}

Since C# 6.0 you can filter just like with VB:

try 
{
  // Do stuff
} 
catch (Exception e) when (e.ErrorCode == 123456) // filter
{
  // Handle, other exceptions will be left alone and bubble up
}

Dave, but (in java at least) you wouldn't throw a "generic" MyException, you'd define a SPECIFIC exception type and throw it, allowing it to be differentiated-by-type in the catch block... But yes, if your not the architect of the exception (I'm thinking JDBC's SQLException (Java again) here, which is disgustingly generic, and exposes getErrorCode() method... Hmmm... You've got a point, it's just that I think there's a better way to do it, where possible. Cheers Mate. I appreciate your time, a lot. Keith.
Well, the question is "Why catch and rethrow Exception in C#?", and this is an answer. =] ...and even with specialized exceptions, Exception Filters make sense: consider the case where you are, let's say, handling a SqlTimeoutException and a SqlConnectionResetException, which are both SqlException. Exception Filters let you catch an SqlException only when it's one of these two, so instead of cluttering your try/catch with identical handling for these two, you could "catch SqlException ex when ex is SqlTimeoutException Or ex is SqlConnectionResetException". (I'm not Dave btw)
Filtered exceptions are coming in C# 6!
P
Peter Mortensen

My main reason for having code like:

try
{
    //Some code
}
catch (Exception e)
{
    throw;
}

is so I can have a breakpoint in the catch, that has an instantiated exception object. I do this a lot while developing/debugging. Of course, the compiler gives me a warning on all the unused e's, and ideally they should be removed before a release build.

They are nice during debugging though.


Yeah, I'll pay that one, but yes, you wouldn't want to see that in published code... ergo: I would be ashamed to publish it ;-)
Actually, this isn't necessary -- in Visual Studio you can set the debugger to break when an exception is thrown and it brings up the exception details in an inspector window for you.
If you want to use some code ONLY during debugging, use #if DEBUG ... #endif , and you don't need to remove these lines
Ya, I've done that a few times myself. Every now and then one will escape to a release. @jammycakes The problem with Visual Studio's break on exception is, sometimes the exception I want isn't the only one (or even only one of its type) being thrown. Still don't know of a break point condition with "break if skipped by exception". Till then, this will remain useful. Michael Freidgeim: #if DEBUG around BOTH the try { and } catch () {...} is a bit messy and, frankly, makes me queasy... The pre-processor is, generally speaking, not my friend.
C
Cheekysoft

A valid reason for rethrowing exceptions can be that you want to add information to the exception, or perhaps wrap the original exception in one of your own making:

public static string SerializeDTO(DTO dto) {
  try {
      XmlSerializer xmlSer = new XmlSerializer(dto.GetType());
      StringWriter sWriter = new StringWriter();
      xmlSer.Serialize(sWriter, dto);
      return sWriter.ToString();
  }
  catch(Exception ex) {
    string message = 
      String.Format("Something went wrong serializing DTO {0}", DTO);
    throw new MyLibraryException(message, ex);
  }
}

Thanx, yep exception wrapping (especially chained) is perfectly sane... what is not sane is catching an exception just so you can chuck away the stack trace, or worse, eat it.
A
Arjan Einbu

Isn't this exactly equivalent to not handling exceptions at all?

Not exactly, it isn't the same. It resets the exception's stacktrace. Though I agree that this probably is a mistake, and thus an example of bad code.


P
Peter Mortensen

You don't want to throw ex - as this will lose the call stack. See Exception Handling (MSDN).

And yes, the try...catch is doing nothing useful (apart from lose the call stack - so it's actually worse - unless for some reason you didn't want to expose this information).


You don't lose the entire call stack when you use throw ex, you just lose the part of the call stack from the point where the exception occurred higher up its call stack. But you retain the call stack from the method that threw the exception down to where the client called it. There actually might be use cases where you'd use that, or else the good people at Microsoft wouldn't have allowed it. That said, I haven't used it. Another issue to remember is that throwing exceptions is expensive. Only do it for a very justifiable reason. Logging I would think would be justifiable, etc.
J
Jackson Tarisa

This can be useful when your programming functions for a library or dll.

This rethrow structure can be used to purposefully reset the call stack so that instead of seeing the exception thrown from an individual function inside the function, you get the exception from the function itself.

I think this is just used so that the thrown exceptions are cleaner and don't go into the "roots" of the library.


s
supercat

A point that people haven't mentioned is that while .NET languages don't really make a proper distinction, the question of whether one should take action when an exception occurs, and whether one will resolve it, are actually distinct questions. There are many cases where one should take action based upon exceptions one has no hope of resolving, and there are some cases where all that is necessary to "resolve" an exception is to unwind the stack to a certain point--no further action required.

Because of the common wisdom that one should only "catch" things one can "handle", a lot of code which should take action when exceptions occur, doesn't. For example, a lot of code will acquire a lock, put the guarded object "temporarily" into a state which violates its invariants, then put it object into a legitimate state, and then release the lock back before anyone else can see the object. If an exception occurs while the object is in a dangerously-invalid state, common practice is to release the lock with the object still in that state. A much better pattern would be to have an exception that occurs while the object is in a "dangerous" condition expressly invalidate the lock so any future attempt to acquire it will immediately fail. Consistent use of such a pattern would greatly improve the safety of so-called "Pokemon" exception handling, which IMHO gets a bad reputation primarily because of code which allows exceptions to percolate up without taking appropriate action first.

In most .NET languages, the only way for code to take action based upon an exception is to catch it (even though it knows it's not going to resolve the exception), perform the action in question and then re-throw). Another possible approach if code doesn't care about what exception is thrown is to use an ok flag with a try/finally block; set the ok flag to false before the block, and to true before the block exits, and before any return that's within the block. Then, within finally, assume that if ok isn't set, an exception must have occurred. Such an approach is semantically better than a catch/throw, but is ugly and is less maintainable than it should be.


s
statler

While many of the other answers provide good examples of why you might want to catch an rethrow an exception, no one seems to have mentioned a 'finally' scenario.

An example of this is where you have a method in which you set the cursor (for example to a wait cursor), the method has several exit points (e.g. if () return;) and you want to ensure the cursor is reset at the end of the method.

To do this you can wrap all of the code in a try/catch/finally. In the finally set the cursor back to the right cursor. So that you don't bury any valid exceptions, rethrow it in the catch.

try
{
    Cursor.Current = Cursors.WaitCursor;
    // Test something
    if (testResult) return;
    // Do something else
}
catch
{
    throw;
}
finally
{
     Cursor.Current = Cursors.Default;
}

Was catch a mandatory part of try...finally historically, or does it play a functional role in this example? - I just double-checked, and I'm able to use try {} finally {} without the catch block at all.
B
Brian

One possible reason to catch-throw is to disable any exception filters deeper up the stack from filtering down (random old link). But of course, if that was the intention, there would be a comment there saying so.


I didn't get what you where on about until I read the link... and I'm still not exactly sure what you're on about... me being totally unfamiliar with VB.NET. I think it results in the sum being reported "inconsistent", right?... I'm a BIG fan of static methods.. apart from them being simple, there's less chance of inconsistency if you seperate the setting of attributes from the code which does the actual work. The stack is "self cleansing".
People expect that when they write "try { Foo(); } finally { Bar(); }" that nothing runs between Foo and Bar. But this is not true; if your caller added an exception filter, and there is no intervening 'catch', and Foo() throws, then some other random code from your caller will run before your finally (Bar) runs. This is very bad if you've broken invariants or elevated security, expecting that they'll be 'immediately' restored to normal by the finally and no other code will see the temporary change.
P
Peter Mortensen

It depends what you are doing in the catch block, and if you are wanting to pass the error on to the calling code or not.

You might say Catch io.FileNotFoundExeption ex and then use an alternative file path or some such, but still throw the error on.

Also doing Throw instead of Throw Ex allows you to keep the full stack trace. Throw ex restarts the stack trace from the throw statement (I hope that makes sense).


S
Sheff

In the example in the code you have posted there is, in fact, no point in catching the exception as there is nothing done on the catch it is just re-thown, in fact it does more harm than good as the call stack is lost.

You would, however catch an exception to do some logic (for example closing sql connection of file lock, or just some logging) in the event of an exception the throw it back to the calling code to deal with. This would be more common in a business layer than front end code as you may want the coder implementing your business layer to handle the exception.

To re-iterate though the There is NO point in catching the exception in the example you posted. DON'T do it like that!


佚名

Sorry, but many examples as "improved design" still smell horribly or can be extremely misleading. Having try { } catch { log; throw } is just utterly pointless. Exception logging should be done in central place inside the application. exceptions bubble up the stacktrace anyway, why not log them somewhere up and close to the borders of the system?

Caution should be used when you serialize your context (i.e. DTO in one given example) just into the log message. It can easily contain sensitive information one might not want to reach the hands of all the people who can access the log files. And if you don't add any new information to the exception, I really don't see the point of exception wrapping. Good old Java has some point for that, it requires caller to know what kind of exceptions one should expect then calling the code. Since you don't have this in .NET, wrapping doesn't do any good on at least 80% of the cases I've seen.


Thank you for your thought Joe. In Java (and C#, I suppose) I would love to see a class-level annotation @FaultBoundary which forces ALL exceptions (including unchecked exception-types) to be caught-or-declared-to-be-thrown. I would use this annotation on public interfaces of each architectural layer. So the @FaultBoundary ThingDAO interface would not be able to leak implementation details such as SQLExceptions, NPE's, or AIOB's. Instead "causal" stacktrace would be logged and a DAOSystemException would be thrown... I define System exception as "permanently fatal".
There are plenty of reasons to catch, log, then rethrow. Specifically if the method with the catch log has information you lose once you're out of the method. The error may be handled later but not logged, and you've lost information about defects in the system.
This is where the Data property of the Exception class is handy -- capturing all that local information for generic logging. This article originally brought it to my attention: blog.abodit.com/2010/03/…
C
Community

In addition to what the others have said, see my answer to a related question which shows that catching and rethrowing is not a no-op (it's in VB, but some of the code could be C# invoked from VB).


While this link may answer the question, it is better to include the essential parts of the answer here and provide the link for reference. Link-only answers can become invalid if the linked page changes. - From Review
@HamzaLH, I agree that it is not a well written answer, but it has information, different to other answers and positive votes. So I don’t understand, why you suggest to delete it? “Short answers that are on topic and give a solution are still answers.” From meta.stackexchange.com/questions/226258/…
this is link-only answer
1. Link-only answers should be change to comments, not deleted. 2. It’s a reference to other SO question, not to external site, which considered less likely to be broken over time. 3. It has some extra description, which make it not “link only” - see meta.stackexchange.com/questions/225370/…
M
Michael Freidgeim

Most of answers talking about scenario catch-log-rethrow.

Instead of writing it in your code consider to use AOP, in particular Postsharp.Diagnostic.Toolkit with OnExceptionOptions IncludeParameterValue and IncludeThisArgument


While this link may answer the question, it is better to include the essential parts of the answer here and provide the link for reference. Link-only answers can become invalid if the linked page changes. - From Review
@TonyDong, I agree that it is not a well written answer, but it has information, different to other answers and positive votes. So I don’t understand, why you suggest to delete it? BTW, the link 5 years later is still valid. “Short answers that are on topic and give a solution are still answers.” From meta.stackexchange.com/questions/226258/…
Stackoverflow only has this suggestion.
@TonyDong, if the answer is not absolutely useless, you should choose “Looks OK”
A
Arsen Khachaturyan

Rethrowing exceptions via throw is useful when you don't have a particular code to handle current exceptions, or in cases when you have a logic to handle specific error cases but want to skip all others.

Example:

string numberText = "";
try
{
    Console.Write("Enter an integer: ");
    numberText = Console.ReadLine();
    var result = int.Parse(numberText);

    Console.WriteLine("You entered {0}", result);
}
catch (FormatException)
{
    if (numberText.ToLowerInvariant() == "nothing")
    {
        Console.WriteLine("Please, please don't be lazy and enter a valid number next time.");
    }
    else
    {
        throw;
    }
}    
finally
{
    Console.WriteLine("Freed some resources.");
}
Console.ReadKey();

However, there is also another way of doing this, using conditional clauses in catch blocks:

string numberText = "";
try
{
    Console.Write("Enter an integer: ");
    numberText = Console.ReadLine();
    var result = int.Parse(numberText);

    Console.WriteLine("You entered {0}", result);
}
catch (FormatException) when (numberText.ToLowerInvariant() == "nothing")
{
    Console.WriteLine("Please, please don't be lazy and enter a valid number next time.");
}    
finally
{
    Console.WriteLine("Freed some resources.");
}
Console.ReadKey();

This mechanism is more efficient than re-throwing an exception because of the .NET runtime doesn’t have to rebuild the exception object before re-throwing it.