Spring Cloud(八)《服务网关路由 Zuul1》

2021-10-31 09:37:07

前言介绍

为什么会有路由层？因为在微服务架构设计中，往往并不会直接将服务暴漏给调用端，而是通过调用路由层进行业务隔离，以达到不同的业务调用对应的服务模块。

Spring Cloud Zuul

Spring Cloud Zuul 路由是微服务架构的不可或缺的一部分，提供动态路由、监控、弹性、安全等的边缘服务。Zuul 是 Netflix 出品的一个基于 JVM 路由和服务端的负载均衡器。

Spring Cloud(八)《服务网关路由 Zuul1》

微信公众号：bugstack虫洞栈 & Spring Cloud Zuul

环境准备

jdk 1.8、idea2018、Maven3
Spring Boot 2.0.6.RELEASE
Spring Cloud Finchley.SR2

代码示例

1itstack-demo-springcloud-08
 2├── itstack-demo-springcloud-eureka-client
 3│   └── src
 4│       └── main
 5│           ├── java
 6│           │   └── org.itstack.demo
 7│           │        ├── web
 8│           │        │   └── EurekaClientController.java
 9│           │        └── EurekaClientApplication.java
10│           └── resources   
11│               └── application.yml
12├── itstack-demo-springcloud-eureka-server
13│   └── src
14│       └── main
15│           ├── java
16│           │   └── org.itstack.demo
17│           │        └── EurekaServerApplication.java
18│           └── resources   
19│               └── application.yml
20├── itstack-demo-springcloud-hystrix-feign
21│   └── src
22│       └── main
23│           ├── java
24│           │   └── org.itstack.demo
25│           │        ├── service
26│           │        │   ├── hystrix
27│           │        │   │   └── FeignServiceHystrix.java
28│           │        │   └── FeignService.java
29│           │        ├── web
30│           │        │   └── FeignController.java
31│           │        └── FeignApplication.java
32│           └── resources   
33│               └── application.yml
34├── itstack-demo-springcloud-hystrix-ribbon
35│   └── src
36│       └── main
37│           ├── java
38│           │   └── org.itstack.demo
39│           │        ├── service
40│           │        │   └── RibbonService.java
41│           │        ├── web
42│           │        │   └── RibbonController.java      
43│           │        └── RibbonApplication.java
44│           └── resources   
45│               └── application.yml
46└── itstack-demo-springcloud-zuul
47    └── src
48        └── main
49            ├── java
50            │   └── org.itstack.demo   
51            │        └── ZuulApplication.java
52            └── resources   
53                └── application.yml

itstack-demo-springcloud-eureka-client | 服务提供方

提供一个查询用户信息的简单方法，在配置文件中通过修改端口启动2次，模拟双实例应用，为调用方负载做准备。

web/EurekaClientController.java & 注意@EnableEurekaClient用于向注册中心提供服务

1/**
 2 * 微信公众号：bugstack虫洞栈 | 沉淀、分享、成长，专注于原创专题案例
 3 * 论坛：http://bugstack.cn
 4 * Create by 付政委 on @2019
 5 */
 6@EnableEurekaClient
 7@RestController
 8public class EurekaClientController {
 9
10    @Value("${server.port}")
11    private int port;
12
13    @RequestMapping(path = "/api/queryUserInfo", method = RequestMethod.GET)
14    public String queryUserInfo(@RequestParam String userId) {
15        return "Hi 微信公众号：bugstack虫洞栈 | " + userId + " >: from eureka client port: " + port;
16    }
17
18}

EurekaClientApplication.java & 服务启动类

1/**
 2 * 微信公众号：bugstack虫洞栈 | 沉淀、分享、成长，专注于原创专题案例
 3 * 论坛：http://bugstack.cn
 4 * Create by 付政委 on @2019
 5 */
 6@SpringBootApplication
 7public class EurekaClientApplication {
 8
 9    public static void main(String[] args) {
10        SpringApplication.run(EurekaClientApplication.class, args);
11    }
12
13}

pom.xml & 配置文件指向注册中心

1server:
 2  port: 8001
 3
 4spring:
 5  application:
 6    name: itstack-demo-springcloud-eureka-client
 7
 8eureka:
 9  client:
