文章目录
简介
Zuul在SpringCloud微服务架构中扮演服务网关的角色，对外部应用访问后端服务进行路由和过滤，服务网关(API网关)的作用的示意图如下：
本文介绍搭建一个Zuul服务网关具体步骤。
Zuul服务搭建
我们一共需要创建两个Spring应用，一个用于提供Zuul API网关服务，一个用来作为后端服务真正处理API网关转发过来的请求。
后端服务book搭建
创建一个web应用
利用Spring Initializr初始化我们的应用，在这里book服务只要是一个普通的Web服务就可以了，所以添加一个Spring Web依赖即可：
将得到的压缩包解压后导入到idea中。
主程序
主程序可以参考：
package com.example.zuulbackendservicebook;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@SpringBootApplication
public class ZuulBackendServiceBookApplication {
@RequestMapping(value = "/available")
public String available() {
return "Spring in Action";
}
@RequestMapping(value = "/checked-out")
public String checkedOut() {
return "Spring Boot in Action";
}
public static void main(String[] args) {
SpringApplication.run(ZuulBackendServiceBookApplication.class, args);
}
}
配置application.properties
spring.application.name=book
server.port=8090
完成以上配置以后就可以把该服务启动起来了。
访问book服务
打开浏览器，输入地址http://localhost:8090/available,出现以下界面则表示服务运行成功：
Zuul服务搭建
创建应用
利用Spring Initializr初始化我们的应用，我们需要添加两个依赖Spring Web和Zuul，如下：
将得到的压缩包解压后导入到idea中。
添加一个pre过滤器
Filter是Zuul的核心，用来实现对外服务的控制。Filter的生命周期有4个，分别是“PRE”、“ROUTING”、“POST”、“ERROR”，整个生命周期可以用下图来表示:
其中PRE过滤器在请求被路由之前调用。我们可利用这种过滤器实现身份验证、在集群中选择请求的微服务、记录调试信息等。
以下实现一个pre过滤器：
package com.example.zuul.filters.pre;
import javax.servlet.http.HttpServletRequest;
import com.netflix.zuul.context.RequestContext;
import com.netflix.zuul.ZuulFilter;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class SimpleFilter extends ZuulFilter {
private static Logger log = LoggerFactory.getLogger(SimpleFilter.class);
@Override
public String filterType() {
return "pre";
}
@Override
public int filterOrder() {
return 1;
}
@Override
public boolean shouldFilter() {
return true;
}
@Override
public Object run() {
RequestContext ctx = RequestContext.getCurrentContext();
HttpServletRequest request = ctx.getRequest();
log.info(String.format("%s request to %s", request.getMethod(), request.getRequestURL().toString()));
return null;
}
}
Filter过滤器实现4个方法：
- filterType()：返回一个字符串表示该过滤器的类型
- filterOrder()：指定该过滤器相对于其它过滤器的执行顺序
- shouldFilter()：包含判断该过滤器是否应该执行的逻辑，在本例中直接返回true，表示该过滤器一定会执行
- run(): 包含该过滤器的功能
Zuul 过滤器把请求和状态信息存储在RequestContext中。
主程序
主程序参考以下代码：
package com.example.zuul;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.zuul.EnableZuulProxy;
import org.springframework.context.annotation.Bean;
@EnableZuulProxy
@SpringBootApplication
public class ZuulApplication {
public static void main(String[] args) {
SpringApplication.run(ZuulApplication.class, args);
}
@Bean
public SimpleFilter simpleFilter() {
return new SimpleFilter();
}
}
配置application.properties
zuul.routes.books.url=http://localhost:8090
ribbon.eureka.enabled=false
server.port=8081
zuul.routes.books.url: zuul会将/books的请求代理到http://localhost:8090，即我们的后端服务- ribbon.eureka.enabled：Spring Netflix Zuul会使用Netflix的Ribbon来进行client-side的负载均衡，默认情况下，Ribbon会使用Netflix Eureka来进行服务注册，在这个简单的示例中，我们可以跳过服务注册，把它设为false。由于Ribbon不能使用Eureka来找到相应的服务，所以我们需要显式指定book服务的url。
完成以上配置以后就可以把Zunl服务启动起来了。
通过Zuul服务网关访问book服务
打开浏览器，输入地址http://localhost:8081/books/available:
从输出可以看到，我们访问的是Zuul服务网关，但结果却是后端服务book的输出，表明请求已经成功被转发到后端服务中。
参考资料
https://spring.io/guides/gs/routing-and-filtering/