Skip to main content

SOLID-Open-closed principle (OCP) Real-Time Example in C#

The SOLID Principles are the design principles that enable us to manage several software design problems. These principles provide us with ways to move from tightly coupled code to loosely coupled and encapsulated real business needs properly. Also readable, adaptable, and scalable code.

The SOLID Principles guide developers as they write readable, adaptable, and scalable code or design an application.

The SOLID Principles can be applied to any OOP program.

The SOLID Principles were developed by computer science instructor and author Robert C. Martin. Now, SOLID principles have also been adopted in both agile development and adaptive software development.

The 5 principles of SOLID are:

1.      Single Responsibility Principle (SRP)

2.      Open-Closed Principle (OCP)

3.      Liskov Substitution Principle (LSP)

4.      Interface Segregation Principle (ISP)

5.      DependencyInversion Principle (DIP)

 Open-closed principle (OCP):

The Open/closed Principle says that a software module/class/function is open for extension and closed for modification. That means a class should be easily extended but there is no need to change its core implementations.

“Software entities … should be open for extension, but closed for modification.” Robert C. Martin.


Implementation:

Let’s take an example of bank accounts like regular savings, salary savings, corporate, etc. for different customers. As for each customer type, there are different rules and different interest rates.

 

The below Account class code violates the OCP principle, if the bank introduces a new Account type in that case, we need to modify CalcInterest method for adding a new account type.

 

The code looks like,

// Does not follow a Open-closed principle (OCP)

public class Account

{

               public decimal InterestRate { get; set; }

               public decimal BalanceAmount { get; set; }

               //members and function declaration

               public decimal CalcInterest(string accountType)

               {

                              // saving Account type

                              if (accountType == "Regular")

                              {

                                     InterestRate = (BalanceAmount * 4) / 100; 

                                    if (BalanceAmount < 1000) InterestRate -= (BalanceAmount * 2) / 100;

                                    if (BalanceAmount < 5000) InterestRate += (BalanceAmount * 4) / 100;

                              } 

                              // salary Account type

                              if (accountType == "Salary")

                              {

                                             InterestRate = (BalanceAmount * 5) / 100;

                              } 

                              // Corporate Account type

                              if (accountType == "Corporate")

                              {

                                             InterestRate = (BalanceAmount * 3) / 100;

                              } 

                              return InterestRate;

               }

}

We can apply the Open-closed principle (OCP) by using interface, abstract class, abstract methods, and virtual methods when we want to extend functionality.

Here in the below, we have used interface (IAccount) to follow an Open-closed principle (OCP) or remove the code that violates OCP principle,

interface IAccount

{

               // members and function declaration, properties

               decimal BalanceAmount { get; set; }

               decimal CalcInterest();

}

 

//regular savings account

public class RegularSavingAccount : IAccount

{

               public decimal BalanceAmount { get; set; } = 0;

               public decimal CalcInterest()

               {

                              decimal InterestRate = (BalanceAmount * 4) / 100;

                              if (BalanceAmount < 1000) InterestRate -= (BalanceAmount * 2) / 100;

                              if (BalanceAmount < 5000) InterestRate += (BalanceAmount * 4) / 100;

                              return InterestRate;

               }

}

//Salary savings account

public class SalarySavingAccount : IAccount

{

               public decimal BalanceAmount { get; set; } = 0;

               public decimal CalcInterest()

               {

                              decimal InterestRate = (BalanceAmount * 5) / 100;

                              return InterestRate;

               }

}

//Corporate Account

public class CorporateAccount : IAccount

{

               public decimal BalanceAmount { get; set; } = 0;

               public decimal CalcInterest()

               {

                              decimal InterestRate = (BalanceAmount * 3) / 100;

                              return InterestRate;

               }

}

In the above code, three new classes are created by extending them from IAccount.

1.      RegularSavingAccount

2.      SalarySavingAccount

3.      CorporateAccount

This is solving the problem of modification of class and by extending the interface, we can extend functionality.

The above code implements both the Open-closed principle (OCP) as well as the Single-responsibility principle (SRP) principle, as each class does a single task and we are not modifying the class and only doing an extension.

 

Use Cases of Open-Closed Principle in C#:

The Open-Closed Principle (OCP) is one of the SOLID principles of object-oriented programming, and it states that a class should be open for extension but closed for modification. In C#, there are several ways to apply the Open-Closed Principle to improve the flexibility and maintainability of your code.

Here are some use cases:

1.      Adding new functionality through inheritance

2.      Using interfaces for extension

3.      Using strategy pattern

4.      Using Abstract Factories

5.      Using Dependency Injection

By applying the Open-Closed Principle in these ways, you can enhance the flexibility of your code, make it easier to extend, and reduce the risk of introducing bugs when adding new features.

 

Advantages of Open-Closed Principle:

1.      Code Reusability

2.      Maintainability

3.      Reduced Risk of Regression Bugs

4.      Encourages Design Patterns

