Zuul API路由网关服务

1. Zuul API路由网关服务简介

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

2. Zuul路由配置

2.1) 项目microservice-zuul-3001搭建

new -> Maven Module
    -> create a simple project
Module Name: microservice-zuul-3001
Parent Project:microservice
Working set:SpringCloud
    -> Artifact
Group Id:com.andrew.springcloud
Artifact Id: microservice-zuul-3001
Version:0.0.1-SNAPSHOT
Packaging:jar

2.2) 修改hosts文件增加zuul

C:\Windows\System32\drivers\etc打开hosts文件增加zuul
127.0.0.1  zuul.andrew.com

2.3) 项目microservice-zuul-3001的pom.xml增加zuul路由网关

<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.andrew.springcloud</groupId>
        <artifactId>microservice</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
    <artifactId>microservice-zuul-3001</artifactId>

    <dependencies>
        <dependency>
            <groupId>com.andrew.springcloud</groupId>
            <artifactId>microservice-common</artifactId>
            <version>${project.version}</version>
        </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>

2.4) 项目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 #显示IP
  client: 
    service-url: 
      defaultZone: http://eureka2001.andrew.com:2001/eureka/,http://eureka2002.andrew.com:2002/eureka/,http://eureka2003.andrew.com:2003/eureka/ # 集群

info: 
   groupId: $project.groupId$
   artifactId: $project.artifactId$
   version: $project.version$
   负责人: 王五
   联系电话: 110

2.5) 项目microservice-zuul-3001新建启动类ZuulApplication_3001.java

package com.andrew;

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 ZuulApplication_3001 {
    public static void main(String[] args) {
        SpringApplication.run(ZuulApplication_3001.class, args);
    }
}

启动microservice-eureka-server-2001
启动microservice-eureka-server-2002
启动microservice-eureka-server-2003
启动microservice-student-provider-1001
启动microservice-zuul-3001

获取数据的两种方式
(1)
http://localhost:1001/student/list
(2)
域名+端口+服务名称+请求地址
http://zuul.andrew.com:3001/microservice-student/student/list

[{"id":1,"name":"zhangsan","grade":"11"},{"id":2,"name":"lisi","grade":"12"},{"id":3,"name":"wangwu","grade":"13"},{"id":4,"name":"student04","grade":"14"},{"id":5,"name":null,"grade":null},{"id":6,"name":"student06","grade":"16"}]

3. Zuul路由映射规则配置

3.1) 配置映射规则，提高服务的安全性

zuul:
  routes:
    studentServer.serviceId: microservice-student
    studentServer.path: /studentServer/**
我们把microservice-student的服务名称映射成/studentServer/**这样就把服务地址影藏了
请求方式
http://zuul.andrew.com:3001/studentServer/student/list

3.2) 增加ignored-services: "microservice-student"屏蔽原来的访问方式

假如要忽略所有的服务名称的话，ignored-services: "*"
配置如下
zuul:
  ignored-services: "*"
  routes:
    studentServer.serviceId: microservice-student
    studentServer.path: /studentServer/**

3.3) 配置请求前缀，加下配置prefix: /andrew

3.4) 最终配置

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

http://zuul.andrew.com:3001/andrew/studentServer/student/list
[{"id":1,"name":"zhangsan","grade":"11"},{"id":2,"name":"lisi","grade":"12"},{"id":3,"name":"wangwu","grade":"13"},{"id":4,"name":"student04","grade":"14"},{"id":5,"name":null,"grade":null},{"id":6,"name":"student06","grade":"16"}]

http://zuul.andrew.com:3001/studentServer/student/list
http://zuul.andrew.com:3001/microservice-student/student/list
等都是404

4. Zuul请求过滤配置

4.1) 项目microservice-zuul-3001新建过滤器AccessFilter.java

package com.andrew.filter;

import javax.servlet.http.HttpServletRequest;

import org.apache.log4j.Logger;

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;
import com.netflix.zuul.exception.ZuulException;

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

4.2) 项目microservice-zuul-3001开启过滤器ZuulConfig.java

package com.andrew.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import com.andrew.filter.AccessFilter;

/**
 * Zuul配置
 */
@Configuration
public class ZuulConfig {
    @Bean
    public AccessFilter accessFilter() {
        return new AccessFilter();
    }
}

启动microservice-eureka-server-2001
启动microservice-eureka-server-2002
启动microservice-eureka-server-2003
启动microservice-student-provider-1001
启动microservice-zuul-3001

http://zuul.andrew.com:3001/andrew/studentServer/student/list
{"result":"accessToken is empty!"}

http://zuul.andrew.com:3001/andrew/studentServer/student/list?accessToken=3232
[{"id":1,"name":"zhangsan","grade":"11"},{"id":2,"name":"lisi","grade":"12"},{"id":3,"name":"wangwu","grade":"13"},{"id":4,"name":"student04","grade":"14"},{"id":5,"name":null,"grade":null},{"id":6,"name":"student06","grade":"16"}]