如何使用 spring cloud alibaba 系列

Question

引入依赖

• 版本 0.2.1.RELEASE 对应的是 Spring Cloud Finchley 版本，
• 版本 0.1.1.RELEASE 对应的是 Spring Cloud Edgware 版本。
• 官方文档目前推荐的 SpringBoot 2.0.6.RELEASE 版本。如果注册不了一般都是版本不对。可以去官方文档查看对应的版本
  如果需要使用已发布的版本，在 dependencyManagement 中添加如下配置。

org.springframework.cloudspring-cloud-alibaba-dependencies0.2.1.RELEASEpomimport

然后在 dependencies 中添加自己所需使用的依赖即可使用。

如果您想体验最新的 BUILD-SNAPSHOT 的新功能，则可以将版本换成最新的版本，但是需要在 pom.xml 中配置 Spring BUILDSNAPSHOT 仓库， 注意: SNAPSHOT 版本随时可能更新

<repositories>
    <repository>
        <id>spring-snapshot</id>
        <name>Spring Snapshot Repository</name>
        <url>https://repo.spring.io/snapshot</url>
        <snapshots>
            <enabled>true</enabled>
        </snapshots>
    </repository>
</repositories>

服务的注册发现(Nacos Discovery)

Nacos 是阿里巴巴开源的一个更易于构建云原生应用的动态服务发现、配置管理和服务管理平台。
如何使用 Nacos Discovery Starter 完成 Spring Cloud 应用的服务注册与发现

创建服务提供者

新建一个项目 cloud-client

1 引入 Nacos Discovery Starter

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

2 配置 Nacos Server 地址

server.port=18082
#服务名称
spring.application.name=cloud-client
#Nacos Server 地址
spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848

3 启动类上使用 @EnableDiscoveryClient 注解开启服务注册与发现功能

4 下载 Nacos Server ： https://github.com/alibaba/nacos/releases

5 启动 Server

• Linux/Unix/Mac 操作系统，执行命令 sh startup.sh -m standalone
• Windows 操作系统，执行命令 cmd startup.cmd
• 访问控制台： http://127.0.0.1:8848/nacos/index.html

0.8 版本默认登录账号的密码 nacos/nacos.

启动

出现如下信息说明注册到 nacos 成功

nacos 控制条界面就会出现注册的服务

以上步骤向您展示了如何将一个服务注册到 Nacos。

创建消费者

新建一个项目 cloud-consumer，配置文件和消费者一样更换下端口即可。

server.port=18083
spring.application.name=service-consumer
#Nacos Server 地址
spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848
management.endpoints.web.exposure.include=*

启动类同样添加 @EnableDiscoveryClient ​ 注册到 nacos

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


    //实例化 RestTemplate 实例
    @Bean
    public RestTemplate restTemplate(){

        return new RestTemplate();
    }

}

新建一个 ConsumerController

@RestController
public class ConsumerController {

    @Autowired
    private LoadBalancerClient loadBalancerClient;
    @Autowired
    private RestTemplate restTemplate;

    @Value("${spring.application.name}")
    private String appName;

    /**
     * 通过带有负载均衡的 RestTemplate 和 FeignClient 也是可以访问的
     * @return
     */
    @GetMapping("/echo/app-name")
    public String echoAppName(){
        //使用 LoadBalanceClient 和 RestTemolate 结合的方式来访问
        ServiceInstance serviceInstance = loadBalancerClient.choose("service-provider");
        String url = String.format("http://%s:%s/echo/%s",serviceInstance.getHost(),serviceInstance.getPort(),appName);
        System.out.println("request url:"+url);
        return restTemplate.getForObject(url,String.class);
    }

}

分别启动 cloud-client 和 cloud-consumer 刷新 nacos

两个服务都注册成功

测试

访问 http://127.0.0.1:18083/echo/app-name 消费者输出访问日志说明请求成功

浏览器出现 第一个 Nacos 程序 service-consumer 到此 Over 基于 Nacos 实现的服务注册发现已经调用就到此为止。入门还是很简单的 阿里巴巴大法好！

Nacos 更多配置信息

