结合OpenFeign、Nacos、Sentinel搭建一个微服务框架

一. 环境准备

• 下载并安装Nacos，访问http://localhost:8848/nacos可以进入Nacos控制台登录界面
• 下载并安装Sentinel，访问http://localhost:8080可以进入Sentinel控制台登录界面

二. 项目创建

1. 创建父模块

1. 新建一个Maven工程
2. 修改Maven工程的pom文件
   1. 标明父工程pom打包方式为pom<packaging>pom</packaging>
   2. 建立依赖版本管理，主要导入以下3个依赖（注意：SpringBoot版本必须与SpringCloud版本兼容！）其他所需依赖自行导入

<dependencyManagement>
    <dependencies>
      <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-dependencies</artifactId>
        <version>2.2.2.RELEASE</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
      <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-dependencies</artifactId>
        <version>Hoxton.SR1</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
      <dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-alibaba-dependencies</artifactId>
        <version>2.1.0.RELEASE</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
 </dependencyManagement>

2. 创建子模块

1. 在父工程下新建模块
2. 修改子模块pom文件：导入nacos-config、nacos-discovery、sentinel、openfeign依赖（注意，由于版本已在父工程中确定，因此在子模块中无需再指定版本号）
3. 新建application.yml（本地yaml)，配置环境profile为dev

spring:
  profiles:
    active: dev

4. 新建bootstrap.yml（系统yaml，可以从Nacos配置中心中获取配置)，在其中配置服务名，Nacos地址，Sentinel地址

server:
  port: 7001

spring:
  application:
    name: cloud-provider-config
  cloud:
  	# Nacos地址配置
    nacos:
      discovery:
        server-addr: localhost:8848
      config:
        server-addr: localhost:8848
        file-extension: yaml
    # Sentinel地址配置
    sentinel:
      transport:
        dashboard: localhost:8080
        port: 8719

二. 业务类编写

1. 服务提供方cloud-provider-config

服务提供方实现一个简单的接口：从Nacos配置中心中获取一个配置项并返回该配置项的内容

1) 编写主启动类

@SpringBootApplication
@EnableDiscoveryClient           //开启Nacos服务注册中心
@@EnableFeignClients			   //开启OpenFeign服务调用
public class ProviderMain7001 {
    public static void main(String[] args) {
        SpringApplication.run(ProviderMain7001.class, args);
    }
}

2) 编写Controller

@RestController
@RefreshScope.     //开启配置动态刷新
public class providerController {
    
    @Value("${config.info}")
    private String configInfo;	     //获取Nacos中的配置项
    
    @GetMapping("/config")
    public String getConfigInfo(){
        return configInfo;
    }
}

3) 在Nacos中发布配置

DataID的配置规则为:${服务名}+${profile}+${后缀名}
注意后缀名必须和bootstrap.yml中配置的完全一致

4)接口测试

如果能够调用http://localhost:7001/config接口成功获取配置，且在Nacos和Sentinel控制台界面中都能成功获取cloud-provider-config服务，则服务提供端编写成功

2. 服务消费方cloud-consumer-config

服务提供方实现一个简单的接口：通过OpenFeign远程调用服务提供端的接口，返回结果

1) 编写主启动类

与服务提供方基本一致

@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients
public class ConsumerMain6001 {
    public static void main(String[] args) {
        SpringApplication.run(ConsumerMain6001.class, args);
    }
}

2) 编写远程服务调用Service接口

@Component
@FeignClient("cloud-provider-config")  //值为服务提供方注册进注册中心的服务名
public interface ConfigFeignService {
	// 可调用的接口为提供方的Controller提供的接口
    @GetMapping("/config")
    String getConfigInfo();
}

• 调用流程：根据服务名到Nacos服务注册中心中获取服务提供方地址，通过负载均衡策略（OpenFeign内部整合Ribbon实现）选择其中一个地址进行远程调用

3) 编写Controller

@RestController
public class ConsumerController {
    
    // 注入远程服务调用Service接口
    @Resource
    private ConfigFeignService configFeignService;
    
    @GetMapping("/consumer/config")
    public String getConfigInfo(){
    	// 通过Service接口RPC远程调用提供方服务
        return configFeignService.getConfigInfo();
    }
}

4) 接口测试

如果能够调用http://localhost:6001/consumer/config接口成功获取配置项，且在Nacos和Sentinel控制台界面中都能成功获取cloud-consumer-config服务，则消费端编写成功

三. Sentinel限流熔断

通过Sentinel控制台可以很方便的配置流控、降级和热点规则

但是如果触发了规则（如QPS超过配置的阈值），会自动以Sentinel默认的方式返回拒绝通知

如果想要自定义拒绝规则，可以在代码中配置

@RestController
public class ConsumerController {

    @Resource
    private ConfigFeignService configFeignService;

    @GetMapping("/consumer/config")
    @SentinelResource(value = "consumer-config", blockHandler = "handleBlock", fallback = "handleException")
    public String getConfigInfo(){
        return configFeignService.getConfigInfo();
    }

    public String handleBlock(BlockException exception){
        return exception.getClass().getCanonicalName();
    }

    public String handleException(Exception exception){
        return exception.getClass().getCanonicalName();
    }
}

其中@SentinelResource的属性：

• value:代表资源名，Sentinel可根据资源名配置限流降级规则
• blockHandler：代表自定义的兜底方法名，当Sentinel控制台的配置被违背后，会去调用该兜底方法
• fallback：代表自定义的降级方法名。blockHandler只能处理Sentinel控制台配置违规，但是如果是业务内部发生异常无法处理。此时需要去调用fallback定义的方法。

（注意：如果既出现异常，又违背Sentinel控制台配置，则只会调用blockHandler的处理逻辑）