Spring Data JPA如何以String格式查询枚举类型字段？

问题 #

我有如下实体类：

public class Role {

    @Id
    private Long id;

    @Enumerated(EnumType.STRING)
    private RoleName name;
}

对应的RoleName枚举类如下：

public enum RoleName {
    ROLE_USER,
    ROLE_ADMIN
}

我尝试按名称查询角色，目前必须传入RoleName枚举格式的参数（传入String会抛出异常），代码如下：

Role r = roleRepository.findByName(RoleName.valueOf(role))
                    .orElseThrow(() -> new NoSuchElementFoundException(NOT_FOUND));

但当用户请求不存在的角色时，会出现如下错误：

Resolved [java.lang.IllegalArgumentException: No enum constant com.company.model.RoleName.ROLE_TEST]

由于用户提供的是String数组形式的角色，我不想先将其转换为枚举，而是直接以String格式查询数据库中是否存在对应角色，请问是否可行？有什么解决办法？

解决办法 #

完全可行，以下是几种实用的解决方案：

1. 在Repository层新增String参数的查询方法 #

直接在RoleRepository接口中定义接收String类型参数的查询方法，JPA会自动处理枚举与数据库存储字符串的映射逻辑：

@Repository
public interface RoleRepository extends JpaRepository<Role, Long> {
    // 保留原有的枚举参数方法（如果需要）
    Optional<Role> findByName(RoleName name);
    
    // 新增支持String参数的查询方法
    Optional<Role> findByName(String name);
}

调用时直接传入String类型的角色名称即可，不存在的角色会返回Optional.empty()，不会抛出IllegalArgumentException：

Role r = roleRepository.findByName(role)
                .orElseThrow(() -> new NoSuchElementFoundException(NOT_FOUND));

2. 使用@Query自定义SQL查询 #

如果需要更灵活的查询逻辑，可以通过@Query编写自定义SQL实现：

@Repository
public interface RoleRepository extends JpaRepository<Role, Long> {
    @Query("SELECT r FROM Role r WHERE r.name = :name")
    Optional<Role> findByName(@Param("name") String name);
}

这种方式和第一种效果一致，JPA会自动完成字符串与枚举字段的匹配。

3. 批量查询处理（适配String数组场景） #

针对用户传入String数组的场景，可以定义批量查询方法一次性获取所有存在的角色：

@Repository
public interface RoleRepository extends JpaRepository<Role, Long> {
    List<Role> findByNameIn(Collection<String> names);
}

调用时将String数组转为集合传入即可，后续可以对比传入的数组和返回的列表，快速定位不存在的角色做后续处理。

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