5.      Scalability

Disadvantages of Open-Closed Principle:

1.      Performance Impact: added extra layers might decrease performance due to added indirection

2.      Abstraction Overhead: added unnecessary abstraction overhead

 

By Anil Singh | Rating of this article (*****)

Popular posts from this blog

React | Encryption and Decryption Data/Text using CryptoJs

To encrypt and decrypt data, simply use encrypt () and decrypt () function from an instance of crypto-js. Node.js (Install) Requirements: 1.       Node.js 2.       npm (Node.js package manager) 3.       npm install crypto-js npm   install   crypto - js Usage - Step 1 - Import var   CryptoJS  =  require ( "crypto-js" ); Step 2 - Encrypt    // Encrypt    var   ciphertext  =  CryptoJS . AES . encrypt ( JSON . stringify ( data ),  'my-secret-key@123' ). toString (); Step 3 -Decrypt    // Decrypt    var   bytes  =  CryptoJS . AES . decrypt ( ciphertext ,  'my-secret-key@123' );    var   decryptedData  =  JSON . parse ( bytes . toString ( CryptoJS . enc . Utf8 )); As an Example,   import   React   from   'react' ; import   './App.css' ; //Including all libraries, for access to extra methods. var   CryptoJS  =  require ( "crypto-js" ); function   App () {    var   data

List of Countries, Nationalities and their Code In Excel File

Download JSON file for this List - Click on JSON file    Countries List, Nationalities and Code Excel ID Country Country Code Nationality Person 1 UNITED KINGDOM GB British a Briton 2 ARGENTINA AR Argentinian an Argentinian 3 AUSTRALIA AU Australian an Australian 4 BAHAMAS BS Bahamian a Bahamian 5 BELGIUM BE Belgian a Belgian 6 BRAZIL BR Brazilian a Brazilian 7 CANADA CA Canadian a Canadian 8 CHINA CN Chinese a Chinese 9 COLOMBIA CO Colombian a Colombian 10 CUBA CU Cuban a Cuban 11 DOMINICAN REPUBLIC DO Dominican a Dominican 12 ECUADOR EC Ecuadorean an Ecuadorean 13 EL SALVADOR

23 Best Key Features of MVC 6 and MVC 5

What’s new In MVC 6? The Added Key Features as following as, 1. The Microsoft makes a bundle of MVC, Web API, WebPages, SignalR, that bundle we called  MVC6 . 2. The MVC 6   added new cloud computing optimization system of MVC, web API, SignalR and entity framework. 3. In MVC 6, Microsoft removed the dependency of system.web.dll from MVC 6 because it's so expensive. Typically it consumes 30K memory per request/response. 4. Right now, in MVC 6 consume 2K memory per request response. It's too small memory consume. 5. Most of the problem solved using the  Roslyn Compiler . 6 . It’s added a  Start-up  class that replaces to  global.asax  file. 7. The Session state and caching adjusts our behavior depending on your hosting environment. 8. Host agnostic and its true side-by-side deployment 9. The vNext is a cross platform and open source and it's also supported to Mac, Linux, etc. 10. It’s also added to TagHeaplers use to creating an

Angular 7 and 8 Validate Two Dates - Start Date & End Date

In this example, I am sharing “ How to compare or validate two dates in Angular? ” using custom validation function in Angular 7 and Angular 8 . Here, I’m validating the two dates  - a start date and end date. The end date should be greater than the Start date”. Let’s see the example :- import { Component , OnInit } from '@angular/core' ; import { UserRequest } from '../model/user' ; @ Component ({   selector: 'User_Cal' ,   templateUrl: './usercal.component.html' ,   styleUrls: [ './usercal.component.css' ] }) export class UserCalComponent implements OnInit {   constructor ( private EncrDecr : EncrDecrService , private   http :  HttpClient ,               private datePipe : DatePipe ) {                            }   //model class   model = new UserRequest ( null , null , null , null , null );   //Error Display   error : any ={ isError: false , errorMessage: '' };   isValid

Encryption and Decryption Data/Password in Angular

You can use crypto.js to encrypt data. We have used 'crypto-js'.   Follow the below steps, Steps 1 –  Install CryptoJS using below NPM commands in your project directory npm install crypto-js --save npm install @types/crypto-js –save After installing both above commands it looks like  – NPM Command  1 ->   npm install crypto-js --save NPM Command  2 ->   npm install @types/crypto-js --save Steps 2  - Add the script path in “ angular.json ” file. "scripts" : [                "../node_modules/crypto-js/crypto-js.js"               ] Steps 3 –  Create a service class “ EncrDecrService ” for  encrypts and decrypts get/set methods . Import “ CryptoJS ” in the service for using  encrypt and decrypt get/set methods . import  {  Injectable  }  from   '@angular/core' ; import   *   as   CryptoJS   from   'crypto-js' ; @ Injectable ({    providedIn:   'root' }) export   class   EncrDecrS