Zuul API路由网关服务

最新推荐文章于 2023-06-12 19:16:57 发布

今日相乐，皆当喜欢

最新推荐文章于 2023-06-12 19:16:57 发布

阅读量214

点赞数

分类专栏：微服务框架文章标签： springcloud Zuul路由网关

本文链接：https://blog.csdn.net/weixin_42687829/article/details/105286220

版权

微服务框架专栏收录该内容

20 篇文章 0 订阅

订阅专栏

Zuul API路由网关服务简介

如上图，这里的API路由网关服务由Zuul实现，主要就是对外提供服务接口的时候，起到了请求的路由和过滤作用，也因此能够隐藏内部服务的接口细节，从而有利于保护系统的安全性

Zuul API路由网关服务的应用

新建一个microservice-zuul-3001模块，把zuul也注册到eureka服务里，端口为3001；先修改下hosts文件，专门为zuul搞个本地域名映射，在hosts文件里加下：

127.0.0.1  zuul.test.com

microservice-zuul-3001模块的pom依赖如下：

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>com.ue</groupId>
        <artifactId>microservice</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <artifactId>microservice-zuul-3001</artifactId>

    <dependencies>
        <dependency>
            <groupId>com.ue</groupId>
            <artifactId>microservice-common</artifactId>
            <version>${project.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- zuul路由网关 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-zuul</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka</artifactId>
        </dependency>
        <!-- actuator监控 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <!-- hystrix容错 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-hystrix</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-config</artifactId>
        </dependency>
        <!-- 修改后立即生效，热部署 -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>springloaded</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
        </dependency>
    </dependencies>

</project>

microservice-zuul-3001模块的application.yml配置如下：

server:
  port: 3001
  context-path: /
spring:
  application:
    name: microservice-zuul
eureka:
  instance:
    instance-id: microservice-zuul:3001
    prefer-ip-address: true
  client:
    service-url:
      defaultZone: http://eureka2001.test.com:2001/eureka/,http://eureka2002.test.com:2002/eureka/,http://eureka2003.test.com:2003/eureka/
info:
  groupId: com.ue.microservice
  artifactId: microservice-zuul-3001
  version: 1.0-SNAPSHOT
  contacts: Tom
  phone: 123456

在启动类加入@EnableZuulProxy注解：

package com.ue;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
import org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration;
import org.springframework.cloud.netflix.zuul.EnableZuulProxy;

@SpringBootApplication(exclude={DataSourceAutoConfiguration.class, HibernateJpaAutoConfiguration.class})
@EnableZuulProxy
public class MicroserviceZuul3001Application {

    public static void main(String[] args) {
        SpringApplication.run(MicroserviceZuul3001Application.class, args);
    }

}

然后启动一个eureka，再启动1006服务提供者，带feign的服务消费者以及zuul网关服务：

访问注册中心可以看到有两个服务：

通过消费者http://localhost/student/getInfo访问，能获取到数据；通过zuul网关http://zuul.test.com:3001/microservice-student/student/list（域名+端口+服务名称+请求地址），也能请求到数据：

但如果休眠的时间弄长一点，就会出现下面这种现象：

这种现象是由于接口响应时间超过了zuul网关默认的超时时间，解决方案如下：

关于使用zuul后的容错处理：Zuul作为服务网关为了保证自己不被服务拖垮，本身已经集成了Hystrix对路由转发进行隔离，为了方便开发人员对服务短路进行自定义处理，可使用以下两个接口来完成自定义的Hystrix Fallback：

ZuulFallbackProvider：Zuul提供了ZuulFallbackProvider接口，开发人员可以通过实现该接口来完成自定义Hystrix Fallback
FallbackProvider：SpringCloud Zuul提供了FallbackProvider替代了ZuulFallbackProvider接口

本篇博客通过实现ZuulFallbackProvider接口来进行解决，新建一个ZuulFallBack类：

package com.ue.fallback;

import org.springframework.cloud.netflix.zuul.filters.route.ZuulFallbackProvider;
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;

@Component
public class ZuulFallBack implements ZuulFallbackProvider {

    @Override
    public String getRoute() {
        return "*";
    }

    /**
     * 在给zuul整合回退功能时，只要类实现ZuulFallbackProvider接口，并且注册bean即可。
     * 不过需要注意的时，这个回退只有服务掉线或者超时的情况下才会触发（Camden.SR4版本测试是这样），
     * 如果服务程序出现异常，此回退程序是不能处理的，异常会直接返回给调用者，比如页面。
     *
     * @return
     */
    @Override
    public ClientHttpResponse fallbackResponse() {
        return new ClientHttpResponse() {
            @Override
            public HttpHeaders getHeaders() {
                HttpHeaders headers = new HttpHeaders();
                headers.setContentType(MediaType.APPLICATION_JSON_UTF8);//application/json;charset=UTF-8
                return headers;
            }

            @Override
            public InputStream getBody() throws IOException {
                String msg = "服务繁忙，请稍后.....";
                //new ByteArrayInputStream("{\"code\":-1,\"msg\":\"服务暂不可用\"}".getBytes(StandardCharsets.UTF_8))
                return new ByteArrayInputStream(msg.getBytes());
            }

            @Override
            public String getStatusText() throws IOException {
                return HttpStatus.BAD_REQUEST.getReasonPhrase();//400
            }

            @Override
            public HttpStatus getStatusCode() throws IOException {
                return HttpStatus.BAD_REQUEST;
            }

            @Override
            public int getRawStatusCode() throws IOException {
                return HttpStatus.BAD_REQUEST.value();//"Bad Request"
            }

            @Override
            public void close() {

            }
        };
    }
}

然后再进行测试，结果会返回友好提示：

如果要修改zuul网关的默认超时时间，可在yml里进行配置：

zuul:
  host:
    socket-timeout-millis: 60000
    connect-timeout-millis: 60000

feign:
  hystrix:
    enabled: true

hystrix:
  command:
    default:
      execution:
        timeout:
          enabled: true
        isolation:
          thread:
            timeoutInMilliseconds: 15000

ribbon:
  ReadTimeout: 6000
  ConnectTimeout: 6000
  MaxAutoRetries: 0
  MaxAutoRetriesNextServer: 1
  eureka:
    enabled: true

图解分布式服务

路由映射规则配置

上面是zuul的简单使用，接口地址很轻易的就暴露了服务提供者的唯一标识名microservice-student；有安全风险，所以需要将其隐藏，在yml文件中添加以下配置：

zuul:
  routes:
    studentServer.serviceId: microservice-student
    studentServer.path: /studentServer/**
  ignored-services: "*"
  prefix: /javajl

ignored-services的作用是将原来的服务提供者唯一标识名禁用

Prefix的作用是给服务加前缀

配置后的测试效果如下：

请求过滤配置

比如登录某个系统需要进行身份验证，即验证用户名密码啥的；当请求服务的时候，需要进行身份验证，也就是过滤非法请求，Zuul可通过ZuulFilter过滤器来实现非法请求的过滤；一般具体实现的话每次经过Zuul服务网关的时候都要对带来的token进行有效性验证，这里只是介绍如何使用，所以弄得比较简单

先定义一个AccessFilter类：

package com.ue.filter;

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;
import com.netflix.zuul.exception.ZuulException;
import org.apache.log4j.Logger;

import javax.servlet.http.HttpServletRequest;

/**
 * @Author LiJun
 * @Date 2020/04/02
 * @Time 11:27
 */
public class AccessFilter extends ZuulFilter {

    Logger logger = Logger.getLogger(AccessFilter.class);

    /**
     * 判断该过滤器是否要被执行
     */
    @Override
    public boolean shouldFilter() {
        return true;
    }

    /**
     * 过滤器的具体执行逻辑
     */
    @Override
    public Object run() throws ZuulException {
        RequestContext ctx = RequestContext.getCurrentContext();
        HttpServletRequest request = ctx.getRequest();
        String parameter = request.getParameter("accessToken");
        logger.info(request.getRequestURL().toString()+" 请求访问");
        if(parameter == null){
            logger.error("accessToken为空！");
            ctx.setSendZuulResponse(false);
            ctx.setResponseStatusCode(401);
            ctx.setResponseBody("{\"result\":\"accessToken is empty!\"}");
            return null;
        }
        //token判断逻辑
        logger.info(request.getRequestURL().toString()+" 请求成功");
        return null;
    }

    /**
     * 过滤器的类型 这里用pre，代表会再请求被路由之前执行
     */
    @Override
    public String filterType() {
        return "pre";
    }

    /**
     * 过滤器的执行顺序
     */
    @Override
    public int filterOrder() {
        return 0;
    }

}

然后再弄一个配置类开启Filter：

package com.ue.config;

import com.ue.filter.AccessFilter;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @Author LiJun
 * @Date 2020/04/02
 * @Time 11:27
 */
@Configuration
public class ZuulConfig {

    @Bean
    public AccessFilter accessFilter(){
        return new AccessFilter();
    }
}

然后用携带token跟不携带token进行测试：

今日相乐，皆当喜欢

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
Zuul API路由网关服务

Zuul API路由网关服务简介如上图，这里的API路由网关服务由Zuul实现，主要就是对外提供服务接口的时候，起到了请求的路由和过滤作用，也因此能够隐藏内部服务的接口细节，从而有利于保护系统的安全性Zuul API路由网关服务的应用新建一个microservice-zuul-3001模块，把zuul也注册到eureka服务里，端口为3001；先修改下hosts文件，专门为zuul...
复制链接

扫一扫