Solid Principles C# (How it Works For Developers)

1. The Five SOLID Principles in C#

2. Uses of SOLID Design Principles

using System;

// Abstract base class representing a shape
public abstract class Shape
{
    // Abstract method to be implemented by derived classes
    public abstract double Area();
}

// Derived class representing a circle
class Circle : Shape
{
    public double Radius { get; set; }

    // Override Area() method to calculate the area of a circle
    public override double Area() => Math.PI * Math.Pow(Radius, 2);
}

// Derived class representing a rectangle
class Rectangle : Shape
{
    public double Width { get; set; }
    public double Height { get; set; }

    // Override Area() method to calculate the area of a rectangle
    public override double Area() => Width * Height;
}

// Class responsible for calculating the area of a shape
class AreaCalculator
{
    // Method to calculate the area of a given shape
    public double CalculateArea(Shape shape) => shape.Area();
}

// Interface for logging messages
interface ILogger 
{
    void Log(string message); // Interface segregation principle
}

// Implementation of ILogger that logs messages to the console
class ConsoleLogger : ILogger
{
    public void Log(string message) => Console.WriteLine($"Log: {message}");
}

// Implementation of ILogger that simulates logging messages to a file
class FileLogger : ILogger
{
    public void Log(string message) => Console.WriteLine($"File Log: {message}");
}

// Service to manage user-related tasks
class UserService
{
    private readonly ILogger logger;

    // Constructor injection for dependency inversion principle
    public UserService(ILogger logger) => this.logger = logger;

    public void CreateUser()
    {
        logger.Log("User created successfully");
    }
}

// Service to manage email-related tasks
class EmailService
{
    private readonly ILogger logger;

    // Constructor injection for dependency inversion principle
    public EmailService(ILogger logger) => this.logger = logger;

    public void SendEmail()
    {
        logger.Log("Email sent successfully");
    }
}

using System;

// Abstract base class representing a shape
public abstract class Shape
{
    // Abstract method to be implemented by derived classes
    public abstract double Area();
}

// Derived class representing a circle
class Circle : Shape
{
    public double Radius { get; set; }

    // Override Area() method to calculate the area of a circle
    public override double Area() => Math.PI * Math.Pow(Radius, 2);
}

// Derived class representing a rectangle
class Rectangle : Shape
{
    public double Width { get; set; }
    public double Height { get; set; }

    // Override Area() method to calculate the area of a rectangle
    public override double Area() => Width * Height;
}

// Class responsible for calculating the area of a shape
class AreaCalculator
{
    // Method to calculate the area of a given shape
    public double CalculateArea(Shape shape) => shape.Area();
}

// Interface for logging messages
interface ILogger 
{
    void Log(string message); // Interface segregation principle
}

// Implementation of ILogger that logs messages to the console
class ConsoleLogger : ILogger
{
    public void Log(string message) => Console.WriteLine($"Log: {message}");
}

// Implementation of ILogger that simulates logging messages to a file
class FileLogger : ILogger
{
    public void Log(string message) => Console.WriteLine($"File Log: {message}");
}

// Service to manage user-related tasks
class UserService
{
    private readonly ILogger logger;

    // Constructor injection for dependency inversion principle
    public UserService(ILogger logger) => this.logger = logger;

    public void CreateUser()
    {
        logger.Log("User created successfully");
    }
}

// Service to manage email-related tasks
class EmailService
{
    private readonly ILogger logger;

    // Constructor injection for dependency inversion principle
    public EmailService(ILogger logger) => this.logger = logger;

    public void SendEmail()
    {
        logger.Log("Email sent successfully");
    }
}

3. Applying SOLID Principles in IronPDF

Now that we've explored the SOLID principles in theory, let's delve into their practical application in C# using IronPDF, a popular library for working with PDFs. IronPDF allows developers to create, manipulate, and process PDF documents seamlessly in C#. By integrating SOLID principles, we can ensure that our code remains modular, extensible, and maintainable.

