SpringCould 快速入门二(nacos配置和Fegin远程调用)

目录

1.Nacos配置管理

1.1.统一配置管理

1.1.1.在nacos中添加配置文件

1.1.2.从微服务拉取配置

1引入nacos-config依赖

2添加bootstrap.yaml

3读取nacos配置

1.2.配置热更新

1.2.1.方式一

 1.2.2.方式二

1.3.配置共享

1添加一个环境共享配置

2在user-service中读取共享配置

3运行两个UserApplication，使用不同的profile

4）配置共享的优先级  

1.4.搭建Nacos集群

2.Feign远程调用

2.1.Feign替代RestTemplate

1引入依赖

2添加注解

3编写Feign的客户端

4测试

5总结

2.2.自定义配置

2.2.1.配置文件方式

2.2.2.Java代码方式

2.3.Feign使用优化

2.4.最佳实践

2.4.1.继承方式

2.4.2.抽取方式

2.4.3.实现基于抽取的最佳实践

2在order-service中使用feign-api

3重启测试

4解决扫描包问题

---

1.Nacos配置管理

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

1.1.统一配置管理

当微服务部署的实例越来越多，达到数十、数百时，逐个修改微服务配置就会让人抓狂，而且很容易出错。我们需要一种统一配置管理方案，可以集中管理所有实例的配置。

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

1.1.1.在nacos中添加配置文件

如何在nacos中管理配置呢？

 

 然后在弹出的表单中，填写配置信息：

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

1.1.2.从微服务拉取配置

微服务要拉取nacos中管理的配置，并且与本地的application.yml配置合并，才能完成项目启动。

但如果尚未读取application.yml，又如何得知nacos地址呢？

因此spring引入了一种新的配置文件：bootstrap.yaml文件，会在application.yml之前被读取，流程如下：

1引入nacos-config依赖

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

    com.alibaba.cloud
    spring-cloud-starter-alibaba-nacos-config

2添加bootstrap.yaml

然后，在user-service中添加一个bootstrap.yaml文件，内容如下：

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

 踩坑 这里给nacos 里面配置的配置id一定要和spring里面的name 也就是userservice 要写对，

因这里会根据spring.cloud.nacos.server-addr获取nacos地址，再根据

${spring.application.name}-${spring.profiles.active}.${spring.cloud.nacos.config.file-extension}作为文件id，来读取配置

本例中，就是去读取userservice-dev.yaml：

 

3读取nacos配置

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

 

 完整代码：

package cn.hlm.user.web;

import cn.hlm.user.pojo.User;
import cn.hlm.user.service.UserService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.*;

import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;

@Slf4j
@RestController
@RequestMapping("/user")
public class UserController {

    @Autowired
    private UserService userService;

   @Value("${pattern.dateformat}")
   private String dateformate;

   @GetMapping("/now")
   public String now(){
       return LocalDateTime.now().format(DateTimeFormatter.ofPattern(dateformate));
   }



    /**
     * 路径： /user/110
     *
     * @param id 用户id
     * @return 用户
     */
    @GetMapping("/{id}")
    public User queryById(@PathVariable("id") Long id) {
        return userService.queryById(id);
    }
}

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

 

1.2.配置热更新

但是每次我们改完nacos配置后都要重启服务，太麻烦了 我们最终的目的，是修改nacos中的配置后，微服务中无需重启即可让配置生效，也就是配置热更新。

要实现配置热更新，可以使用两种方式：

1.2.1.方式一

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

然后修改配置 

 访问

 1.2.2.方式二

使用@ConfigurationProperties注解代替@Value注解。

在user-service服务中，添加一个类，读取patterrn.dateformat属性：

package cn.hlm.user.config;

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

@Component
@Data
@ConfigurationProperties(prefix = "pattern")
public class PatternProperties {
    private String dateformat;
}

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

1.3.配置共享

其实微服务启动时，会去nacos读取多个配置文件，例如：

• [spring.application.name]-[spring.profiles.active].yaml，例如：userservice-dev.yaml

• [spring.application.name].yaml，例如：userservice.yaml

而[spring.application.name].yaml不包含环境，因此可以被多个环境共享

下面我们通过案例来测试配置共享

1添加一个环境共享配置

我们在nacos中添加一个userservice.yaml文件：

2在user-service中读取共享配置

在user-service服务中，修改PatternProperties类，读取新添加的属性：

 在user-service服务中，修改UserController，添加一个方法：

3运行两个UserApplication，使用不同的profile

修改UserApplication2这个启动项，改变其profile值：

 

这样，UserApplication(8081)使用的profile是dev，UserApplication2(8082)使用的profile是test。

启动UserApplication和UserApplication2

访问http://localhost:8081/user/prop，结果：

 访问http://localhost:8082/user/prop，结果：

 可以看出来，不管是dev，还是test环境，都读取到了envSharedValue这个属性的值。

4）配置共享的优先级  

那么这里有一个问题，当nacos、服务本地同时出现相同属性时，优先级是怎样的？

 

1.4.搭建Nacos集群

Nacos生产环境下一定要部署为集群状态，部署方式参考url：nacos集群搭建（后面会写一章文章专门来讲它）

2.Feign远程调用

先来看我们以前利用RestTemplate发起远程调用的代码：

存在下面的问题：

•代码可读性差，编程体验不统一

•参数复杂URL难以维护

Feign是一个声明式的http客户端，官方地址：https://github.com/OpenFeign/feign

其作用就是帮助我们优雅的实现http请求的发送，解决上面提到的问题。

 

2.1.Feign替代RestTemplate

Fegin的使用步骤如下：