10    serviceUrl:
11      defaultZone: http://localhost:7397/eureka/

itstack-demo-springcloud-eureka-server | 单个服务注册中心

服务注册中心用于承载接口提供方向上注册，同时正在调用方链接后可以获取指定应用的服务实例。

EurekaServerApplication.java & 通过注解@EnableEurekaServer启动服务注册与发现中心

1/**
 2 * 微信公众号：bugstack虫洞栈 | 沉淀、分享、成长，专注于原创专题案例
 3 * 论坛：http://bugstack.cn
 4 * Create by 付政委 on @2019
 5 */
 6@SpringBootApplication
 7@EnableEurekaServer
 8public class EurekaServerApplication {
 9
10    public static void main(String[] args) {
11        SpringApplication.run( EurekaServerApplication.class, args );
12    }
13
14}

pom.xml & 服务注册中心

1server:
 2  port: 7397
 3
 4eureka:
 5  instance:
 6    hostname: localhost
 7  client:
 8    registerWithEureka: false
 9    fetchRegistry: false
10    serviceUrl:
11      defaultZone: http://${eureka.instance.hostname}:${server.port}/eureka/
12
13spring:
14  application:
15    name: itstack-demo-springcloud-eureka-server

itstack-demo-springcloud-feign | Feign服务调用方

Feign 是一个声明式的 Web Service 客户端，它的目的就是让 Web Service 调用更加简单。它整合了 Ribbon 和 Hystrix，从而让我们不再需要显式地使用这两个组件。Feign 还提供了 HTTP 请求的模板，通过编写简单的接口和插入注解，我们就可以定义好 HTTP 请求的参数、格式、地址等信息。接下来，Feign 会完全代理 HTTP 的请求，我们只需要像调用方法一样调用它就可以完成服务请求。

Feign 具有如下特性：

可插拔的注解支持，包括 Feign 注解和 JAX-RS 注解

支持可插拔的 HTTP 编码器和解码器

支持 Hystrix 和它的 Fallback

支持 Ribbon 的负载均衡

支持 HTTP 请求和响应的压缩

service/FeignService.java | 注解方式调用，方便易用。@FeignClient会在调用时进行解析服务到具体的http://ip:port/

1/**
 2 * 微信公众号：bugstack虫洞栈 | 沉淀、分享、成长，专注于原创专题案例
 3 * 论坛：http://bugstack.cn
 4 * Create by 付政委 on @2019
 5 */
 6@FeignClient(value = "itstack-demo-springcloud-eureka-client", fallback = FeignServiceHystrix.class)
 7public interface FeignService {
 8
 9    @RequestMapping(value = "/api/queryUserInfo", method = RequestMethod.GET)
10    String queryUserInfo(@RequestParam String userId);
11
12}

service/hystrix/FeignServiceHystrix.java | 提供熔断服务，当发生异常时主动返回预定结果

1/**
 2 * 微信公众号：bugstack虫洞栈 | 沉淀、分享、成长，专注于原创专题案例
 3 * 论坛：http://bugstack.cn
 4 * Create by 付政委 on @2019
 5 */
 6@Component
 7public class FeignServiceHystrix implements FeignService {
 8
 9    @Override
10    public String queryUserInfo(String userId) {
11        return "queryUserInfo by userId：" + userId + " err！from feign hystrix";
12    }
13
14}

web/FeignController.java | 使用接口提供服务 From Feign

1/**
 2 * 微信公众号：bugstack虫洞栈 | 沉淀、分享、成长，专注于原创专题案例
 3 * 论坛：http://bugstack.cn
 4 * Create by 付政委 on @2019
 5 */
 6@RestController
 7public class FeignController {
 8
 9    @Resource
10    private FeignService ribbonService;
11
12    @RequestMapping(path = "/api/queryUserInfo", method = RequestMethod.GET)
13    public String queryUserInfo(@RequestParam String userId) {
14        return ribbonService.queryUserInfo(userId) + " From Feign";
15    }
16
17}

FeignApplication.java | 注解@EnableEurekaClient、@EnableFeignClients、@EnableDiscoveryClient获取调用注册中心服务

