The misunderstanding and experience summary of Java exception handling--Reprint

This article emphatically introduced the Java exception choice and the use of some misunderstandings, I hope you can master the exception handling some of the points of attention and principles, pay attention to summary and induction. Only when the exception is handled, can we improve the basic literacy of the developers, improve the robustness of the system, enhance the user experience and improve the value of the product.

Misunderstanding one, the choice of anomalies Figure 1. Exception classification

Figure 1 describes the structure of the anomaly, in fact, we all know the anomaly detection anomaly and non-detection anomaly, but in practice, but also confused the application of these two anomalies. Because of the ease of use of non-detection anomalies, many developers consider it useless to detect anomalies. In fact, abnormal application scenarios can be summarized as follows:

One, the calling code cannot continue execution and needs to be terminated immediately. There are too many possibilities for this, such as server connections, incorrect parameters, and so on. This applies to non-detection exceptions, does not require explicit capture and processing of the calling code, and the code is straightforward.

Second, the calling code needs to be further processed and resumed. If SQLException is defined as a non-detection exception, the developer takes the data for granted that the SQLException does not require explicit capture and processing of the calling code, which in turn leads to serious Connection not shutting down, Transaction not rolling back, DB such as dirty data in the SQLException is defined as a detection exception that drives the developer to explicitly capture and cleans up resources after the code generates an exception. Of course, after cleaning up the resources, you can continue to throw non-detection exceptions to prevent the execution of the program. Based on observation and understanding, detection anomalies can be applied to tool classes in most cases.

Back to top of page

Misunderstanding two, the exception is displayed directly on the page or client.

The example of printing an exception directly on the client is common, with JSP as an example, and by default the container prints the exception stack information directly on the page, once the code is running abnormally. In fact, from the customer's point of view, any exception has no practical significance, the vast majority of customers also do not understand the abnormal information, software development should try to avoid the exception directly to the user.

Listing 1

