The Repository Pattern in Clean Arch
Implement the Repository pattern to abstract data access, allowing Use Cases to interact with data persistence without knowing its details.
The Repository Pattern in Clean Arch is a free Clean Architecture & Design Patterns in Practice lesson on CoddyKit — lesson 1 of 4. You can read the complete lesson below for free — then practise it hands-on in the browser with a built-in code editor and a 24/7 AI tutor. It is part of the Clean Architecture & Design Patterns in Practice learning path, one of 4 lessons in the course, and your progress syncs across the web and the CoddyKit app.
What's the Repository Pattern?
In Clean Architecture, we want our core business logic (Use Cases) to be independent of external details like databases or web frameworks.
The Repository Pattern helps achieve this by abstracting the way data is stored and retrieved. It acts as a mediator between the domain and data mapping layers.
The Problem: Direct Data Access
Imagine your Use Case directly querying a database or calling an ORM (Object-Relational Mapper) like Hibernate or Entity Framework.
- Your Use Case becomes coupled to the database technology.
- Changing the database means changing the Use Case.
- Testing Use Cases requires a live database connection.
This violates the Dependency Rule of Clean Architecture, which states that dependencies should only point inwards.
Introducing the Repository Interface
The solution is to define an interface (a contract) for data access within your Use Case layer. This interface is the Repository.
It declares methods like findById(), save(), or findAll(). The Use Case layer owns this interface, meaning it defines what data operations it needs.
Code: User & Repository Interface
First, we define a simple User entity. Then, the UserRepository interface specifies the contract for how we'll interact with User data.
public class User {
String id;
String name;
public User(String id, String name) {
this.id = id; this.name = name;
}
public String getId() { return id; }
public String getName() { return name; }
@Override public String toString() {
return name + " (" + id + ")";
}
}
public interface UserRepository {
User findById(String id);
void save(User user);
}
public class Main {
public static void main(String[] args) {
System.out.println("User entity and UserRepository interface defined.");
}
}Repository Implementations
While the interface lives in your core domain, the concrete implementation of the Repository lives in an outer layer, typically the 'Interface Adapters' or 'Frameworks/Drivers' layer.
This implementation knows the details of the specific persistence technology (e.g., SQL database, NoSQL database, external API, or even in-memory storage).
Code: In-Memory Implementation
Here's an example of an InMemoryUserRepository. It implements the UserRepository interface using a simple HashMap, simulating a database for testing or simple applications.
// Assume User and UserRepository exist
import java.util.HashMap;
import java.util.Map;
public class InMemoryUserRepository implements UserRepository {
private final Map<String, User> users = new HashMap<>();
@Override
public User findById(String id) {
return users.get(id);
}
@Override
public void save(User user) {
users.put(user.getId(), user);
}
}
public class Main {
public static void main(String[] args) {
InMemoryUserRepository repo = new InMemoryUserRepository();
User newUser = new User("001", "Charlie");
repo.save(newUser);
User found = repo.findById("001");
System.out.println("Found user: " + found.getName());
}
}Use Cases & Repositories
A Use Case receives an instance of the UserRepository interface through dependency injection (e.g., via its constructor).
The Use Case then calls methods on this interface, completely unaware of whether it's talking to an in-memory map, a SQL database, or a remote API. This is true decoupling!
Code: Use Case with Repository
This CreateUserUseCase depends only on the UserRepository interface, not its specific implementation. This makes it highly testable and flexible.
// Assume User, UserRepository, InMemoryUserRepository exist
public class CreateUserUseCase {
private final UserRepository userRepository;
public CreateUserUseCase(UserRepository userRepository) {
this.userRepository = userRepository;
}
public User execute(String id, String name) {
User newUser = new User(id, name);
userRepository.save(newUser);
return newUser;
}
}
public class Main {
public static void main(String[] args) {
// Inject the in-memory implementation
UserRepository repo = new InMemoryUserRepository();
CreateUserUseCase createUser = new CreateUserUseCase(repo);
User createdUser = createUser.execute("002", "Diana");
System.out.println("Created user: " + createdUser.getName());
User found = repo.findById("002");
System.out.println("Verified in repo: " + found.getName());
}
}Benefits of Repositories in Clean Arch
Using the Repository Pattern offers significant advantages:
- Decoupling: Business rules are isolated from data storage details.
- Testability: Use Cases can be tested with mock or in-memory repositories.
- Flexibility: Easily swap data sources (e.g., from SQL to NoSQL) without changing core logic.
- Maintainability: Changes in data access technology are localized to repository implementations.
Quick Check on Repositories
The Repository Pattern is a cornerstone for maintaining separation of concerns in Clean Architecture.
Repository Pattern: Recap
You've learned about the Repository Pattern and its crucial role in Clean Architecture!
- It abstracts data access from your core business logic.
- It uses an interface (owned by the domain) and concrete implementations (in outer layers).
- This approach greatly enhances decoupling, testability, and flexibility.
By implementing Repositories, you ensure your Use Cases remain clean, focused, and independent of external data storage mechanisms.
Frequently asked questions
Is the “The Repository Pattern in Clean Arch” lesson free?
Yes — the full text of “The Repository Pattern in Clean Arch” is free to read here on the web, and the Clean Architecture & Design Patterns in Practice course includes 4 lessons in total. To practise it interactively (a built-in code editor and a 24/7 AI tutor) and unlock the rest of the Clean Architecture & Design Patterns in Practice course, upgrade to CoddyKit PRO.
What will I learn in “The Repository Pattern in Clean Arch”?
Implement the Repository pattern to abstract data access, allowing Use Cases to interact with data persistence without knowing its details. You practise Clean Architecture & Design Patterns in Practice with hands-on code you run directly in the browser, and a 24/7 AI tutor answers your questions as you work through the lesson.
Do I need any experience to start Clean Architecture & Design Patterns in Practice?
No prior experience is required. Clean Architecture & Design Patterns in Practice on CoddyKit is structured for beginners through advanced learners; this is — lesson 1 of 4, so you can start here or from the beginning and move at your own pace.
How long does the “The Repository Pattern in Clean Arch” lesson take?
Most CoddyKit lessons take about 5–10 minutes. Each one is bite-sized and interactive, so you make steady progress and pick up exactly where you left off across the web and the app.
Can I write and run code in this Clean Architecture & Design Patterns in Practice lesson?
Yes. Every Clean Architecture & Design Patterns in Practice lesson includes a built-in code editor, so you write and run real code right in your browser and get instant AI feedback — no local setup required.
All lessons in this course
- The Repository Pattern in Clean Arch
- Gateway Interfaces for External Systems
- Data Mappers and DTOs
- Anti-Corruption Layers for Third-Party APIs