SpringCloud（七）API网关–Zuul
服务网关Zuul
Zuul主要功能是路由转发和过滤器，为API服务提供网关功能，你可以理解为他是一个nginx（路由转发）+lua（自定义代码实现过滤器）的java实现。它可以用来提供动态路由、监控、授权、安全、调度等等的边缘服务(edge service)，Zuul默认和ribbon实现的负载均衡的功能，Zuul基于groovy语言可以实现动态编译。
路由配置
1. 配置文件中配置
配置/api-a-url请求都转发至localhost:8080(ribbon+restTempalte) /api-b-url/请求都转发至localhost:8081(feign)
zuul.routes.api-a-url.path=/api-a-url/**
zuul.routes.api-a-url.url=http://localhost:8080/
zuul.routes.api-b-url.path=/api-b-url/**
zuul.routes.api-b-url.url=http://localhost:8081/
此种方式相当于在配置文件中写死了配置，无法扩展。所以引出了配置2
2. 基于服务中心的服务映射（serviceId）
eureka中已经有我们的配置信息，那我们可以借助他来完成地址映射。
zuul.routes.api-a.path=/api-a/**
#ribbon+restTempalte的实现方式
zuul.routes.api-a.serviceId= eureka-consumer
zuul.routes.api-b.path=/api-b/**
#feign实现方式的消费者
zuul.routes.api-b.serviceId= eureka-consumer-feign
eureka.client.serviceUrl.defaultZone=http://localhost:8761/eureka/
过滤器
过滤机制
zuul把Request route到 用户处理逻辑 的过程中，这些filter参与一些过滤处理，比如
- 验证与安全保障: 识别面向各类资源的验证要求并拒绝那些与要求不符的请求。
- 审查与监控: 在边缘位置追踪有意义数据及统计结果，从而为我们带来准确的生产状态结论。
- 动态路由: 以动态方式根据需要将请求路由至不同后端集群处。
- 压力测试: 逐渐增加指向集群的负载流量，从而计算性能水平。
- 负载分配: 为每一种负载类型分配对应容量，并弃用超出限定值的请求。
- 静态响应处理: 在边缘位置直接建立部分响应，从而避免其流入内部集群。
- 多区域弹性: 跨越AWS区域进行请求路由，旨在实现ELB使用多样化并保证边缘位置与使用者尽可能接近。
生命周期
过滤器的声明周期，和类似aop。
Simple
在http://start.spring.io/中，输入eureka discovery与zuul快速生成zuul服务网关项目。
添加@EnableDiscoveryClient注解与@EnableZuulProxy，启动springboot项目(此项目与其他Restful风格的springboot项目一致,只需要添加@EnableDiscoveryClien即可注册至服务中心)
声明@ EnableZuulProxy，启用zuul路由之后基于服务中心的serviceId配置路由，编写filter进行具体过滤的操作。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
<?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.hanson</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.SR2</spring-cloud.version> </properties> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-eureka</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> |
conf
|
1 2 3 4 5 6 7 8 9 10 |
spring.application.name=eureka-zuul server.port=8200 eureka.client.serviceUrl.defaultZone=http://localhost:8761/eureka/ #zuul路由配置 #所有的api-a请求转发至eureka上的eureka-consumer服务 zuul.routes.api-a.path=/api-a/** zuul.routes.api-a.serviceId=eureka-consumer #所有的api-b请求转发至eureka上的eureka-consumer-feign服务 zuul.routes.api-b.path=/api-b/** zuul.routes.api-b.serviceId=eureka-consumer-feign |
code
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
package com.hanson.zuul; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.cloud.client.discovery.EnableDiscoveryClient; import org.springframework.cloud.netflix.zuul.EnableZuulProxy; //开启zuul @EnableZuulProxy @EnableDiscoveryClient @SpringBootApplication public class ZuulApplication { public static void main(String[] args) { SpringApplication.run(ZuulApplication.class, args); } } |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
package com.hanson.zuul; import javax.servlet.http.HttpServletRequest; import org.springframework.stereotype.Component; import com.netflix.zuul.ZuulFilter; import com.netflix.zuul.context.RequestContext; @Component public class TokenCheckFilter extends ZuulFilter{ /* *run：过滤器的具体逻辑。需要注意，这里我们通过ctx.setSendZuulResponse(false)令zuul过滤该请求， * 不对其进行路由，然后通过ctx.setResponseStatusCode(401)设置了其返回的错误码， * 当然我们也可以进一步优化我们的返回，比如，通过ctx.setResponseBody(body)对返回body内容进行编辑等。 */ @Override public Object run() { RequestContext ctx = RequestContext.getCurrentContext(); HttpServletRequest request = ctx.getRequest(); Object accessToken = request.getParameter("token"); //定义规则：访问url中必须带有token参数 if(accessToken == null) { ctx.setSendZuulResponse(false); ctx.setResponseStatusCode(401); try { ctx.getResponse().getWriter().write(String.format("method:%s,url:%s,error:%s", request.getMethod(),request.getRequestURL(),"token is empty")); }catch (Exception e){} return null; } return null; } /** * shouldFilter：返回一个boolean类型来判断该过滤器是否要执行，所以通过此函数可实现过滤器的开关。 * 在上例中，我们直接返回true，所以该过滤器总是生效。 */ @Override public boolean shouldFilter() { return true; } /** * filterOrder：通过int值来定义过滤器的执行顺序 */ @Override public int filterOrder() { return 0; } /** * filterType： * 返回一个字符串代表过滤器的类型，在zuul中定义了四种不同生命周期的过滤器类型，具体如下： * pre：可以在请求被路由之前调用 * routing：在路由请求时候被调用 * post：在routing和error过滤器之后被调用 * error：处理请求时发生错误时被调用 */ @Override public String filterType() { //路由之前被调用 return "pre"; } } |
启动服务，访问eureka server，可以看到zuul服务已经在服务中心注册。
访问http://localhost:8200/api-a 可以看到浏览器提示token is empty说明zuul的拦截器已经生效。
添加token再次访问,基于以上配置，此时访问的是eureka-consumer服务（localhost:8080）
访问api-b http://localhost:8200/api-b?token=hanson ，此时访问的是eureka-consumer-feign服务(localhost:8081)，发现此时路由已经生效了。
发表评论