Compare commits

..

No commits in common. "041b8c0218e4199278074e1f43506b13b8f70b43" and "a76dd2227ee2f9d8828abb92cd0b65670e0896e1" have entirely different histories.

11 changed files with 184 additions and 195 deletions

View File

@ -1,4 +1,4 @@
# Nacos注册中心 # 微服务文档
## 注册中心 ## 注册中心
@ -18,24 +18,25 @@ public class DiscoveryTest {
@Test @Test
void discoveryClientTest() { void discoveryClientTest() {
// 使用Spring Cloud标准DiscoveryClient
for (String service : discoveryClient.getServices()) { for (String service : discoveryClient.getServices()) {
System.out.println(service); System.out.println("服务名称: " + service);
for (ServiceInstance instance : discoveryClient.getInstances(service)) { for (ServiceInstance instance : discoveryClient.getInstances(service)) {
System.out.println("IP地址" + instance.getHost()); System.out.println("实例IP地址: " + instance.getHost());
System.out.println("端口号" + instance.getPort()); System.out.println("实例端口号: " + instance.getPort());
} }
} }
System.out.println("----------------------------------------------"); System.out.println("----------------------------------------------");
// 两个方式一样DiscoveryClient 是 Spring自带的 NacosDiscoveryClient是 Nacos // 使用Nacos专用DiscoveryClient
for (String service : nacosDiscoveryClient.getServices()) { for (String service : nacosDiscoveryClient.getServices()) {
System.out.println(service); System.out.println("服务名称: " + service);
for (ServiceInstance instance : nacosDiscoveryClient.getInstances(service)) { for (ServiceInstance instance : nacosDiscoveryClient.getInstances(service)) {
System.out.println("IP地址" + instance.getHost()); System.out.println("实例IP地址: " + instance.getHost());
System.out.println("端口号" + instance.getPort()); System.out.println("实例端口号: " + instance.getPort());
} }
} }
} }
@ -44,11 +45,11 @@ public class DiscoveryTest {
### 远程调用 ### 远程调用
订单模块调用远程商品模块,使用了nacos可以使用`RestTemplate`,其中`RestTemplate`是线程安全的,只要注册一次全局都是可以使用。 订单模块调用远程商品模块,使用Nacos作为注册中心可以使用`RestTemplate`进行远程调用。`RestTemplate`是线程安全的,只需注册一次即可全局使用。
**RestTemplate源码** **RestTemplate线程安全说明**
继承了`InterceptingHttpAccessor`,在`InterceptingHttpAccessor`中,使用了单例模式。 `RestTemplate`继承了`InterceptingHttpAccessor`,其中使用了单例模式保证线程安全:
```java ```java
public ClientHttpRequestFactory getRequestFactory() { public ClientHttpRequestFactory getRequestFactory() {
@ -59,7 +60,6 @@ public ClientHttpRequestFactory getRequestFactory() {
factory = new InterceptingClientHttpRequestFactory(super.getRequestFactory(), interceptors); factory = new InterceptingClientHttpRequestFactory(super.getRequestFactory(), interceptors);
this.interceptingRequestFactory = factory; this.interceptingRequestFactory = factory;
} }
return factory; return factory;
} else { } else {
return super.getRequestFactory(); return super.getRequestFactory();
@ -69,9 +69,9 @@ public ClientHttpRequestFactory getRequestFactory() {
#### 实现远程调用 #### 实现远程调用
##### 普通方式调用 ##### 基础调用方式
注册`RestTemplate` 1. 注册`RestTemplate` Bean
```java ```java
@Bean @Bean
@ -80,26 +80,27 @@ public RestTemplate restTemplate() {
} }
``` ```
如果我们的服务启动了多个,在下面代码中即使一个服务宕机也可以做到远程调用。 2. 实现远程调用:
```java ```java
private Product getProductFromRemote(Long productId) { private Product getProductFromRemote(Long productId) {
// 获取商品服务所有及其的 IP+port // 获取商品服务所有实例
List<ServiceInstance> instances = discoveryClient.getInstances("service-product"); List<ServiceInstance> instances = discoveryClient.getInstances("service-product");
ServiceInstance instance = instances.get(0); if (instances.isEmpty()) {
throw new RuntimeException("未找到可用的商品服务实例");
}
// 远程URL ServiceInstance instance = instances.get(0);
String url = "http://" + instance.getHost() + ":" + instance.getPort() + "/api/product/" + productId; String url = "http://" + instance.getHost() + ":" + instance.getPort() + "/api/product/" + productId;
// 2. 远程发送请求 log.info("远程调用商品服务: {}", url);
log.info("远程调用:{}", url);
return restTemplate.getForObject(url, Product.class); return restTemplate.getForObject(url, Product.class);
} }
``` ```
##### 负载均衡调用 ##### 负载均衡调用
注册`RestTemplate` 1. 注册`RestTemplate` Bean
```java ```java
@Bean @Bean
@ -108,39 +109,32 @@ public RestTemplate restTemplate() {
} }
``` ```
使用负载均衡`LoadBalancerClient`,通过负载均衡算法动态调用远程服务。 2. 使用`LoadBalancerClient`实现负载均衡:
```java ```java
/** /**
* 远程调用商品模块 --- 负载均衡 * 使用负载均衡调用远程商品服务
* *
* @param productId 商品id * @param productId 商品ID
* @return 商品对象 * @return 商品信息
*/ */
private Product getProductFromRemoteWithLoadBalancer(Long productId) { private Product getProductFromRemoteWithLoadBalancer(Long productId) {
// 1. 获取商品服务所有及其的 IP+port
ServiceInstance instance = loadBalancerClient.choose("service-product"); ServiceInstance instance = loadBalancerClient.choose("service-product");
// 远程URL
String url = "http://" + instance.getHost() + ":" + instance.getPort() + "/api/product/" + productId; String url = "http://" + instance.getHost() + ":" + instance.getPort() + "/api/product/" + productId;
// 2. 远程发送请求 log.info("负载均衡远程调用商品服务: {}", url);
log.info("负载均衡远程调用:{}", url);
return restTemplate.getForObject(url, Product.class); return restTemplate.getForObject(url, Product.class);
} }
``` ```
##### 负载均衡注解调用 ##### 注解式负载均衡调用
> [!TIP] > [!TIP]
> > 关于注册中心宕机的影响:
> 如果远程注册中心宕机是否可以调用? > - 已调用过的服务:可以继续调用,因为客户端有缓存
> > - 未调用过的服务:首次调用会失败,因为需要从注册中心获取服务列表
> 调用过:远程调用不在依赖注册中心,可以通过。
>
> 没调用过:第一次发起远程调用;不能通过。
在`RestTemplate`上加上`@LoadBalanced`注解使用负载均衡。 1. 注册带负载均衡的`RestTemplate`
```java ```java
@Bean @Bean
@ -150,85 +144,67 @@ public RestTemplate restTemplate() {
} }
``` ```
在实际的调用中并不需要再显式调用将URL替换成服务名称即可。 2. 直接使用服务名进行调用:
```java ```java
/** /**
* 远程调用商品模块 --- 负载均衡注解调用 * 使用注解式负载均衡调用远程商品服务
* *
* @param productId 商品id * @param productId 商品ID
* @return 商品对象 * @return 商品信息
*/ */
private Product getProductFromRemoteWithLoadBalancerAnnotation(Long productId) { private Product getProductFromRemoteWithLoadBalancerAnnotation(Long productId) {
// 远程URL实现动态替换
String url = "http://service-product/api/product/" + productId; String url = "http://service-product/api/product/" + productId;
log.info("负载均衡注解调用商品服务: {}", url);
// 远程发送请求
log.info("负载均衡注解调用:{}", url);
return restTemplate.getForObject(url, Product.class); return restTemplate.getForObject(url, Product.class);
} }
``` ```
## 按需加载 ### 远程配置管理
### 数据隔离架构 #### 基础配置
![数据隔离架构图](./images/image-20250526160251551.png) 1. 添加依赖:
### 命名空间管理 ```xml
<dependency>
#### 创建命名空间 <groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
> [!TIP] </dependency>
> 预配置的命名空间示例可在项目 `samples/namespace-config` 目录下找到。
建议创建以下标准命名空间:
- `dev` - 开发环境
- `test` - 测试环境
- `prod` - 生产环境
**操作步骤**
1. 进入Nacos控制台命名空间管理
2. 点击"新建命名空间"
3. 填写命名空间信息ID和名称
![创建命名空间界面](./images/image-20250526160457765.png)
![命名空间列表](./images/image-20250526160718723.png)
#### 配置管理
**开发环境配置示例**
1. 基础配置:
```yaml
order:
timeout: 1min
auto-confirm: 1h
``` ```
2. 数据库配置: 2. 在Nacos中配置
配置内容示例:
```yaml ```yaml
order: order:
db-url: jdbc:mysql://dev-db:3306/order_dev timeout: 30min
auto-confirm: true
``` ```
![配置管理界面](./images/image-20250526160842062.png) 3. 创建配置读取接口:
#### 命名空间克隆 ```java
@RestController
@RequestMapping("/api/order")
@RequiredArgsConstructor
public class OrderController {
通过克隆功能快速创建相似环境的命名空间: @Value("${order.timeout}")
private String timeout;
![命名空间克隆界面](./images/image-20250526161104319.png) @Value("${order.auto-confirm}")
private String autoConfirm;
### 动态环境配置 @Operation(summary = "读取配置")
@GetMapping("config")
public String config() {
return "timeout: " + timeout + "\nautoConfirm: " + autoConfirm;
}
}
```
#### Spring Boot 配置方案 4. 应用配置:
**基础配置**
```yaml ```yaml
server: server:
@ -238,100 +214,150 @@ spring:
name: service-order name: service-order
profiles: profiles:
active: dev active: dev
cloud:
nacos:
server-addr: ${NACOS_HOST:192.168.95.135}:8848
config:
namespace: ${spring.profiles.active:dev} # 动态匹配当前profile
group: DEFAULT_GROUP
```
**多环境配置加载**
```yaml
spring:
config: config:
import: import:
- optional:nacos:service-order.yml - nacos:service-order.yml
- optional:nacos:common.yml?group=order cloud:
- optional:nacos:database.yml?group=order nacos:
server-addr: 192.168.95.135:8848
config:
import-check:
enabled: false
``` ```
> [!NOTE] > [!CAUTION]
> 使用`optional:`前缀可避免配置不存在时启动失败 > 注意事项:
> - 不要在`server-addr`中使用变量引用如`${nacos.server-addr}`,这可能导致连接失败
> - 对于不需要动态配置的模块,可以禁用配置检查
### 配置读取实现 #### 动态刷新配置
**配置类** 1. 添加`@RefreshScope`注解:
```java
@SpringBootApplication
@EnableDiscoveryClient
@RefreshScope
public class ProductServiceApplication {
public static void main(String[] args) {
SpringApplication.run(ProductServiceApplication.class, args);
}
}
```
#### 批量配置绑定
> [!TIP]
> 使用`@ConfigurationProperties`批量绑定配置:
> - 无需`@RefreshScope`即可实现动态刷新
> - 支持中划线命名自动转为驼峰命名
1. 创建配置类:
```java ```java
@Configuration @Configuration
@ConfigurationProperties(prefix = "order") @ConfigurationProperties(prefix = "order")
@Getter
@Setter
public class OrderProperties { public class OrderProperties {
private String timeout; private String timeout;
private String autoConfirm; private String autoConfirm;
private String dbUrl; // 自动映射db-url // getters and setters
} }
``` ```
**REST接口** 2. 使用配置
```java ```java
@RestController @RestController
@RequestMapping("/api/order") @RequestMapping("/api/order")
@RequiredArgsConstructor @RequiredArgsConstructor
public class OrderController { public class OrderController {
private final OrderProperties orderProperties; private final OrderProperties orderProperties;
@GetMapping("/config") @Operation(summary = "读取配置")
public Map<String, String> getConfig() { @GetMapping("config")
return Map.of( public String config() {
"timeout", orderProperties.getTimeout(), return "timeout: " + orderProperties.getTimeout() +
"autoConfirm", orderProperties.getAutoConfirm(), "\nautoConfirm: " + orderProperties.getAutoConfirm();
"dbUrl", orderProperties.getDbUrl()
);
} }
} }
``` ```
### 按需加载策略 #### 高级配置管理
#### 多环境差异化配置 1. 多环境配置:
```yaml ```yaml
spring: spring:
profiles: profiles:
active: prod # 可通过启动参数覆盖 active: @profileActive@
---
# 生产环境配置
spring:
config: config:
import: import:
- nacos:service-order-prod.yml - nacos:service-order-${spring.profiles.active}.yml
- nacos:common-prod.yml?group=order
activate:
on-profile: prod
---
# 开发环境配置
spring:
config:
import:
- nacos:service-order-dev.yml
- nacos:database-dev.yml?group=order
activate:
on-profile: dev
---
# 测试环境配置
spring:
config:
import:
- nacos:service-order-test.yml
- nacos:database-test.yml?group=order
activate:
on-profile: test
``` ```
2. 共享配置:
```yaml
spring:
config:
import:
- nacos:common-config.yml
- nacos:service-order.yml
```
3. 命名空间和分组:
```yaml
cloud:
nacos:
config:
namespace: dev
group: DEFAULT_GROUP
```
4. 配置优先级:
- 应用名-profile.yml (最高优先级)
- 应用名.yml
- 扩展配置
- 共享配置 (最低优先级)
### 配置监听
![f69073a0-a94a-437a-b555-1abe9914556f](./images/f69073a0-a94a-437a-b555-1abe9914556f.png)
#### 实现配置监听
1. 项目启动时注册监听器:
```java
@SpringBootApplication
@EnableDiscoveryClient
public class OrderServiceApplication {
public static void main(String[] args) {
SpringApplication.run(OrderServiceApplication.class, args);
}
@Bean
public ApplicationRunner runner(NacosConfigManager nacosConfigManager) {
return args -> {
ConfigService configService = nacosConfigManager.getConfigService();
configService.addListener("service-order.yml", "DEFAULT_GROUP", new Listener() {
@Override
public Executor getExecutor() {
return Executors.newFixedThreadPool(10);
}
@Override
public void receiveConfigInfo(String configInfo) {
System.out.println("配置变更内容: " + configInfo);
// 实现配置变更后的处理逻辑
System.out.println("发送配置变更通知邮件...");
}
});
System.out.println("订单服务启动完成,配置监听已注册");
};
}
}
```

Binary file not shown.

Before

Width:  |  Height:  |  Size: 193 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 50 KiB

View File

@ -15,6 +15,4 @@ public class OrderProperties {
// 中划线写法会自动映射为小驼峰 // 中划线写法会自动映射为小驼峰
private String autoConfirm; private String autoConfirm;
private String dbUrl;
} }

View File

@ -35,8 +35,6 @@ public class OrderController {
public String config() { public String config() {
String timeout = orderProperties.getTimeout(); String timeout = orderProperties.getTimeout();
String autoConfirm = orderProperties.getAutoConfirm(); String autoConfirm = orderProperties.getAutoConfirm();
String dbUrl = orderProperties.getDbUrl(); return "timeout" + timeout + "\nautoConfirm" + autoConfirm;
return "timeout" + timeout + "\nautoConfirm" + autoConfirm + "\norder.db-url" + dbUrl;
} }
} }

View File

@ -1,49 +1,16 @@
server: server:
port: 8000 port: 8000
spring: spring:
application: application:
name: service-order name: service-order
profiles: profiles:
active: prod active: dev
config:
import:
- nacos:service-order.yml
cloud: cloud:
nacos: nacos:
server-addr: 192.168.95.135:8848 server-addr: 192.168.95.135:8848
config: config:
import-check: import-check:
enabled: false enabled: false
# namespace: prod # 所在的命名空间
namespace: ${spring.profiles.active:dev} # 所在的命名空间,如果没有写 dev 为默认值
---
spring:
config:
import:
- nacos:service-order.yml
- nacos:common.yml?group=order # 在nacos中配置了分组
- nacos:database.yml?group=order # 在nacos中配置了分组
activate:
on-profile: prod
---
---
spring:
config:
import:
- nacos:service-order.yml
- nacos:common.yml?group=order # 在nacos中配置了分组
- nacos:database.yml?group=order # 在nacos中配置了分组
activate:
on-profile: dev
---
---
spring:
config:
import:
- nacos:service-order.yml
- nacos:common.yml?group=order # 在nacos中配置了分组
- nacos:database.yml?group=order # 在nacos中配置了分组
activate:
on-profile: test
---