Iterator Pattern — Complete Guide

Introduction

Iterator Pattern — Complete Guide is essential for .NET architects building ShopNest Enterprise Architecture Platform — Toolliyo's 69-article design patterns master path covering GoF patterns, enterprise architecture, microservices, ASP.NET Core integration, and senior interview preparation. Every article includes minimum 2 mandatory real-world examples in different business domains.

In Indian delivery projects (TCS, Infosys, Wipro), interviewers expect iterator pattern with real banking, e-commerce, or SaaS examples — not toy animal demos. This article delivers two mandatory enterprise examples on Inventory.

After this article you will

• Explain Iterator Pattern in plain English and in enterprise architecture terms
• Implement iterator pattern in ShopNest Enterprise Architecture Platform (Inventory)
• Compare the wrong approach vs the production-ready enterprise approach
• Answer fresher, mid-level, and senior design pattern interview questions confidently
• Connect this lesson to Article 17 and the 69-article Design Patterns roadmap

Prerequisites

• Software: .NET 8 SDK, VS 2022 or VS Code, SQL Server Express / LocalDB
• Knowledge: C# basics
• Previous: Article 15 — Interpreter Pattern — Complete Guide
• Time: 24 min reading + 30–45 min hands-on

Concept deep-dive

Level 1 — Analogy

Iterator Pattern on ShopNest Enterprise Architecture is like adding a proven blueprint to a growing platform — clear boundaries keep teams productive.

Level 2 — Technical

Iterator Pattern integrates with the LINQ query layer: write queries against IEnumerable or IQueryable, understand deferred execution, project to DTOs for ShopNest Enterprise Architecture reports. On ShopNest Enterprise Architecture this powers Inventory without coupling UI to database internals.

Level 3 — Architecture

[Browser] → [HTTPS/Kestrel] → [Middleware Pipeline]
  → [Routing] → [Controller Action] → [Service Layer]
  → [EF Core / Identity] → [Razor View Engine] → [HTML Response]

Project structure

ShopNest Enterprise Architecture/
├── ShopNest.Domain/           ← Entities, domain events, interfaces
├── ShopNest.Application/      ← Commands, queries, handlers (MediatR)
├── ShopNest.Infrastructure/   ← EF Core, Redis, RabbitMQ, Polly
├── ShopNest.Api/              ← ASP.NET Core Web API + Minimal APIs
├── ShopNest.Workers/          ← Hosted services, outbox processors
└── ShopNest.Gateway/          ← YARP API Gateway

Step-by-Step Implementation — ShopNest (Inventory)

Follow the prompt template: create project → core classes → interfaces → pattern implementation → client code → run → enterprise refactor.

Step 1 — The wrong way

// ❌ BAD — fat controller, no ViewModel, sync DB call
public IActionResult Index()
{
    return _context.Products.Find(id); // sync, exposes entity, no auth
}

Step 2 — The right way

// ✅ CORRECT — Iterator Pattern on ShopNest (Inventory)
var results = await _context.Products
    .Where(p => p.IsPublished && p.CategoryId == categoryId)
    .OrderBy(p => p.Name)
    .Select(p => new ProductReportDto { Id = p.Id, Name = p.Name, Revenue = p.Orders.Sum(o => o.Total) })
    .ToListAsync(ct);

Step 3 — Apply Iterator Pattern

// Iterator Pattern — ShopNest Enterprise Architecture (Inventory)
builder.Services.AddScoped<IIteratorPatternService, IteratorPatternService>();

dotnet run --project ShopNest.Api
# Verify Iterator Pattern pattern registration and integration tests pass

Real-World Example 1 — Payment Gateway Integration

MANDATORY: Enterprise-grade Iterator Pattern implementation in a production payment gateway integration.

Business requirement

External payment APIs fail intermittently; the system must handle timeouts, retries, and circuit breaks without double-charging customers.

Why Iterator Pattern is needed

Without Iterator Pattern, the Payment Gateway Integration team at ShopNest faces tight coupling, untestable code, and painful refactors every sprint. Iterator Pattern decouples responsibilities so the Inventory module can evolve independently while meeting scalability and compliance requirements.

Architecture

[Client/API] → [Iterator Pattern Abstraction]
  → [ShopNest.Inventory Service] → [EF Core / Redis / Message Bus]
  → [Downstream: Audit, Notifications, Reporting]

Tech stack: ASP.NET Core, HttpClientFactory, Polly retry/circuit breaker, structured logging with Serilog

Full working code

// REAL-WORLD EXAMPLE 1: Payment Gateway Integration
// ShopNest Enterprise Architecture — Inventory module
// Pattern: Iterator

namespace ShopNest.Architecture.Inventory;

public interface IIteratorService
{
    Task ExecuteAsync(IteratorRequest request, CancellationToken ct = default);
}

public sealed class PaymentGatewayIntegrationIteratorService : IIteratorService
{
    private readonly ILogger _logger;

    public PaymentGatewayIntegrationIteratorService(ILogger logger)
        => _logger = logger;

    public async Task ExecuteAsync(IteratorRequest request, CancellationToken ct)
    {
        _logger.LogInformation("[Iterator] Processing {Domain} request {Id}",
            "Payment Gateway Integration", request.Id);

        // Production implementation — see Program.cs for DI registration
        await Task.Delay(10, ct);
        return Result.Success(request.Id);
    }
}

// Register in Program.cs:
// builder.Services.AddScoped();

Benefits achieved

• Loose coupling — swap implementations without changing controllers
• Unit testable — mock IIteratorService in xUnit tests
• Scalable — horizontal scaling of Inventory workers under load
• Maintainable — new business rules added via new classes, not if-else chains

