# spring-cloud-zuul ## 目录
一、zuul简介
    1.1 API 网关
    1.2 zuul
二、项目结构
三、构建api 网关 zuul
        3.1 引入依赖
        3.2 在启动类上添加注解@EnableZuulProxy和@EnableDiscoveryClient
        3.3 指定注册中心、配置网关的路由规则
        3.4 启动eureka、producer、consumer、zuul服务，访问 localhost:8090/consumer/sell/product
四、错误熔断
        4.1 zuul 默认整合了 hystrix ，不用导入其他额外依赖
        4.2 创建 CustomZuulFallbackProvider并实现FallbackProvider 接口，同时用@Component声明为spring 组件，即可实现熔断时候的回退服务
五、zuul 过滤器
六、负载均衡
        zuul 默认集成了ribbon 实现了负载均衡。只要启动多个实例即可查看到负载均衡的效果。
        这里我们直接在idea 中启动多个实例来测试：
        负载均衡测试结果：
七、附：关于版本问题可能导致的 zuul 启动失败
## 正文
## 一、zuul简介 ### 1.1 API 网关 api 网关是整个微服务系统的门面，所有的外部访问需要通过网关进行调度和过滤。它实现了请求转发、负载均衡、校验过滤、错误熔断、服务聚合等功能。 下图是直观的显示api Gateway 在微服务网关中的作用（图片引用自spring boot 官网）。
### 1.2 zuul spring cloud 中提供了基础Net flix Zuul 实现的网关组件，这就是Zuul,它除了实现负载均衡、错误熔断、路由转发等功能，还能与spring 其他组件无缝配合使用。 ## 二、项目结构 [spring-cloud-feign](https://github.com/heibaiying/spring-samples-for-all/tree/master/spring-cloud/spring-cloud-feign)用例已经实现通过feign实现服务间的调用，且提供了两个业务服务单元(consumer、producer)，可以方便直观的测试zuul的路由、负载均衡、和错误熔断等功能，所以本用例在其基础上进行zuul的整合。 + common: 公共的接口和实体类； + consumer: 服务的消费者，采用feign调用产品服务； + producer：服务的提供者； + eureka: 注册中心； + zuul: api网关。 聚合项目目录如下：
zuul 项目目录如下：
## 三、构建api 网关 zuul #### 3.1 引入依赖 主要的依赖是 spring-cloud-starter-netflix-zuul ```xml 4.0.0 org.springframework.boot spring-boot-starter-parent 2.0.8.RELEASE zuul 1.8 Finchley.SR2 org.springframework.boot spring-boot-starter-web org.springframework.boot spring-boot-starter-freemarker org.springframework.boot spring-boot-starter-test test org.springframework.cloud spring-cloud-starter-netflix-eureka-client org.springframework.cloud spring-cloud-starter-netflix-zuul org.springframework.boot spring-boot-maven-plugin org.springframework.cloud spring-cloud-dependencies ${spring-cloud.version} pom import ``` #### 3.2 在启动类上添加注解@EnableZuulProxy和@EnableDiscoveryClient @EnableZuulProxy会自动设置Zuul服务器端点并在其中开启一些反向代理过滤器，以便将请求转发到后端服务器。 ```java @SpringBootApplication @EnableZuulProxy @EnableDiscoveryClient public class ZuulApplication { public static void main(String[] args) { SpringApplication.run(ZuulApplication.class, args); } } ``` #### 3.3 指定注册中心、配置网关的路由规则 zuul 需要指定注册中心的地址，zuul 会从eureka获取其他微服务的实例信息，然后按照指定的路由规则进行请求转发。 ```yaml server: port: 8090 # 指定服务命名 spring: application: name: zuul # 指定注册中心地址 eureka: client: serviceUrl: defaultZone: http://localhost:8010/eureka/ # 网关的路由 zuul: routes: xxxx: #这个地方的值是可以任意的字符串 path: /producer/** serviceId: producer consumer: path: /consumer/** serviceId: consumer ``` #### 3.4 启动eureka、producer、consumer、zuul服务，访问 localhost:8090/consumer/sell/product
## 四、错误熔断 #### 4.1 zuul 默认整合了 hystrix ，不用导入其他额外依赖
#### 4.2 创建 CustomZuulFallbackProvider并实现FallbackProvider 接口，同时用@Component声明为spring 组件，即可实现熔断时候的回退服务 ```java /** * @author : heibaiying * @description : zuul 的熔断器 */ @Component public class CustomZuulFallbackProvider implements FallbackProvider { /* * 定义熔断将用于哪些路由的服务 */ @Override public String getRoute() { return "consumer"; } @Override public ClientHttpResponse fallbackResponse(String route, Throwable cause) { return new ClientHttpResponse() { /** * 返回响应的HTTP状态代码 */ @Override public HttpStatus getStatusCode() throws IOException { return HttpStatus.SERVICE_UNAVAILABLE; } /** * 返回HTTP状态代码 */ @Override public int getRawStatusCode() throws IOException { return HttpStatus.SERVICE_UNAVAILABLE.value(); } /** * 返回响应的HTTP状态文本 */ @Override public String getStatusText() throws IOException { return HttpStatus.SERVICE_UNAVAILABLE.getReasonPhrase(); } @Override public void close() { } /** * 将消息正文作为输入流返回 */ @Override public InputStream getBody() throws IOException { return new ByteArrayInputStream("商城崩溃了,请稍后重试！".getBytes()); } /** * 将消息正文作为输入流返回 */ @Override public HttpHeaders getHeaders() { HttpHeaders httpHeaders = new HttpHeaders(); httpHeaders.setContentType(MediaType.APPLICATION_JSON_UTF8); return httpHeaders; } }; } } ``` 正确返回了内容、同时返回的http状态码也和我们设置的一样。
## 五、zuul 过滤器 创建自定义过滤器继承自CustomZuulFilter，当我们访问网关的时候，如果判断session 中没有对应的 code,则跳转到我们自定义的登录页面。 ```java /** * @author : heibaiying * @description : 自定义filter过滤器 */ @Component public class CustomZuulFilter extends ZuulFilter { /** * 返回过滤器的类型 */ @Override public String filterType() { return FilterConstants.PRE_TYPE; } /** * 返回过滤器的优先级顺序 */ @Override public int filterOrder() { return 0; } /** * 从此方法返回“true”意味着应该调用下面的 run（）方法 */ @Override public boolean shouldFilter() { return true; } /** * ZuulFilter的核心校验方法 */ @Override public Object run() throws ZuulException { RequestContext currentContext = RequestContext.getCurrentContext(); HttpServletRequest request = currentContext.getRequest(); String code = (String)request.getSession().getAttribute("code"); if (StringUtils.isEmpty(code)){ // 设置值为false 不将请求转发到对应的服务上 currentContext.setSendZuulResponse(false); // 设置返回的状态码 currentContext.setResponseStatusCode(HttpStatus.NON_AUTHORITATIVE_INFORMATION.value()); HttpServletResponse response = currentContext.getResponse(); try { // 跳转到登录页面 response.sendRedirect("/index"); } catch (IOException e) { e.printStackTrace(); } } return null; } } ``` index.ftl: ```html Title
``` ## 六、负载均衡 #### zuul 默认集成了ribbon 实现了负载均衡。只要启动多个实例即可查看到负载均衡的效果。
#### 这里我们直接在idea 中启动多个实例来测试：
#### 负载均衡测试结果：
## 七、附：关于版本问题可能导致的 zuul 启动失败 如果出现以下错误导致启动失败，是 spring boot 版本不兼容导致的错误，Finchley SR2版本 spring cloud 中的 zuul 和 spring boot 2.1.x 版本存在不兼容。如果出现这个问题，则将 spring boot 将至 2.0.x 的版本即可，用例中采用的是 2.0.8 版本。在实际的开发中应该严格遵循spring 官方的版本依赖说明。 ```java APPLICATION FAILED TO START --- Description: The bean 'counterFactory', defined in class path resource [org/springframework/cloud/netflix/zuul/ZuulServerAutoConfiguration$ZuulCounterFactoryConfiguration.class], could not be registered. A bean with that name has already been defined in class path resource [org/springframework/cloud/netflix/zuul/ZuulServerAutoConfiguration$ZuulMetricsConfiguration.class] and overriding is disabled. Action: Consider renaming one of the beans or enabling overriding by setting spring.main.allow-bean-definition-overriding=true ``` **spring cloud 版本说明**： | Release Train | Boot Version | | ------------- | ------------ | | Greenwich | 2.1.x | | Finchley | 2.0.x | | Edgware | 1.5.x | | Dalston | 1.5.x | 更多组件的版本说明可以在[spring cloud overview](https://spring.io/projects/spring-cloud#overview) 页面查看。