0Pricing
Spring Boot 4 Complete Guide · 课时

自定义 Spring Data 数据仓库

通过自定义方法和查询定义扩展 Spring Data JPA 数据仓库，以处理复杂的数据操作。

自定义 Spring Data 数据仓库 是 CoddyKit 上的免费 Spring Boot 4 Complete Guide 课时。 这是第 1 节课，共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 Spring Boot 4 Complete Guide 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 Spring Boot 4 Complete Guide 课程共包含 4 节课。

本课时的部分内容尚未翻译，以英文显示。

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!

常见问题解答

「自定义 Spring Data 数据仓库」课时是免费的吗？

是的 — 「自定义 Spring Data 数据仓库」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 Spring Boot 4 Complete Guide 课程的其余内容，请升级到 CoddyKit PRO。 Spring Boot 4 Complete Guide 课程共包含 4 节课。

「自定义 Spring Data 数据仓库」这节课中我会学到什么？

通过自定义方法和查询定义扩展 Spring Data JPA 数据仓库，以处理复杂的数据操作。 你通过在浏览器中直接运行的动手代码来练习 Spring Boot 4 Complete Guide，全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 Spring Boot 4 Complete Guide 需要有经验吗？

无需任何先前经验。CoddyKit 上的 Spring Boot 4 Complete Guide 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。 这是第 1 节课，共 4 节。

「自定义 Spring Data 数据仓库」课时需要多长时间？

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。

我能在这节 Spring Boot 4 Complete Guide 课中编写并运行代码吗？

能。每节 Spring Boot 4 Complete Guide 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

  1. 自定义 Spring Data 数据仓库
  2. 集成 NoSQL 数据库
  3. 使用 Spring Cache 进行缓存
  4. 使用 Flyway 进行数据库迁移
← 返回 Spring Boot 4 Complete Guide