Good architecture and solution structure Cheat Sheet

by Skepticoder via cheatography.com/144584/cs/31050/

DATABASE DAO CLASSES SHOULD HAVE (cont)

Create tables with good names (singular and often similar to domain update​(model object)
model class names) delete​(model object)
Use good column names (singular, with only standard abbrev​iations
the extra "​cru​d" methods
in the names
`delet​eBy​Id(int id) (or other name for key column: delete​ByA​cco​unt​‐
Normalize DB to 3rd normal form
Number, etc.) - findBy​Par​tOf​Nam​e(S​tring partOf​Name) (or other
Add foreign key and unique constr​aints searchable attribute)
Use IDENTITY (autog​ene​rated keys) on surrogate key columns (or other
findBy​Par​tOf​Nam​e(S​tring partOf​Name)
Implement robust cascading update​/delete choices on foreign key searchable attribute)
constr​aints for refere​ntial integrity transa​ctions wherever you need to do two or more operations as a
Add good denorm​ali​zation choices for speeding up working with the unit: e.g.
DB read inventory count and place order if product is available

move assets (e.g. funds from one account to another)

DATA ACCESS LAYER
update denorm​alized values (e.g. a number​OfLikes column, which
Add a DAO interface per database table with the CRUD actions stores the number of likes in the like table for fast access)
needed
Proper transa​ction structure with a
Add a concrete implem​ent​ation of each DAO interface (prefe​rably in
(C#)/setAut​oCo​mmi​t(f​alse)
beginT​ran​sac​tion()
a packag​e/n​ame​space that designates the persis​tence layer brand,
(Java)
i.e. MSSQL, MySQL, Oracle)
commit() at the end of the "​try..."​ which contains the CRUD code
Add a DAO factory which can provide instances of the DAO classes
for the contro​llers through static methods (e.g. public static a rollback() in the "​cat​ch..."
Custom​erDao getCus​tom​erDao()) any cleaning up (Conne​cti​on.s​et​Aut​oCo​mmi​t(f​alse), etc.) in the "​fin​‐
Add a Dataco​ntext class with a static method which can provide a all​y..."
Connection object (e.g. getObj​ect()method) for use by the DAO Check for the number of rows affected on updates (UPDATE,
classes INSERT, DELETE) and throw an Exception if necessary with a good

Add a unique database login (prefe​rable Active Directory account for exception message (e.g. "​Unknown error. Account number 354 was

Windows authen​tic​ation or non-SA for SQL logins) with only minimal not delete​d.").

permis​sions necessary (e.g. dbread​er/​dbw​riter) on the relevant try-catch code which rethrows any exceptions that happen while
DB/tables intera​cting with the database, with a message about what was
attempted when the exception happened plus the original exception.
MODEL LAYER

Mimic the database tables' structure with regards to naming and data
types (often one model class per table)
Add a good toString() method to your model classes for debugg​‐
ing​/vi​sua​lizing object state
Use good encaps​ulation (espec​ially of collec​tions) so you can
change the underlying data structure without changing the interface
Code good constr​uctors which ensure you can't instan​tiate objects in
an invalid state

DAO CLASSES SHOULD HAVE

a helper method for converting a single row in a ResultSet to an
object
a helper method which converts an entire ResultSet to a List of
objects reusing the above method
the 5 basic CRUD methods
getAll()

getByI​d(int id)(or other name for key column, getByS​‐

SN(ssn), etc.)

insert​(model object)

By Skepticoder Not published yet. Sponsored by ApolloPad.com

Last updated 6th March, 2022. Everyone has a novel in them. Finish
Page 1 of 2. Yours!
https://apollopad.com
cheatography.com/skepticoder/