本文主要介绍如何用 Spring Cloud 程序读取 nacos 中的配置信息
文章目录
一、启动nacos
如何操作,可以参考Spring Cloud 中 OpenFeign的使用 一文中启动nacos的部分
二、在nacos中添加配置项
选择配置管理-配置列表,点击创建配置,然后填入/选择以下内容
Data ID是由前缀加上yaml 后缀组成,前缀与我们的项目名称一致,这样我们的项目就能找到个配置。
Group就采用的默认的 DEFAULT_GROUP。
配置格式,因为我们DataID使用的是yaml后缀,因此,格式要符合这个约定,选择yaml。
配置内容,我们就简单地设置了一个name属性,值为abcd。
点击发布,就配置好了。
接下来就是要用spring cloud项目来读取这个配置。
二、order-service项目读取配置项
1. 项目的pom.xml 文件
order-service 是一个spring web项目,pom.xml 要引入
spring-cloud-starter-alibaba-nacos-config
spring-cloud-starter-bootstrap
spring-cloud-starter-alibaba-nacos-config 好理解,要读取nacos中的配置项,引入这个依赖。
这里说明一下spring-cloud-starter-bootstrap,我们在项目中将采用 bootstrap.yml ,程序要在启动的时候就能读取bootstrap.yml。开始没有引入spring-cloud-starter-bootstrap 这个依赖项,项目启动就会报错,说
No spring.config.import property has been defined
后续找解决方案发现是因为在spring cloud 2020.0.2版本中把bootstrap的相关依赖从spring-cloud-starter-config中移除了,所以现在在2020.02 以后需要单独引入spring-cloud-starter-bootstrap 依赖。1
order-service项目的全部依赖:
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-bootstrap</artifactId>
</dependency>
</dependencies>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>2023.0.3</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-alibaba-dependencies</artifactId>
<version>2023.0.1.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
2. bootstrap.yml 配置文件,配置nacos
spring:
application:
name: order-service
cloud:
nacos:
discovery:
server-addr: 127.0.0.1:8848
config:
server-addr: 127.0.0.1:8848
file-extension: yaml
group: DEFAULT_GROUP
prefix: ${spring.application.name}
server:
port: 9002
其中config,就是指向nacos中的order-service.yaml,从而让程序能读取到其中的配置项。
3. Controller方法中读取nacos配置
@RestController
@RequestMapping("/testnacosconfig")
public class TestNacosConfigController {
@Value(value = "${name}")
private String name;
@GetMapping("test")
public String test(){
return "name:" +name;
}
}
4. URL调用接口,看到返回的结果
通过 http://localhost:9002/testnacosconfig/test 访问前面 Controller的 test 方法,我们可以在浏览器上看到打印出 name: abcd