IronPDF excels in HTML to PDF conversion, ensuring precise preservation of original layouts and styles. It's perfect for creating PDFs from web-based content, such as reports, invoices, and documentation. With support for HTML files, URLs, and raw HTML strings, IronPDF easily produces high-quality PDF documents.

using IronPdf;

class Program
{
    static void Main(string[] args)
    {
        var renderer = new ChromePdfRenderer();

        // 1. Convert HTML String to PDF
        var htmlContent = "<h1>Hello, IronPDF!</h1><p>This is a PDF from an HTML string.</p>";
        var pdfFromHtmlString = renderer.RenderHtmlAsPdf(htmlContent);
        pdfFromHtmlString.SaveAs("HTMLStringToPDF.pdf");

        // 2. Convert HTML File to PDF
        var htmlFilePath = "path_to_your_html_file.html"; // Specify the path to your HTML file
        var pdfFromHtmlFile = renderer.RenderHtmlFileAsPdf(htmlFilePath);
        pdfFromHtmlFile.SaveAs("HTMLFileToPDF.pdf");

        // 3. Convert URL to PDF
        var url = "http://ironpdf.com"; // Specify the URL
        var pdfFromUrl = renderer.RenderUrlAsPdf(url);
        pdfFromUrl.SaveAs("URLToPDF.pdf");
    }
}

using IronPdf;

class Program
{
    static void Main(string[] args)
    {
        var renderer = new ChromePdfRenderer();

        // 1. Convert HTML String to PDF
        var htmlContent = "<h1>Hello, IronPDF!</h1><p>This is a PDF from an HTML string.</p>";
        var pdfFromHtmlString = renderer.RenderHtmlAsPdf(htmlContent);
        pdfFromHtmlString.SaveAs("HTMLStringToPDF.pdf");

        // 2. Convert HTML File to PDF
        var htmlFilePath = "path_to_your_html_file.html"; // Specify the path to your HTML file
        var pdfFromHtmlFile = renderer.RenderHtmlFileAsPdf(htmlFilePath);
        pdfFromHtmlFile.SaveAs("HTMLFileToPDF.pdf");

        // 3. Convert URL to PDF
        var url = "http://ironpdf.com"; // Specify the URL
        var pdfFromUrl = renderer.RenderUrlAsPdf(url);
        pdfFromUrl.SaveAs("URLToPDF.pdf");
    }
}

Consider the Single Responsibility Principle. When working with IronPDF, it's beneficial to have classes that handle specific aspects of PDF generation or manipulation. For instance, one class could create PDF documents, while another focuses on adding and formatting content.

The Open/Closed Principle encourages us to design our PDF-related classes with extension in mind. Instead of modifying existing classes to accommodate new features, we can create classes that extend or implement existing interfaces. This way, we adhere to the principle without compromising existing functionality.

The Liskov Substitution Principle comes into play when dealing with different types of PDF elements. Whether it's text, images, or annotations, designing classes that adhere to a common interface allows for seamless substitution and enhances the flexibility of our PDF generation code. The Interface Segregation Principle is essential when defining contracts for classes that interact with IronPDF. By creating small, specific interfaces tailored to the needs of different components, we avoid unnecessary dependencies and ensure that classes only implement the methods they require.

Finally, applying the Dependency Inversion Principle can improve the testability and maintainability of our code. By injecting dependencies rather than hardcoding them, we create a more loosely coupled system that is easier to update and extend.

Let's illustrate these concepts with a simple code example using IronPDF:

using IronPdf;
using System;

// Interface for PDF creation
public interface IPdfCreator
{
    void CreatePdf(string filePath, string content);
}

// Concrete implementation using IronPDF
public class IronPdfCreator : IPdfCreator
{    
    public void CreatePdf(string filePath, string content)
    {
        // IronPDF-specific code for creating a PDF
        var renderer = new ChromePdfRenderer();
        var pdf = renderer.RenderHtmlAsPdf(content);
        pdf.SaveAs(filePath);
    }
}

// Service adhering to Single Responsibility Principle
public class PdfGenerationService
{
    private readonly IPdfCreator pdfCreator;

    public PdfGenerationService(IPdfCreator pdfCreator)
    {
        this.pdfCreator = pdfCreator;
    }