1引入依赖

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

    org.springframework.cloud
    spring-cloud-starter-openfeign

2添加注解

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

3编写Feign的客户端

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

package cn.hlm.order.service;

import cn.hlm.order.pojo.User;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;

@FeignClient("userservice")
public interface userClient {
    @GetMapping("/user/{id}")
    User findById(@PathVariable("id") Long id);
}

4测试

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

 

 

 是不是看起来优雅多了。

5总结

使用Feign的步骤：

① 引入依赖

② 添加@EnableFeignClients注解

③ 编写FeignClient接口

④ 使用FeignClient中定义的方法代替RestTemplate

2.2.自定义配置

Feign可以支持很多的自定义配置，如下表所示：

类型	作用	说明
feign.Logger.Level	修改日志级别	包含四种不同的级别：NONE、BASIC、HEADERS、FULL
feign.codec.Decoder	响应结果的解析器	http远程调用的结果做解析，例如解析json字符串为java对象
feign.codec.Encoder	请求参数编码	将请求参数编码，便于通过http请求发送
feign. Contract	支持的注解格式	默认是SpringMVC的注解
feign. Retryer	失败重试机制	请求失败的重试机制，默认是没有，不过会使用Ribbon的重试

 一般情况下，默认值就能满足我们使用，如果要自定义时，只需要创建自定义的@Bean覆盖默认Bean即可。

下面以日志为例来演示如何自定义配置

2.2.1.配置文件方式

基于配置文件修改feign的日志级别可以针对单个服务：

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

 也可以针对所有服务：

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

而日志的级别分为四种：

• NONE：不记录任何日志信息，这是默认值。

• BASIC：仅记录请求的方法，URL以及响应状态码和执行时间

• HEADERS：在BASIC的基础上，额外记录了请求和响应的头信息

• FULL：记录所有请求和响应的明细，包括头信息、请求体、元数据。

2.2.2.Java代码方式

 也可以基于Java代码来修改日志级别，先声明一个类，然后声明一个Logger.Level的对象：

public class DefaultFeignConfiguration  {
    @Bean
    public Logger.Level feignLogLevel(){
        return Logger.Level.BASIC; // 日志级别为BASIC
    }
}

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

@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration .class) 

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

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

 

2.3.Feign使用优化

Feign底层发起http请求，依赖于其它的框架。其底层客户端实现包括：

•URLConnection：默认实现，不支持连接池

•Apache HttpClient ：支持连接池

•OKHttp：支持连接池

因此提高Feign的性能主要手段就是使用连接池代替默认的URLConnection。

这里我们用Apache的HttpClient来演示。

1）引入依赖

在order-service的pom文件中引入Apache的HttpClient依赖：

    io.github.openfeign
    feign-httpclient

2）配置连接池

在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 # 每个路径的最大连接数

 接下来，在FeignClientFactoryBean中的loadBalance方法中打断点：

 Debug方式启动order-service服务，可以看到这里的client，底层就是Apache HttpClient：

 

总结，Feign的优化：

1.日志级别尽量用basic

2.使用HttpClient或OKHttp代替URLConnection

① 引入feign-httpClient依赖

② 配置文件开启httpClient功能，设置连接池参数

 

2.4.最佳实践

所谓最近实践，就是使用过程中总结的经验，最好的一种使用方式。

自习观察可以发现，Feign的客户端与服务提供者的controller代码非常相似：

feign客户端：

 

UserController：

 

 有没有一种办法简化这种重复的代码编写呢？

2.4.1.继承方式

一样的代码可以通过继承来共享：

1）定义一个API接口，利用定义方法，并基于SpringMVC注解做声明。

2）Feign客户端和Controller都集成改接口

 

优点：

• 简单

• 实现了代码共享

缺点：

• 服务提供方、服务消费方紧耦合

• 参数列表中的注解映射并不会继承，因此Controller中必须再次声明方法、参数列表、注解

 

2.4.2.抽取方式

将Feign的Client抽取为独立模块，并且把接口有关的POJO、默认的Feign配置都放到这个模块中，提供给所有消费者使用。

例如，将UserClient、User、Feign的默认配置都抽取到一个feign-api包中，所有微服务引用该依赖包，即可直接使用。

 

2.4.3.实现基于抽取的最佳实践

1）抽取

首先创建一个module，命名为feign-api：

 项目结构：

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

    org.springframework.cloud
    spring-cloud-starter-openfeign

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

 

 

2在order-service中使用feign-api

首先，删除order-service中的UserClient、User、DefaultFeignConfiguration等类或接口。

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

    cn.hlm.demo
    feign-api
    1.0

修改order-service中的所有与上述三个组件有关的导包部分，改成导入feign-api中的包

3重启测试

重启后，发现服务报错了：

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

Description:

Field userClient in cn.hlm.order.service.OrderService required a bean of type 'cn.hlm.feign.clients.UserClient' that could not be found.

The injection point has the following annotations:
	- @org.springframework.beans.factory.annotation.Autowired(required=true)


Action:

Consider defining a bean of type 'cn.hlm.feign.clients.UserClient' in your configuration.

 

这是因为UserClient现在在cn.hlm.feign.clients包下，

而order-service的@EnableFeignClients注解是在cn.hlm.order包下，不在同一个包，无法扫描到UserClient。

4解决扫描包问题

方式一：

指定Feign应该扫描的包：

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

方式二：

指定需要加载的Client接口：

@EnableFeignClients(clients = {UserClient.class})

感觉第二个更好 第一个说白了用feign 的所有接口都会被扫描到 第二个则是指定了接口