Class diagrams in LLD - System Design Guide

Problem Statement

When designing software, developers often struggle to understand how different parts of the system relate to each other. Without a clear visual representation, it becomes hard to communicate structure, spot design flaws, or plan changes effectively.

Solution

Class diagrams provide a visual map of the system's classes, their attributes, methods, and relationships. By showing how classes connect and interact, they help developers and stakeholders understand the system's design and guide implementation.

Architecture

┌─────────────┐       ┌─────────────┐
│   Person    │       │   Address   │
├─────────────┤       ├─────────────┤
│ - name      │       │ - street    │
│ - age       │       │ - city      │
├─────────────┤       ├─────────────┤
│ + greet()   │       │ + full_addr()│
└─────┬───────┘       └─────┬───────┘
      │ 1                     │ 1..*
      │                       │
      └───────────── owns ─────┘

This diagram shows two classes, Person and Address, with their attributes and methods. It also shows a one-to-many ownership relationship where one Person owns multiple Addresses.

Trade-offs

✓ Pros

→

Helps visualize and communicate system structure clearly.

→

Identifies relationships and dependencies early in design.

→

Facilitates better planning and reduces misunderstandings.

→

Supports documentation and onboarding of new team members.

✗ Cons

→

Can become complex and hard to read for very large systems.

→

Requires effort to keep diagrams updated with code changes.

→

May oversimplify dynamic behaviors not captured in static diagrams.

Use class diagrams during design phases for systems with multiple interacting classes, especially when collaboration or documentation is important.

Avoid relying on class diagrams for very small or trivial programs where the overhead of creating diagrams outweighs the benefits.

Real World Examples

Amazon

Uses class diagrams to design their order processing system, clarifying how orders, customers, and payments relate before coding.

Uber

Employs class diagrams to model entities like drivers, riders, and trips, ensuring clear relationships and responsibilities.

LinkedIn

Uses class diagrams to represent user profiles, connections, and messaging components to maintain consistent design across teams.

Code Example

The before code shows two unrelated classes without any connection. The after code models a one-to-many relationship where a Person can have multiple Addresses, reflecting the class diagram structure.

LLD

### Before: No clear structure or relationships
class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age

class Address:
    def __init__(self, street, city):
        self.street = street
        self.city = city

# No link between Person and Address

### After: Clear class design with relationships
class Address:
    def __init__(self, street: str, city: str):
        self.street = street
        self.city = city

    def full_addr(self) -> str:
        return f"{self.street}, {self.city}"

class Person:
    def __init__(self, name: str, age: int):
        self.name = name
        self.age = age
        self.addresses: list[Address] = []

    def add_address(self, address: Address) -> None:
        self.addresses.append(address)

    def greet(self) -> str:
        return f"Hello, my name is {self.name}."

Alternatives

Entity-Relationship Diagrams (ERD)

Focuses on database entities and their relationships rather than object-oriented classes and methods.

Use when: When designing or modeling database schemas specifically.

Sequence Diagrams

Shows object interactions over time rather than static class structure.

Use when: When you need to understand or document dynamic behavior and message flow.

Summary

Class diagrams visually represent classes, their attributes, methods, and relationships.

They help developers understand and communicate system structure before coding.

Class diagrams are best used for medium to large systems where design clarity is critical.