快捷導(dǎo)航

如何為Repository添加自定義方法

更新時(shí)間：2021年11月19日 16:49:13 作者：peter824

這篇文章主要介紹了如何為Repository添加自定義方法，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教

為Repository添加自定義方法

一、為某個(gè)Repository添加自定義方法

1、定義一個(gè)接口PersonDao，聲明要添加的方法。

public interface PersonDao{
 public List<Person> getlist();
}

2、提供該接口的實(shí)現(xiàn)類PersonRepositoryImpl。類名需在要與聲明的 Repository 后添加 Impl，并實(shí)現(xiàn)PersonDao中聲明的方法。

@Repository
public class PersonRepositoryImpl implements PersonDao{
 @PersistenceContext
 private EntityManager em;
 
 @Override
 public List<Person> getlist() {
  Query query = em.createQuery("from Person");
  return query.getResultList();
 }
}

3、使用Repository 接口, 并繼承PersonDao接口。

public interface PersonRepository 
 extends JpaRepository<Person, Integer>, JpaSpecificationExecutor<Person>, PersonDao{
}

4、這時(shí)SpringData會(huì)自動(dòng)加載PersonRepositoryImpl的實(shí)現(xiàn)類。

@Test
public void testList(){
 List<Person> list = service.getList();
 for (Person p : list) {
  System.out.println(p);
 }
}

注意：XXXRepositoryImpl 與XXXRepository前面的名字必須相同，后面的也需要按照規(guī)則寫，若將XXXRepositoryImpl與XXXRepository接口放在同意包下，XXXRepositoryImpl不需要添加@Repository注解，但是當(dāng)XXXRepositoryImpl與XXXRepository接口不在同一包下，需要在在XXXRepositoryImpl類上加Repository注解進(jìn)行修飾

二、添加全局Repository

1、聲明一個(gè)接口, 在該接口中聲明需要自定義的方法, 且該接口需要繼承 Spring Data 的 Repository。

@NoRepositoryBean
public interface BaseRepository<T, ID extends Serializable> 
 extends JpaRepository<T, ID> { 
 public void helloworld();
}

注意：全局的擴(kuò)展實(shí)現(xiàn)類不要用 Imp 作為后綴名, 或?yàn)槿謹(jǐn)U展接口添加 @NoRepositoryBean 注解告知 Spring Data: Spring Data 不把其作為 Repository

2、提供BaseRepository所聲明的接口的實(shí)現(xiàn)類. 且繼承 SimpleJpaRepository, 并提供方法的實(shí)現(xiàn)。

public class BaseRepositoryImpl<T, ID extends Serializable> 
 extends SimpleJpaRepository<T, ID>
 implements BaseRepository<T, ID> {
 private EntityManager em;
 public BaseRepositoryImpl(Class<T> domainClass, EntityManager em) {
  super(domainClass, em);
  this.em = em;
 }
 @Override
 public void helloworld() {
  System.out.println("helloworld");
 }
}

3、定義 JpaRepositoryFactoryBean 的實(shí)現(xiàn)類, 使其生成BaseRepository 定義的接口實(shí)現(xiàn)類的對(duì)象。

public class BaseRepositoryFactoryBean<R extends JpaRepository<T, I>, T, I extends Serializable>
  extends JpaRepositoryFactoryBean<R, T, I> {
 
 public BaseRepositoryFactoryBean(Class<? extends R> repositoryInterface) {
  super(repositoryInterface);
 }
 @Override
 protected RepositoryFactorySupport createRepositoryFactory(EntityManager entityManager) {
  return new MyRepositoryFactory(entityManager);
 }
 
 public static class MyRepositoryFactory<T, I extends Serializable>
   extends JpaRepositoryFactory {
 
  private final EntityManager em;
  
  public MyRepositoryFactory(EntityManager entityManager) {
   super(entityManager);
   this.em = entityManager;
  }
  
  @Override
  protected Object getTargetRepository(RepositoryInformation information) {
   return new BaseRepositoryImpl<T, I>((Class<T>) information.getDomainType(), em);
  }
  
  @Override
  protected Class<?> getRepositoryBaseClass(RepositoryMetadata metadata) {
   return BaseRepositoryImpl.class;
  }
 }
}

4、修改 <jpa:repositories /> 節(jié)點(diǎn)的 factory-class 屬性指向BaseRepositoryFactoryBean的全類名。

<jpa:repositories base-package="com.znsd.springdata.dao" 
  entity-manager-factory-ref="entityManagerFactory" 
  transaction-manager-ref="txManager" 
  factory-class="com.znsd.springdata.dao.BaseRepositoryFactoryBean" />