1/**
 2 * 微信公众号：bugstack虫洞栈 | 沉淀、分享、成长，专注于原创专题案例
 3 * 论坛：http://bugstack.cn
 4 * Create by 付政委 on @2019
 5 */
 6@SpringBootApplication
 7@EnableEurekaClient
 8@EnableDiscoveryClient
 9@EnableFeignClients
10@EnableHystrix
11public class FeignApplication {
12
13    public static void main(String[] args) {
14        SpringApplication.run(FeignApplication.class, args);
15    }
16
17}

application.yml | eureka服务配置，从注册中心获取可用服务。开启hystrix=true

1server:
 2  port: 9001
 3
 4spring:
 5  application:
 6    name: itstack-demo-springcloud-feign
 7
 8eureka:
 9  client:
10    serviceUrl:
11      defaultZone: http://localhost:7397/eureka/
12
13feign.hystrix.enabled: true

itstack-demo-springcloud-ribbon | Ribbon服务调用方

Ribbon是一个基于 HTTP 和 TCP 的客户端负载均衡器。它可以通过在客户端中配置 ribbonServerList 来设置服务端列表去轮询访问以达到均衡负载的作用。

当 Ribbon 与 Eureka 联合使用时，ribbonServerList 会被 DiscoveryEnabledNIWSServerList 重写，扩展成从 Eureka 注册中心中获取服务实例列表。同时它也会用 NIWSDiscoveryPing 来取代 IPing，它将职责委托给 Eureka 来确定服务端是否已经启动。

service/RibbonService.java | 接口式硬编码调用不太易于维护，因此也是比较少用的方式。hystrix实际通过getFallback()返回熔断结果

1/**
 2 * 微信公众号：bugstack虫洞栈 | 沉淀、分享、成长，专注于原创专题案例
 3 * 论坛：http://bugstack.cn
 4 * Create by 付政委 on @2019
 5 */
 6@Service
 7public class RibbonService {
 8
 9    @Autowired
10    private RestTemplate restTemplate;
11
12    @HystrixCommand(fallbackMethod = "queryUserInfoFallback")
13    public String queryUserInfo(String userId) {
14        return restTemplate.getForObject("http://ITSTACK-DEMO-SPRINGCLOUD-EUREKA-CLIENT/api/queryUserInfo?userId=" + userId, String.class);
15    }
16
17    /**
18     * Specifies a method to process fallback logic.
19     * A fallback method should be defined in the same class where is HystrixCommand.
20     * Also a fallback method should have same signature to a method which was invoked as hystrix command.
21     * for example:
22     * <code>
23     *      @HystrixCommand(fallbackMethod = "getByIdFallback")
24     *      public String getById(String id) {...}
25     *
26     *      private String getByIdFallback(String id) {...}
27     * </code>
28     * Also a fallback method can be annotated with {@link HystrixCommand}
29     * <p/>
30     * default => see {@link com.netflix.hystrix.contrib.javanica.command.GenericCommand#getFallback()}
31     *
32     * @return method name
33     *
34     * getFallback()
35     * 
36     * @Override
37     * protected Object getFallback() {
38     *     final CommandAction commandAction = getFallbackAction();
39     *     if (commandAction != null) {
40     *         try {
41     *             return process(new Action() {
42     *                 @Override
43     *                 Object execute() {
44     *                     MetaHolder metaHolder = commandAction.getMetaHolder();
45     *                     Object[] args = createArgsForFallback(metaHolder, getExecutionException());
46     *                     return commandAction.executeWithArgs(metaHolder.getFallbackExecutionType(), args);
47     *                 }
48     *             });
49     *         } catch (Throwable e) {
50     *             LOGGER.error(FallbackErrorMessageBuilder.create()
51     *                     .append(commandAction, e).build());
52     *             throw new FallbackInvocationException(unwrapCause(e));
53     *         }
54     *     } else {
55     *         return super.getFallback();
56     *     }
57     * }
58     */
59    public String queryUserInfoFallback(String userId) {
60        return "queryUserInfo by userId：" + userId + " err！from ribbon hystrix";
61    }
62
63}

web/RibbonController.java | 使用接口提供服务 From Ribbon

