Spring Boot 4 Complete Guide · Lesson

Custom Spring Data Repositories

Extend Spring Data JPA repositories with custom methods and query definitions for complex data operations.

Custom Spring Data Repositories is a free Spring Boot 4 Complete Guide 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 Spring Boot 4 Complete Guide learning path, one of 4 lessons in the course, and your progress syncs across the web and the CoddyKit app.

Intro to Custom Repositories

Spring Data JPA is amazing for reducing boilerplate code, but sometimes you need very specific, complex data operations that aren't covered by simple method name derivations.

This is where custom repositories come in! They allow you to define and implement your own complex data access logic, extending Spring Data JPA's capabilities.

When to Use Custom Logic

When do you need to write custom repository logic? Here are some common scenarios:

Complex Joins & Aggregations: When standard query methods can't express your join or aggregation needs.
Batch Operations: Performing updates or deletions on multiple records that require specific logic.
Stored Procedures: Interacting with database-specific stored procedures.
Performance Tuning: Applying specific query hints or optimizations.
Business-Specific Operations: Logic that combines several data access steps into one cohesive method.

Defining a Custom Interface

The first step is to define an interface for your custom methods. This interface will declare the methods that don't fit Spring Data JPA's conventions.

Think of it as a blueprint for your unique data operations.

package com.coddykit.repo;

public interface CustomUserRepository {
    void activateUsersOlderThan(int age);
    // Add more specific methods here
}

Implementing Custom Logic

Next, create a class that implements your custom interface. This is where you'll write the actual code for your complex data operations.

You'll typically use EntityManager from JPA or JdbcTemplate for more direct SQL interaction.

package com.coddykit.repo.impl;

import com.coddykit.repo.CustomUserRepository;
import jakarta.persistence.EntityManager;
import jakarta.persistence.PersistenceContext;
import jakarta.transaction.Transactional;

public class CustomUserRepositoryImpl implements CustomUserRepository {

    @PersistenceContext
    private EntityManager entityManager;

    @Override
    @Transactional
    public void activateUsersOlderThan(int age) {
        System.out.println("Executing custom logic...");
        entityManager.createQuery(
            "UPDATE User u SET u.active = true WHERE u.age > :age")
            .setParameter("age", age)
            .executeUpdate();
    }
}

Integrating with Main Repository

To make your custom implementation available, your main Spring Data JPA repository interface needs to extend your custom interface.

Spring Data JPA will automatically detect and link the implementation class (it expects the implementation class name to be [CustomInterfaceName]Impl).

package com.coddykit.repo;

import com.coddykit.entity.User;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;

@Repository
public interface UserRepository extends JpaRepository<User, Long>, CustomUserRepository {
    // Standard methods from JpaRepository
    // Plus custom methods from CustomUserRepository
}

Full Custom Repository Demo

Let's see a complete example demonstrating a custom repository in action. We'll define a User entity, a UserRepository that combines standard and custom methods, and a Spring Boot app to use it.

Try running this example:

package com.coddykit;

import jakarta.persistence.Entity;
import jakarta.persistence.GeneratedValue;
import jakarta.persistence.GenerationType;
import jakarta.persistence.Id;
import jakarta.transaction.Transactional;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import jakarta.persistence.EntityManager;
import jakarta.persistence.PersistenceContext;

// 1. User Entity
@Entity
class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String name;
    private int age;
    private boolean active;

    public User() {}
    public User(String name, int age, boolean active) {
        this.name = name;
        this.age = age;
        this.active = active;
    }

    public Long getId() { return id; }
    public void setId(Long id) { this.id = id; }
    public String getName() { return name; }
    public void setName(String name) { this.name = name; }
    public int getAge() { return age; }
    public void setAge(int age) { this.age = age; }
    public boolean isActive() { return active; }
    public void setActive(boolean active) { this.active = active; }

    @Override
    public String toString() {
        return "User{" + "id=" + id + ", name='" + name + '\'' + ", age=" + age + ", active=" + active + '}';
    }
}

// 2. Custom Interface
interface CustomUserRepository {
    void activateUsersOlderThan(int age);
}

// 3. Custom Implementation
class CustomUserRepositoryImpl implements CustomUserRepository {
    @PersistenceContext
    private EntityManager entityManager;

    @Override
    @Transactional
    public void activateUsersOlderThan(int age) {
        System.out.println("Activating users older than " + age + "...");
        entityManager.createQuery(
            "UPDATE User u SET u.active = true WHERE u.age > :age")
            .setParameter("age", age)
            .executeUpdate();
    }
}

