SpringCloud微服务架构-Nacos-Feign远程调用

Nacos注册中心

认识和安装Nacos

[Nacos](https://nacos.io/)是阿里巴巴的产品，现在是[SpringCloud](https://spring.io/projects/spring-cloud)中的一个组件。相比[Eureka](https://github.com/Netflix/eureka)功能更加丰富，在国内受欢迎程度较高。

1、下载安装包
　　GitHub主页：https://github.com/alibaba/nacos

2、解压

　　bin：启动脚本
　　conf：配置文件

3、端口配置
Nacos的默认端口是8848，如果你电脑上的其它进程占用了8848端口，请先尝试关闭该进程。
如果无法关闭占用8848端口的进程，也可以进入nacos的conf目录，修改配置文件中的端口：

修改其中的内容：

4、启动：在bin目录下运行指令：

startup.cmd -m standalone

5、访问
　　在浏览器输入地址：http://127.0.0.1:8848/nacos即可，默认的账号和密码都是nacos，进入后：

服务注册到nacos

Nacos是SpringCloudAlibaba的组件，而SpringCloudAlibaba也遵循SpringCloud中定义的服务注册、服务发现规范。因此使用Nacos和使用Eureka对于微服务来说，并没有太大区别。
主要差异在于：
　　依赖不同
　　服务地址不同

引入依赖

1、在cloud-demo父工程的pom文件中添加spring-cloud-alilbaba的管理依赖：

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-alibaba-dependencies</artifactId>
    <version>2.2.6.RELEASE</version>
    <type>pom</type>
    <scope>import</scope>
</dependency>

2、注释掉order-service和user-service中原有的eureka依赖。
3、然后在user-service和order-service中的pom文件中引入nacos-discovery依赖：

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>

配置nacos地址

修改user-service&order-service中的application.yml文件，注释eureka地址，添加nacos地址：

spring:
  cloud:
    nacos:
      server-addr: localhost:8848

重启

重启微服务后，登录nacos管理页面，可以看到微服务信息：

服务分级存储模型

一个服务可以有多个实例，假如这些实例分布于全国各地的不同机房，Nacos就将同一机房内的实例划分为一个集群。user-service是服务，一个服务可以包含多个集群，如杭州、上海，每个集群下可以有多个实例，形成分级模型，如图：

微服务互相访问时，应该尽可能访问同集群实例，因为本地访问速度更快。当本集群内不可用时，才访问其它集群。例如：

给user-service配置集群

修改user-service的application.yml文件，添加集群配置：

spring:
  cloud:
    nacos:
      server-addr: localhost:8848  # nacos 服务端地址
      discovery:
        cluster-name: HZ # 配置集群名称，也就是机房位置，例如：HZ，杭州

重启两个user-service实例后，我们可以在nacos控制台看到下面结果：

修改user-service的application.yml文件的cluster-name，添加集群配置：

spring:
  cloud:
    nacos:
      server-addr: localhost:8848  # nacos 服务端地址
      discovery:
        cluster-name: SH # 配置集群名称，也就是机房位置，例如：HZ，杭州；SH，上海

重启第三个user-service实例后，我们可以在nacos控制台看到下面结果：

同集群优先的负载均衡

默认的ZoneAvoidanceRule并不能实现根据同集群优先来实现负载均衡。
因此Nacos中提供了一个NacosRule的实现，可以优先从同集群中挑选实例。
1）给order-service配置集群信息
修改order-service的application.yml文件，添加集群配置：

spring:
  cloud:
    nacos:
      server-addr: localhost:8848 # nacos 服务端地址
      discovery:
        cluster-name: HZ # 配置集群名称，也就是机房位置

2）修改负载均衡规则
修改order-service的application.yml文件中设置负载均衡的IRule为NacosRule，这个规则优先会寻找与自己同集群的服务：

userservice:
  ribbon:
    NFLoadBalancerRuleClassName: com.alibaba.cloud.nacos.ribbon.NacosRule # 负载均衡规则

NacosRule负载均衡策略
　　1、优先选择同集群服务实例列表。
　　2、本地集群找不到提供者，才去其它集群寻找，并且会报警告。

　　3、确定了可用实例列表后，再采用随机负载均衡挑选实例。

权重配置

实际部署中会出现这样的场景：
　　服务器设备性能有差异，部分实例所在机器性能较好，另一些较差，我们希望性能好的机器承担更多的用户请求。
但默认情况下NacosRule是同集群内随机挑选，不会考虑机器的性能问题。
因此，Nacos提供了权重配置来控制访问频率，权重越大则访问频率越高。
在nacos控制台，找到user-service的实例列表，点击编辑，即可修改权重（0~1之间，权重越高被访问的频率越高）：

将权重设置为0.1，测试可以发现8081被访问到的频率大大降低。

注：如果权重修改为0，则该实例永远不会被访问。

环境隔离

Nacos中服务存储和数据存储的最外层都是一个名为namespace的东西，用来做最外层隔离：
　　nacos中可以有多个namespace
　　namespace下可以有group、service等
　　不同namespace之间相互隔离，例如不同namespace的服务互相不可见

默认情况下，所有service、data、group都在同一个namespace，名为public。我们可以点击页面新增按钮，添加一个namespace：

然后填写一个新的命名空间信息：

给微服务配置namespace

给微服务配置namespace只能通过修改配置来实现。修改order-service的application.yml文件：

spring:
  cloud:
    nacos:
      server-addr: localhost:8848
      discovery:
        cluster-name: HZ
        namespace: 492a7d5d-237b-46a1-a99a-fa8e98e4b0f9 # 命名空间，填ID

重启order-service后，访问控制台，可以看到下面的结果：

此时访问order-service，因为namespace不同，会导致找不到userservice，控制台会报错：

每个namespace都有唯一id
服务设置namespace时要写id而不是名称
不同namespace下的服务互相不可见

Nacos与Eureka的区别

Nacos的服务实例分为两种类型：
　　临时实例：如果实例宕机超过一定时间，会从服务列表剔除，默认的类型。
　　非临时实例：如果实例宕机，不会从服务列表剔除，也可以叫永久实例。

配置一个服务实例为永久实例：

spring:
  cloud:
    nacos:
      discovery:
        ephemeral: false # 设置为非临时实例

Nacos和Eureka整体结构类似，服务注册、服务拉取、心跳等待，但是也存在一些差异：

Nacos与eureka的共同点：
　　都支持服务注册和服务拉取
　　都支持服务提供者心跳方式做健康检测
Nacos与Eureka的区别：
　　Nacos支持服务端主动检测提供者状态：临时实例采用心跳模式，非临时实例采用主动检测模式。
　　临时实例心跳不正常会被剔除，非临时实例则不会被剔除。
　　Nacos支持服务列表变更的消息推送模式，服务列表更新更及时。
　　Nacos集群默认采用AP方式，当集群中存在非临时实例时，采用CP模式；Eureka采用AP方式。

Nacos配置管理

Nacos除了可以做注册中心，同样可以做配置管理来使用。

统一配置管理

Nacos一方面可以将配置集中管理，另一方可以在配置变更时，及时通知微服务，实现配置的热更新。

在nacos中添加配置文件

在弹出表单中填写配置信息：

注：项目的核心配置，需要热更新的配置才有放到nacos管理的必要。基本不会变更的一些配置还是保存在微服务本地比较好。

从微服务拉取配置

微服务要拉取nacos中管理的配置，并且与本地的application.yml配置合并，才能完成项目启动。
由于尚未读取application.yml，因此spring引入了一种新的配置文件：bootstrap.yaml文件，会在application.yml之前被读取，流程如下：

1）在user-service服务中，引入nacos-config的客户端依赖：

<!--nacos配置管理依赖-->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
</dependency>

2）在user-service中的resource目录添加一个bootstrap.yml文件，这个文件是引导文件，优先级高于application.yml：

spring:
  application:
    name: userservice # 服务名称
  profiles:
    active: dev #开发环境，这里是dev 
  cloud:
    nacos:
      server-addr: localhost:8848 # Nacos地址
      config:
        file-extension: yaml # 文件后缀名

这里会根据spring.cloud.nacos.server-addr获取nacos地址，再根据${spring.application.name}-${spring.profiles.active}.${spring.cloud.nacos.config.file-extension}作为文件id，来读取配置。
本例中，就是去读取 userservice-dev.yaml ：

3）在user-service中的UserController中添加业务逻辑，读取pattern.dateformat配置：

 1 @RestController
 2 @RequestMapping("/user")
 3 public class UserController {
 4     @Autowired
 5     private UserService userService;
 6     
 7     // 注入nacos中的配置属性
 8     @Value("${pattern.dateformat}")
 9     private String dateformat;
10     
11     // 编写controller，通过日期格式化器来格式化现在时间并返回
12     @GetMapping("now")
13     public String now(){
14         return LocalDateTime.now().format(DateTimeFormatter.ofPattern(dateformat));
15     }
16     // ...略
17 }

在页面访问，可以看到效果：

配置热更新

修改nacos中的配置后，微服务中无需重启即可让配置生效，也就是配置热更新。
要实现配置热更新，可以使用两种方式：

方式一

在@Value注入的变量所在类上添加注解@RefreshScope：

方式二（推荐）

使用@ConfigurationProperties注解代替@Value注解。
在user-service服务中，添加一个类，读取patterrn.dateformat属性：

1 @Component
2 @Data
3 @ConfigurationProperties(prefix = "pattern")
4 public class PatternProperties {
5     private String dateformat;
6 }

在UserController中使用PatternProperties这个类代替@Value：

 1 @RestController
 2 @RequestMapping("/user")
 3 public class UserController {
 4     @Autowired
 5     private UserService userService;
 6 
 7     @Autowired
 8     private PatternProperties patternProperties;
 9     
10     // 注入nacos中的配置属性
11     //@Value("${pattern.dateformat}")
12     //private String dateformat;
13 
14     @GetMapping("now")
15     public String now(){
16         //return LocalDateTime.now().format(DateTimeFormatter.ofPattern(dateformat));
17         return LocalDateTime.now().format(DateTimeFormatter.ofPattern(patternProperties.getDateformat()));
18     }
19     // 略
20 }

配置共享

微服务启动时会从nacos读取多个配置文件：
　　[spring.application.name]-[spring.profiles.active].yaml，例如：userservice-dev.yaml
　　[spring.application.name].yaml，例如：userservice.yaml
无论profile如何变化，[spring.application.name].yaml这个文件一定会加载，因此多环境共享配置可以写入这个文件

当nacos、服务本地同时出现相同属性时，优先级有高低之分：

Feign远程调用

利用RestTemplate发起远程调用的代码：

代码可读性差，编程体验不统一。
参数复杂URL难以维护。

Feign是一个声明式的http客户端，官方地址：https://github.com/OpenFeign/feign
其作用就是帮助我们优雅的实现http请求的发送，解决上面提到的问题。

Feign替代RestTemplate

1、引入依赖

在order-service服务的pom文件中引入feign的依赖：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

2、添加注解

在order-service的启动类添加注解开启Feign的功能：

1 @EnableFeignClients
2 @MapperScan("cn.itcast.order.mapper")
3 @SpringBootApplication
4 public class OrderApplication {
5     public static void main(String[] args) {
6         SpringApplication.run(OrderApplication.class, args);
7     }
8 }

3、编写Feign的客户端

在order-service中新建一个接口，内容如下：

1 @FeignClient("userservice")
2 public interface UserClient {
3     @GetMapping("/user/{id}")
4     User findById(@PathVariable("id") Long id);
5 }

这个客户端主要是基于SpringMVC的注解来声明远程调用的信息，比如：
　　服务名称：userservice
　　请求方式：GET
　　请求路径：/user/{id}
　　请求参数：Long id
　　返回值类型：User
这样，Feign就可以帮助我们发送http请求，无需自己使用RestTemplate来发送了。

4、测试-使用Feign客户端代替RestTemplate

修改order-service中的OrderService类中的queryOrderById方法，使用Feign客户端代替RestTemplate：

 1 @Autowired
 2 private UserClient userClient;
 3 public Order queryOrderById(Long orderId) {
 4     // 1.查询订单
 5     Order order = orderMapper.findById(orderId);
 6     // 2.利用Feign发起http 请求，查询用户
 7     User user = userClient.findById(order.getUserId());
 8     // 3.封装user到Order
 9     order.setUser(user);
10     // 4.返回
11     return order;
12 }

自定义配置

Feign运行自定义配置来覆盖默认配置，可以修改的配置如下：

一般我们需要配置的就是日志级别。

配置Feign日志有两种方式：

方式一：配置文件方式

局部生效：

feign:  
  client:
    config: 
      userservice: # 针对某个微服务的配置
        loggerLevel: FULL #  日志级别

全局生效：

feign:  
  client:
    config: 
      default: # 这里用default就是全局配置，如果是写服务名称，则是针对某个微服务的配置
        loggerLevel: FULL #  日志级别

日志的级别分为四种：
　　NONE：不记录任何日志信息，这是默认值。（日常）
　　BASIC：仅记录请求的方法，URL以及响应状态码和执行时间。（日常）
　　HEADERS：在BASIC的基础上，额外记录了请求和响应的头信息。
　　FULL：记录所有请求和响应的明细，包括头信息、请求体、元数据。（调试日志）

方式二：Java代码方式

先声明一个类，然后声明一个Logger.Level的对象：

1 public class DefaultFeignConfiguration  {
2     @Bean
3     public Logger.Level feignLogLevel(){
4         return Logger.Level.BASIC; // 日志级别为BASIC
5     }
6 }

如果要全局生效，将其放到启动类的@EnableFeignClients这个注解中：

@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration.class)