spring.cloud.nacos.discovery.server-addr  #Nacos Server 启动监听的 ip 地址和端口
spring.cloud.nacos.discovery.service  #给当前的服务命名
spring.cloud.nacos.discovery.weight  #取值范围 1 到 100，数值越大，权重越大
spring.cloud.nacos.discovery.network-interface #当 IP 未配置时，注册的 IP 为此网卡所对应的 IP 地址，如果此项也未配置，则默认取第一块网卡的地址
spring.cloud.nacos.discovery.ip  #优先级最高
spring.cloud.nacos.discovery.port  #默认情况下不用配置，会自动探测
spring.cloud.nacos.discovery.namespace #常用场景之一是不同环境的注册的区分隔离，例如开发测试环境和生产环境的资源（如配置、服务）隔离等。

spring.cloud.nacos.discovery.access-key  #当要上阿里云时，阿里云上面的一个云账号名
spring.cloud.nacos.discovery.secret-key #当要上阿里云时，阿里云上面的一个云账号密码
spring.cloud.nacos.discovery.metadata    #使用 Map 格式配置，用户可以根据自己的需要自定义一些和服务相关的元数据信息
spring.cloud.nacos.discovery.log-name   日志文件名
spring.cloud.nacos.discovery.enpoint   #地域的某个服务的入口域名，通过此域名可以动态地拿到服务端地址
ribbon.nacos.enabled  #是否集成 Ribbon 一般都设置成 true 即可

限流组件 Sentinel

• Sentinel 是把流量作为切入点，从流量控制、熔断降级、系统负载保护等多个维度保护服务的稳定性。
• 默认支持 Servlet、Feign、RestTemplate、Dubbo 和 RocketMQ 限流降级功能的接入，可以在运行时通过控制台实时修改限流降级规则，还支持查看限流降级 Metrics 监控。
• 自带控台动态修改限流策略。但是每次服务重启后就丢失了。所以它也支持 ReadableDataSource 目前支持 file, nacos, zk, apollo 这 4 种类型

接入 Sentinel

创建项目 cloud-sentinel

1 引入 Sentinel starter

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

2 application.properties 配置如下

server.port=18084
spring.application.name=service-sentinel

#Sentinel 控制台地址
spring.cloud.sentinel.transport.dashboard=localhost:8080
#取消 Sentinel 控制台懒加载
spring.cloud.sentinel.eager=true

接入限流埋点

Sentinel 默认为所有的 HTTP 服务提供了限流埋点。引入依赖后自动完成所有埋点。只需要在控制配置限流规则即可

注解埋点：如果需要对某个特定的方法进行限流或降级，可以通过 @SentinelResource 注解来完成限流的埋点

@SentinelResource("resource")
@RequestMapping("/sentinel/hello")
public Map<String,Object> hello(){
        Map<String,Object> map=new HashMap<>(2);
        map.put("appName",appName);
        map.put("method","hello");
        return map;
}

部署 Sentinel 控制台

安装

Sentinel 下载

启动控制台

执行 Java 命令 java -jar sentinel-dashboard.jar 默认的监听端口为 8080

访问

打开 http://localhost:8080 即可看到控制台界面

说明 cloud-sentinel 已经成功和 Sentinel 完成率通讯

配置限流规则

如果控制台没有找到自己的应用，可以先调用一下进行了 Sentinel 埋点的 URL 或方法或着禁用 Sentinel 的赖加载 spring.cloud.sentinel.eager=true

配置 URL 限流规则

控制器随便添加一个普通的 http 方法

  /**
     * 通过控制台配置 URL 限流
     * @return
     */
    @RequestMapping("/sentinel/test")
    public Map<String,Object> test(){
        Map<String,Object> map=new HashMap<>(2);
        map.put("appName",appName);
        map.put("method","test");
        return map;
    }

点击新增流控规则。为了方便测试阀值设为 1

浏览器重复请求 http://localhost:18084/sentinel/test 如果超过阀值就会出现如下界面

整个 URL 限流就完成了。但是返回的提示不够友好。

配置自定义限流规则(@SentinelResource 埋点)

