如何在Spring Data JDBC的@Query中转换自定义类型参数为字符串

嘿，这个问题我之前也碰到过，Spring Data JDBC对自定义值对象的参数转换确实需要额外配置，我来一步步帮你解决：

核心问题原因 #

Spring Data JDBC默认不知道怎么把你的UserId自定义类型映射到数据库的VARCHAR/String字段，所以必须注册类型转换器来告诉它如何转换，这比你尝试的直接访问属性或者SpEL表达式更通用、更优雅。

步骤1：编写类型转换器 #

你需要实现Spring的Converter接口，分别处理UserId -> String（参数绑定到SQL时）和String -> UserId（从数据库读取数据映射回对象时）的转换：

import org.springframework.core.convert.converter.Converter;
import org.springframework.stereotype.Component;

// 把UserId转成数据库能识别的String
@Component
public class UserIdToStringConverter implements Converter<UserId, String> {
    @Override
    public String convert(UserId userId) {
        return userId.getValue(); // 假设你的UserId有getValue()方法返回内部的String值
    }
}

// 从数据库的String转回到UserId对象（如果需要查询结果映射的话）
@Component
public class StringToUserIdConverter implements Converter<String, UserId> {
    @Override
    public UserId convert(String username) {
        return new UserId(username); // 假设UserId有接收String的构造方法
    }
}

步骤2：在JDBC配置中注册转换器 #

因为你的配置类继承了AbstractJdbcConfiguration，可以重写jdbcCustomConversions()方法，把刚才的转换器加入到Spring Data JDBC的自定义转换体系中：

import org.springframework.context.annotation.Configuration;
import org.springframework.data.jdbc.repository.config.EnableJdbcRepositories;
import org.springframework.data.jdbc.repository.config.AbstractJdbcConfiguration;
import org.springframework.data.jdbc.core.convert.JdbcCustomConversions;
import java.util.ArrayList;
import java.util.List;

@Configuration
@EnableJdbcRepositories
public class PersistenceConfig extends AbstractJdbcConfiguration {

    private final UserIdToStringConverter userIdToStringConverter;
    private final StringToUserIdConverter stringToUserIdConverter;

    // 构造注入转换器（Spring会自动扫描@Component标注的类）
    public PersistenceConfig(UserIdToStringConverter userIdToStringConverter,
                             StringToUserIdConverter stringToUserIdConverter) {
        this.userIdToStringConverter = userIdToStringConverter;
        this.stringToUserIdConverter = stringToUserIdConverter;
    }

    @Override
    protected JdbcCustomConversions jdbcCustomConversions() {
        List<Converter<?, ?>> converters = new ArrayList<>();
        converters.add(userIdToStringConverter);
        converters.add(stringToUserIdConverter);
        return new JdbcCustomConversions(converters);
    }
}

步骤3：使用原来的查询方法即可 #

现在你不需要修改原来的@Query代码，Spring Data JDBC会自动帮你把UserId参数转换成对应的String值：

@Query("select * from USERS where USERNAME = :id")
User findById(@Param("id") UserId id);

为什么之前的尝试无效？ #

• :id.value：这种写法不符合Spring Data JDBC的参数绑定规则，它会把id.value当作一个独立的参数名去查找，而不是解析id对象的属性。
• :#{id.value}：理论上SpEL表达式是可以工作的，但可能因为参数在SpEL上下文中的可见性问题（比如参数命名的问题）导致失败，而且这种写法只能在这个查询里用，不如转换器通用。

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