    public void GeneratePdfDocument(string filePath)
    {
        // Business logic for generating content
        string content = "<p>This PDF is generated using IronPDF and follows SOLID principles.</p>";
        // Delegate the PDF creation to the injected dependency
        pdfCreator.CreatePdf(filePath, content);
        Console.WriteLine($"PDF generated successfully at {filePath}");
    }
}

class Program
{
    static void Main()
    {
        // Dependency injection using the Dependency Inversion Principle
        IPdfCreator ironPdfCreator = new IronPdfCreator();
        PdfGenerationService pdfService = new PdfGenerationService(ironPdfCreator);
        // Generate PDF using the service
        string pdfFilePath = "output.pdf";
        pdfService.GeneratePdfDocument(pdfFilePath);
        Console.ReadLine(); // To prevent the console window from closing immediately
    }
}

using IronPdf;
using System;

// Interface for PDF creation
public interface IPdfCreator
{
    void CreatePdf(string filePath, string content);
}

// Concrete implementation using IronPDF
public class IronPdfCreator : IPdfCreator
{    
    public void CreatePdf(string filePath, string content)
    {
        // IronPDF-specific code for creating a PDF
        var renderer = new ChromePdfRenderer();
        var pdf = renderer.RenderHtmlAsPdf(content);
        pdf.SaveAs(filePath);
    }
}

// Service adhering to Single Responsibility Principle
public class PdfGenerationService
{
    private readonly IPdfCreator pdfCreator;

    public PdfGenerationService(IPdfCreator pdfCreator)
    {
        this.pdfCreator = pdfCreator;
    }

    public void GeneratePdfDocument(string filePath)
    {
        // Business logic for generating content
        string content = "<p>This PDF is generated using IronPDF and follows SOLID principles.</p>";
        // Delegate the PDF creation to the injected dependency
        pdfCreator.CreatePdf(filePath, content);
        Console.WriteLine($"PDF generated successfully at {filePath}");
    }
}

class Program
{
    static void Main()
    {
        // Dependency injection using the Dependency Inversion Principle
        IPdfCreator ironPdfCreator = new IronPdfCreator();
        PdfGenerationService pdfService = new PdfGenerationService(ironPdfCreator);
        // Generate PDF using the service
        string pdfFilePath = "output.pdf";
        pdfService.GeneratePdfDocument(pdfFilePath);
        Console.ReadLine(); // To prevent the console window from closing immediately
    }
}

1. IPdfCreator Interface: Defines a contract for PDF creation, adhering to the Single Responsibility Principle by focusing on one responsibility.
2. IronPdfCreator Class: Implements IPdfCreator using IronPDF to create a PDF. This class encapsulates the logic specific to PDF creation.
3. PdfGenerationService Class: Represents a service responsible for generating PDFs. It adheres to the Single Responsibility Principle by handling the business logic for content generation and delegates the PDF creation to the injected IPdfCreator.
4. Program Class (Main): Demonstrates using the Service and the injected dependency, adhering to the Dependency Inversion Principle by depending on abstractions (interfaces) rather than concrete implementations.

To run this code, ensure you install the IronPDF library in your project. You can do this using the NuGet Package Manager:

Install-Package IronPdf

Replace the content and logic in the PdfGenerationService class with your specific requirements.

4. Conclusion

In conclusion, SOLID principles provide a solid foundation for designing maintainable and scalable software in C#. By understanding and applying these principles, developers can create more modular code, adaptable to change and more accessible to test.

When working with libraries like IronPDF, integrating SOLID principles becomes even more crucial. Designing classes that adhere to these principles ensures that your code remains flexible and can evolve with the changing requirements of your PDF-related tasks.

As you continue to develop C# applications, keep in mind the SOLID principles as guidelines for crafting code that stands the test of time. Whether you're working on PDF generation, database interactions, or any other aspect of software development, SOLID principles provide a roadmap to building functional and maintainable code in the long run.

To know more about the IronPDF library, Visit IronPDF Documentation. To learn about the license and get a free trial, visit the IronPDF licensing page.