如果是局部生效，则把它放到对应的@FeignClient这个注解中：

@FeignClient(value = "userservice", configuration = DefaultFeignConfiguration.class)

Feign的性能优化

Feign底层发起http请求，依赖于其它的框架。其底层客户端实现包括：
　　URLConnection：默认实现，不支持连接池
　　Apache HttpClient ：支持连接池
　　OKHttp：支持连接池
因此优化Feign的性能主要包括：
　　使用连接池代替默认的URLConnection
　　日志级别，最好用basic或none

Feign添加HttpClient的支持：
　　在order-service的pom文件中引入Apache的HttpClient依赖：

<!--httpClient的依赖 -->
<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-httpclient</artifactId>
</dependency>

　　在order-service的application.yml中添加配置：

feign:
  client:
    config:
      default: # default全局的配置
        loggerLevel: BASIC # 日志级别，BASIC就是基本的请求和响应信息
  httpclient:
    enabled: true # 开启feign对HttpClient的支持
    max-connections: 200 # 最大的连接数
    max-connections-per-route: 50 # 每个路径的最大连接数

最佳实践

Feign的客户端与服务提供者的controller代码非常相似：

order-service下的feign客户端：

user-service下的UserController：

需要简化重复的代码编写。

方式一：继承方式

1）定义一个API接口，利用定义方法，并基于SpringMVC注解做声明。
2）给消费者的FeignClient和提供者的controller定义统一的父接口作为标准。

