如何在spring-data-rest的HAL _links中将UUID编码修改为base-32格式

问题根因 #

Spring Data REST 生成 HAL 结构的 _links 字段时，不会走 Jackson 的序列化逻辑，而是使用自身的 ID 转换机制生成路径中的 ID 段，因此你之前配置的 UUID 序列化器仅对响应体中的普通 UUID 字段生效，对链接中的 UUID 无效。

解决方案 #

实现 Spring Data REST 提供的 BackendIdConverter 接口，自定义 ID 转换逻辑，该接口专门用于处理实体 ID 和 URL 中 ID 字符串的双向转换，配置后会在生成和解析链接时自动调用。

代码实现

import org.springframework.data.rest.webmvc.spi.BackendIdConverter;
import org.springframework.stereotype.Component;
import java.io.Serializable;
import java.util.UUID;

@Component
public class Base32UuidBackendIdConverter implements BackendIdConverter {

    // 保持和你现有 UUIDSerialiser 中一致的 base32 编码逻辑
    private String convertUuidToBase32(UUID uuid) {
        // 替换为你自己的 base32 编码实现
    }

    // 保持和你现有 UUIDDeserialiser 中一致的 base32 解码逻辑
    private UUID convertBase32ToUuid(String base32Str) {
        // 替换为你自己的 base32 解码实现，可保留原有兼容标准UUID格式的逻辑
    }

    @Override
    public Serializable fromRequestId(String id, Class<?> entityType) {
        // 解析入站请求URL中的ID字符串为实体ID
        return convertBase32ToUuid(id);
    }

    @Override
    public String toRequestId(Serializable id, Class<?> entityType) {
        // 生成出站链接时将UUID转为base32格式
        if (id instanceof UUID uuid) {
            return convertUuidToBase32(uuid);
        }
        return id.toString();
    }

    @Override
    public boolean supports(Class<?> entityType) {
        // 配置该转换器适用的实体类，可根据实际情况调整判断逻辑
        // 示例：仅对ID字段为UUID类型的实体生效
        // return Arrays.stream(entityType.getDeclaredFields())
        //         .anyMatch(field -> field.isAnnotationPresent(Id.class) && field.getType().equals(UUID.class));
        return true;
    }
}

注意事项 #

• 该组件添加 @Component 注解后 Spring Data REST 会自动发现并注册，无需额外配置
• 可在 fromRequestId 方法中保留你现有兼容标准带横杠UUID的逻辑，原有临时兼容方案可以平滑过渡
• 配置完成后 _links 中的 UUID 会自动转为 base32 编码，和响应体中的 UUID 格式保持一致

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