Real-World Example 2 — Hospital Management System

MANDATORY: Second complete example in a different domain — Hospital Management System.

Business problem

Patient records, appointments, billing, and lab results involve multiple departments with different access policies and HIPAA-style audit requirements.

Why Iterator Pattern solves it

In Hospital Management System, Indian IT delivery teams (TCS, Infosys, Wipro lateral rounds) frequently ask how Iterator Pattern applies to distributed systems. This example shows production-level implementation with ASP.NET Core integration, not toy animal/car demos.

Production implementation

// REAL-WORLD EXAMPLE 2: Hospital Management System
// ShopNest Enterprise Architecture — Inventory module
// Pattern: Iterator

namespace ShopNest.Architecture.Inventory;

public interface IIteratorService
{
    Task ExecuteAsync(IteratorRequest request, CancellationToken ct = default);
}

public sealed class HospitalManagementSystemIteratorService : IIteratorService
{
    private readonly ILogger _logger;

    public HospitalManagementSystemIteratorService(ILogger logger)
        => _logger = logger;

    public async Task ExecuteAsync(IteratorRequest request, CancellationToken ct)
    {
        _logger.LogInformation("[Iterator] Processing {Domain} request {Id}",
            "Hospital Management System", request.Id);

        // Production implementation — see Program.cs for DI registration
        await Task.Delay(10, ct);
        return Result.Success(request.Id);
    }
}

// Register in Program.cs:
// builder.Services.AddScoped();

Scalability benefits

• Supports multi-region deployment on Azure with independent scaling
• Integrates with ShopNest distributed events (RabbitMQ) for async workflows
• Redis caching reduces database load for read-heavy Hospital operations
• Polly resilience policies handle transient failures in cloud-native environments

Pattern variations & ASP.NET Core integration

Modern C# 12 implementations use primary constructors, records, and DI. Register pattern abstractions in Program.cs with appropriate lifetimes (Singleton for stateless, Scoped for request-bound, Transient for lightweight factories).

Microservices: Apply Iterator Pattern within bounded contexts — each ShopNest service (Orders, Payments, Inventory) owns its pattern implementation.

Pattern comparison & when NOT to use

Compare Iterator Pattern with similar patterns. Avoid overengineering — if a simple function or DI registration suffices, do not force a pattern. Senior architects value judgment over pattern count.

Common errors & fixes

🔴 Mistake 1: Fat controllers with EF Core queries inline
✅ Fix: Move data access to services/repositories; keep controllers thin.

🔴 Mistake 2: Calling .ToList() too early materializing millions of rows into memory
✅ Fix: Defer execution — build IQueryable pipeline, then ToListAsync() once at the end.

🔴 Mistake 3: Filtering in memory after .ToList() instead of in the database query
✅ Fix: Keep filters in IQueryable, use Select projection, paginate with Skip/Take before materialization.

🔴 Mistake 4: Hard-coding connection strings in controllers
✅ Fix: Use appsettings.json + User Secrets locally; Azure Key Vault in production.

Best practices

• 🟢 Use async/await end-to-end for database and I/O calls
• 🟢 Register DbContext as Scoped; avoid capturing it in singletons
• 🟡 Use IQueryable until the last moment; avoid multiple enumeration; project with Select before ToList
• 🟡 Prefer method syntax for complex chains; use query syntax for joins when readability wins
• 🔴 Log structured data with Serilog — include OrderId, UserId, not passwords
• 🔴 Use HTTPS, secure cookies, and authorization policies in production

Interview questions

Fresher level

Q1: What is Iterator Pattern in ASP.NET Core MVC?
A: Iterator Pattern is a core MVC capability used in ShopNest Enterprise Architecture for Inventory. Explain in one sentence, then describe controller/view/service placement.

Q2: How would you implement Iterator Pattern on a TCS-style delivery project?
A: Deferred execution, IQueryable pipelines, Select projection, Skip/Take pagination, and SQL logging in development.

Q3: IEnumerable vs IQueryable — when to use which?
A: IEnumerable for in-memory collections; IQueryable for EF Core database queries that translate to SQL.

Mid / senior level

Q4: Explain LINQ deferred execution and query translation briefly.
A: LINQ → Expression Tree → IQueryProvider → SQL (EF) or Iterator (in-memory) → Results.

Q5: Common production mistake with this topic?
A: Skipping validation, exposing secrets in Git, or untested edge cases (null model, unauthorized user).

Q6: .NET LINQ vs SQL — when to push logic to database?
A: Core is cross-platform, faster, cloud-ready; Framework is maintenance mode on Windows/IIS.

Coding round

Implement Iterator Pattern for ShopNest Inventory: show interface, concrete class, DI registration, and xUnit test with mock.

public class IteratorPatternTests
{
    [Fact]
    public async Task ExecuteAsync_ReturnsSuccess()
    {
        var mock = new Mock();
        mock.Setup(s => s.ExecuteAsync(It.IsAny(), default))
            .ReturnsAsync(Result.Success("test-id"));
        var result = await mock.Object.ExecuteAsync(new Request("test-id"));
        Assert.True(result.IsSuccess);
    }
}

Summary & next steps

• Article 16: Iterator Pattern — Complete Guide
• Module: Module 3: Behavioral Design Patterns · Level: INTERMEDIATE
• Applied to ShopNest Enterprise Architecture — Inventory

Previous: Interpreter Pattern — Complete Guide
Next: Mediator Pattern — Complete Guide

Practice: Add one small feature using today's pattern — commit with feat(design-patterns): article-16.

FAQ