// 4. Main Repository extends JpaRepository and Custom Interface
@Repository
interface UserRepository extends JpaRepository<User, Long>, CustomUserRepository {
    // Spring Data JPA methods
}

@SpringBootApplication
public class Main implements CommandLineRunner {

    @Autowired
    private UserRepository userRepository;

    public static void main(String[] args) {
        SpringApplication.run(Main.class, args);
    }

    @Override
    public void run(String... args) throws Exception {
        // Save some users
        userRepository.save(new User("Alice", 25, false));
        userRepository.save(new User("Bob", 30, false));
        userRepository.save(new User("Charlie", 35, false));

        System.out.println("--- Initial Users ---");
        userRepository.findAll().forEach(System.out::println);

        // Use custom method
        userRepository.activateUsersOlderThan(28);

        System.out.println("--- Users After Custom Update ---");
        userRepository.findAll().forEach(System.out::println);
    }
}

Using @Query for JPQL/HQL

For specific queries that aren't easily expressed by method names, you can use the @Query annotation. It allows you to write JPQL (Java Persistence Query Language) or HQL (Hibernate Query Language) directly on your repository methods.

You can use positional parameters (?1) or named parameters (:paramName).

package com.coddykit.repo;

import com.coddykit.entity.User;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.Query;
import org.springframework.stereotype.Repository;
import java.util.List;

@Repository
public interface UserRepository extends JpaRepository<User, Long> {

    @Query("SELECT u FROM User u WHERE u.age > ?1 AND u.active = true")
    List<User> findActiveUsersOlderThan(int age);

    @Query("SELECT u FROM User u WHERE u.name LIKE %:namePart%")
    List<User> findUsersWithNameContaining(@org.springframework.data.repository.query.Param("namePart") String namePart);
}

Native SQL Queries with @Query

Sometimes, JPQL isn't enough, and you need to use native SQL queries specific to your database (e.g., for database-specific functions or performance reasons).

You can do this by setting nativeQuery = true in the @Query annotation. Be careful, as native queries are less portable across different databases.

package com.coddykit.repo;

import com.coddykit.entity.User;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.Query;
import org.springframework.stereotype.Repository;
import java.util.List;

@Repository
public interface UserRepository extends JpaRepository<User, Long> {

    @Query(value = "SELECT * FROM User WHERE age < ?1 ORDER BY name", nativeQuery = true)
    List<User> findYoungerUsersNative(int age);

    @Query(value = "SELECT COUNT(*) FROM User WHERE active = :status", nativeQuery = true)
    long countUsersByActiveStatusNative(@org.springframework.data.repository.query.Param("status") boolean status);
}

Dynamic Queries with Specifications

For highly dynamic queries based on varying criteria (e.g., complex search filters), Spring Data JPA offers JpaSpecificationExecutor.

It allows you to define reusable query predicates using the JPA Criteria API.
This approach is powerful for building queries that change at runtime without needing to write many static @Query methods.
It's a more advanced technique for flexible search screens.

Custom Repository Check

Which of the following are valid ways to extend Spring Data JPA repositories with custom functionality?

Recap: Custom Repositories

In this lesson, we explored how to go beyond basic Spring Data JPA methods:

We defined custom interfaces and implemented them to encapsulate complex, unique data access logic.
We integrated these custom implementations with our main repositories.
We learned to use the @Query annotation for both JPQL/HQL and native SQL queries to define specific data retrieval.
We briefly touched upon JpaSpecificationExecutor for building dynamic queries based on varying criteria.

These techniques empower you to handle almost any data access requirement in your Spring Boot applications!

Frequently asked questions

Is the “Custom Spring Data Repositories” lesson free?

Yes — the full text of “Custom Spring Data Repositories” is free to read here on the web, and the Spring Boot 4 Complete Guide 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 Spring Boot 4 Complete Guide course, upgrade to CoddyKit PRO.

What will I learn in “Custom Spring Data Repositories”?

Extend Spring Data JPA repositories with custom methods and query definitions for complex data operations. You practise Spring Boot 4 Complete Guide 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 Spring Boot 4 Complete Guide?

No prior experience is required. Spring Boot 4 Complete Guide 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 “Custom Spring Data Repositories” 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 Spring Boot 4 Complete Guide lesson?

Yes. Every Spring Boot 4 Complete Guide 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

← Back to Spring Boot 4 Complete Guide