优点：
　　简单
　　实现了代码共享
缺点：
　　服务提供方、服务消费方紧耦合
　　参数列表中的注解映射并不会继承，因此Controller中必须再次声明方法、参数列表、注解

方式二：抽取方式

将Feign的Client抽取为独立模块，并且把接口有关的POJO、默认的Feign配置都放到这个模块中，提供给所有消费者使用。
例如，将UserClient、User、Feign的默认配置都抽取到一个feign-api包中，所有微服务引用该依赖包，即可直接使用

实现基于抽取的最佳实践

1、抽取
首先创建一个module，命名为feign-api：

在feign-api中然后引入feign的starter依赖

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

将order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中

2、在order-service中使用feign-api
首先，删除order-service中的UserClient、User、DefaultFeignConfiguration等类或接口。
在order-service的pom文件中中引入feign-api的依赖：

<dependency>
    <groupId>cn.itcast.demo</groupId>
    <artifactId>feign-api</artifactId>
    <version>1.0</version>
</dependency>

修改order-service中的所有与上述三个组件有关的导包部分，改成导入feign-api中的包
3、重启测试
重启后，发现服务报错了：

这是因为UserClient现在在cn.itcast.feign.clients包下，而order-service的@EnableFeignClients注解是在cn.itcast.order包下，不在同一个包，无法扫描到UserClient。
4、解决扫描包问题
方式一：指定Feign应该扫描的包（所有feign.client下的包）：

@EnableFeignClients(basePackages = "cn.itcast.feign.clients")

方式二：指定需要加载的Client接口（指定具体的接口）（推荐）：

@EnableFeignClients(clients = {UserClient.class})

posted @ 2025-07-25 16:10 溯鸣阅读(186) 评论(0) 收藏举报

刷新页面返回顶部

sunnysml