使用 @NoRepositoryBean 简化数据库访问

清疚 2024-05-24 12:59 75阅读 0赞

在 Spring Data JPA 应用程序中管理跨多个存储库接口的数据库访问逻辑可能会变得乏味且容易出错。开发人员经常发现自己为常见查询和方法重复代码，从而导致维护挑战和代码冗余。幸运的是，Spring Data JPA 为这个问题提供了一个强大的解决方案：`@NoRepositoryBean` 注解。在本文中，我们将探讨 `@NoRepositoryBean` 如何允许我们在超级接口中定义通用查询和方法，然后可以由所有基本类型存储库继承，从而简化我们的代码库并促进代码重用。

### 问题场景 ###

在 Spring Data JPA 应用程序中管理跨多个存储库接口的数据库访问逻辑通常会导致冗余代码和维护挑战。每个存储库接口可能需要类似的查询和方法，导致代码重复并降低可维护性。

### 理解@NoRepositoryBean ###

`@NoRepositoryBean` 注释充当 Spring Data JPA 中的标记接口。当应用于存储库接口时，它指示 Spring Data JPA 不要为该接口创建具体的存储库 bean。相反，它旨在用作其他存储库接口的超类，提供可继承的通用功能。

### 实体建模 ###

在深入研究存储库之前，让我们定义图书馆管理系统的实体模型：

@Entity
    public class Library {
        @Id
        @GeneratedValue(strategy = GenerationType.IDENTITY)
        private Long id;
        // Other attributes of the library entity
        @OneToMany(mappedBy = "library")
        private List<LibraryItem> items;
        // Getters and setters
    }
    @Entity
    @Inheritance(strategy = InheritanceType.JOINED)
    public class LibraryItem {
        @Id
        @GeneratedValue(strategy = GenerationType.IDENTITY)
        private Long id;
        // Common attributes for all types of library items
        @ManyToOne
        @JoinColumn(name = "library_id")
        private Library library;
        @ManyToMany
        @JoinTable(
            name = "libraryitem_author",
            joinColumns = @JoinColumn(name = "libraryitem_id"),
            inverseJoinColumns = @JoinColumn(name = "author_id"))
        private List<Author> authors;
        // Getters and setters
    }
    @Entity
    public class Book extends LibraryItem {
        // Additional attributes specific to books
        // Getters and setters
    }
    @Entity
    public class ElectronicBook extends LibraryItem {
        // Additional attributes specific to electronic books
        // Getters and setters
    }
    @Entity
    public class Magazine extends LibraryItem {
        // Additional attributes specific to magazines
        // Getters and setters
    }
    @Entity
    public class Author {
        @Id
        @GeneratedValue(strategy = GenerationType.IDENTITY)
        private Long id;
        private String name;
        // Other attributes of the author entity
        @ManyToMany(mappedBy = "authors")
        private List<LibraryItem> libraryItems;
        // Getters and setters
    }

### 创建通用查询 ###

现在我们已经定义了实体模型，让我们实现一个通用查询来根据图书馆 ID 检索图书馆项目。我们将通过创建一个用 `@NoRepositoryBean` 注释的基本存储库接口来实现这一点：

import org.springframework.data.jpa.repository.JpaRepository;
    import org.springframework.data.repository.NoRepositoryBean;
    import org.springframework.data.repository.query.Param;
    import org.springframework.data.jpa.repository.Query;
    import java.util.List;
    
    @NoRepositoryBean
    public interface BaseLibraryItemRepository<T extends LibraryItem> extends JpaRepository<T, Long> {
        @Query("SELECT t FROM #{#entityName} t WHERE t.library.id = :libraryId")
        List<T> findAllByLibraryId(@Param("libraryId") Long libraryId);
    }

在本例中，`BaseLibraryItemlRepository`定义了一个公共查询方法`findAllByLibraryId`，它根据图书馆ID检索图书馆项目。 SpEL 表达式 `#{#entityName}` 在运行时动态解析为与存储库关联的实体的名称。

### 继承通用功能 ###

import org.springframework.stereotype.Repository;
    import java.util.List;
    @Repository
    public interface BookRepository extends BaseLibraryItemRepository<Book> {
        // Additional book-specific methods can be defined here
    }

类似地，`ElectronicBookRepository`和`MagazineRepository`可以以相同的方式扩展`BaseLibraryItemRepository`。

通过这种方法，我们有效地简化了 Spring Data JPA 应用程序中的数据库访问逻辑、减少了代码重复并提高了可维护性。

### 结论 ###

总之，Spring Data JPA 中的 `@NoRepositoryBean` 注释为跨多个存储库接口管理数据库访问逻辑提供了强大的解决方案。通过在超级接口中定义通用功能，开发人员可以促进代码重用、减少冗余并增强应用程序的可维护性。这种方法在存储库共享相似查询和方法的场景中特别有用。通过实施此解决方案，开发人员可以简化其代码库并专注于实现特定于业务的逻辑，而无需承担重复的数据库访问代码的负担。

我们创建了一个高质量的Spring技术交流群，与优秀的人在一起，自己也会优秀起来，赶紧[点击加群][Link 1]，享受一起成长的快乐。

> 欢迎关注我的公众号：程序猿DD。前沿技术早知道，弯道超车有希望！积累超车资本，从关注DD开始！

[Link 1]: https://www.didispace.com/jiaqun.html