5、使用自定義的BaseRepository接口。

public interface StudentRepository extends BaseRepository<Student, Integer>{
}

繼承jpa Repository 寫自定義方法查詢

今天在寫jpa查詢的時(shí)候，遇到了添加自定義方法，項(xiàng)目啟動(dòng)報(bào)錯(cuò)原因，現(xiàn)總結(jié)如下：

首先定義實(shí)體類

@Entity
@Table(name = "user")
Class User{
     @Id
    @GeneratedValue 
      int id；
      @Column
      String age；
      @Column
      String school；
      @Column
      String userName；
  set，get方法 （省略）
}

public interface UserRepository extends JpaRepository<User, Long> {
      List<User> findByUsernameLike(String username);
     List<User> aaa();
}

啟動(dòng)項(xiàng)目時(shí)，項(xiàng)目報(bào)錯(cuò)提示信息為：org.springframework.data.mapping.PropertyReferenceException: No property aaa found for type com.fpi.safety.common.entity.po.User

再將List<User> aaa();方法去掉后，項(xiàng)目又可以正常啟動(dòng)運(yùn)行

是什么原因呢？

經(jīng)查找，原來是繼承jpa，必須滿足一些規(guī)則，規(guī)則如下

Spring Data JPA框架在進(jìn)行方法名解析時(shí)，會(huì)先把方法名多余的前綴截取掉，比如find，findBy，read，readBy，get，getBy，然后對(duì)剩下的部分進(jìn)行解析。

假如創(chuàng)建如下的查詢：findByUserName（），框架在解析該方法時(shí)，首先剔除findBy，然后對(duì)剩下的屬性進(jìn)行解析，假設(shè)查詢實(shí)體為User

1：先判斷userName（根據(jù)POJO規(guī)范，首字母變?yōu)樾懀┦欠駷椴樵儗?shí)體的一個(gè)屬性，如果是，則表示根據(jù)該屬性進(jìn)行查詢;如果沒有該屬性，繼續(xù)第二步;

2：從右往左截取第一個(gè)大寫字母開頭的字符串此處是Name），然后檢查剩下的字符串是否為查詢實(shí)體的一個(gè)屬性，如果是，則表示根據(jù)該屬性進(jìn)行查詢;如果沒有該屬性，則重復(fù)第二步，繼續(xù)從右往左截取;最后假設(shè)用戶為查詢實(shí)體的一個(gè)屬性;

3：接著處理剩下部分（UserName），先判斷用戶所對(duì)應(yīng)的類型是否有userName屬性，如果有，則表示該方法最終是根據(jù)“User.userName”的取值進(jìn)行查詢;否則繼續(xù)按照步驟2的規(guī)則從右往左截取，最終表示根據(jù)“User.userName”的值進(jìn)行查詢。

4：可能會(huì)存在一種特殊情況，比如User包含一個(gè)的屬性，也有一個(gè)userNameChange屬性，此時(shí)會(huì)存在混合。可以明確在屬性之間加上“_”以顯式表達(dá)意思，比如“findByUser_NameChange ）“或者”findByUserName_Change（）“

從上面，我們可以得知，jap在解析是，aaa在user類中是沒有屬性的，所以報(bào)錯(cuò)No property aaa found.

如果我們想要使用jap框架，又不想再多增加一個(gè)自定義類，則必須符合其命名規(guī)則
如果，你記不住jpa的規(guī)則也沒關(guān)系，你可以自己再多寫一個(gè)類來實(shí)現(xiàn)自定義查詢方法

如下：

1. 自定義一個(gè)接口，該接口用來聲明自己額外定義的查詢。

public interface UseerRepositoryTwo {
    public List<User> searchUser(String name, int id);
}

2. 創(chuàng)建一個(gè)接口，該接口 extends JpaRepository 或者 CurdRepository，以及上面自己定義的接口 UseerRepositoryTwo

public interface UserRepositoryTwoService extends CrudRepository<LogDTO, Integer>, CustomizedLogRepository {
}

3. 實(shí)現(xiàn)UserRepositoryTwoService

注意此處的類名，必須以 2 中創(chuàng)建的接口的名字UserRepositoryTwoService，后面加上 Impl 來聲明，而不是寫成 UseerRepositoryTwoImpl

public class UserRepositoryTwoServiceImpl implements UserRepositoryTwoService {
    @Autowired
    @PersistenceContext
    private EntityManager entityManager;
    @Override
    public List<User> searchLogs(int Id, String name) {
        ......
    }
}

自己在寫自定義實(shí)現(xiàn)即可

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

您可能感興趣的文章: