Implement Interfaces in a Project

In object-oriented programming, interfaces define a contract that classes can implement. They specify method signatures and properties that implementing classes must provide. This allows for consistent behavior across different types while enabling flexibility in implementation. In C#, interfaces are defined using the interface keyword, and classes implement them using the : InterfaceName syntax.

In this exercise, you will create a console app to define and implement interfaces, including explicit interface implementations, to ensure consistent behavior across various components of an application.

This exercise takes approximately 20 minutes to complete.

Before you start

Before you can start this exercise, you need to:

Ensure that you have the latest short term support (STS) version of the .NET SDK installed on your computer. You can download the latest versions of the .NET SDK using the following URL: Download .NET.
Ensure that you have Visual Studio Code installed on your computer. You can download Visual Studio Code using the following URL: Download Visual Studio Code.
Ensure that you have the C# Dev Kit configured in Visual Studio Code.

For additional help configuring the Visual Studio Code environment, see Install and configure Visual Studio Code for C# development.

Exercise scenario

Suppose you’re a software developer at a tech company working on a new project. Your team needs to define common behaviors across different classes using interfaces. To ensure consistent behavior, you decide to create and implement interfaces, including explicit interface implementations, in a simple console application.

This exercise includes the following tasks:

Create a new C# project.
Define the IPerson interface with method signatures and properties.
Implement the defined IPerson interface in a class.
Create a second class to implement IPerson interface with different behavior.
Demonstrate the interface implementation.
Test the implemented interfaces.

Task 1: Create a new C# project

To start, you need to create a new C# project in your development environment. This project will serve as the foundation for implementing interfaces and their respective classes.

Open Visual Studio Code.
Ensure that the C# Dev Kit extension is installed.
Use Visual Studio Code to open a folder location for your new code project.

For example:
1. Open the File menu and select Open Folder.
2. In the Open Folder dialog box, navigate root of the C drive.
3. Select New Folder and name the folder TrainingProjects.
4. Select the TrainingProjects folder and then select Select Folder.
Use the Command Palette to create a new console app named ImplementInterfaces.

For example:
1. To open the Command Palette, press Ctrl+Shift+P.
2. In the Command Palette, type .NET: and then select .NET: New Project.
3. In the ‘Create a new .NET Project’ box, select Console App.
4. In the ‘Name the new project’ box, type ImplementInterfaces and then press Enter.
5. In the ‘Select location for the project’ box, select Default directory
6. In the ‘Create project or view options’ box, select Create project
You should see a new console app project named ImplementInterfaces in the Visual Studio Code EXPLORER view.
Ensure that the project has been created successfully.

Verify the presence of the Program.cs file in the project directory. You should also see the project structure in the Visual Studio Code Explorer pane.

Task 2: Define the IPerson interface with method signatures and properties

Next, you will define an interface that includes method signatures and properties. This interface will be used to enforce a contract for any class that implements it. The code defines an interface in C# which shows interfaces enforcing consistent behavior across classes.

Create a new file named IPerson.cs in the ImplementInterfaces project.
Add the following code to define the IPerson interface:
```
namespace ImplementInterfaces
{
    public interface IPerson
    {
        string Name { get; set; }
        int Age { get; set; }
        void DisplayInfo();
    }
}
```
The IPerson interface has been defined to include the Name and Age properties, along with the DisplayInfo method signature, ensuring a consistent contract for implementing classes.

Task 3: Implement the defined IPerson interface in a class

Now, you will create a class that implements the IPerson interface. This class will provide concrete implementations for the interface members. The code in this step implements an interface in a class and provides concrete implementations for the interface.

In the ImplementInterfaces project, create a new file named Student.cs.

Add the following code to implement the IPerson interface in the Student class:

namespace ImplementInterfaces
{
    public class Student : IPerson
    {
        public string Name { get; set; } = string.Empty;
        public int Age { get; set; } = 0;

        public void DisplayInfo()
        {
            Console.WriteLine($"Student Name: {Name}, Age: {Age}");
        }
    }
}

The Student class has been implemented to adhere to the IPerson interface. It provides concrete implementations for the Name and Age properties, as well as the DisplayInfo method, ensuring compliance with the interface contract.

Task 4: Create a second class to implement IPerson interface with different behavior

You will now create another class that implements the IPerson interface but with different behavior. Task 4 implements the same interface in multiple classes. This demonstrates how to provide unique behavior for each class using an interface.

Create a new file named Teacher.cs in the ImplementInterfaces project.

Add the following code to implement the IPerson interface in the Teacher class:

namespace ImplementInterfaces
{
    public class Teacher : IPerson
    {
        public string Name { get; set; } = string.Empty;
        public int Age { get; set; } = 0;

        public void DisplayInfo()
        {
            Console.WriteLine($"Teacher Name: {Name}, Age: {Age}");
        }
    }
}

You have created the Teacher class, which implements the IPerson interface. This class provides its own implementation for the Name and Age properties, as well as the DisplayInfo method, ensuring it adheres to the interface contract.

Task 5: Demonstrate the interface implementation

In this task, you will demonstrate the use of the interface by creating instances of the Student and Teacher classes and calling their methods. This demonstrates how to use polymorphism to treat objects of different classes as the same interface type.

Open the Program.cs file in the ImplementInterfaces project.

Replace the existing code with the following:

using System;

namespace ImplementInterfaces
{
    class Program
    {
        static void Main(string[] args)
        {
            IPerson student = new Student { Name = "Eric Solomon", Age = 20 };
            IPerson teacher = new Teacher { Name = "Kayla Lewis", Age = 35 };

            student.DisplayInfo();
            teacher.DisplayInfo();
        }
    }
}

The Program.cs file demonstrates how to use the IPerson interface to create polymorphic behavior. By creating instances of the Student and Teacher classes, you can observe how each class adheres to the interface contract while providing its own unique implementation of the DisplayInfo method.

Task 6: Test the implemented interfaces

Next, you will test the implemented interfaces and their respective classes to ensure they function correctly. This section of code demonstrates how to test interface implementations in a C# application.

Ensure that the Program.cs file contains the code to create instances of Student and Teacher and calls their DisplayInfo methods and all files are saved.
Build the application using the following command:
```
 dotnet build
```
Ensure that the build completes successfully without any errors.
Run the application again using the following command:
```
dotnet run
```
Confirm that the application runs without errors and displays the correct information for both the student and the teacher. The output should look similar to the following:
```
 Student Name: Eric Solomon, Age: 20
 Teacher Name: Kayla Lewis, Age: 35
```
Observe that the output confirms the successful implementation of the IPerson interface in both the Student and Teacher classes. Each class adheres to the interface contract while providing its unique implementation of the DisplayInfo method, demonstrating polymorphism in action.

Key learnings

This exercise demonstrated how to use interfaces in C# to enforce consistent behavior across multiple classes. By implementing the IPerson interface in both Student and Teacher classes, you explored how interfaces enable polymorphism and allow different classes to share a common contract while maintaining unique behavior. This approach is essential for building scalable and maintainable applications.

Clean up

Now that you’ve finished the exercise, consider archiving your project files for review at a later time. Having your own projects available for review can be a valuable resource when you’re learning to code. Also, building up a portfolio of projects can be a great way to demonstrate your skills to potential employers.