本文以Zuul网关为例,以后会介绍另一个Spring Cloud推出的GateWay
Zuul简介
Zuul的主要功能是路由转发和过滤器,路由功能是微服务的一部分,比如/api/user转发到User服务,/api/shop转发的Shop服务,Zuul默认和Ribbon结合实现了负载均衡的功能。
创建路由网关
还是和其他服务一样 在父模块创建空文件夹创建Pom.xml文件(别忘记将此项目托管至maven)
pom.xml
<?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>
<parent>
<groupId>com.funtl</groupId>
<artifactId>hello-spring-cloud-dependencies</artifactId>
<version>1.0.0-SNAPSHOT</version>
<relativePath>../hello-spring-cloud-dependencies/pom.xml</relativePath>
</parent>
<artifactId>hello-spring-cloud-zuul</artifactId>
<packaging>jar</packaging>
<name>hello-spring-cloud-zuul</name>
<url>http://www.funtl.com</url>
<inceptionYear>2018-Now</inceptionYear>
<dependencies>
<!-- Spring Boot Begin -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<!-- Spring Boot End -->
<!-- Spring Cloud Begin -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-zuul</artifactId>
</dependency>
<!-- Spring Cloud End -->
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<mainClass>com.funtl.hello.spring.cloud.zuul.ZuulApplication</mainClass>
</configuration>
</plugin>
</plugins>
</build>
</project>
Application.class两个注解
@EnableZuulProxy //启动Zuul服务
@EnableEurekaClient //启动eureka客户端(被eureka发现)
package com.funtl.hello.spring.cloud.zuul;
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;
@EnableEurekaClient
@EnableZuulProxy
@SpringBootApplication
public class ZuulApplication {
public static void main(String[] args) {
SpringApplication.run(ZuulApplication.class,args);
}
}
application.yml
spring:
application:
name: hello-spring-cloud-zuul
server:
port: 8769 #zuul服务的端口
eureka:
client:
serviceUrl:
defaultZone: http://localhost:8761/eureka/
zuul:
routes: #路由
api-a:
path: /api/a/** #访问路径一 访问localhost:8769/api/a/hi是访问ribbon
serviceId: hello-spring-cloud-web-admin-ribbon #ribbon注册在eureka的服务名
api-b:
path: /api/b/** #访问路径二 访问localhost:8769/api/a/hi是访问feign
serviceId: hello-spring-cloud-web-admin-feign #feign注册在eureka的服务名
路由说明:
以/api/a开头的请求都转发给hello-spring-cloud-web-admin-ribbon
以/api/b开头的请求都转发给hello-spring-cloud-web-admin-feign
测试访问
依次运行EurekaApplication、ServiceAdminApplication、WebAdminFeignApplication、WebAdminRibbonApplication、ZuulApplication
打开浏览器访问 http://localhost:8769/api/a/hi?message=HelloZuul ,浏览器显示
Hi your message is : HelloZuul port :8762
打开浏览器访问 http://localhost:8769/api/b/hi?message=HelloZuul ,浏览器显示
Hi your message is : HelloZuul port :8762
至此说明Zuul的路由功能配置成功。
配置网关路由失败时的回调
创建一个自定义回调类(名字随便但要有意义) 需要实现 spring cloud 提供的 FallBackProvider类
package com.funtl.hello.spring.cloud.zuul.provider;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.cloud.netflix.zuul.filters.route.FallbackProvider;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.client.ClientHttpResponse;
import org.springframework.stereotype.Component;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.HashMap;
import java.util.Map;
@Component
public class WebAdminFeignFallbackProvider implements FallbackProvider {
@Override
public String getRoute() {
// ServiceId,如果需要所有调用都支持回退,则 return "*" 或 return null
return "hello-spring-cloud-web-admin-feign";
}
/**
* 如果请求服务失败,则返回指定的信息给调用者
* @param route
* @param cause
* @return
*/
@Override
public ClientHttpResponse fallbackResponse(String route, Throwable cause) {
return new ClientHttpResponse() {
/**
* 网关向 api 服务请求失败了,但是消费者客户端向网关发起的请求是成功的,
* 不应该把 api 的 404,500 等问题抛给客户端
* 网关和 api 服务集群对于客户端来说是黑盒
* @return
* @throws IOException
*/
@Override
public HttpStatus getStatusCode() throws IOException {
return HttpStatus.OK;
}
@Override
public int getRawStatusCode() throws IOException {
return HttpStatus.OK.value();
}
@Override
public String getStatusText() throws IOException {
return HttpStatus.OK.getReasonPhrase();
}
@Override
public void close() {
}
@Override
public InputStream getBody() throws IOException {
ObjectMapper objectMapper = new ObjectMapper();
Map<String, Object> map = new HashMap<>();
map.put("status", 200);
map.put("message", "无法连接,请检查您的网络");
return new ByteArrayInputStream(objectMapper.writeValueAsString(map).getBytes("UTF-8"));
}
@Override
public HttpHeaders getHeaders() {
HttpHeaders headers = new HttpHeaders();
// 和 getBody 中的内容编码一致
headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
return headers;
}
};
}
}
路由网关的服务过滤功能
Zuul不仅仅只是路由功能,还有很多强大的功能,网关的过滤功能可以用在很多地方,比如安全校验。
创建服务过滤器
继承ZuulFilter类并在类上增加@Component注解就可以使用服务过滤功能了,十分简单方便。
package com.funtl.hello.spring.cloud.zuul.filter;
import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;
import com.netflix.zuul.exception.ZuulException;
import org.springframework.stereotype.Component;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
@Component
public class LoginFilter extends ZuulFilter {
/**
* filterType 返回一个字符串代表过滤器的类型,在Zuul中定义了四种不同生命周期的过滤类型
* pre:路由之前
* routing:路由之时
* post:路由之后
* error:发送错误调用
*/
@Override
public String filterType() {
return "pre";
}
/**
* 过滤的顺序
*/
@Override
public int filterOrder() {
return 0;
}
/**
* 是否需要过滤
*/
@Override
public boolean shouldFilter() {
return true;
}
/**
* 过滤的具体业务代码
* @return
* @throws ZuulException
*/
@Override
public Object run() throws ZuulException {
RequestContext currentContext = RequestContext.getCurrentContext();
HttpServletRequest request = currentContext.getRequest();
String token = request.getParameter("token");
if (token == null){
currentContext.setSendZuulResponse(false);
currentContext.setResponseStatusCode(401);
try {
HttpServletResponse response = currentContext.getResponse();
response.setContentType("text/html;charset=utf-8");
currentContext.getResponse().getWriter().write("非法请求");
} catch (IOException e) {
e.printStackTrace();
}
}
return null;
}
}
测试服务过滤功能
重启Zuul服务,并在浏览器里访问 http://localhost:8769/api/b/hi?message=HelloSpring
出现下列显示:
在访问地址后加入token后,手动设置一个token用来测试
至此,一个简单的网关过滤功能已经实现。
关注我
觉得有点东西就点一下“赞和在看”吧!感谢大家的支持了!