如何通过Spring Cloud Config从Git仓库获取二进制文件

Spring cloud-config-server 内置了与Git仓库通信、读取文件的机制，同时会向Spring Boot客户端暴露端点，供客户端读取配置文件。官方文档提到它提供基于HTTP的API来获取键值对、YAML这类配置内容，还支持通过路径后缀（.yml、.yaml或.properties）返回对应格式的配置，也能返回.txt纯文本文件。

但实际开发中，我们常会遇到需要从Config Server端点返回非文本文件的场景，比如.pdf、.xlsx或.zip。这时会出现一个问题：假设Git仓库featureA分支里有myFile.zip文件，通过/{application}/{profile}[/{label}]风格的路径（比如serverUrl:serverPort/myApp/default/featureA/myFile.zip）访问时，文件会被当作纯文本处理后返回，导致原始二进制内容损坏，无法正常使用。

下面是解决这个问题的方案：

实现步骤 #

1. 自定义二进制资源转换器
   创建一个实现ResourceTransformer接口的类，用于识别二进制文件，跳过Config Server默认的文本转换逻辑，直接返回原始资源：

import org.springframework.cloud.config.server.environment.ResourceTransformer;
import org.springframework.core.io.Resource;
import org.springframework.http.MediaType;
import org.springframework.http.MediaTypeFactory;
import java.io.IOException;

public class BinaryResourceTransformer implements ResourceTransformer {
    @Override
    public Resource transform(Resource resource) throws IOException {
        MediaType mediaType = MediaTypeFactory.getMediaType(resource).orElse(MediaType.APPLICATION_OCTET_STREAM);
        // 非文本类型文件直接返回原始资源
        if (!mediaType.isTextBased()) {
            return resource;
        }
        return resource;
    }
}

2. 注册转换器到Config Server
   在Config Server的配置类中，将自定义转换器注入到环境仓库的资源转换器列表中（以Git仓库为例）：

import org.springframework.cloud.config.server.environment.GitEnvironmentRepository;
import org.springframework.cloud.config.server.environment.EnvironmentRepository;
import org.springframework.cloud.config.server.environment.ResourceTransformer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import java.util.List;

@Configuration
public class ConfigServerCustomConfig {
    @Bean
    public EnvironmentRepository environmentRepository(List<ResourceTransformer> transformers) {
        GitEnvironmentRepository gitRepo = new GitEnvironmentRepository();
        // 添加自定义转换器
        gitRepo.setResourceTransformers(transformers);
        return gitRepo;
    }

    @Bean
    public ResourceTransformer binaryResourceTransformer() {
        return new BinaryResourceTransformer();
    }
}

3. 补充媒体类型映射（可选）
   如果部分文件类型的媒体类型无法被自动识别，可以在application.yml中添加自定义映射：

spring:
  mvc:
    media-types:
      zip: application/zip
      xlsx: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
      pdf: application/pdf

完成以上配置后，再访问二进制文件时，Config Server会直接返回原始字节流，不会损坏文件内容。

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