Zuul 簡介

Zuul 的主要功能是路由轉發和過濾器。路由功能是微服務的一部分，比如 /api/admin 轉發到到 Admin 服務，/api/member 轉發到到 Member 服務。Zuul 預設和 Ribbon 結合實現了負載均衡的功能。

引入依賴

在 pom.xml 中主要新增 spring-cloud-starter-netflix-eureka-server 和 spring-cloud-starter-netflix-zuul 依賴

<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>

相關配置

在 application.yml 中主要新增 Zuul 路由配置

zuul:
 routes:
  api-a:
   path: /api/ribbon/**
   serviceId: hello-spring-cloud-web-admin-ribbon
  api-b:
   path: /api/feign/**
   serviceId: hello-spring-cloud-web-admin-feign

路由說明：

以 /api/ribbon 開頭的請求都轉發給 spring-cloud-web-admin-ribbon 服務
以 /api/feign 開頭的請求都轉發給 spring-cloud-web-admin-feign 服務

@SpringBootApplication
@EnableEurekaClient
@EnableZuulProxy
public class ZuulApplication {
  public static void main(String[] args) {
    SpringApplication.run(ZuulApplication.class,args);
  }
}

配置閘道器路由失敗時的回撥

建立 WebAdminFeignFallbackProvider 回撥類

/**
 * 路由 hello-spring-cloud-web-admin-feign 失敗時的回撥
 */
@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;
      }
    };
  }
}

測試路由訪問

依次執行 EurekaApplication > ServiceAdminApplication > WebAdminRibbonApplication > WebAdminFeignApplication > ZuulApplication 各服務

訪問：http://localhost:8769/api/ribbon/hi?message=zuul

瀏覽器顯示

port : 8763，message : zuul

訪問：http://localhost:8769/api/feign/hi?message=zuul

瀏覽器顯示

port : 8763，message : zuul

至此說明 Zuul 的路由功能配置成功。

使用 Zuul 的服務過濾功能

Zuul 不僅僅只是路由，還有很多強大的功能。比如用在安全驗證方面。

建立服務過濾器

/**
 * Zuul 的服務過濾演示
 */
@Component
public class LoginFilter extends ZuulFilter {

  private static final Logger logger = LoggerFactory.getLogger(LoginFilter.class);

  /**
   * 配置過濾型別，有四種不同生命週期的過濾器型別
   * 1. pre：路由之前
   * 2. routing：路由之時
   * 3. post：路由之後
   * 4. error：傳送錯誤呼叫
   * @return
   */
  @Override
  public String filterType() {
    return "pre";
  }

  /**
   * 配置過濾的順序
   * @return
   */
  @Override
  public int filterOrder() {
    return 0;
  }

  /**
   * 配置是否需要過濾：true/需要，false/不需要
   * @return
   */
  @Override
  public boolean shouldFilter() {
    return true;
  }

  /**
   * 過濾器的具體業務程式碼
   * @return
   * @throws ZuulException
   */
  @Override
  public Object run() throws ZuulException {
    RequestContext context = RequestContext.getCurrentContext();
    HttpServletRequest request = context.getRequest();
    String token = request.getParameter("token");
    if (token == null) {
      logger.warn("Token is empty");
      context.setSendZuulResponse(false);
      context.setResponseStatusCode(401);
      try {
        context.getResponse().getWriter().write("Token is empty");
      } catch (IOException e) {
      }
    } else {
      logger.info("OK");
    }
    return null;
  }
}

測試過濾器

訪問：http://localhost:8769/api/feign/hi?message=zuul

網頁顯示

Token is empty

訪問：http://localhost:8769/api/feign/hi?message=zuul&token=1

網頁顯示

port : 8763，message : zuul

以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支援我們。