自定义限流规则就不是添加方法的访问路径。 配置的是 @SentinelResource 注解中 value 的值。比如 @SentinelResource("resource") 就是配置路径为 resource

• 访问： http://localhost:18084/sentinel/hello
• 通过 @SentinelResource 注解埋点配置的限流规则如果没有自定义处理限流逻辑，当请求到达限流的阀值时就返回 404 页面
  

自定义限流处理逻辑

@SentinelResource 注解包含以下属性：

• value: 资源名称，必需项（不能为空）
• entryType: 入口类型，可选项（默认为 EntryType.OUT）
• blockHandler:blockHandlerClass 中对应的异常处理方法名。参数类型和返回值必须和原方法一致
• blockHandlerClass：自定义限流逻辑处理类

 //通过注解限流并自定义限流逻辑
 @SentinelResource(value = "resource2", blockHandler = "handleException", blockHandlerClass = {ExceptionUtil.class})
 @RequestMapping("/sentinel/test2")
    public Map<String,Object> test2() {
        Map<String,Object> map=new HashMap<>();
        map.put("method","test2");
        map.put("msg","自定义限流逻辑处理");
        return  map;
    }

public class ExceptionUtil {

    public static Map<String,Object> handleException(BlockException ex) {
        Map<String,Object> map=new HashMap<>();
        System.out.println("Oops: " + ex.getClass().getCanonicalName());
        map.put("Oops",ex.getClass().getCanonicalName());
        map.put("msg","通过 @SentinelResource 注解配置限流埋点并自定义处理限流后的逻辑");
        return  map;
    }
}

控制台新增 resource2 的限流规则并设置阀值为 1。访问 http://localhost:18084/sentinel/test2 请求到达阀值时机会返回自定义的异常消息

基本的限流处理就完成了。 但是每次服务重启后 之前配置的限流规则就会被清空因为是内存态的规则对象.所以下面就要用到 Sentinel 一个特性 ReadableDataSource 获取文件、数据库或者配置中心是限流规则

读取文件的实现限流规则

一条限流规则主要由下面几个因素组成：

• resource：资源名，即限流规则的作用对象
• count: 限流阈值
• grade: 限流阈值类型（QPS 或并发线程数）
• limitApp: 流控针对的调用来源，若为 default 则不区分调用来源
• strategy: 调用关系限流策略
• controlBehavior: 流量控制效果（直接拒绝、Warm Up、匀速排队）
  SpringCloud alibaba 集成 Sentinel 后只需要在配置文件中进行相关配置，即可在 Spring 容器中自动注册 DataSource，这点很方便。配置文件添加如下配置

# 通过文件读取限流规则
spring.cloud.sentinel.datasource.ds1.file.file=classpath: flowrule.json
spring.cloud.sentinel.datasource.ds1.file.data-type=json
spring.cloud.sentinel.datasource.ds1.file.rule-type=flow

在 resources 新建一个文件 比如 flowrule.json 添加限流规则

[
  {
    "resource": "resource",
    "controlBehavior": 0,
    "count": 1,
    "grade": 1,
    "limitApp": "default",
    "strategy": 0
  },
  {
    "resource": "resource3",
    "controlBehavior": 0,
    "count": 1,
    "grade": 1,
    "limitApp": "default",
    "strategy": 0
  }
]

重新启动项目。出现如下日志说明文件读取成功

 [Sentinel Starter] DataSource ds1-sentinel-file-datasource start to loadConfig
 [Sentinel Starter] DataSource ds1-sentinel-file-datasource load 2 FlowRule

刷新 Sentinel 控制台 限流规则就会自动添加进去

Sentinel 的配置

spring.cloud.sentinel.enabled              #Sentinel 自动化配置是否生效
spring.cloud.sentinel.eager               #取消 Sentinel 控制台懒加载
spring.cloud.sentinel.transport.dashboard   #Sentinel 控制台地址
spring.cloud.sentinel.transport.heartbeatIntervalMs        #应用与 Sentinel 控制台的心跳间隔时间
spring.cloud.sentinel.log.dir            #Sentinel 日志文件所在的目录