Spring Data JPA 与 SpEL 的高级用法：构建通用仓库

前言
在开发大型项目时，代码复用性是一个重要的考量因素。Spring Data JPA 提供了强大的功能，结合 SpEL（Spring Expression Language），可以实现高度灵活且可复用的代码结构。本文将通过一个具体的实例，展示如何利用 SpEL 和 Spring Data JPA 创建通用仓库接口，从而减少重复代码的编写。
一、背景介绍
在实际开发中，我们常常会遇到多个实体类继承自同一个父类的情况。例如，AsyncTask 和 SyncTask 都继承自 Task 类。如果为每个子类都单独编写仓库接口和查询方法，会导致代码冗余。通过使用 SpEL 和通用仓库接口，我们可以将查询方法定义在父类仓库中，并让子类仓库继承这些方法。
二、实例代码

1. 实体类定义
   首先定义一个抽象父类 Task，并使用 @MappedSuperclass 注解，表示该类是一个映射超类，而不是一个独立的实体。
   java复制
   @MappedSuperclass
   public abstract class Task {
   @Id
   @GeneratedValue
   private long id;
   private String name;
   // 省略 getter 和 setter 方法
   }
   接下来定义两个子类 AsyncTask 和 SyncTask，它们分别继承自 Task 类。
   java复制
   @Entity
   public class AsyncTask extends Task {
   // 省略具体实现
   }

@Entity
public class SyncTask extends Task {
// 省略具体实现
}
2. 通用仓库接口
创建一个通用仓库接口 TaskRepository，它基于泛型 T，并继承自 CrudRepository。在该接口中，使用 @Query 注解结合 SpEL 的 #entityName 变量，定义了一个通用的查询方法。
java复制
@NoRepositoryBean
public interface TaskRepository extends CrudRepository {
@Query(“SELECT t FROM #{#entityName} t WHERE t.name = ?1”)
List findTaskByName(String taskName);
}
这里使用了 @NoRepositoryBean 注解，表示该接口不会被 Spring 自动实例化为一个仓库。它只是一个模板接口，供子类仓库继承。
3. 子类仓库接口
定义两个子类仓库接口 AsyncTaskRepository 和 SyncTaskRepository，它们分别继承自 TaskRepository。
java复制
public interface AsyncTaskRepository extends TaskRepository {
}

public interface SyncTaskRepository extends TaskRepository {
}
4. 客户端代码
在客户端代码中，通过注入 AsyncTaskRepository 和 SyncTaskRepository，可以调用它们继承的通用查询方法。
java复制
@Component
public class ExampleClient {
@Autowired
private AsyncTaskRepository repoAsync;
@Autowired
private SyncTaskRepository repoSync;

public void run() {
    repoAsync.saveAll(Arrays.asList(AsyncTask.of("Scheduling"), AsyncTask.of("Cleaning")));
    repoSync.saveAll(Arrays.asList(SyncTask.of("Downloading"), SyncTask.of("Reporting")));

    System.out.println(" -- finding async task  --");
    List list = repoAsync.findTaskByName("Cleaning");
    list.forEach(System.out::println);

    System.out.println(" -- finding sync task  --");
    List list2 = repoSync.findTaskByName("Reporting");
    list2.forEach(System.out::println);
}

}
5. 主类
在主类中，启动 Spring 应用上下文并运行客户端代码。
java复制
public class ExampleMain {
public static void main(String[] args) {
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(AppConfig.class);
ExampleClient exampleClient = context.getBean(ExampleClient.class);
exampleClient.run();
EntityManagerFactory emf = context.getBean(EntityManagerFactory.class);
emf.close();
}
}
三、运行结果
运行程序后，输出如下：
复制
– finding async task –
AsyncTask{id=2, name=‘Cleaning’}
– finding sync task –
SyncTask{id=4, name=‘Reporting’}
四、总结
通过使用 Spring Data JPA 和 SpEL，我们可以创建通用仓库接口，从而减少重复代码的编写。在实际开发中，这种模式可以大大提高开发效率，同时保持代码的整洁性和可维护性。希望本文的实例能帮助你更好地理解和应用这一技术。
五、技术栈
Spring Data JPA 2.0.7.RELEASE
Hibernate Core 5.3.1.Final
H2 Database Engine 1.4.197
JDK 1.8
Maven 3.3.9