有没有办法注册一个存储库基类与一个Spring启动自动配置？

Question

我们有一个基本的JPA存储库类，其中有一些我们在项目中使用的附加实用程序方法。在Spring Data JPA留档之后，我们创建了这个类，并在配置类中使用@EnableJpaRepository注释，如以下示例所示：

@Configuration
@EnableJpaRepositories(basePackageClasses = MyApplication.class,
    repositoryBaseClass = MyJpaRepositoryImpl.class)
public class SpringDataJpaMyRepositoryConfiguration {
}

由于配置类不在应用程序根包中，因此我们还设置了base PackageClass属性，以便找到我们的存储库。一切都按预期进行，因此到目前为止没有问题。

现在，我们想创建一个spring启动启动程序，在不进行进一步配置的情况下将存储库基类添加到我们的项目中，但我们不知道如何做到这一点。如果我们使用EnableJpaRepositories注释设置repositoryBaseClass属性来创建一个自动配置类，那么在@SpringBootApplication注释的类下查找存储库的自动存储库查找策略将不再有效。

而且我们不能使用base PackageClass属性，因为我们不知道使用自动配置的项目的主类或包。

有什么办法吗？也许在我们的自动配置中重新定义一些bean？

理想的方法是允许设置存储库基类，而不必再次定义所有的Spring Data JPA自动配置。

Answer 1

编辑：我几乎重写了我的答案——我误解了最初的问题

这不是最好的解决方案，但我能看到这一点的唯一方法是在@EnableJpaRepositories中使用SpEL。

然后，可以在自动配置中使用@ConditionalOnProperty仅在设置了基本包属性的情况下进行自动配置

@Configuration
@ConditionalOnProperty("repositories-base-packages")
public class BaseRepositoryAutoConfiguration {

    @Configuration
    @EnableJpaRepositories(
            repositoryBaseClass = MyJpaRepositoryImpl.class,
            basePackages = "${repositories-base-packages}"
    )
    public static class JpaRepositoriesConfig { }

}

然后确保你有一个应用程序。属性或应用程序。yml在应用程序中定义存储库基本包。

不确定如何声明多个基本包，我的SpEL知识是原始的，所以不确定它是否可能。

Answer 2

这个问题当时把我逼疯了，所以我想我可以在这方面帮你。

基本上，这个想法是：

• 为Jpa配置创建一个配置类
• 添加引用与basePackageClass相同的配置类的@EntityScan和@EnableJpaRepositories
• 在自动配置中导入此配置类
• 创建一个注释，然后在需要Jpa配置的地方重用它

在您的示例中，您使用Spring应用程序类作为扫描的基础。

我已经提出了一个示例项目POC的主要想法在https://github.com/rdlopes/custom-jpa-demo

在本例中，有一个JPA实体/存储库项目公开了一个JPA配置：

   @Configuration
   @EntityScan(basePackageClasses = JpaConfiguration.class)
   @EnableJpaRepositories(basePackageClasses = JpaConfiguration.class,
                          repositoryBaseClass = BaseRepositoryImpl.class)
   public class JpaConfiguration {

   }

小心你的存储库的通用实现，你需要显示一个特殊的签名：

@NoRepositoryBean
public class BaseRepositoryImpl<T, ID extends Serializable>
        extends SimpleJpaRepository<T, ID>
        implements BaseRepository<T, ID> {

    public BaseRepositoryImpl(JpaEntityInformation<T, ID> entityInformation, EntityManager entityManager) {
        super(entityInformation, entityManager);
    }

    @Override
    public String someCustomMethod(ID id) {
        return "Class for entity of id " + id + " is: " + getDomainClass().getSimpleName();
    }
}

然后，您可以创建如下自动配置：

@Configuration
@ConditionalOnClass(CustomJpaRepositories.class)
@Import(JpaConfiguration.class)
public class JpaCustomAutoConfiguration {

}

提供一个注释来保持整洁，并在需要JPA的地方使用它：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface CustomJpaRepositories {
}

使用您的JPA类将非常简单，就像使用以下注释一样，您可以在其中调用您的JPA存储库：

@SpringBootApplication
@CustomJpaRepositories
public class CustomJpaSampleApplication {

    public static void main(String[] args) {
        SpringApplication.run(CustomJpaSampleApplication.class, args);
    }

    @Bean
    public CommandLineRunner dataInitializer(UserRepository userRepository) {
        return args -> {
            User user1 = new User();
            user1.setName("user 1");
            userRepository.save(user1);

            User user2 = new User();
            user2.setName("user 2");
            userRepository.save(user2);

            userRepository.findAll()
                          .forEach(user -> System.out.println(
                                  userRepository.someCustomMethod(user.getId())));
        };
    }
}

希望这有助于你度过挠头的时刻：-）