SAP CLEANUP - Guide

Get Example source ABAP code based on a different SAP table

GUIDELINE 5.14

Cleanups After Exceptions

ABAP_BACKGROUND
Every TRY control structure can contain a CLEANUP block. If a class-based exception occurs in the TRY block of the same TRY control structure, but is handled in a CATCH block of an external TRY control structure, the CLEANUP block is executed before the context of the exception is deleted. Therefore, when a handler is executed the CLEANUP blocks of all TRY control structures that have been unsuccessfully searched for a handler up until that point are executed from the inside out.
The BEFORE UNWIND addition for the CATCH statement determines whether execution takes place before or after handling. However, the CLEANUP blocks are not executed if RESUME is used during exception handling to restart in the context of the exception.

ABAP_RULE
Cleanup Before Forwarding
Before forwarding an exception to higher-level call layers, perform the necessary cleanups in the CLEANUP block.

ABAP_DETAILS
Each exception changes the program flow and can thus pose a significant risk to the consistency of an application. If you decide not to handle an exception, but to forward it, you must make sure that you leave the current software layer in a consistent state. You can implement the CLEANUP block in this case, to execute cleanups before the exception is forwarded to higher-level software layers.

Bad Example
The following source code shows the forwarding of an exception without first explicitly closing an open resource (in this case a database cursor). The closing of the database cursor is implicitly delegated to any exception handler. TRY.
OPEN CURSOR db_cursor
FOR SELECT ...
...
CATCH cx_sy_sql_error INTO exc.
RAISE EXCEPTION TYPE cx_persistency_error
EXPORTING previous = exc.
ENDTRY.

Good Example
The following source code shows the same example as above, but the database cursor is closed in the CLEANUP block. TRY.
OPEN CURSOR db_cursor
FOR SELECT ...
...
CATCH cx_sy_sql_error INTO exc.
RAISE EXCEPTION TYPE cx_persistency_error
EXPORTING previous = exc.
CLEANUP.
CLOSE CURSOR db_cursor.
ENDTRY.