如何实现适配多@Id字段的JPA通用Repository？

针对不同实体类ID字段名称不一致（含@EmbeddedId复合主键）的场景，提供两种可行解决方案：

方案一：SpEL动态获取ID字段名 #

通过自定义SpEL辅助类反射获取实体的ID字段名，结合JPA动态查询实现通用findById方法。

步骤1：编写ID字段解析工具类 #

import jakarta.persistence.Id;
import jakarta.persistence.EmbeddedId;
import java.lang.reflect.Field;

public class EntityIdResolver {
    public static String getIdFieldName(Class<?> entityClass) {
        for (Field field : entityClass.getDeclaredFields()) {
            if (field.isAnnotationPresent(Id.class) || field.isAnnotationPresent(EmbeddedId.class)) {
                return field.getName();
            }
        }
        throw new IllegalArgumentException("实体类" + entityClass.getName() + "未定义@Id或@EmbeddedId字段");
    }
}

步骤2：定义通用Repository接口 #

添加@NoRepositoryBean标记，避免Spring直接实例化该接口：

import org.springframework.data.jpa.repository.Query;
import org.springframework.data.repository.NoRepositoryBean;
import org.springframework.data.repository.Repository;

@NoRepositoryBean
public interface IUniversalRepository<T, K> extends Repository<T, K> {

    @Query("select t from #{#entityName} t where t.#{T(com.yourpackage.EntityIdResolver).getIdFieldName(T(#{#entityName}))} = ?1")
    T findById(K id);
}

步骤3：业务Repository继承使用 #

// TaxRate仓库
public interface TaxRateRepository extends IUniversalRepository<TaxRate, Integer> {
}

// Settings仓库（注意修正原示例中的泛型错误）
public interface SettingsRepository extends IUniversalRepository<Settings, String> {
}

// 复合主键实体仓库示例
public interface UserRepository extends IUniversalRepository<User, UserId> {
}

方案二：自定义Repository基类实现 #

基于Spring Data JPA的元模型API，编写通用Repository实现类，更可靠且性能更优。

步骤1：定义通用Repository接口 #

import org.springframework.data.repository.NoRepositoryBean;
import org.springframework.data.repository.Repository;

@NoRepositoryBean
public interface IUniversalRepository<T, K> extends Repository<T, K> {
    T findById(K id);
}

步骤2：编写通用实现类 #

继承SimpleJpaRepository，利用JPA元模型自动识别ID字段：

import jakarta.persistence.EntityManager;
import jakarta.persistence.TypedQuery;
import jakarta.persistence.criteria.CriteriaBuilder;
import jakarta.persistence.criteria.CriteriaQuery;
import jakarta.persistence.criteria.Root;
import org.springframework.data.jpa.repository.support.JpaEntityInformation;
import org.springframework.data.jpa.repository.support.SimpleJpaRepository;

import java.io.Serializable;

public class UniversalRepositoryImpl<T, K extends Serializable> extends SimpleJpaRepository<T, K> implements IUniversalRepository<T, K> {

    private final EntityManager entityManager;
    private final JpaEntityInformation<T, K> entityInformation;

    public UniversalRepositoryImpl(JpaEntityInformation<T, K> entityInformation, EntityManager entityManager) {
        super(entityInformation, entityManager);
        this.entityManager = entityManager;
        this.entityInformation = entityInformation;
    }

    @Override
    public T findById(K id) {
        CriteriaBuilder cb = entityManager.getCriteriaBuilder();
        CriteriaQuery<T> cq = cb.createQuery(entityInformation.getJavaType());
        Root<T> root = cq.from(entityInformation.getJavaType());
        
        // 自动获取实体的ID属性，支持普通@Id和@EmbeddedId
        cq.where(cb.equal(root.get(entityInformation.getIdAttribute()), id));
        
        TypedQuery<T> query = entityManager.createQuery(cq);
        return query.getSingleResult();
    }
}

步骤3：配置Spring使用自定义基类 #

在JPA配置类中指定自定义实现类：

import org.springframework.context.annotation.Configuration;
import org.springframework.data.jpa.repository.config.EnableJpaRepositories;

@Configuration
@EnableJpaRepositories(repositoryBaseClass = UniversalRepositoryImpl.class)
public class JpaConfig {
}

步骤4：业务仓库直接继承使用 #

同方案一的Repository继承方式即可。

方案对比 #

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