jerryr7 / design-pattern-examples-in-csharp

UML model and code examples of design patterns for C#. The model is created with Astah.

Design Pattern Examples in C#

Model and code examples of GoF Design Patterns for C#.
This project is available for the following objectives:

• To understand GoF Design Pattern examples in C#.
• To understand the mapping between UML model and C# code.
• To try Model-Driven Development (MDD) using Astah and M PLUS plug-in.

UML model example:

C# file example:

// ˅
using System;
using System.Collections.Generic;
using System.Text;

// ˄

namespace StructuralPatterns.Composite
{
    public class File : FileSystemElement
    {
        // ˅

        // ˄

        public override string Name
        {
            // ˅
            get;
            // ˄
        }

        public override int Size
        {
            // ˅
            get;
            // ˄
        }

        public File(string name, int size)
            // ˅
            
            // ˄
        {
            // ˅
            Name = name;
            Size = size;
            // ˄
        }

        // Print this element with the "upperPath".
        public override void Print(string upperPath)
        {
            // ˅
            Console.WriteLine($"{upperPath}/{this}");
            // ˄
        }

        // ˅
        
        // ˄
    }
}

// ˅

// ˄

Installation on Windows

UML Modeling Tool

• Download the modeling tool Astah UML or Professional, and install.
• Download M PLUS plug-in ver.2.4.0 or higher, and add it to Astah.
  How to add plugins to Astah

Visual Studio

• .NET Core 3.1 is required, so download and install Visual Studio version 16.4 or higher.
  Tested and confirmed to work on Windows 10.

Usage on Windows

Code Generation from UML

1. Open the Astah file (model/DesignPatternExamplesInCsharp.asta).
2. Select model elements on the model browser of Astah.
3. Click the Generate Code button.
   
   The generated code has User Code Area. The User Code Area is the area enclosed by "˅" and "˄". Handwritten code written in the User Code Area remains after a re-generation. View code example.
   For detailed usage of the tools, please see Astah Manual and M PLUS plug-in Tips.

Build and Run

1. Open the solution file (design-pattern-examples-in-csharp.sln) in Visual Studio.
2. Set up a startup project, and run it.
   

References

• Gamma, E. et al. Design Patterns: Elements of Reusable Object-Oriented Software, Addison-Wesley, 1994
• Hiroshi Yuki. Learning Design Patterns in Java [In Japanese Language], Softbank publishing, 2004

Licence

This project is licensed under the Creative Commons Zero (CC0) license. The model and code are completely free to use.

Other Language Examples

C++, Crystal, Go, Java, JavaScript, Kotlin, Python, Ruby, Scala, Swift, TypeScript