How to get the value in application.yml in springboot

In projects, some configuration information is often needed. This information may have different configurations in the test environment and production environment, and may need to be modified later based on actual business conditions. We cannot hard-code these configurations in the code. It is best to write them in the configuration file. For example, you can write this information to the application.yml file.

So, how to get or use this address in the code? There are 2 methods.

Method 1:

We can get the value corresponding to the key in the configuration file (application.yml) through the ${key} annotated with @Value. This method is suitable for microservices Relatively few situations

Method 2:

In actual projects, when encountering complicated business and complex logic, you need to consider encapsulating one or more Configuration class. For example, if a business needs to use microservice 1, microservice 2 and microservice 3 at the same time, then these microservices will be called.

It would be too cumbersome to use the @Value annotation to introduce the corresponding microservice addresses one by one.

Perhaps in actual business, there are far more than these three microservices, or even more than a dozen. For this situation, we can first define a MicroServiceUrl class to specifically save the URL of the microservice

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "url")
public class MicroServiceUrl {

private String orderUrl;
private String userUrl;
private String shoppingUrl;

public String getOrderUrl() {
return orderUrl;
}

public void setOrderUrl(String orderUrl) {
this.orderUrl = orderUrl;
}

public String getUserUrl() {
return userUrl;
}

public void setUserUrl(String userUrl) {
this.userUrl = userUrl;
}

public String getShoppingUrl() {
return shoppingUrl;
}

public void setShoppingUrl(String shoppingUrl) {
this.shoppingUrl = shoppingUrl;
}
}

Add dependencies:

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>

Current configuration It’s written. At this time, there is no need to introduce the URLs of these microservices one by one in the code. You can directly inject the configuration class you just wrote through the @Resource annotation and use it. The following is the test Controller:

import com.example.test1.config.MicroServiceUrl;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.annotation.Resource;

/**
* 获取配置文件（application.yml）中和 key 对应的 value 值
* 2种方法
*/
@RestController
@RequestMapping("/test")
public class ConfigController {

private static final Logger LOGGER = LoggerFactory.getLogger(ConfigController.class);

@Value("${url.orderUrl}")
private String orderUrl;

@Resource
private MicroServiceUrl microServiceUrl;

@RequestMapping("/config")
public String testConfig() {
LOGGER.info("获取的地址为：{}", orderUrl);
LOGGER.info("微服务1地址为：{}", microServiceUrl.getOrderUrl());
LOGGER.info("微服务2地址为：{}", microServiceUrl.getUserUrl());
LOGGER.info("微服务3地址为：{}", microServiceUrl.getShoppingUrl());
return "success";
}
}

The above is the detailed content of How to get the value in application.yml in springboot. For more information, please follow other related articles on the PHP Chinese website!