能否创建基于外部API的自定义Spring Data CrudRepository？及方案咨询

核心结论 #

可以实现基于外部API的自定义CrudRepository，但需要额外的底层配置工作；如果只是为了快速搭建对接外部API的REST服务，传统的@Controller -> @Service -> @Repository架构会更简单直接。

一、自定义Spring Data CrudRepository的可行路径 #

要让Spring Data识别并使用对接外部API的Repository，需要绕过默认的数据库驱动适配，步骤如下：

1. 定义领域模型：创建普通POJO作为领域类（无需@Entity/@RedisHash等持久化注解），比如：

   public class User {
       private Long id;
       private String name;
       // getter/setter
   }
   

2. 定义Repository接口：继承CrudRepository：

   public interface UserRepository extends CrudRepository<User, Long> {
       // 可添加自定义查询方法，比如findByName(String name)
   }
   

3. 实现Repository具体逻辑：编写实现类，在方法内调用外部API：

   public class UserRepositoryImpl implements UserRepository {
       private final RestTemplate restTemplate;
   
       public UserRepositoryImpl(RestTemplate restTemplate) {
           this.restTemplate = restTemplate;
       }
   
       @Override
       public <S extends User> S save(S entity) {
           return restTemplate.postForObject("https://external-api/users", entity, User.class);
       }
   
       @Override
       public Optional<User> findById(Long id) {
           return Optional.ofNullable(restTemplate.getForObject("https://external-api/users/{id}", User.class, id));
       }
   
       // 实现其他CrudRepository方法（findAll、deleteById等）
   }
   

4. 配置Repository工厂：自定义RepositoryFactoryBean，告诉Spring Data使用你的实现类创建Repository实例：

   public class ExternalApiRepositoryFactoryBean<T extends Repository<S, ID>, S, ID> extends RepositoryFactoryBeanSupport<T, S, ID> {
   
       public ExternalApiRepositoryFactoryBean(Class<? extends T> repositoryInterface) {
           super(repositoryInterface);
       }
   
       @Override
       protected RepositoryFactorySupport createRepositoryFactory() {
           return new ExternalApiRepositoryFactory();
       }
   
       private static class ExternalApiRepositoryFactory extends RepositoryFactorySupport {
           @Override
           protected Object getTargetRepository(RepositoryInformation information) {
               return new UserRepositoryImpl(new RestTemplate());
           }
   
           @Override
           protected Class<?> getRepositoryBaseClass(RepositoryMetadata metadata) {
               return UserRepositoryImpl.class;
           }
       }
   }
   

5. 启用自定义Repository：在配置类上指定工厂Bean：

   @Configuration
   @EnableRepositories(
       basePackages = "com.yourpackage.repository",
       repositoryFactoryBeanClass = ExternalApiRepositoryFactoryBean.class
   )
   public class RepositoryConfig {
   }
   

二、Spring Data REST不识别的原因与解决 #

Spring Data REST默认仅识别关联@Entity/@RedisHash等持久化注解的Repository，因为它需要依赖这些元数据生成标准化REST端点。要让它识别自定义Repository：

• 给领域类添加@RepositoryRestResource注解，显式声明需要暴露的端点：

  @RepositoryRestResource(path = "users")
  public class User {
      // ...
  }
  

• 或者自定义RepositoryRestConfigurer，手动注册领域类型与Repository：

  @Configuration
  public class RestConfig implements RepositoryRestConfigurer {
      @Override
      public void configureRepositoryRestConfiguration(RepositoryRestConfiguration config) {
          config.exposeIdsFor(User.class);
          config.registerRepositoryDetectionStrategy(RepositoryDetectionStrategy.RepositoryDetectionStrategies.ANNOTATED);
      }
  }
  

不过这会额外增加配置复杂度，且Spring Data REST的部分自动功能（如基于注解的查询参数解析）可能无法直接复用。

三、两种方案的取舍建议 #

如果你的核心需求是复用Spring Data REST的标准化REST端点能力，且愿意投入时间做底层适配，可尝试自定义Repository；如果只是需要快速实现对接外部API的CRUD服务，传统架构是更务实的选择。

内容的提问来源于stack exchange，提问作者Ian Lloyd