【SpringCloud】第五篇: 路由网关(zuul)

前言:

必需学会SpringBoot基础知识

简介:

spring cloud 为开发人员提供了快速构建分布式系统的一些工具，包括配置管理、服务发现、断路器、路由、微代理、事件总线、全局锁、决策竞选、分布式会话等等。它运行环境简单，可以在开发人员的电脑上跑。

工具:

JDK8

apache-maven-3.5.2

IntelliJ IDEA 2018.1 x64

在微服务架构中，需要几个基础的服务治理组件，包括服务注册与发现、服务消费、负载均衡、断路器、智能路由、配置管理等，由这几个基础组件相互协作，共同组建了一个简单的微服务系统。一个简答的微服务系统如下图：

注意：A服务和B服务是可以相互调用的，作图的时候忘记了。并且配置服务也是注册到服务注册中心的。

在Spring Cloud微服务系统中，一种常见的负载均衡方式是，客户端的请求首先经过负载均衡（zuul、Ngnix），再到达服务网关（zuul集群），然后再到具体的服。，服务统一注册到高可用的服务注册中心集群，服务的所有的配置文件由配置服务管理（下一篇文章讲述），配置服务的配置文件放在git仓库，方便开发人员随时改配置。

一、Zuul简介

Zuul的主要功能是路由转发和过滤器。路由功能是微服务的一部分，比如／api/user转发到到user服务，/api/shop转发到到shop服务。zuul默认和Ribbon结合实现了负载均衡的功能。

zuul有以下功能：

• Authentication
• Insights
• Stress Testing
• Canary Testing
• Dynamic Routing
• Service Migration
• Load Shedding
• Security
• Static Response handling
• Active/Active traffic management

二、准备工作

继续使用上一节的工程。在原有的工程上，创建一个新的工程。

三、创建eureka-zuul工程

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.lwc</groupId>
    <artifactId>eureka-zuul</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>eureka-zuul</name>
    <description>Demo project for Spring Boot</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.10.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <spring-cloud.version>Edgware.SR3</spring-cloud.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka-server</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-zuul</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

启动类加上注解@EnableZuulProxy，开启zuul：

package com.lwc;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
import org.springframework.cloud.netflix.zuul.EnableZuulProxy;

/**
 * @author Eddie
 */
@EnableZuulProxy
@EnableEurekaClient
@SpringBootApplication
public class EurekaZuulApplication {

    public static void main(String[] args) {
        SpringApplication.run(EurekaZuulApplication.class, args);
    }
}

*.yml 配置, path对应serviceId

application.yml	application-dev.yml
spring: application: name: eureka-zuul profiles: active: ${@profileActiv@:dev}	eureka: client: serviceUrl: defaultZone: http://localhost:8761/eureka/ server: port: 8769 zuul: routes: api-a: path: /zuul-a/** serviceId: eureka-ribbon api-b: path: /zuul-b/** serviceId: eureka-feign

四、服务过滤

zuul不仅只是路由，并且还能过滤，做一些安全验证。继续改造工程；

package com.lwc.config;

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

import javax.servlet.http.HttpServletRequest;

/**
 * @author eddie.lee
 * @Package com.lwc.config
 * @ClassName MyFilter
 * @description Zuul路由过滤器
 * @date created in 2018-04-02 19:58
 * @modified by
 */
@Component
public class MyFilter extends ZuulFilter {

//    filterType：返回一个字符串代表过滤器的类型，在zuul中定义了四种不同生命周期的过滤器类型，具体如下：
//    pre：路由之前
//    routing：路由之时
//    post： 路由之后
//    error：发送错误调用
//    filterOrder：过滤的顺序
//    shouldFilter：这里可以写逻辑判断，是否要过滤，本文true,永远过滤。
//    run：过滤器的具体逻辑。可用很复杂，包括查sql，nosql去判断该请求到底有没有权限访问。

    private static Logger log = LoggerFactory.getLogger(MyFilter.class);

    @Override
    public String filterType() {
        return "pre";
    }

    @Override
    public int filterOrder() {
        return 0;
    }

    @Override
    public boolean shouldFilter() {
        return true;
    }

    @Override
    public Object run() {
        RequestContext requestContext = RequestContext.getCurrentContext();
        HttpServletRequest request = requestContext.getRequest();
        log.info(String.format("%s ==> %s", request.getMethod(), request.getRequestURL().toString()));
        Object accessToken = request.getParameter("str");
        if (accessToken == null) {
            log.warn("Please add str");
            requestContext.setSendZuulResponse(false);
            requestContext.setResponseStatusCode(401);
            try {
                requestContext.getResponse().getWriter().write("Please add str");
            } catch (Exception e) {
                //log.error("Zuul路由错误: ", e.getMessage());
            }

            return null;
        }
        log.info("Yes Eddie");
        return null;
    }
}

五、测试：

1. 运行之前章节的实例, 总共五个;

2. 在浏览器上查看成果, 也可以使用postman, GET方式

3. 过滤器测试: 添加str关键字

eureka-ribbon :

http://localhost:8764/eureka/ribbon?name=eddie  ==> hi eddie, i am from port:8762

eureka-feign :

http://localhost:8765/eureka/feign?name=eddie ==> hi eddie, i am from port:8762

eureka-zuul (没有使用过滤器返回)

http://localhost:8769/zuul-b/eureka/feign?name=eddie ==> Please add str

eureka-zuul (使用过滤器返回)

http://localhost:8769/zuul-a/eureka/ribbon?name=eddie&str=123456 ==> hi eddie, i am from port:8762

六、源码下载:

标签 5-1

https://github.com/eddie-code/SpringCloudDemo/tree/master/eureka-zuul

七、盲区解答

问: 什么是路由?

答: 按我当年做运维经验, 路由就好比如马路, 在十字路口里面, 标记某车辆去哪里, 比如A直接过对面车道, 就把A要走的车道标记起来,让A可以放行, 不会迷失在马路上徘徊!

问: 有博民问我, 前几章节, 说到多开, 有无其他方法呢?

答: 有

(1) 如果你使用IDEA的同学, 应该试过自己添加 tomcat server, 同理, 如果多开, 可以自己添加不同端口;

(2) 使用传统方式 jar 包启动, 可以设置对应的配置文件, 文件里面自己定义好对应端口;