超简单的SpringClound入门教程(四.路由网关zuul)

一个微服务的项目架构是要有要的基础构件的,包括服务注册与发现、服务消费、负载均衡、断路器、智能路由、配置管理等;这样便能构件出一个简单的微服务项目;

整理出一个简单的微服务架构图;

大家可以看在图中Zuul就充当着路由转发的角色

不止如此,Zuul还具备很多功能:

Authentication / Insights / Stress Testing / Canary Testing / Dynamic Routing / Service Migration   / Load Shedding  /Security   / Static Response handling  / Active / Active traffic management等;

一.项目准备;

我们继续沿用上一篇文章的工程;在此基础上我们创建一个新的Model;

二.创建service-zuuul

同样的,创建一个SpringBoot项目的Model;命名service-zuul;

pomy依赖如下;

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

   <groupId>com.example</groupId>
   <artifactId>demo</artifactId>
   <version>0.0.1-SNAPSHOT</version>
   <packaging>jar</packaging>

   <name>demo</name>
   <description>Demo project for Spring Boot</description>

   <parent>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-parent</artifactId>
      <version>1.5.2.RELEASE</version>
      <relativePath/> <!-- lookup parent from repository -->
   </parent>

   <properties>
      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
      <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
      <java.version>1.8</java.version>
   </properties>

   <dependencies>
      <dependency>
         <groupId>org.springframework.cloud</groupId>
         <artifactId>spring-cloud-starter-eureka</artifactId>
      </dependency>
      <dependency>
         <groupId>org.springframework.cloud</groupId>
         <artifactId>spring-cloud-starter-zuul</artifactId>
      </dependency>
      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-web</artifactId>
      </dependency>

      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-test</artifactId>
         <scope>test</scope>
      </dependency>
   </dependencies>

   <dependencyManagement>
      <dependencies>
         <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>Dalston.RC1</version>
            <type>pom</type>
            <scope>import</scope>
         </dependency>
      </dependencies>
   </dependencyManagement>

   <build>
      <plugins>
         <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
         </plugin>
      </plugins>
   </build>

   <repositories>
      <repository>
         <id>spring-milestones</id>
         <name>Spring Milestones</name>
         <url>https://repo.spring.io/milestone</url>
         <snapshots>
            <enabled>false</enabled>
         </snapshots>
      </repository>
   </repositories>

</project>

properties配置文件如下;

#服务端口
server.port=8886

#注册服务中心地址
eureka.client.service-url.defaultZone=http://localhost:8880/eureka/

#注册服务端name
spring.application.name=service-zuul

#/api-a的服务调用ribbon
zuul.routes.api-a.path=/api-a/**
zuul.routes.api-a.serviceId= service-ribbon

#/api-b的服务调用feign
zuul.routes.api-b.path=/api-b/**
zuul.routes.api-b.serviceId= service-feign

我们在启动类上贴@EnableZuulProxy,表示开启Zuul功能;

@EnableZuulProxy          //开启zuul的功能：
@EnableEurekaClient
@SpringBootApplication
public class ZuulApplication {

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

这时候我们启动Eureka,service-hello(两个实例),service-ribbon,service-fegin,最后启动service-zuul;

我们访问 http://localhost:8886/api-a/hello  和  http://localhost:8886/api-b/hello

会看到如下结果:

这就说明了我们的zuul项目起到了路由作用,

三,Zuul的过滤功能;

下面我们来实践Zuul的过滤功能;通过其过滤功能我们可以做一些安全验证,数据加解密,登录验证等等需求;

我们只需自定义个类;并继承ZuulFilter即可;

代码如下:

/**
 * 用zuul做过滤
 */

@Component
public class MyFilter extends ZuulFilter {

    private static Logger log = LoggerFactory.getLogger(MyFilter.class);


    //filterType：返回一个字符串代表过滤器的类型
    @Override
    public String filterType() {
        return "pre";      //pre：路由之前   routing：路由之时  post： 路由之后  error：发送错误调用
    }

    //filterOrder：过滤的顺序
    @Override
    public int filterOrder() {
        return 0;
    }


    //这里可以写逻辑判断，是否要过滤，本文true,永远过滤
    @Override
    public boolean shouldFilter() {
        return true;
    }


    //过滤器的具体逻辑。可以查sql，nosql去判断该请求到底有没有权限访问。
    @Override
    public Object run() {
        RequestContext     ctx     = RequestContext.getCurrentContext();
        HttpServletRequest request = ctx.getRequest();
        log.info(String.format("%s >>> %s", request.getMethod(), request.getRequestURL().toString()));
        Object accessToken = request.getParameter("token");
        if(accessToken == null) {
            log.warn("token is empty");
            ctx.setSendZuulResponse(false);
            ctx.setResponseStatusCode(401);
            try {
                ctx.getResponse().getWriter().write("token is empty");
            }catch (Exception e){}

            return null;
        }
        log.info("ok");
        return null;
    }
}

此时我们重启service-zuul;访问连接   http://localhost:8886/api-a/hello

就会通过过滤功能验证,token为空,达到token的验证效果;

我们再带上token来访问; http://localhost:8886/api-a/hello?token=888

此时便通过验证,访问服务;

官方文档:

router_and_filter_zuul