Package com.ibm.dw.sample.exception;/** * Custom RuntimeException * Add error code Properties */public Class RuntimeException extends java.la Ng. runtimeexception {      //Default error code public     static final Integer GENERIC = 1000000;     Error code    private Integer ErrorCode;      Public RuntimeException (Integer ErrorCode, throwable cause) {This            (ErrorCode, NULL, cause);     }     Public runtimeexception (String message, throwable cause) {            //Take advantage of the generic error code this            (GENERIC, message, cause);     }     Public RuntimeException (Integer errorCode, String message, Throwable cause) {            Super (message, cause);            This.errorcode = ErrorCode;     }     Public Integer GetErrorCode () {            return errorCode;     }}

As the sample code shows, introducing an error code into the exception, once an exception occurs, we simply present the exception's error code to the user, or convert the error code to a more understandable hint. In fact, the error code here also contains another function, the developer can also be based on the error code to know exactly what type of exception occurred.

Back to top of page

Misunderstanding three, the pollution of the Code hierarchy structure

We often divide the code into different hierarchies, such as Service, Business Logic, and DAO, and the DAO layer contains methods for throwing exceptions, as shown in Listing 2:

Listing 2

Public Customer Retrievecustomerbyid (Long id) throw SQLException {//query database by ID}

The above code is not a problem at all, but from the design coupling point of view, here SQLException pollution to the upper calling code, the call layer needs to explicitly use the Try-catch capture, or further to the upper layer of the throw. According to the design isolation principle, we can modify it appropriately to:

Listing 3

Public Customer Retrievecustomerbyid (Long id) {     try{            //query database by ID     }catch (SQLException e) {            // Detecting anomalies with non-detection anomaly encapsulation, reducing the level coupling            throw new RuntimeException (Sqlerrorcode, E);     } finally{            //close connection, clean up resources     }}

Back to top of page

Misunderstanding four, ignoring exceptions

The exception handling below simply outputs the exception to the console, without any meaning. And there's an exception here that doesn't interrupt the program, and the calling code continues execution, causing more exceptions.

Listing 4

public void Retrieveobjectbyid (Long id) {   try{       //. Some code that throws SQLException    }catch (SQLException ex) {     /**       * Know everyone knows that abnormal printing here is meaningless, just output the error stack to the console.       * In the Production environment, the error stack needs to be output to the log.       * And after the catch is processed, the program continues to execute, which can cause further problems *                 /Ex.printstacktrace ();}     }

Can be re-formed:

Listing 5

public void Retrieveobjectbyid (Long id) {try{    //. Some code, throws SQLException} catch (SQLException ex) {    throw new RuntimeException ("Exception in RETIEVEOBJECTB Yid ", ex); } finally{    //clean up resultset, statement, Connection etc}}

This misunderstanding is relatively basic, the general situation will not make this low-level error?

Back to top of page

Error five, the exception is included in the LOOP statement block

The exception is included in the For Loop statement block, as shown in the following code.

Listing 6

for (int i=0; i<100; i++) {    try{    }catch (xxxexception e) {         //...    }}

We all know that exception handling consumes system resources. At first glance, we all think we will not make such a mistake. At a different angle, a loop is executed in class A, and the method of Class B is called, and the method called in Class B contains a block of statements such as Try-catch. Fade the hierarchy of classes, and the code is the same as above.

Back to top of page

Misunderstanding six, using Exception to capture all potential anomalies

Several different types of exceptions are thrown during a method execution, and for the sake of brevity, the base class Exception captures all potential exceptions, as shown in the following example:

Listing 7

public void Retrieveobjectbyid (Long id) {    try{        //... Throw IOException Code Call        //... The code that throws SQLException calls    }catch (Exception e) {        //Here takes advantage of all potential exceptions captured by the base class Exception, and if multiple levels are captured like this, the valid information of the original exception is lost        throw New RuntimeException ("Exception in Retieveobjectbyid", e);}    }

Can be re-formed

Listing 8

Click to view the code listing

Back to top of page

Error seven, multi-level encapsulation throws non-detection exception

If we keep insisting that different types of exceptions must use different capture statements, then most of the examples can bypass this section. However, if a single code call throws more than one exception, it is often not necessary to write a catch statement for each of the different types of Exception, and for development, any exception is sufficient to illustrate the specific problem of the program.

Listing 9

try{    //May throw runtimeexception, ioexeption or other;    //Note here and the misunderstanding six difference, here is a piece of code throws a variety of exceptions. The above is a multi-segment code, each throw a different exception}catch (Exception e) {    ///, as always, will Exception converted to RuntimeException, but here the E is actually runtimeexception instance, The    throw new RuntimeException (/**/code,/**/, E) has been encapsulated in the previous code;}

If we convert all the Exception to RuntimeException as shown in the example above, then when the Exception type is already runtimeexception, we do a package again. The runtimeexception was re-encapsulated once, thus losing the valid information that the original runtimeexception carried.

The workaround is that we can add the relevant checks in the RuntimeException class to confirm that the parameter throwable is not an instance of RuntimeException. If it is, the corresponding property is copied to the newly created instance. or capture RuntimeException and other Exception with different catch statement blocks. Personal Preference Mode One, the benefits are self-evident.

Back to top of page

Misunderstanding eight, multi-level printing anomalies

Let's take a look at the following example, which defines 2 classes A and B. Where Class A calls the code for Class B, and the Class A and Class B catch print exceptions.

Listing 10

public class A {private static Logger Logger = Loggerfactory.getlogger (a.class), public void process () {     try{     ///instance Class B, can be replaced by other injection and other methods     b b = new B ();     B.process ();     Other code might cause exception    } catch (Xxxexception e) {       //If the class B process method throws an exception, the exception is printed in Class B and will be printed here, which will print 2 Sub       -Logger.error (e);       throw new RuntimeException (/* ERROR code */ErrorCode,/* Exception information */msg, e);}}}    public class b{private static Logger Logger = Loggerfactory.getlogger (b.class);    public void process () {        try{            //May throw exception code        }        catch (Xxxexception e) {            logger.error (e);            throw new RuntimeException (/* ERROR code */ErrorCode,/* Exception information */msg, e);        } }}

The same exception will be printed 2 times. If the level is a little more complicated, not to consider the performance of the print log consumption of the system, only in the Exception log to locate the exception specific problems have enough headaches.

In fact, the print log only needs to capture print on the outermost layer of the Code, and exception printing can also be written as AOP, woven into the outermost layer of the frame.

Back to top of page

Misunderstanding nine, the information contained in the exception can not adequately locate the problem

Exceptions not only allow developers to know what is wrong, but more often developers need to know what causes the problem, and we know java. lang. Exception has a constructor method for string type parameters, which can be customized to be easily understandable.

Simple custom information developers can only know where an exception has occurred, but in many cases, developers need to know what parameters are causing such an exception. At this point we need to append the parameter information of the method invocation to the custom information. The following example only lists the case of a parameter, where multiple parameters can be written in a single tool class to organize such a string.

Listing 11

public void Retieveobjectbyid (Long id) {    try{        //. Some code that throws SQLException   }catch (SQLException ex) {        //Add the parameter information to the exception information in the        throw new RuntimeException (" Exception in Retieveobjectbyid with Object ID: "+ ID, ex);}   }

Back to top of page

Error ten, can not predict the potential anomalies

In the process of writing code, because of the lack of a deep understanding of the calling code, it is not possible to accurately determine whether the calling code produces an exception and therefore ignores processing. After the Production Bug is created, you should add an exception catch at a certain code point and not even pinpoint the cause of the exception. This requires the developer not only to know what they are doing, but also to know as much as possible what others have done, what results may result, and to consider the whole process of the application from the global. These ideas can affect the writing and processing of our code.

Back to top of page

Misunderstanding Xi. mixed use of a variety of third-party log libraries

Today there are more and more types of third-party log libraries in Java, and a large project introduces a variety of frameworks that rely on the implementation of different log libraries. The most troublesome problem is not the introduction of all the required log libraries, the problem is that the imported log libraries are inherently incompatible. If this is possible at the beginning of the project, you can re-introduce all the log libraries in your code as needed, or change the framework. But such costs are not borne by each project, and the greater the risk is as the project progresses.

How to effectively avoid similar problems, most of the current framework has taken into account a similar problem, you can configure the Properties or XML files, parameters, or run-time scanning Lib Library of the log implementation class, really in the application run time to determine the specific application of the specific log library.

In fact, based on the principle of not requiring a multi-level print log, we can simplify many of the classes that originally called the Log Print code. In many cases, we can use interceptors or filters to achieve log printing, reducing the cost of code maintenance and migration.

Back to top of page

Conclusion

The above is purely personal experience and summary, things are dialectical, there is no absolute principle, suitable for their own is the most effective principle. I hope the above explanation and analysis can be helpful to you.

Original: http://www.ibm.com/developerworks/cn/java/j-lo-exception-misdirection/

The misunderstanding and experience summary of Java exception handling--Reprint