如何為Repository添加自定義方法

Posted on by

為Repository添加自定義方法

一、為某個Repository添加自定義方法

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

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

2、提供該接口的實現類PersonRepositoryImpl。類名需在要與聲明的 Repository 後添加 Impl，並實現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、這時SpringData會自動加載PersonRepositoryImpl的實現類。

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

註意：XXXRepositoryImpl 與XXXRepository前面的名字必須相同，後面的也需要按照規則寫，若將XXXRepositoryImpl與XXXRepository接口放在同意包下，XXXRepositoryImpl不需要添加@Repository註解，但是當XXXRepositoryImpl與XXXRepository接口不在同一包下，需要在在XXXRepositoryImpl類上加Repository註解進行修飾

二、添加全局Repository

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

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

註意：全局的擴展實現類不要用 Imp 作為後綴名, 或為全局擴展接口添加 @NoRepositoryBean 註解告知 Spring Data: Spring Data 不把其作為 Repository

2、提供BaseRepository所聲明的接口的實現類. 且繼承 SimpleJpaRepository, 並提供方法的實現。

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 的實現類, 使其生成BaseRepository 定義的接口實現類的對象。

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 /> 節點的 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查詢的時候，遇到瞭添加自定義方法，項目啟動報錯原因，現總結如下：

首先定義實體類

@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();
}

啟動項目時，項目報錯提示信息為：org.springframework.data.mapping.PropertyReferenceException: No property aaa found for type com.fpi.safety.common.entity.po.User

再將List<User> aaa();方法去掉後，項目又可以正常啟動運行

是什麼原因呢？

經查找，原來是繼承jpa，必須滿足一些規則，規則如下

Spring Data JPA框架在進行方法名解析時，會先把方法名多餘的前綴截取掉，比如find，findBy，read，readBy，get，getBy，然後對剩下的部分進行解析。

假如創建如下的查詢：findByUserName（），框架在解析該方法時，首先剔除findBy，然後對剩下的屬性進行解析，假設查詢實體為User

1：先判斷userName（根據POJO規范，首字母變為小寫）是否為查詢實體的一個屬性，如果是，則表示根據該屬性進行查詢;如果沒有該屬性，繼續第二步;

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

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

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

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

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

如下：

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

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

2. 創建一個接口，該接口 extends JpaRepository 或者 CurdRepository， 以及上面自己定義的接口 UseerRepositoryTwo

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

3. 實現UserRepositoryTwoService

註意此處的類名，必須以 2 中創建的接口的名字UserRepositoryTwoService，後面加上 Impl 來聲明，而不是寫成 UseerRepositoryTwoImpl

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

自己在寫自定義實現即可

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：