SpringCloud Zuul API网关服务模块

说明

SpringCloud Zuul基于Netflix Zuul实现，SpringCloud Zuul通过与SpringCloud Eureka整合，将自身注册为Eureka服务治理下的应用，同时从Eureka中获得了所有其他微服务实例信息。这样的设计非常巧妙地将服务治理体系中维护的实例信息利用起来， 使得将维护服务实例的工作交给了服务治理框架自动完成， 不再需要人工介入。 而对千路由规则的维护， Zuul默认会将通过以服务名作为ContextPath的方式来创建路由映射，大部分情况下， 这样的默认设置已经可以实现我们大部分的路由需求， 除了一些特殊情况（比 如兼容一些老的URL)还需要做一些特别的配置 。 但是相比于之前架构下的运维工作量， 通过引入SpringCloud Zuul实现API网关后， 已经能够大大减少了。

API网关：API网关是一个更为智能的应用服务器， 它的定义类似于面向对象设计模式中的Facade模式， 它的存在就像是整个微服务架构系统的门面一样，所有的外部客户端访问都需要经过它来进行调度和过滤。它除了要实现请求路由、 负载均衡、 校验过滤等功能之外， 还需要更多能力， 比如与服务治理框架的结合、 请求转发时的熔断机制、 服务的聚合等一系列高级功能。

目标

使用SpringCloud Zuul转发路由，并设置验证（JWT）

快速开始

首先给出项目结构（可以使用原来Ribbon的项目进行改造）

1 更新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>

	<groupId>yunlingfly</groupId>
	<artifactId>mavenspringcloudribbon</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>jar</packaging>

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

	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>1.5.10.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>
		<spring-cloud.version>Dalston.SR2</spring-cloud.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-ribbon</artifactId>
		</dependency>

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>

		<dependency>
			<groupId>org.springframework.cloud</groupId>
			<artifactId>spring-cloud-starter-eureka-server</artifactId>
		</dependency>

		<!-- 断路器 -->
		<dependency>
			<groupId>org.springframework.cloud</groupId>
			<artifactId>spring-cloud-starter-hystrix</artifactId>
		</dependency>

		<!-- 断路器仪表盘 -->
		<dependency>
			<groupId>org.springframework.cloud</groupId>
			<artifactId>spring-cloud-starter-hystrix-dashboard</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-test</artifactId>
			<scope>test</scope>
		</dependency>
	</dependencies>

	<dependencyManagement>
		<dependencies>
			<dependency>
				<groupId>org.springframework.cloud</groupId>
				<artifactId>spring-cloud-dependencies</artifactId>
				<version>${spring-cloud.version}</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>
</project>

2 更新application.yml

eureka:
  client:
    serviceUrl:
      defaultZone: http://xxx.xxx.xxx.xxx:8761/eureka/,http://xxx.xxx.xxx.xxx:8762/eureka/
server:
  port: 8764
spring:
  application:
    name: service-ribbon
info:
  app:
    name: 一个消费者
    version: 0.0.1
zuul:
  #注意若使用yml配置Zuul路由，那么如果一个url同时匹配到多个路由，会按照配置的顺序来选择路由
  routes:
    api-a:
      path: /api-a/**
      #下面的是传统方式直接HTTP访问服务
      #url: http://localhost:8080/hi
      #下面是面向服务的路由，到注册中心按照服务名查找服务
      serviceId: eureka-client
    api-b:
      path: /api-b/**
      serviceId: eureka-client

3 填写启动类

package yunlingfly.mavenspringcloudribbon;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.client.loadbalancer.LoadBalanced;
import org.springframework.cloud.netflix.hystrix.EnableHystrix;
import org.springframework.cloud.netflix.hystrix.dashboard.EnableHystrixDashboard;
import org.springframework.cloud.netflix.zuul.EnableZuulProxy;
import org.springframework.cloud.netflix.zuul.filters.discovery.PatternServiceRouteMapper;
import org.springframework.context.annotation.Bean;
import org.springframework.web.client.RestTemplate;
import yunlingfly.mavenspringcloudribbon.filter.JwtFilter;

@SpringBootApplication
// 向服务中心注册
@EnableDiscoveryClient
// 开启断路器
@EnableHystrix
// 开启仪表盘
@EnableHystrixDashboard
// 开启路由网关
@EnableZuulProxy
public class MavenspringcloudribbonApplication {

	public static void main(String[] args) {
		SpringApplication.run(MavenspringcloudribbonApplication.class, args);
	}
	@Bean
	// @LoadBalanced注解表明这个restRemplate开启负载均衡的功能
	@LoadBalanced
	RestTemplate restTemplate() {
		return new RestTemplate();
	}

	//使用@Bean使Zuul过滤器生效，拦截/api-a/**，/api-b/**
	@Bean
	public JwtFilter accssFilter(){
		return new JwtFilter();
	}

	/**
	 * 用于转发不同版本的路由
	 * 该路由设置形如userservice-v1这样的url转发到/v1/userservice/**，
	 * @return
	 */
