快捷導(dǎo)航

Spring?Data?JPA框架的核心概念與Repository接口詳解

更新時間：2022年04月27日 16:05:01 作者：嫣夜來

Spring?Data?JPA是Spring基于JPA規(guī)范的基礎(chǔ)上封裝的?套?JPA?應(yīng)?框架，可使開發(fā)者?極簡的代碼即可實現(xiàn)對數(shù)據(jù)庫的訪問和操作，本篇我們來了解Spring?Data?JPA框架的核心概念與Repository接口

1 核心概念

Spring Data存儲庫抽象的中心接口是Repository。它把要管理的實體類以及實體類的ID類型作為類型參數(shù)。這個接口主要是作為一個標(biāo)記接口，用來捕捉工作中的類型，并幫助你發(fā)現(xiàn)擴(kuò)展這個接口的接口。CrudRepository接口為被管理的實體類提供復(fù)雜的CRUD功能。

自己可以看看Repository的擴(kuò)展接口以及實現(xiàn)類 IDEA中將光標(biāo)定位在Repository.java文件中， ctrl+h快捷鍵就可以看。

類圖繼承關(guān)系如下:

CrudRepository接口

這個接口定義了一套CRUD基本操作的方法，使用起來很方便

CrudRepository接口比較強(qiáng)大的地方在于可以派生方法,什么意思，舉個例子

you一張用戶表，如果你想按照某個字段統(tǒng)計一下數(shù)量，這個實現(xiàn)的確非常強(qiáng)大。

public interface MemberMapper extends CustomRepository<Member, Long> {
    /** 派生方法按照用戶名統(tǒng)計人數(shù) */
    Long countByMemberName(String username);
    /** 派生方法按照用戶部門號統(tǒng)計人數(shù) */
    Long countByDeptId(Integer deptId);
}

PagingAndSortingRepository接口

在CrudRepository之上，有一個PagingAndSortingRepository的抽象，它增加了額外的方法以方便對實體類的分頁查詢訪問

2 查詢方法

標(biāo)準(zhǔn)的CRUD功能庫通常有對底層數(shù)據(jù)存儲的查詢。使用Spring Data，聲明這些查詢需要4個步驟:

1】聲明一個擴(kuò)展Repository或其子接口之一的接口，并指定它應(yīng)該處理的實體類和ID類型

interface MemberRepository extends Repository<Member, Long> { … }

2】在接口中聲明查詢方法

interface MemberRepository extends Repository<Member, Long> {
  List<Member> findByMembername(String username);
}

3】設(shè)置Spring為這些接口創(chuàng)建代理實例，可以使用配置類或xml配置文件的方式來實現(xiàn)

通過配置類的方式，示例如下：

import org.springframework.data.jpa.repository.config.EnableJpaRepositories;
@EnableJpaRepositories
public class MyConfig {
 }

通過 xml配置文件的方式，示例如下：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns:jpa="http://www.springframework.org/schema/data/jpa"
   xsi:schemaLocation="http://www.springframework.org/schema/beans
     https://www.springframework.org/schema/beans/spring-beans.xsd
     http://www.springframework.org/schema/data/jpa
     https://www.springframework.org/schema/data/jpa/spring-jpa.xsd">
   <jpa:repositories base-package="com.kkarma.repository"/>
</beans>

本示例中使用的是JPA命名空間。如果你對任何其他存儲使用存儲庫抽象，你需要將其修改成你的存儲模塊的對應(yīng)命名空間聲明。換句話說，你應(yīng)該把jpa換成其他的存儲類型，例如mongodb。

另外，請注意，JavaConfig配置類并不明確地配置掃描的基礎(chǔ)包，因為默認(rèn)情況下會使用注釋類的包。要自定義要掃描的包，請使用數(shù)據(jù)存儲特定庫的 @Enable${store}Repositories-annotation 的 basePackage… 屬性之一。什么意思呢，舉例：

如果你的store類型是 mongodb, 就使用@EnableMongoRepositories

@Configuration
@EnableMongoRepositories(*arrayOf("com.kkarma.repository", "com.???.???"))
class PersistenceConfig : AbstractMongoConfiguration() {
}

如果你的store類型是 redis, 就使用@EnableRedisRepositories

如果你的store類型是 jpa, 就使用@EnableJpaRepositories

簡單配置單個package，格式如下：

@EnableJpaRepositories("com.spr.repository")

簡單配置支持多個package，格式如下：

@EnableJpaRepositories({"com.cshtong.sample.repository", "com.cshtong.tower.repository"})

4】注入Repository實例并使用它

@Service
public class MemberServiceImpl implements MemberService {
    private final MemberMapper memberMapper;
    public MemberServiceImpl(MemberMapper memberMapper) {
        this.memberMapper = memberMapper;
    }
    @Override
    public ApiResponse insertMember(Member member) {
        Member user = memberMapper.save(member);
        return ApiResponse.success("新增成功", user);
    }
}