修改介绍

eeb2de41 · Nepxion · ae043ea4 · eeb2de41
Commit eeb2de41 authored Aug 04, 2018 by Nepxion
Hide whitespace changes
Inline Side-by-side

Showing with 4 additions and 245 deletions

README.md
+4 -245

No files found.
--- a/README.md
+++ b/README.md
@@ -20,7 +20,8 @@ Nepxion Discovery是一款对Spring Cloud的服务注册发现的增强中间件
 ![Alt text](https://github.com/Nepxion/Docs/blob/master/zxing-doc/微信群-1.jpg) ![Alt text](https://github.com/Nepxion/Docs/blob/master/zxing-doc/微信-1.jpg)

 ## 快速开始
- 查阅[极简入门教程](https://github.com/Nepxion/Docs/blob/master/discovery-plugin-doc/README_QUICK_START.md)
+- [入门教程](https://github.com/Nepxion/Docs/blob/master/discovery-plugin-doc/README_QUICK_START.md)
+- [示例演示](https://github.com/Nepxion/Docs/blob/master/discovery-plugin-doc/README_EXAMPLE.md)
 - 图形化演示操作
  - 请访问[http://www.iqiyi.com/w_19rzwzovrl.html](http://www.iqiyi.com/w_19rzwzovrl.html)，视频清晰度改成720P，然后最大化播放
  - 请访问[https://pan.baidu.com/s/1eq_N56VbgSCaTXYQ5aKqiA](https://pan.baidu.com/s/1eq_N56VbgSCaTXYQ5aKqiA)，获取更清晰的视频，注意一定要下载下来看，不要在线看，否则也不清晰
@@ -473,246 +474,4 @@ spring.application.strategy.scan.packages=com.nepxion.discovery.plugin.example.s
 ### 控制台接口
 参考Swagger界面，如下图

-![Alt text](https://github.com/Nepxion/Docs/blob/master/discovery-plugin-doc/Swagger2.jpg)
-
-## 示例演示
-### 场景描述
-本例将模拟一个较为复杂的场景，如下图
-
-![Alt text](https://github.com/Nepxion/Docs/blob/master/discovery-plugin-doc/Version.jpg)
-
- 系统部署情况：
-  - 网关Zuul集群部署了1个
-  - 微服务集群部署了3个，分别是A服务集群、B服务集群、C服务集群，分别对应的实例数为2、2、3
- 微服务集群的调用关系为网关Zuul->服务A->服务B->服务C
- 系统调用关系
-  - 网关Zuul的1.0版本只能调用服务A的1.0版本，网关Zuul的1.1版本只能调用服务A的1.1版本
-  - 服务A的1.0版本只能调用服务B的1.0版本，服务A的1.1版本只能调用服务B的1.1版本
-  - 服务B的1.0版本只能调用服务C的1.0和1.1版本，服务B的1.1版本只能调用服务C的1.2版本
-
-用规则来表述上述关系
-```xml
-<?xml version="1.0" encoding="UTF-8"?>
-<rule>
-    <discovery>
-        <version>
-            <!-- 表示网关z的1.0，允许访问提供端服务a的1.0版本 -->
-            <service consumer-service-name="discovery-springcloud-example-zuul" provider-service-name="discovery-springcloud-example-a" consumer-version-value="1.0" provider-version-value="1.0"/>
-            <!-- 表示网关z的1.1，允许访问提供端服务a的1.1版本 -->
-            <service consumer-service-name="discovery-springcloud-example-zuul" provider-service-name="discovery-springcloud-example-a" consumer-version-value="1.1" provider-version-value="1.1"/>
-            <!-- 表示消费端服务a的1.0，允许访问提供端服务b的1.0版本 -->
-            <service consumer-service-name="discovery-springcloud-example-a" provider-service-name="discovery-springcloud-example-b" consumer-version-value="1.0" provider-version-value="1.0"/>
-            <!-- 表示消费端服务a的1.1，允许访问提供端服务b的1.1版本 -->
-            <service consumer-service-name="discovery-springcloud-example-a" provider-service-name="discovery-springcloud-example-b" consumer-version-value="1.1" provider-version-value="1.1"/>
-            <!-- 表示消费端服务b的1.0，允许访问提供端服务c的1.0和1.1版本 -->
-            <service consumer-service-name="discovery-springcloud-example-b" provider-service-name="discovery-springcloud-example-c" consumer-version-value="1.0" provider-version-value="1.0;1.1"/>
-            <!-- 表示消费端服务b的1.1，允许访问提供端服务c的1.2版本 -->
-            <service consumer-service-name="discovery-springcloud-example-b" provider-service-name="discovery-springcloud-example-c" consumer-version-value="1.1" provider-version-value="1.2"/>
-        </version>
-    </discovery>
-</rule>
-```
-
-上述微服务分别见discovery-springcloud-example-service、discovery-springcloud-example-zuul和discovery-springcloud-example-gateway三个工程。相应的服务名、端口和版本见下表
-
-| 微服务 | 服务端口 | 管理端口 | 版本 |
-| --- | --- | --- | --- |
-| A1 | 1100 | 5100 | 1.0 |
-| A2 | 1101 | 5101 | 1.1 |
-| B1 | 1200 | 5200 | 1.0 |
-| B2 | 1201 | 5201 | 1.1 |
-| C1 | 1300 | 5300 | 1.0 |
-| C2 | 1301 | 5301 | 1.1 |
-| C3 | 1302 | 5302 | 1.2 |
-| Zuul | 1400 | 5400 | 1.0 |
-| Gateway | 1500 | 5500 | 1.0 |
-
-独立控制台见discovery-springcloud-example-console，对应的版本和端口号如下表
-
-| 服务端口 | 管理端口 |
-| --- | --- |
-| 2222 | 3333 |
-
-Admin见discovery-springcloud-example-admin，对应的版本和端口号如下表
-
-| 服务端口 | 
-| --- |
-| 5555 |
-
-### 开始演示
- 启动服务注册发现中心，默认是Eureka。可供选择的有Eureka，Zuul，Zookeeper。Eureka，请启动discovery-springcloud-example-eureka下的应用，后两者自行安装服务器
- 根据上面选择的服务注册发现中心，对示例下的discovery-springcloud-example-service/pom.xml进行组件切换
-```xml
-<dependency>
-    <groupId>com.nepxion</groupId>
-    <artifactId>discovery-plugin-starter-eureka</artifactId>
-    <!-- <artifactId>discovery-plugin-starter-consul</artifactId> -->
-    <!-- <artifactId>discovery-plugin-starter-zookeeper</artifactId> -->
-    <version>${discovery.plugin.version}</version>
-</dependency>
-```
- 根据上面选择的服务注册发现中心，对控制台下的discovery-springcloud-example-console/pom.xml进行组件切换切换
-```xml
-<dependency>
-    <groupId>org.springframework.cloud</groupId>
-    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
-    <!-- <artifactId>spring-cloud-starter-consul-discovery</artifactId> -->
-    <!-- <artifactId>spring-cloud-starter-zookeeper-discovery</artifactId> -->
-</dependency>
-```
-
-### 服务注册过滤的操作演示
-黑/白名单的IP地址注册的过滤
- 在rule.xml把本地IP地址写入到相应地方
- 启动DiscoveryApplicationA1.java
- 抛出禁止注册的异常，即本地服务受限于黑名单的IP地址列表，不会注册到服务注册发现中心；白名单操作也是如此，不过逻辑刚好相反
-
-最大注册数的限制的过滤
- 在rule.xml修改最大注册数为0
- 启动DiscoveryApplicationA1.java
- 抛出禁止注册的异常，即本地服务受限于最大注册数，不会注册到服务注册发现中心
-
-黑/白名单的IP地址发现的过滤
- 在rule.xml把本地IP地址写入到相应地方
- 启动DiscoveryApplicationA1.java和DiscoveryApplicationB1.java、DiscoveryApplicationB2.java
- 你会发现A服务无法获取B服务的任何实例，即B服务受限于黑名单的IP地址列表，不会被A服务的发现；白名单操作也是如此，不过逻辑刚好相反
-
-### 服务发现和负载均衡控制的操作演示
-#### 基于图形化方式的多版本灰度访问控制
- 请访问[http://www.iqiyi.com/w_19s07thtsh.html](http://www.iqiyi.com/w_19s07thtsh.html)，视频清晰度改成720P，然后最大化播放
- 请访问[https://pan.baidu.com/s/1eq_N56VbgSCaTXYQ5aKqiA](https://pan.baidu.com/s/1eq_N56VbgSCaTXYQ5aKqiA)，获取更清晰的视频，注意一定要下载下来看，不要在线看，否则也不清晰
-
-#### 基于Rest方式的多版本灰度访问控制
-基于服务的操作过程和效果
- 启动discovery-springcloud-example-service下7个DiscoveryApplication，无先后顺序，等待全部启动完毕
- 下面URL的端口号，可以是服务端口号，也可以是管理端口号
- 通过版本切换，达到灰度访问控制，针对A服务
-  - 1.1 通过Postman或者浏览器，执行POST [http://localhost:1100/routes](http://localhost:1100/routes)，填入discovery-springcloud-example-b;discovery-springcloud-example-c，查看路由路径，如图1，可以看到符合预期的调用路径
-  - 1.2 通过Postman或者浏览器，执行POST [http://localhost:1100/version/update](http://localhost:1100/version/update)，填入1.1，动态把服务A的版本从1.0切换到1.1
-  - 1.3 通过Postman或者浏览器，再执行第一步操作，如图2，可以看到符合预期的调用路径，通过版本切换，灰度访问控制成功
- 通过规则改变，达到灰度访问控制，针对B服务
-  - 2.1 通过Postman或者浏览器，执行POST [http://localhost:1200/config/update-sync](http://localhost:1200/config/update-sync)，发送新的规则XML（内容见下面）
-  - 2.2 通过Postman或者浏览器，执行POST [http://localhost:1201/config/update-sync](http://localhost:1201/config/update-sync)，发送新的规则XML（内容见下面）
-  - 2.3 上述操作也可以通过独立控制台，进行批量更新，见图5。操作的逻辑：B服务的所有版本都只能访问C服务3.0版本，而本例中C服务3.0版本是不存在的，意味着这么做B服务不能访问C服务
-  - 2.4 重复1.1步骤，发现调用路径只有A服务->B服务，如图3，通过规则改变，灰度访问控制成功
- 负载均衡的灰度测试
-  - 3.1 通过Postman或者浏览器，执行POST [http://localhost:1100/invoke](http://localhost:1100/invoke)，这是example内置的访问路径示例（通过Feign实现）
-  - 3.2 重复“通过版本切换，达到灰度访问控制”或者“通过规则改变，达到灰度访问控制”操作，查看Ribbon负载均衡的灰度结果，如图4
- 上述操作，都是单次操作，如需要批量操作，可通过“独立控制台”接口，它集成批量操作和推送到远程配置中心的功能，可以取代上面的某些调用方式
- 其它更多操作，请参考“配置中心”、“管理中心”和“独立控制台”
-
-新XML规则
-```xml
-<?xml version="1.0" encoding="UTF-8"?>
-<rule>
-    <discovery>
-        <version>
-            <service consumer-service-name="discovery-springcloud-example-b" provider-service-name="discovery-springcloud-example-c" consumer-version-value="" provider-version-value="3.0"/>
-        </version>
-    </discovery>
-</rule>
-```
-
-图1
-
-![Alt text](https://github.com/Nepxion/Docs/blob/master/discovery-plugin-doc/Result1.jpg)
-
-图2
-
-![Alt text](https://github.com/Nepxion/Docs/blob/master/discovery-plugin-doc/Result2.jpg)
-
-图3
-
-![Alt text](https://github.com/Nepxion/Docs/blob/master/discovery-plugin-doc/Result3.jpg)
-
-图4
-
-![Alt text](https://github.com/Nepxion/Docs/blob/master/discovery-plugin-doc/Result4.jpg)
-
-图5
-
-![Alt text](https://github.com/Nepxion/Docs/blob/master/discovery-plugin-doc/Result5.jpg)
-
-基于网关的操作过程和效果
- 在上面基础上，启动discovery-springcloud-example-zuul下DiscoveryApplicationZuul或者启动discovery-springcloud-example-gateway下DiscoveryApplicationGateway
- 因为Zuul和Spring Cloud Api Gateway是一种特殊的微服务，也遵循Spring Cloud体系的服务注册发现和负载均衡机制，所以所有操作过程跟上面完全一致
-
-图6
-
-![Alt text](https://github.com/Nepxion/Docs/blob/master/discovery-plugin-doc/Result6.jpg)
-
-图7
-
-![Alt text](https://github.com/Nepxion/Docs/blob/master/discovery-plugin-doc/Result7.jpg)
-
-### 用户自定义和编程灰度路由的操作演示
- 在网关层（以Zuul为例），编程灰度路由策略，如下代码，表示请求的Header中的token包含'abc'，在负载均衡层面，对应的服务示例不会被负载均衡到
-```java
-public class MyDiscoveryEnabledAdapter implements DiscoveryEnabledAdapter {
-    private static final Logger LOG = LoggerFactory.getLogger(MyDiscoveryEnabledAdapter.class);
-
-    @Override
-    public boolean apply(Server server, Map<String, String> metadata) {
-        RequestContext context = RequestContext.getCurrentContext();
-        String token = context.getRequest().getHeader("token");
-        // String value = context.getRequest().getParameter("value");
-
-        String serviceId = server.getMetaInfo().getAppName().toLowerCase();
-
-        LOG.info("Zuul端负载均衡用户定制触发：serviceId={}, host={}, metadata={}, context={}", serviceId, server.toString(), metadata, context);
-
-        String filterToken = "abc";
-        if (StringUtils.isNotEmpty(token) && token.contains(filterToken)) {
-            LOG.info("过滤条件：当Token含有'{}'的时候，不能被Ribbon负载均衡到", filterToken);
-
-            return false;
-        }
-
-        return true;
-    }
-}
-```
-
-图8
-
-![Alt text](https://github.com/Nepxion/Docs/blob/master/discovery-plugin-doc/Result8.jpg)
-
- 在服务层，编程灰度路由策略，如下代码，因为示例中只有一个方法 String invoke(String value)，表示当服务名为discovery-springcloud-example-c，同时版本为1.0，同时参数value中包含'abc'，三个条件同时满足的情况下，在负载均衡层面，对应的服务示例不会被负载均衡到
-```java
-public class MyDiscoveryEnabledAdapter implements DiscoveryEnabledAdapter {
-    private static final Logger LOG = LoggerFactory.getLogger(MyDiscoveryEnabledAdapter.class);
-
-    @SuppressWarnings("unchecked")
-    @Override
-    public boolean apply(Server server, Map<String, String> metadata) {
-        ServiceStrategyContext context = ServiceStrategyContext.getCurrentContext();
-        Map<String, Object> attributes = context.getAttributes();
-
-        String serviceId = server.getMetaInfo().getAppName().toLowerCase();
-        String version = metadata.get(PluginConstant.VERSION);
-
-        LOG.info("Serivice端负载均衡用户定制触发：serviceId={}, host={}, metadata={}, context={}", serviceId, server.toString(), metadata, context);
-
-        String filterServiceId = "discovery-springcloud-example-c";
-        String filterVersion = "1.0";
-        String filterBusinessValue = "abc";
-        if (StringUtils.equals(serviceId, filterServiceId) && StringUtils.equals(version, filterVersion)) {
-            if (attributes.containsKey(ServiceStrategyConstant.PARAMETER_MAP)) {
-                Map<String, Object> parameterMap = (Map<String, Object>) attributes.get(ServiceStrategyConstant.PARAMETER_MAP);
-                String value = parameterMap.get("value").toString();
-                if (StringUtils.isNotEmpty(value) && value.contains(filterBusinessValue)) {
-                    LOG.info("过滤条件：当serviceId={} && version={} && 业务参数含有'{}'的时候，不能被Ribbon负载均衡到", filterServiceId, filterVersion, filterBusinessValue);
-
-                    return false;
-                }
-            }
-        }
-
-        return true;
-    }
-}
-```
-
-图9
-
-![Alt text](https://github.com/Nepxion/Docs/blob/master/discovery-plugin-doc/Result9.jpg)
\ No newline at end of file
+![Alt text](https://github.com/Nepxion/Docs/blob/master/discovery-plugin-doc/Swagger2.jpg)
\ No newline at end of file