\documentclass[10pt,a4paper]{article} % Packages \usepackage{fancyhdr} % For header and footer \usepackage{multicol} % Allows multicols in tables \usepackage{tabularx} % Intelligent column widths \usepackage{tabulary} % Used in header and footer \usepackage{hhline} % Border under tables \usepackage{graphicx} % For images \usepackage{xcolor} % For hex colours %\usepackage[utf8x]{inputenc} % For unicode character support \usepackage[T1]{fontenc} % Without this we get weird character replacements \usepackage{colortbl} % For coloured tables \usepackage{setspace} % For line height \usepackage{lastpage} % Needed for total page number \usepackage{seqsplit} % Splits long words. %\usepackage{opensans} % Can't make this work so far. Shame. Would be lovely. \usepackage[normalem]{ulem} % For underlining links % Most of the following are not required for the majority % of cheat sheets but are needed for some symbol support. \usepackage{amsmath} % Symbols \usepackage{MnSymbol} % Symbols \usepackage{wasysym} % Symbols %\usepackage[english,german,french,spanish,italian]{babel} % Languages % Document Info \author{Skepticoder} \pdfinfo{ /Title (good-architecture-and-solution-structure.pdf) /Creator (Cheatography) /Author (Skepticoder) /Subject (Good architecture and solution structure Cheat Sheet) } % Lengths and widths \addtolength{\textwidth}{6cm} \addtolength{\textheight}{-1cm} \addtolength{\hoffset}{-3cm} \addtolength{\voffset}{-2cm} \setlength{\tabcolsep}{0.2cm} % Space between columns \setlength{\headsep}{-12pt} % Reduce space between header and content \setlength{\headheight}{85pt} % If less, LaTeX automatically increases it \renewcommand{\footrulewidth}{0pt} % Remove footer line \renewcommand{\headrulewidth}{0pt} % Remove header line \renewcommand{\seqinsert}{\ifmmode\allowbreak\else\-\fi} % Hyphens in seqsplit % This two commands together give roughly % the right line height in the tables \renewcommand{\arraystretch}{1.3} \onehalfspacing % Commands \newcommand{\SetRowColor}[1]{\noalign{\gdef\RowColorName{#1}}\rowcolor{\RowColorName}} % Shortcut for row colour \newcommand{\mymulticolumn}[3]{\multicolumn{#1}{>{\columncolor{\RowColorName}}#2}{#3}} % For coloured multi-cols \newcolumntype{x}[1]{>{\raggedright}p{#1}} % New column types for ragged-right paragraph columns \newcommand{\tn}{\tabularnewline} % Required as custom column type in use % Font and Colours \definecolor{HeadBackground}{HTML}{333333} \definecolor{FootBackground}{HTML}{666666} \definecolor{TextColor}{HTML}{333333} \definecolor{DarkBackground}{HTML}{1D8A07} \definecolor{LightBackground}{HTML}{F7FBF7} \renewcommand{\familydefault}{\sfdefault} \color{TextColor} % Header and Footer \pagestyle{fancy} \fancyhead{} % Set header to blank \fancyfoot{} % Set footer to blank \fancyhead[L]{ \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{C} \SetRowColor{DarkBackground} \vspace{-7pt} {\parbox{\dimexpr\textwidth-2\fboxsep\relax}{\noindent \hspace*{-6pt}\includegraphics[width=5.8cm]{/web/www.cheatography.com/public/images/cheatography_logo.pdf}} } \end{tabulary} \columnbreak \begin{tabulary}{11cm}{L} \vspace{-2pt}\large{\bf{\textcolor{DarkBackground}{\textrm{Good architecture and solution structure Cheat Sheet}}}} \\ \normalsize{by \textcolor{DarkBackground}{Skepticoder} via \textcolor{DarkBackground}{\uline{cheatography.com/144584/cs/31050/}}} \end{tabulary} \end{multicols}} \fancyfoot[L]{ \footnotesize \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{LL} \SetRowColor{FootBackground} \mymulticolumn{2}{p{5.377cm}}{\bf\textcolor{white}{Cheatographer}} \\ \vspace{-2pt}Skepticoder \\ \uline{cheatography.com/skepticoder} \\ \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Cheat Sheet}} \\ \vspace{-2pt}Not Yet Published.\\ Updated 6th March, 2022.\\ Page {\thepage} of \pageref{LastPage}. \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Sponsor}} \\ \SetRowColor{white} \vspace{-5pt} %\includegraphics[width=48px,height=48px]{dave.jpeg} Measure your website readability!\\ www.readability-score.com \end{tabulary} \end{multicols}} \begin{document} \raggedright \raggedcolumns % Set font size to small. Switch to any value % from this page to resize cheat sheet text: % www.emerson.emory.edu/services/latex/latex_169.html \footnotesize % Small font. \begin{multicols*}{2} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{DATABASE}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{Create tables with good names (singular and often similar to domain model class names)} \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{Use good column names (singular, with only standard abbreviations in the names} \tn % Row Count 4 (+ 2) % Row 2 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{Normalize DB to 3rd normal form} \tn % Row Count 5 (+ 1) % Row 3 \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{Add foreign key and unique constraints} \tn % Row Count 6 (+ 1) % Row 4 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{Use IDENTITY (autogenerated keys) on surrogate key columns} \tn % Row Count 8 (+ 2) % Row 5 \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{Implement robust cascading update/delete choices on foreign key constraints for referential integrity} \tn % Row Count 11 (+ 3) % Row 6 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{Add good denormalization choices for speeding up working with the DB} \tn % Row Count 13 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{DATA ACCESS LAYER}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{Add a DAO interface per database table with the CRUD actions needed} \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{Add a concrete implementation of each DAO interface (preferably in a package/namespace that designates the persistence layer brand, i.e. MSSQL, MySQL, Oracle)} \tn % Row Count 6 (+ 4) % Row 2 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{Add a DAO factory which can provide instances of the DAO classes for the controllers through static methods (e.g. `public static CustomerDao getCustomerDao()`)} \tn % Row Count 10 (+ 4) % Row 3 \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{Add a Datacontext class with a static method which can provide a Connection object (e.g. `getObject()` method) for use by the DAO classes} \tn % Row Count 13 (+ 3) % Row 4 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{Add a unique database login (preferable Active Directory account for Windows authentication or non-SA for SQL logins) with only minimal permissions necessary (e.g. dbreader/dbwriter) on the relevant DB/tables} \tn % Row Count 18 (+ 5) \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{8.4cm}}{\bf\textcolor{white}{MODEL LAYER}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{Mimic the database tables' structure with regards to naming and data types (often one model class per table)} \tn % Row Count 3 (+ 3) % Row 1 \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{Add a good toString() method to your model classes for debugging/visualizing object state} \tn % Row Count 5 (+ 2) % Row 2 \SetRowColor{LightBackground} \mymulticolumn{1}{x{8.4cm}}{Use good encapsulation (especially of collections) so you can change the underlying data structure without changing the interface} \tn % Row Count 8 (+ 3) % Row 3 \SetRowColor{white} \mymulticolumn{1}{x{8.4cm}}{Code good constructors which ensure you can't instantiate objects in an invalid state} \tn % Row Count 10 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{8.4cm}{p{0.8 cm} x{7.2 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{DAO CLASSES SHOULD HAVE}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{a helper method for converting a single row in a ResultSet to an object} \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} \mymulticolumn{2}{x{8.4cm}}{a helper method which converts an entire ResultSet to a List of objects reusing the above method} \tn % Row Count 4 (+ 2) % Row 2 \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{the 5 basic CRUD methods} \tn % Row Count 5 (+ 1) % Row 3 \SetRowColor{white} & `getAll()` \tn % Row Count 6 (+ 1) % Row 4 \SetRowColor{LightBackground} & `getById(int id)` (or other name for key column, `getBySSN(ssn)`, etc.) \tn % Row Count 8 (+ 2) % Row 5 \SetRowColor{white} & `insert(model object)` \tn % Row Count 9 (+ 1) % Row 6 \SetRowColor{LightBackground} & `update(model object)` \tn % Row Count 10 (+ 1) % Row 7 \SetRowColor{white} & `delete(model object)` \tn % Row Count 11 (+ 1) % Row 8 \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{the extra "crud" methods} \tn % Row Count 12 (+ 1) % Row 9 \SetRowColor{white} & `deleteById(int id) (or other name for key column: deleteByAccountNumber, etc.) - findByPartOfName(String partOfName) (or other searchable attribute) \tn % Row Count 17 (+ 5) % Row 10 \SetRowColor{LightBackground} & `findByPartOfName(String partOfName)` (or other searchable attribute) \tn % Row Count 19 (+ 2) % Row 11 \SetRowColor{white} \mymulticolumn{2}{x{8.4cm}}{transactions wherever you need to do two or more operations as a unit: e.g.} \tn % Row Count 21 (+ 2) % Row 12 \SetRowColor{LightBackground} & read inventory count and place order if product is available \tn % Row Count 23 (+ 2) % Row 13 \SetRowColor{white} & move assets (e.g. funds from one account to another) \tn % Row Count 25 (+ 2) % Row 14 \SetRowColor{LightBackground} & update denormalized values (e.g. a numberOfLikes column, which stores the number of likes in the like table for fast access) \tn % Row Count 29 (+ 4) % Row 15 \SetRowColor{white} \mymulticolumn{2}{x{8.4cm}}{Proper transaction structure with a} \tn % Row Count 30 (+ 1) \end{tabularx} \par\addvspace{1.3em} \vfill \columnbreak \begin{tabularx}{8.4cm}{p{0.8 cm} x{7.2 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{8.4cm}}{\bf\textcolor{white}{DAO CLASSES SHOULD HAVE (cont)}} \tn % Row 16 \SetRowColor{LightBackground} & `beginTransaction()` \seqsplit{(C\#)/`setAutoCommit(false)`} (Java) \tn % Row Count 2 (+ 2) % Row 17 \SetRowColor{white} & `commit()` at the end of the "try..." which contains the CRUD code \tn % Row Count 4 (+ 2) % Row 18 \SetRowColor{LightBackground} & a `rollback()` in the "catch..." \tn % Row Count 5 (+ 1) % Row 19 \SetRowColor{white} & any cleaning up \seqsplit{(Connection.setAutoCommit(false)}, etc.) in the "finally..." \tn % Row Count 8 (+ 3) % Row 20 \SetRowColor{LightBackground} \mymulticolumn{2}{x{8.4cm}}{Check for the number of rows affected on updates (UPDATE, INSERT, DELETE) and throw an Exception if necessary with a good exception message (e.g. "Unknown error. Account number 354 was not deleted.").} \tn % Row Count 12 (+ 4) % Row 21 \SetRowColor{white} \mymulticolumn{2}{x{8.4cm}}{try-catch code which rethrows any exceptions that happen while interacting with the database, with a message about what was attempted when the exception happened plus the original exception.} \tn % Row Count 16 (+ 4) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} % That's all folks \end{multicols*} \end{document}