spring-data-jpa使用自定義repository來實現原生sql

Posted on by

使用自定義repository實現原生sql

Spring Data JPA中的Repository是接口，是JPA根據方法名幫我們自動生成的。但很多時候，我們需要為Repository提供一些自定義的實現。今天我們看看如何為Repository添加自定義的方法。

自定義Repository接口

首先我們來添加一個自定義的接口：

  • 添加BaseRepository接口
  • BaseRepository繼承瞭JpaRepository，這樣可以保證所有Repository都有jpa提供的基本方法。
  • 在BaseRepository上添加@NoRepositoryBean標註，這樣Spring Data Jpa在啟動時就不會去實例化BaseRepository這個接口
/**
 * Created by liangkun on 2016/12/7.
 */
@NoRepositoryBean
public interface BaseRepository<T,ID extends Serializable> extends JpaRepository<T,ID> {
 
    //sql原生查詢
    List<Map<String, Object>> listBySQL(String sql);
}

接下來實現BaseRepository接口，並繼承SimpleJpaRepository類，使其擁有Jpa Repository的提供的方法實現。

/**
 * Created by liangkun on 2017/12/7.
 */
public class BaseRepositoryImpl<T, ID extends Serializable> extends SimpleJpaRepository<T,ID> implements BaseRepository<T,ID> {
    private final EntityManager entityManager;
    //父類沒有不帶參數的構造方法，這裡手動構造父類
    public BaseRepositoryImpl(Class<T> domainClass, EntityManager entityManager) {
        super(domainClass, entityManager);
        this.entityManager = entityManager;
    }
 
    //通過EntityManager來完成查詢
    @Override
    public  List<Map<String, Object>> listBySQL(String sql) {
        return entityManager.createNativeQuery(sql).getResultList();
    }
}

這裡著重說下EntityManager

EntityManager是JPA中用於增刪改查的接口，它的作用相當於一座橋梁，連接內存中的java對象和數據庫的數據存儲。也可以根據他進行sql的原生查找。

源碼如下：

public interface EntityManager {
    <T> T find(Class<T> var1, Object var2);
    Query createNativeQuery(String var1);
    Query createNativeQuery(String var1, Class var2);
    Query createNativeQuery(String var1, String var2);
}

由上可以看出其有具體的原生查詢實現接口 createNativeQuery

接下來需要將我們自定義的Repository接口，通過工廠模式添加到Spring的容器中：

創建自定義RepositoryFactoryBean

接下來我們來創建一個自定義的RepositoryFactoryBean來代替默認的RepositoryFactoryBean。RepositoryFactoryBean負責返回一個RepositoryFactory，Spring Data Jpa 將使用RepositoryFactory來創建Repository具體實現。

查看JpaRepositoryFactoryBean的源碼，通過createRepositoryFactory返回JpaRepositoryFactory實例：

public class JpaRepositoryFactoryBean<T extends Repository<S, ID>, S, ID extends Serializable>
 extends TransactionalRepositoryFactoryBeanSupport<T, S, ID> {
 private EntityManager entityManager;
 public JpaRepositoryFactoryBean(Class<? extends T> repositoryInterface) {
  super(repositoryInterface);
 }
 
 @PersistenceContext
 public void setEntityManager(EntityManager entityManager) {
  this.entityManager = entityManager;
 }
 
 @Override
 public void setMappingContext(MappingContext<?, ?> mappingContext) {
  super.setMappingContext(mappingContext);
 }
 
 @Override
 protected RepositoryFactorySupport doCreateRepositoryFactory() {
  return createRepositoryFactory(entityManager);
 }
 
 protected RepositoryFactorySupport createRepositoryFactory(EntityManager entityManager) {
  return new JpaRepositoryFactory(entityManager);
 }
 
 @Override
 public void afterPropertiesSet() {
 
  Assert.notNull(entityManager, "EntityManager must not be null!");
  super.afterPropertiesSet();
 }
}

終上我們可根據相應的規則進行創建自定義RepositoryFactoryBean

