文章目录
SpringCloud搭建Zuul动态服务网关
zuul是spring cloud的一个推荐组件,https://github.com/Netflix/zuul
-
网关接口(API Gateway ) 接口是没有图形化界面的
网关概念: 相当于客户端请求先同一请求到网关服务器上,再由网关服务器进行转发到实际服务器地址上, 类似于: Nginx
网关作用: 网关的作用,可以实现负载均衡、路由转发、日志、权限控制、监控等
网关分类
网关分为 内网网关和外网网关
-
接口产生的背景: 在面向服务架构和微服务背景下产生的 目的都是为了解耦 RPC远程调用中产生的
-
接口分类:
-
开放接口 — 其他结构合作伙伴进行调用(必须在外网访问) 专线 蚂蚁开放平台、微信公众号开发 需要appid+appscrect生成accessToken进行通信 对接支付开发、微信开发
目的可以授权一些接口权限 OAtuth2.0协议方式
-
内部接口 — 一般只能在局域网中进行访问,服务与服务之间的调用关系都在同一个微服务系统中
目的是为了保证安全问题
-
-
网关和过滤器的区别
- 网关是拦截所有服务器请求进行控制
- 过滤器拦截某单个服务器请求进行控制
-
Nginx于Zuul的区别
- 相同点
- Zuul和Nginx都可以实现负载均衡、反向代理、过滤请求、实现网关效果
- 不同点
- Nginx是采用C语言编写 Zuul是采用Java语言编写
- Zuul负载均衡实现: 采用Ribbon+Eureka实现本地负载均衡 Nginx负载均衡实现: 采用服务器端实现负载均衡的
- Nginx比Zuul功能会更加强大 ,能够整合其他语言比如lua脚本实现强大的功能
- Nginx适合于服务器端负载均衡 也是可以实现网关的。 Zuul适合微服务中实现网关,而且使用技术是Java语言 最好建议是Nginx+Zuul实现网关 其中Nginx作用是实现反向代理 Zuul是对微服务实现网关拦截
- Nginx可以更好的抗高并发,Zuul网关适用于请求过滤和拦截等。
- 相同点
[外链图片转存失败(img-yXTOeaTW-1569335070127)(images/1569294045462.png)]
现在让你去设计一套公司项目的接口,你会如何设计?
考虑 接口权限(开放接口|内部接口)、考虑幂等性、安全性(Https) 防止篡改数据(验证签名)、使用网关拦截 接口实现黑名单和白名单、接口使用http协议+json格式 restful目的是为了跨平台,考虑高并发 对接口服务实现服务保护 如服务降级、熔断、隔离之类,最后使用同一的API管理平台(如swagger)。
开放Api
开放api(openApi) 企业需要将自身数据、能力等作为开发平台向外开放,通常会以rest的方式向外提供,最好的例子就是淘宝开放平台、腾讯公司的QQ开发平台、微信开放平台。 Open API开放平台必然涉及到客户应用的接入、API权限的管理、调用次数管理等,必然会有一个统一的入口进行管理,这正是API网关可以发挥作用的时候。
微服务网关
微服务的概念最早在2012年提出,在Martin Fowler的大力推广下,微服务在2014年后得到了大力发展。 在微服务架构中,有一个组件可以说是必不可少的,那就是微服务网关,微服务网关处理了负载均衡,缓存,路由,访问控制,服务代理,监控,日志等。API网关在微服务架构中正是以微服务网关的身份存在。+
API服务管理平台
上述的微服务架构对企业来说有可能实施上是困难的,企业有很多遗留系统,要全部抽取为微服务器改动太大,对企业来说成本太高。但是由于不同系统间存在大量的API服务互相调用,因此需要对系统间服务调用进行管理,清晰地看到各系统调用关系,对系统间调用进行监控等。 API网关可以解决这些问题,我们可以认为如果没有大规模的实施微服务架构,那么对企业来说微服务网关就是企业的API服务管理平台。
网关设计
开放API接口
对于OpenAPI使用的API网关来说,一般合作伙伴要以应用的形式接入到OpenAPI平台,合作伙伴需要到 OpenAPI平台申请应用。 因此在OpenAPI网关之外,需要有一个面向合作伙伴的使用的平台用于合作伙伴,这就要求OpenAPI网关需要提供API给这个用户平台进行访问。 如下架构:
[外链图片转存失败(img-GITtQ11T-1569335070127)(images/1569308519330.png)]
当然如果是在简单的场景下,可能并不需要提供一个面向合作伙伴的门户,只需要由公司的运营人员直接添加合作伙伴应用id/密钥等,这种情况下也就不需要合作伙伴门户子系统。
内网API接口
对于内网的API网关,在起到的作用上来说可以认为是微服务网关,也可以认为是内网的API服务治理平台。 当企业将所有的应用使用微服务的架构管理起来,那么API网关就起到了微服务网关的作用。 而当企业只是将系统与系统之间的调用使用rest api的方式进行访问时使用API网关对调用进行管理,那么API网关起到的就是API服务治理的作用。 架构参考如下:
[外链图片转存失败(img-65Z9qIwn-1569335070128)(images/1569308574872.png)]
对于公司内部公网应用(如APP、公司的网站),如果管理上比较细致,在架构上是可能由独立的API网关来处理这部分内部公网应用,如果想比较简单的处理,也可以是使用面向合作伙伴的API网关。 如果使用独立的API网关,有以下的好处:
面向合作伙伴和面向公司主体业务的优先级不一样,不同的API网关可以做到业务影响的隔离。
内部API使用的管理流程和面向合作伙伴的管理流程可能不一样。
内部的API在功能扩展等方面的需求一般会大于OpenAPI对于功能的要求。
基于以上的分析,如果公司有能力,那么还是建议分开使用合作伙伴OPEN API网关和内部公网应用网关。
网关框架
Kong kong是基于Nginx+Lua进行二次开发的方案, https://konghq.com/
Netflix Zuul,zuul是spring cloud的一个推荐组件,https://github.com/Netflix/zuul
orange,这个开源程序是国人开发的, http://orange.sumory.com/
使用Zuul实现反向代理
[外链图片转存失败(img-dY04921S-1569335070128)(images/1569308813003.png)]
-
创建项目
springcloud-zuul-gateway
-
添加Maven依赖信息
<parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.0.1.RELEASE</version> </parent> <!-- 管理依赖 --> <dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-dependencies</artifactId> <version>Finchley.M7</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-zuul</artifactId> </dependency> <!-- SpringBoot整合eureka客户端 --> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId> </dependency> </dependencies> <!-- 注意: 这里必须要添加, 否者各种依赖有问题 --> <repositories> <repository> <id>spring-milestones</id> <name>Spring Milestones</name> <url>https://repo.spring.io/libs-milestone</url> <snapshots> <enabled>false</enabled> </snapshots> </repository> </repositories>
-
创建
application.yml
###注册中心地址 eureka: client: serviceUrl: defaultZone: http://localhost:8100/eureka/ ### 网关端口号 server: port: 80 ###网关名称 spring: application: name: service-zuul ### 配置网关反向代理 zuul: routes: ### 定义转发服务规则+ api-a: ### 当客户端输入以 /api-member/访问转发到会员服务 path: /api-member/** ### 服务别名 zuul网关默认整合Ribbon 自动实现负载均衡轮询效果 serviceId: app-itmayiedu-member api-b: ### 当客户端输入以 /api-order/访问转发到订单服务 path: /api-order/** serviceId: app-itmayiedu-order
-
创建SpringBoot启动类
package com.itmayiedu; 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; // @EnableZuulProxy 表示开启网关代理 @SpringBootApplication @EnableEurekaClient @EnableZuulProxy public class AppGateWay { public static void main(String[] args) { SpringApplication.run(AppGateWay.class, args); } }
-
先启动 Eureka注册中心 -> 启动网关服务 -> 启动会员服务 -> 启动订单服务
-
最终效果如下
[外链图片转存失败(img-pZWz3tsi-1569335070128)(images/1569309053559.png)]
- 会员服务真实地址 http://localhost:8002/
[外链图片转存失败(img-1zvqMYWu-1569335070128)(images/1569309082849.png)]
- 会员服务通过网关访问地址http://localhost:80/api-member/
[外链图片转存失败(img-NiQC13Nl-1569335070129)(images/1569309068999.png)]
- 订单服务真实地址 http://localhost:8001/
[外链图片转存失败(img-i11N1Qds-1569335070129)(images/1569309100188.png)]
- 订单服务通过网关访问地址 http://localhost:80/api-order/
[外链图片转存失败(img-pwPoyqmW-1569335070129)(images/1569309110861.png)]
- 会员服务真实地址 http://localhost:8002/
使用Zuul过滤器
案例:使用过滤器验证客户端是否有登陆。
package com.itmayiedu.filter;
import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;
import com.netflix.zuul.exception.ZuulException;
import org.apache.commons.lang.StringUtils;
import org.springframework.stereotype.Component;
import javax.servlet.http.HttpServletRequest;
@Component
public class TokenFilter extends ZuulFilter {
// 过滤类型 pre 表示在请求之前进行执行
@Override
public String filterType() {
return "pre";
}
// 过滤器的执行顺序。当请求在一个阶段的时候存在多个过滤器时,需要根据该方法的返回值依次执行
@Override
public int filterOrder() {
return 0;
}
// 判断过滤器是否生效
@Override
public boolean shouldFilter() {
return true;
}
// 编写过滤器拦截业务逻辑代码
@Override
public Object run() throws ZuulException {
// 案例: 拦截所有的服务器接口, 判断服务接口上是否有传递 userToken参数
// 1. 获取上下文
RequestContext currentContext = RequestContext.getCurrentContext();
// 2. 获取 request 对象
HttpServletRequest request = currentContext.getRequest();
// 3. 获取 token 的时候 一般从请求头中获取
String token = request.getParameter("userToken");
if (StringUtils.isEmpty(token)) {
// 返回错误提示
// 表示不会继续去执行 不放行 不会去调用服务接口 网关服务直接响应给客户端
currentContext.setSendZuulResponse(false);
currentContext.setResponseBody("userToken is null");
currentContext.setResponseStatusCode(401);
return null;
}
// 正常调用其他服务接口
return null;
}
}
重启网关服务 访问网关服务 不传递userToken 会提示相应的错误信息 传递userToken信息会正常得到相应服务返回值
[外链图片转存失败(img-VVwhgkfp-1569335070129)(images/1569313943701.png)]
[外链图片转存失败(img-lCvGneXk-1569335070130)(images/1569313955219.png)]
使用Zuul整合Ribbon
Zuul 默认开启了 Ribbon本地负载均衡功能。
动态网关实现
传统方式将路由规则配置在配置文件中,如果路由规则发生了改变,需要重启服务器。这时候我们结合上节课内容整合SpringCloud Config分布式配置中心,实现动态路由规则。
- 在git上创建一个文件service-zuul-dev.yml
### 配置网关反向代理
zuul:
routes:
api-a:
### 以 /api-member/访问转发到会员服务
path: /api-member/**
serviceId: app-itmayiedu-member
api-b:
### 以 /api-order/访问转发到订单服务
path: /api-order/**
serviceId: app-itmayiedu-order
-
添加Maven依赖信息(新增监控中心依赖信息)
<!-- actuator监控中心 --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency> <!-- springcloud config 2.0 --> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-config-client</artifactId> </dependency>
-
配置 application.yml (网关中的yml)
###注册中心地址 eureka: client: serviceUrl: defaultZone: http://localhost:8100/eureka/ ### 网关端口号 server: port: 80 ###网关名称 spring: application: name: service-zuul cloud: config: ####读取版本环境 profile: dev ####读取config-server注册地址 discovery: service-id: config-server ### 开启读取权限 enabled: true ### 配置网关反向代理 #zuul: # routes: # ### 定义转发服务规则+ # api-a: # ### 以 /api-member/访问转发到会员服务 # path: /api-member/** # ### 服务别名 zuul网关默认整合Ribbon 自动实现负载均衡轮询效果 # serviceId: app-itmayiedu-member # api-b: # ### 以 /api-order/访问转发到订单服务 # path: /api-order/** # serviceId: app-itmayiedu-order ###开启所有监控中心接口 management: endpoints: web: exposure: include: "*"
-
启动类中添加
package com.itmayiedu; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.cloud.context.config.annotation.RefreshScope; import org.springframework.cloud.netflix.eureka.EnableEurekaClient; import org.springframework.cloud.netflix.zuul.EnableZuulProxy; import org.springframework.cloud.netflix.zuul.filters.ZuulProperties; // @EnableZuulProxy 表示开启网关代理 @SpringBootApplication @EnableEurekaClient @EnableZuulProxy public class AppGateWay { public static void main(String[] args) { SpringApplication.run(AppGateWay.class, args); } // zuul配置能够使用config实现实时更新 @RefreshScope @ConfigurationProperties("zuul") public ZuulProperties zuulProperties() { return new ZuulProperties(); } }
- 启动顺序 启动Eureka监控中心 → 启动Springcloud Config server端 → 启动网关 → 启动会员服务 → 启动订单服务
- 测试根据网关路径访问 调用会员接口是否正常
- 修改gitee上的配置文件 调用下面手动刷新接口 接入新服务 不重启项目 看是否能读取新的配置文件(即网关转发路径)
手动刷新接口
http://127.0.0.1/actuator/refresh