Simplifying Local Development with OpenFeign: Custom URL Routing via ImportBeanDefinitionRegistrar

OpenFeign is widely used for inter‑service calls in microservice architectures, but during local development the default load‑balancing can route requests to Docker‑based instances, causing network failures because the 192.168.x.x and 172.17.x.x subnets are isolated.

The proposed solution is to add a url attribute to @FeignClient so that requests are always directed to the locally started service. However, hard‑coding the URL requires code changes before deployment, which is error‑prone.

To address this, the article introduces a custom ImportBeanDefinitionRegistrar that registers Feign clients manually. It scans for interfaces annotated with @FeignClient , reads configuration properties, and builds the client with Feign.builder() using injected Client , Encoder , Decoder , and Contract beans.

The core registration logic creates a bean definition like:

@Bean
public Contract contract() {
    return new SpringMvcContract();
}

@Bean(name = "defaultClient")
public Client defaultClient() {
    return new Client.Default(null, null);
}

// ... other beans for ribbonClient, encoder, decoder ...

private void registerFeignClient(BeanDefinitionRegistry registry, AnnotationMetadata metadata, Map
attrs) {
    // resolve class, get name, contextId, etc.
    Feign.Builder builder = Feign.builder()
        .encoder(encoder)
        .decoder(decoder)
        .contract(contract);
    String serviceUrl = addressMapping.get(name);
    Object target = (StringUtils.hasText(serviceUrl))
        ? builder.client(defaultClient).target(clazz, serviceUrl)
        : builder.client(ribbonClient).target(clazz, "http://" + name);
    // register bean definition
}

The configuration class FeignAutoConfiguration defines the necessary beans and is conditionally loaded when feign.local.enable=true . The properties file supplies enable , basePackage , and a map of addressMapping that links service names to local URLs.

After packaging the module (e.g., mvn clean install ) and adding the dependency, developers can simply enable the feature in application.yml and let the registrar override any url defined in the original @FeignClient . Tests show that the overridden URL is used and the service responds correctly.

When moving to production, setting feign.local.enable=false disables the custom routing, and the standard @EnableFeignClients behavior resumes.

In summary, this approach removes the need for manual URL edits in Feign clients, streamlines local debugging, and deepens understanding of Spring’s extension points such as ImportBeanDefinitionRegistrar and bean registration.