Code Best Practices

Goal: Technical

Sponsor: Trek Global

Description:

Findbugs

Cases applied to Idempiere:

• Dead store to local variable.

• BigDecimal constructed from double that isn't represented precisely.

• Possible null pointer dereference.

• Nullcheck of value previously dereferenced.

• Method may fail to close database resource.

• Method may fail to close stream.

• Unread field: should this field be static?.

• Should be a static inner class.

• Possible null pointer dereference in method on exception path.

• Integral division result cast to double or float.

• Nonconstant string passed to execute method on an SQL statement.

• Non-transient non-serializable instance field in serializable class.

• Method might ignore exception.

• Class defines equals() and uses Object.hashCode().

• Nullcheck of value previously dereferenced.

• Incorrect lazy initialization and update of static field.

• Null pointer dereference.

• Impossible downcast of toArray() resul.

• Exception created and dropped rather than thrown.

• Very confusing method names.

• No relationship between generic parameter and method argument.

• Call to equals() comparing different types.

• Method concatenates strings using + in a loop.

• Potentially dangerous use of non-short-circuit logic.

• Redundant nullcheck of value known to be non-null.

fb-contrib

fb-contrib™ is an extra detector plugin to be used with the static bug finder FindBugs™.

• LSYC_LOCAL_SYNCHRONIZED_COLLECTION.

• PRMC_POSSIBLY_REDUNDANT_METHOD_CALLS.

• EXS_EXCEPTION_SOFTENING_NO_CONSTRAINTS.

Solve eclipse warnings

• Deprecation

• Type Generic

• Unused Code

• Type Safety

The finally Block

The finally block always executes when the try block exits. This ensures that the finally block is executed even if an unexpected exception occurs. more.

it is good practice to free the resources using the finally block.

Make iDempiere safer using saveEx instead of save

To make iDempiere safer is better to replace all unattended save calls with saveEx.

Performance improvements

Technical Info: IDEMPIERE-37 IDEMPIERE-455 IDEMPIERE-568

Performance: IDEMPIERE-144 IDEMPIERE-145 IDEMPIERE-146 IDEMPIERE-174 IDEMPIERE-175 IDEMPIERE-308 IDEMPIERE-312 IDEMPIERE-314

---

Source: Wiki