Better Living through Better Code’s
Organized Thought Paradigm

We will be exploring a collection of Design Principles and Design Patterns that work together as a Single Organized Thought Paradigm:

Successfully Processing a Client’s Request by
Returning a Robust Response Object
within a Stateless Web Environment

The Science we will be using in this series is ASP.NET 4.5 and the C# Object Oriented Programming Language.

This series targets a recurring problem in designing and developing great code for Web Clients:

How to create a Bulletproof, Scalable,
and Extensible Stateless Information Exchange Process

Each article in this series will be supporting the ability for a Web Client, to REQUEST Information in Serialized JSON and receive a RESPONSE in Serialized JSON or HTML.

A Web Client is defined as a Native or Hybrid Mobile Application, an Application Server using Microservices or a Single Page Application using the Web Browsers.

The Series Article Posts:

1. The Command Query Separation Design Pattern

   1. What CQS pattern solves

   2. When to use CQS

   3. How CQS is used in this series

2. The Request/Response Design Pattern

   1. What the Request/Response Design Pattern solves

   2. What are the Request/Response Design Pattern components

      1. Feature Request and Response DTOs

         1. CodeMessagesRequestDTO

         2. CodeMessagesResponseDTO

      2. Request and Response Common Base DTOs

         1. BaseRequestDTO

         2. BaseResponseDTO

      3. Web State Common Request and Response DTOs

         1. BaseStateRequestDTO

         2. BaseStateResponseDTO 

      4. Error Handling Response State: The Response Packing List

         1. ErrorCommonDTO

         2. IErrorCommon

         3. ILogger

         4. IMessaging

   3. How is the  Request/Response Design Pattern is used in this series

4. The Error Handling, Logging and Messaging Pattern

   1. What this pattern solves

   2. What are the pattern components

      1. IErrorCommon

      2. ILogger

      3. IMessaging

   3. How this pattern is used in this series

5. The Onion Layer Pattern

   1. What this pattern solves

   2. What are the pattern components

      1. Services

      2. Factories

   3. How this pattern is used in this series

The main attention of this series is focused on the Request/Response pattern as it encompasses all of the above patterns and base principles.

Each component will be demonstrated in real working best practice C# 4.51 code created using the Test First Principle. All Code Test Suites will be available as well.

All Software Developers are Artists!!!

… Some are Really Good Artists

…… And Some are Really Bad Artists

BUT All Software Developers are Artists!!!

Better Living through Better Code’s
Organized Thought Paradigm

We will be exploring a collection of Design Principles and Design Patterns that work together as a Single Organized Thought Paradigm:

Successfully Processing a Client’s Request by
Returning a Robust Response Object
within a Stateless Web Environment

The Science we will be using in this series is ASP.NET 4.5 and the C# Object Oriented Programming Language.

The Artist Palette will include the following Tools:

1. Visual Studio 2012 as the Integrated Development Environment (IDE) 

2. MS Test as the Unit and Integration Test Suite Framework

3. SQL Server 2012 for Data Persistence

4. Entity Framework 6 as a ORM Data Access Layer (DAL)

5. Unity 3 for the Object Management Factory Inversion of Control Container (IOC)

6. MS Test as the Unit and Integration Test Suite Framework

The Palette will also include these Design Principles:

1. Single Responsibility Principle (SRP) 

2. Open / Closed Principle (OCP)

3. Dependency Inversion Principle (DIP)

   1. Dependency Injection: DI

   2. Object Factories: IOC

4. Don’t Repeat Yourself Principle (DRY)

5. Inversion Of Control Principle (IOCP)

6. Data Transfer Object Role Principle (DTORP)

   1. Request / Response Complex Data Transfer Objects: DTOs

   2. State Management and Error Reporting: The Response Package “Packing List”

7. Test First Principle (TFP)

   1. RED, GREEN and REFACTORING

   2. Acceptance Criteria Defined in the Gherkin Language Syntax

Adding these Design Patterns to Complete the Palette:

1. Request / Response Design Pattern 

2. Command Query Separation Pattern: CQS

3. The Onion Layer Pattern

4. The Error Handling Extension Pattern: IErrorCommon

5. The Data Access Extension Pattern: IDataAccess

6. Error & Information Database Messaging Pattern: IMessaging

The Artist Palette will include the following Tools:

1. Visual Studio 2012 as the Integrated Development Environment (IDE) 

2. MS Test as the Unit and Integration Test Suite Framework

3. SQL Server 2012 for Data Persistence

4. Entity Framework 6 as a ORM Data Access Layer (DAL)

5. Unity 3 for the Object Management Factory Inversion of Control Container (IOC)

6. MS Test as the Unit and Integration Test Suite Framework

The Palette will also include these Design Principles:

1. Single Responsibility Principle (SRP) 

2. Open / Closed Principle (OCP)

3. Dependency Inversion Principle (DIP)

   1. Dependency Injection: DI

   2. Object Factories: IOC

4. Don’t Repeat Yourself Principle (DRY)

5. Inversion Of Control Principle (IOCP)

6. Data Transfer Object Role Principle (DTORP)

   1. Request / Response Complex Data Transfer Objects: DTOs

   2. State Management and Error Reporting: The Response Package “Packing List”

7. Test First Principle (TFP)

   1. RED, GREEN and REFACTORING

   2. Acceptance Criteria Defined in the Gherkin Language Syntax

Adding these Design Patterns to Complete the Palette:

1. Request / Response Design Pattern 

2. Command Query Separation Pattern: CQS

3. The Onion Layer Pattern

4. The Error Handling Extension Pattern: IErrorCommon

5. The Data Access Extension Pattern: IDataAccess

6. Error & Information Database Messaging Pattern: IMessaging

Concluding Thoughts

The Better Living through Better Code Development Series is NOT an abstract concept of what “Could Be”.

This series is based on a Real Enterprise Implementation of the above Design Principles and Design Patterns to solve a Real World Web Development Requirement:

Sourcing a Request from a Web Page
and Returning a Response
that the Requesting Page
can process for User Interactions

All of the above Best Practices will be demonstrated in C# 4.51 code and explained in detail as to the “Value Added” by using these Patterns and Principles.

Stay Tuned for More of the Series …

 How Good is Your Code Really?

Wisdom Pearl # 121 – Work Quality Concept

Your Work is Only as Good

… As How it is Perceived by the Next Person who Touches It

Positive Acceptance of your Work is Your Preeminent Responsibility