Spring Boot Configuration class cannot wire ConfigurationProperties at runtime

Question

Java 8 and Spring Boot 1.5.8 here. I have the following application.properties file:

logging:
  config: 'logback.groovy'
myapp:
  hystrixTimeoutMillis: 500
  jwt:
    expiry: 86400000
    secret: 12345
  machineId: 12345
spring:
  cache:
    type: none

Which maps to the following @ConfigurationProperties POJO:

@ConfigurationProperties(prefix = "myapp")
public class MyAppConfig {
  private Jwt jwt;
  private Long hystrixTimeoutMillis;
  private String machineId;

  public Jwt getJwt() {
    return jwt;
  }

  public void setJwt(Jwt jwt) {
    this.jwt = jwt;
  }

  public Long getHystrixTimeoutMillis() {
    return hystrixTimeoutMillis;
  }

  public void setHystrixTimeoutMillis(Long hystrixTimeoutMillis) {
    this.hystrixTimeoutMillis = hystrixTimeoutMillis;
  }

  public String getMachineId() {
    return machineId;
  }

  public void setMachineId(String machineId) {
    this.machineId = machineId;
  }

  public static class Jwt {
    private Long expiry;
    private String secret;

    public Long getExpiry() {
      return expiry;
    }

    public void setExpiry(Long expiry) {
      this.expiry = expiry;
    }

    public String getSecret() {
      return secret;
    }

    public void setSecret(String secret) {
      this.secret = secret;
    }
  }
}

And I have the following @Configuration (injector) class:

@Configuration
public class MyAppInjector implements ApplicationContextAware {
  private Logger log = LoggerFactory.getLogger(this.getClass());

  private ApplicationContext applicationContext;

  @Autowired
  private MyAppConfig myAppConfig;

  @Bean
  public AuthService authService(MyAppConfig myAppConfig) {
    return new JwtAuthService(myAppConfig);
  }
}

And the following JwtAuthService class:

public class JwtAuthService implements AuthService {
  private static final String BEARER_TOKEN_NAME = "Bearer";

  private Logger log = LoggerFactory.getLogger(this.getClass());

  private MyAppConfig myAppConfig;

  @Autowired
  public JwtAuthService(MyAppConfig myAppConfig) {
    this.myAppConfig = myAppConfig;
  }

  @Override
  public boolean isValidAuthToken(String authToken) {
    return true;
  }
}

At startup I get the following error:

***************************
APPLICATION FAILED TO START
***************************

Description:

Field myAppConfig in com.example.myapp.spring.MyAppInjector required a bean of type 'com.example.myapp.spring.MyAppConfig' that could not be found.

Action:

Consider defining a bean of type 'com.example.myapp.spring.MyAppConfig' in your configuration.

Why am I getting this error? Where am I injecting/configuring things incorrectly?

score 1 · Answer 1 · answered Feb 27 '19 at 18:03

1

Class with @ConfigurationProperties should also be bean. You need to annotate it as @Component or manually register in @Configuration class with @Bean annotation (instead of trying to autowire it there)

answered Feb 27 '19 at 18:03

amseager

5,795
4
24
47

score 1 · Accepted Answer · answered Feb 27 '19 at 18:03

You are not declaring MyAppConfig as a bean anywhere in your example, @ConfigurationProperties doesn't make annotated class a bean. You can do it as part of MyAppInjector configuration:

@Configuration
public class MyAppInjector {

  @Bean
  public AuthService authService() {
    return new JwtAuthService(myAppConfig());
  }

  @Bean
  public MyAppConfig myAppConfig() {
    return new MyAppConfig();
  }

}

Spring Boot Configuration class cannot wire ConfigurationProperties at runtime

2 Answers2