/**
 * Created by liangkun on 2018/07/20.
 */
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 em) {
        return new BaseRepositoryFactory(em);
    }
 
    //創建一個內部類，該類不用在外部訪問
    private static class BaseRepositoryFactory<T, I extends Serializable> extends JpaRepositoryFactory {
        private final EntityManager em;
        public BaseRepositoryFactory(EntityManager em) {
            super(em);
            this.em = em;
        }
 
        //設置具體的實現類是BaseRepositoryImpl
        @Override
        protected Object getTargetRepository(RepositoryInformation information) {
            return new BaseRepositoryImpl<T, I>((Class<T>) information.getDomainType(), em);
        }
 
        //設置具體的實現類的class
        @Override
        protected Class<?> getRepositoryBaseClass(RepositoryMetadata metadata) {
            return BaseRepositoryImpl.class;
        }
    }
}

自定義完成。

SpringDataJpa原生SQL查詢

一些比較復雜的關聯查詢要怎麼實現呢，JPA的處理方法是：利用原生的SQL命令來實現那些復雜的關聯查詢，通過設置nativeQuery = true 來設置開啟使用數據庫原生SQL語句。下面就在上一個案例的基礎上實現原生sql的增刪改查，代碼如下。

a.首先在StudentRepository裡添加如下方法

//利用原生的SQL進行查詢操作 
@Query(value = "select s.* from studenttb s where s.student_name=?1", nativeQuery = true) 
public List<Student> findStudentByName(String name);
//利用原生的SQL進行刪除操作 
@Query(value = "delete from studenttb where student_id=?1 ", nativeQuery = true) 
@Modifying
@Transactional 
public int deleteStudentById(int uid); 
//利用原生的SQL進行修改操作 @Query(value = "update studenttb set student_name=?1 where student_id=?2 ", nativeQuery = true)
@Modifying 
@Transactional 
public int updateStudentName(String name,int id);
//利用原生的SQL進行插入操作
@Query(value = "insert into studenttb(student_name,student_age) value(?1,?2)", nativeQuery = true)
@Modifying
@Transactional 
public int insertStudent(String name,int age); 
@Query(value=" SELECT * FROM studenttb WHERE STUDENT_NAME LIKE %:name% ",nativeQuery=true) 
List<Student> queryBynameSQL(@Param(value = "name") String name);

b.在StudentController裡面進行調用以上方法

代碼如下：

//原生sql的調用 
/*** 
* http://localhost:8090/findStudentByName?name=劉一 
* @param name 
* @return */ 
@RequestMapping("/findStudentByName") 
public Object findStuByName(String name) { 
    List<Student> student = repository.findStudentByName(name); 
    return student; 
}
/*** 
* http://localhost:8090/deleteStudentById?id=劉 
* @param name 
* @return */ 
@RequestMapping("/deleteStudentById") 
public Object deleteStudentById(int id) { 
    int i = repository.deleteStudentById(id); 
    Map<String,Object> map=new HashMap<String,Object>(); 
    if(i>0) { 
        map.put("success", true); 
    } else { 
        map.put("success", false); 
    }
    return map; 
}
/*** 
* http://localhost:8090/updateStudentName?name=Tom&id=1 
* @param name 
* @return */ 
@RequestMapping("/updateStudentName") 
public Object updateStudentName(String name,int id) { 
    int i = repository.updateStudentName(name,id); 
    Map<String,Object> map=new HashMap<String,Object>(); 
    if(i>0) { 
        map.put("success", true); 
    } else { 
        map.put("success", false); 
    }
    return map; 
}
/*** 
* http://localhost:8090/insertStudent?name=xiao&age=18 
* @param name 
* @return */ 
@RequestMapping("/insertStudent") 
public Object insertStudent(String name,int age) { 
    int i = repository.insertStudent(name,age); 
    Map<String,Object> map=new HashMap<String,Object>(); 
    if(i>0) { 
        map.put("success", true); 
    } else { 
        map.put("success", false); 
    }
    return map; 
}
/*** 
* http://localhost:8090/queryBynameSQL?name=劉 
* @param name 
* @return */ 
@RequestMapping("/queryBynameSQL") 
public Object queryBynameSQL(String name) { 
    List<Student> student= repository.queryBynameSQL(name); 
    return student; 
}

運行效果請各位自行測試。

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

推薦閱讀：