//	@Bean
//	public PatternServiceRouteMapper serviceRouteMapper(){
//		return new PatternServiceRouteMapper("(?<name>^.+)-(?<version>v.+$)","(${version}/{name})");
//	}
}

 

4 服务消费者的service层

 

package yunlingfly.mavenspringcloudribbon.service;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.stereotype.Service;
import org.springframework.web.client.RestTemplate;
import com.netflix.hystrix.contrib.javanica.annotation.HystrixCommand;

@Service
@Component
public class HelloService {
    @Autowired
    RestTemplate restTemplate;

    @HystrixCommand(fallbackMethod = "hiError")
    public String hiService(String name) {
        return restTemplate.getForObject("http://eureka-client/hi?name="+name,String.class);
    }

    public String hiError(String name){
        return "hi "+name+",sorry,error,断路器启动...";
    }
}

5 服务消费者的Controller层

package yunlingfly.mavenspringcloudribbon.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import yunlingfly.mavenspringcloudribbon.service.HelloService;

@RestController
public class HelloControler {
    @Autowired
    HelloService helloService;
    @RequestMapping(value = "/hi")
    public String hi(@RequestParam String name){
        return helloService.hiService(name);
    }
}

6 编写filter过滤层

package yunlingfly.mavenspringcloudribbon.filter;

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;
import org.apache.http.HttpStatus;

import javax.servlet.http.HttpServletRequest;

// ZuulFilter路由过滤
public class JwtFilter extends ZuulFilter {
    /**
     * 设置过滤器类型，pre表示会在请求被路由之前执行 ，routing表示在路由请求被调用，error表示请求错误时被调用，post表示在routing和error过滤器之后被调用
     * @return
     */
    @Override
    public String filterType() {
        return "pre";
    }

    /**
     * 设置过滤器的执行顺序，数值越小优先级越高
     * @return
     */
    @Override
    public int filterOrder() {
        return 0;
    }

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

    /**
     * 简单验证是否Token
     * @return
     */
    @Override
    public Object run() {
        RequestContext ctx=RequestContext.getCurrentContext();
        HttpServletRequest request=ctx.getRequest();

        System.out.println("send:"+request.getMethod()+" to:"+request.getRequestURL().toString());

        String token=request.getParameter("token");
        if(null==token){
            System.out.println("token为空！");
            ctx.setSendZuulResponse(false);     //设置不转发路由
            ctx.setResponseStatusCode(HttpStatus.SC_UNAUTHORIZED);    //设置返回状态码为401
//            ctx.setResponseBody("");          //设置返回的内容
            return null;
        }
        System.out.println("带有token，进行转发");
        return null;
    }
}

运行

先启动Eureka，再启动消息服务者（都是沿用前面的项目），再启动本项目，浏览器访问http://localhost:8764/api-a/hi?token=xxx&name=芸灵ly

控制台:

如果直接使用http://localhost:8764/api-a/hi?name=芸灵fly访问发现并不能访问，当然这里只是是否带有Token的简单验证，实际情况可以将JWT验证放在这里，例如我的另一篇文章应用->JWT在SpringBoot中的应用

注意事项：启动类@EnableZuulProxy开启路由网关，application.yml里配置Zuul路由，并继承ZuulFilter类来定义过滤器，使用@Bean来使过滤器生效