1/**
 2 * 微信公众号：bugstack虫洞栈 | 沉淀、分享、成长，专注于原创专题案例
 3 * 论坛：http://bugstack.cn
 4 * Create by 付政委 on @2019
 5 */
 6@RestController
 7public class RibbonController {
 8
 9    @Resource
10    private RibbonService ribbonService;
11
12    @RequestMapping(path = "/api/queryUserInfo", method = RequestMethod.GET)
13    public String queryUserInfo(@RequestParam String userId) {
14        return ribbonService.queryUserInfo(userId) + " From Ribbon";
15    }
16
17}

RibbonApplication.java | 通过注解@LoadBalanced注册rest模版，用于Ribbon接口调用。并启动@EnableHystrix

1/**
 2 * 微信公众号：bugstack虫洞栈 | 沉淀、分享、成长，专注于原创专题案例
 3 * 论坛：http://bugstack.cn
 4 * Create by 付政委 on @2019
 5 */
 6@SpringBootApplication
 7@EnableEurekaClient
 8@EnableDiscoveryClient
 9@EnableHystrix
10public class RibbonApplication {
11
12    public static void main(String[] args) {
13        SpringApplication.run(RibbonApplication.class, args);
14    }
15
16    @Bean
17    @LoadBalanced
18    RestTemplate restTemplate() {
19        return new RestTemplate();
20    }
21
22}

application.yml | eureka服务配置，从注册中心获取可用服务

1server:
 2  port: 9002
 3
 4spring:
 5  application:
 6    name: itstack-demo-springcloud-ribbon
 7
 8eureka:
 9  client:
10    serviceUrl:
11      defaultZone: http://localhost:7397/eureka/

itstack-demo-springcloud-zuul | Zull路由层

ZuulApplication.java & 路由服务启动

1/**
 2 * 微信公众号：bugstack虫洞栈 | 专注原创技术专题案例
 3 * 论坛：http://bugstack.cn
 4 * Create by 付政委 on @2019
 5 */
 6@SpringBootApplication
 7@EnableZuulProxy
 8@EnableEurekaClient
 9@EnableDiscoveryClient
10public class ZuulApplication {
11
12    public static void main(String[] args) {
13        SpringApplication.run(ZuulApplication.class, args);
14    }
15
16}

pom.mxl & 路由配置

1server:
 2  port: 10001
 3
 4spring:
 5  application:
 6    name: itstack-demo-ddd-zuul
 7
 8eureka:
 9  client:
10    serviceUrl:
11      defaultZone: http://localhost:7397/eureka/
12
13# http://localhost:10001/route-a/api/queryUserInfo?userId=111
14# http://localhost:10001/route-b/api/queryUserInfo?userId=111
15zuul:
16  routes:
17    api-a:
18      path: /route-a/**
19      serviceId: itstack-demo-springcloud-feign
20    api-b:
21      path: /route-b/**
22      serviceId: itstack-demo-springcloud-ribbon
23

测试验证

分别启动如下系统模拟；

1. itstack-demo-springcloud-eureka-server 服务注册发现中心
2. itstack-demo-springcloud-eureka-client 测试接口提供方
3. itstack-demo-springcloud-hystrix-feign 接口调用方Feign
4. itstack-demo-springcloud-hystrix-ribbon 接口调用方Ribbon
5. itstack-demo-springcloud-zuul 路由服务

测试接口
访问Feign、Ribbon接口，验证服务是否可用；http://localhost:9001/api/queryUserInfo?userId=111、http://localhost:9002/api/queryUserInfo?userId=111
访问路由接口A；http://localhost:10001/route-a/api/queryUserInfo?userId=111
访问路由接口B；http://localhost:10001/route-b/api/queryUserInfo?userId=111
>Hi 微信公众号：bugstack虫洞栈 | 111 >: from eureka client port: 8001 From Ribbon

综上总结

zuul目前SpringCloud结合的是zuul 1， Netflix 已经发布了 Zuul 2但目前还未整合
SpringCloud还有自己的网关服务；Spring Cloud Gateway
通过最上层的路由功能可以很方便的隔离业务，但是路由层一定是高可用的，否则路由瘫痪整个服务将不可用

码农公寓