SpringCloud Zuul自定义filter代码实例

实现过滤器很简单,只需要继承ZuulFilter,并实现ZuulFilter中的抽象方法。

  • filterType():定义过滤器的类型,它有4种类型,分别是pre、post、routing和error
  • filterOrder():过滤顺序,它是一个Int类型的值,值越小,越早执行该过滤器
  • shouldFilter():表示该过滤器是否过滤逻辑,如果为true,则执行run方法,如果为false,则不执行run方法
  • Object run():写具体的过滤逻辑

注意重要说明,有些版本在转发post时,文件上传无法转法。只要升级下版本就可以了。

本示中使用的是 springcloud Edgware.RELEASE 对应springboot1.5.9

Spring Boot Spring Cloud
1.2.x Angel版本
1.3.x  Brixton版本
1.4.xstripes Camden版本
1.5.x  Dalston版本、Edgware版本
2.0.x Finchley版本
2.1.x   Greenwich.SR2

示例

1.pom中引用

<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.company</groupId>
  <artifactId>zuuldemo</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <packaging>jar</packaging>

  <name>zuuldemo</name>
  <url>http://maven.apache.org</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
  </properties>
  <parent>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-parent</artifactId>
    <version>Edgware.RELEASE</version>
    <relativePath></relativePath>
  </parent>
  <dependencies>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-zuul</artifactId>
    </dependency>
    <dependency>
      <groupId>commons-codec</groupId>
      <artifactId>commons-codec</artifactId>
    </dependency>
    <dependency>
      <groupId>org.apache.httpcomponents</groupId>
      <artifactId>httpclient</artifactId>
    </dependency>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <scope>test</scope>
    </dependency>
    <dependency>
      <groupId>com.google.guava</groupId>
      <artifactId>guava</artifactId>
    </dependency>
    <dependency>
      <groupId>com.alibaba</groupId>
      <artifactId>fastjson</artifactId>
      <version>1.2.58</version>
    </dependency>
  </dependencies>
</project>

2.springcloud项目

2.1 src/main/resources/application.yml

server:
  port: 80
spring:
  application:
   name: api-geteway
  http:
   multipart:
     enabled: true # 使用http multipart上传处理
     file-size-threshold: 1MB # 当上传文件达到1MB的时候进行磁盘写入
     max-request-size: 10MB # 设置最大的请求文件的大小
     max-file-size: 10MB # 设置单个文件的最大长度
zuul:
  routes:
   weixin:
     path: /mypath/**
     url: https://www.baidu.com

2.2 App.java

package com.company.zuuldemo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.zuul.EnableZuulProxy;
import org.springframework.context.annotation.Bean;

import com.company.zuuldemo.filter.MyFilter;

/**
 * Hello world!
 *
 */
@EnableZuulProxy
@SpringBootApplication
public class ZuulApp {

  //使用filter
  @Bean
  public MyFilter myFilter() {
    return new MyFilter();
  }

//  @Bean
//  public FirstFilter firstFilter() {
//    return new FirstFilter();
//  }
//
//  @Bean
//  public SecondFilter secondFilter() {
//    return new SecondFilter();
//  }

  public static void main(String[] args) {
    // System.out.println( "Hello World!" );
    SpringApplication.run(ZuulApp.class);
  }
}

2.3 MyFilter.java

package com.company.zuuldemo.filter;

import java.util.Arrays;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

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

public class MyFilter extends ZuulFilter {

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

  // 这里可以依据url规则判断是否需要进行过滤 true需要过滤进入run方法 ,false直接忽略
  public boolean shouldFilter() {
    RequestContext ctx = RequestContext.getCurrentContext();
    logger.info(ctx.getRequest().getRequestURI() + " get request path info");
    String url = ctx.getRequest().getRequestURI().toLowerCase();

    // 这里判断url逻辑
    if (url.startsWith("/login")) {
      return false;
    }

    return true;
  }

  public Object run() {

    RequestContext ctx = RequestContext.getCurrentContext();

    // 通过其它业务生成token
    String access_token = "user_name_token";

    // 使用1 :向request的header中增加参数access_token
    ctx.addZuulRequestHeader("access_token", access_token);

    // 使用2:向request的url里增加参数,示例增加 access_token
    Map<String, List<String>> requestQueryParams = ctx.getRequestQueryParams();
    if (requestQueryParams == null) {
      requestQueryParams = new HashMap<>();
    }

    requestQueryParams.put("access_token", Arrays.asList(access_token));

    ctx.setRequestQueryParams(requestQueryParams);

    //使用3 ::判断是否登录,如果未登录直接返回404
    if (access_token == null || access_token.trim().length() == 0) {
      //过滤该请求,不对其进行路由(直接输入返回)
      ctx.setSendZuulResponse(false);
      //返回错误码
      ctx.setResponseStatusCode(401);
      // 返回错误内容
      ctx.setResponseBody("{\"result\":\"access_token is not correct!\"}");

      //让下一个Filter看到上一个Filter的状态用于过滤器间的协调
      ctx.set("my_filter_is_success", false);
      return null;
    }

    // 对该请求进行路由(默认就是true)
    //ctx.setSendZuulResponse(true);
    //ctx.setResponseStatusCode(200);
    //让下一个Filter看到上一个Filter的状态用于过滤器间的协调
    ctx.set("my_filter_is_success", false);

    return null; //直接返回null即可
  }

  @Override
  public String filterType() {
    // 前置过滤器
    //pre:可以在请求被路由之前调用
    //route:在路由请求时候被调用
    //post:在route和error过滤器之后被调用
    //error:处理请求时发生错误时被调用
    return "pre";
  }

  @Override
  public int filterOrder() {
    //优先级为0,数字越大,优先级越低
    return 0;
  }
}

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持我们。

(0)

相关推荐

  • SpringCloud Zuul过滤器实现登陆鉴权代码实例

    1.新建一个filter'包 2.新建一个类,实现ZuulFilter,重写里面的方法 3.在顶部类添加注解,@Component,让Spring扫描 /** * 登陆过滤器 */ @Component public class LoginFilter extends ZuulFilter { @Override public String filterType() { //前置过滤器 return PRE_TYPE; } @Override public int filterOrder() {

  • SpringCloud Zuul实现动态路由

    前言 Zuul 是在Spring Cloud Netflix平台上提供动态路由,监控,弹性,安全等边缘服务的框架,是Netflix基于jvm的路由器和服务器端负载均衡器,相当于是设备和 Netflix 流应用的 Web 网站后端所有请求的前门.本文基于上篇(SpringCloud系列--Ribbon 负载均衡)实现Zuul动态路由 GitHub地址:https://github.com/Netflix/zuul 官方文档:https://cloud.spring.io/spring-cloud-

  • SpringCloud Zuul网关功能实现解析

    简介 API Gateway,时系统的唯一对外的入口,介于客户端和服务端之间的中间层,处理非业务功能, 提供路由请求,鉴权,监控,缓存,限流等功能 统一接入 智能路由 AB测试.灰度测试 负载均衡.容灾处理 日志埋点(类似 Nignx日志) 流量监控 限流处理 服务降级 安全防护 鉴权处理 监控 机器网终隔离 1.添加依赖 注意SpringBoot和SpringCloud版本兼容 <dependency> <groupId>org.springframework.cloud<

  • springcloud教程之zuul路由网关的实现

    1.简介 当微服务对外提供接口访问时,并且有多个微服务,外部如何访问到具体的微服务?这时就可以使用网关的路由功能,依据url匹配将请求分别转发到不同的服务上 2.使用 zuul除了有转发功能,还有过滤功能,在网关层面可以对请求权限进行校验,token信息生成,设置token信息过期等等,并且可以将token保存到redis缓存中. <dependency> <groupId>org.springframework.cloud</groupId> <artifact

  • Spring Cloud 网关服务 zuul 动态路由的实现方法

    zuul动态路由 网关服务是流量的唯一入口.不能随便停服务.所以动态路由就显得尤为必要. 数据库动态路由基于事件刷新机制热修改zuul的路由属性. DiscoveryClientRouteLocator 可以看到DiscoveryClientRouteLocator 是默认的刷新的核心处理类. //重新加载路由信息方法 protected方法.需要子方法重新方法. protected LinkedHashMap<String, ZuulRoute> locateRoutes() //触发刷新的

  • Spring Cloud Zuul路由规则动态更新解析

    这篇文章主要介绍了Spring Cloud Zuul路由规则动态更新解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下 背景 Spring Cloud Zuul 作为微服务的网关,请求经过zuul路由到内部的各个service,由于存在着新增/修改/删除服务的路由规则的需求,zuul的路由规则的动态变更功能 提供了 无须重启zuul网关,即可实时更新,现有如下几种方式: 一.基于refresh + config-server事件动态刷新 (1)

  • SpringCloud Zuul过滤器和谷歌Gauva实现限流

    前提: 已经配置Zuul网关 参考: https://www.jb51.net/article/182894.htm 限流方式: 1)nginx层限流 2)网关层限流 1.添加限流过滤器 import com.alibaba.fastjson.JSON; import com.google.common.util.concurrent.RateLimiter; import com.netflix.zuul.ZuulFilter; import com.netflix.zuul.context.

  • SpringCLoud搭建Zuul网关集群过程解析

    1.使用技术 Springboot,SpringCloud,Zuul,Nignx 2.目的 使用Zuul搭建微服务高可用的网关 3.项目创建 3.1 创建注册中心(略) 3.2 创建一个hello-service的服务工程 3.3 创建springcloud-zuul-ha网关服务 3.3.1 创建工程(略) 3.3.2 pom.xml <?xml version="1.0" encoding="UTF-8"?> <project xmlns=&q

  • SpringCloud Zuul自定义filter代码实例

    实现过滤器很简单,只需要继承ZuulFilter,并实现ZuulFilter中的抽象方法. filterType():定义过滤器的类型,它有4种类型,分别是pre.post.routing和error filterOrder():过滤顺序,它是一个Int类型的值,值越小,越早执行该过滤器 shouldFilter():表示该过滤器是否过滤逻辑,如果为true,则执行run方法,如果为false,则不执行run方法 Object run():写具体的过滤逻辑 注意重要说明,有些版本在转发post时

  • Java web自定义filter代码实例

    filter顾名思义,过滤器的意思,在javaweb中的Struts就利用了这种机制去实现视图和业务分离. 这里来配置下自己的Filter来理解下Struts的内在. 在web.xml 中添加下面: <filter> <filter-name>myfilter</filter-name> <filter-class>sun.fifter.MyFifter</filter-class> </filter> <filter-mapp

  • Springboot 自定义校验代码实例

    这篇文章主要介绍了Springboot 自定义校验代码实例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下 StartWithValidation.class @Documented @Constraint(validatedBy = StartWithValidator.class ) @Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface StartWithValidati

  • SpringCloud Gateway自定义filter获取body中的数据为空的问题

    最近在使用SpringCloud Gateway进行网关的开发,我使用的版本是:SpringBoot的2.3.4.RELEASE+SpringCloud的Hoxton.SR8,在自定义过滤器时需要获取ServerHttpRequest中body的数据,发现一直无法获取到数据,经过各种百度.谷歌,再加上自己的实践,终于找到解决方案: 1.首先创建一个全局过滤器把body中的数据缓存起来 package com.cloudpath.gateway.portal.filter; import lomb

  • Spring Boot中整合Spring Security并自定义验证代码实例

    最终效果 1.实现页面访问权限限制 2.用户角色区分,并按照角色区分页面权限 3.实现在数据库中存储用户信息以及角色信息 4.自定义验证代码 效果如下: 1.免验证页面 2.登陆页面 在用户未登录时,访问任意有权限要求的页面都会自动跳转到登陆页面. 3.需登陆才能查看的页面 用户登陆后,可以正常访问页面资源,同时可以正确显示用户登录名: 4.用户有角色区分,可以指定部分页面只允许有相应用户角色的人使用 4.1.只有ADMIN觉得用户才能查看的页面(权限不足) 4.2.只有ADMIN觉得用户才能查

  • Java注解Annotation原理及自定义注解代码实例

    什么是注解? 对于很多初次接触的开发者来说应该都有这个疑问?Annontation是Java5开始引入的新特征,中文名称叫注解.它提供了一种安全的类似注释的机制,用来将任何的信息或元数据(metadata)与程序元素(类.方法.成员变量等)进行关联.为程序的元素(类.方法.成员变量)加上更直观更明了的说明,这些说明信息是与程序的业务逻辑无关,并且供指定的工具或框架使用. Annontation像一种修饰符一样,应用于包.类型.构造方法.方法.成员变量.参数及本地变量的声明语句中. Java注解是

  • Android中自定义ScrollView代码实例

    Android中的ScrollView其实是很简陋的,竟然没有和ListView一样的可以设置一个OnScrollListener,不过没有关系,我们可以继承自ScrollView来自定义一个.废话不多说,直接上代码: 复制代码 代码如下: public class ObservableScrollView extends ScrollView { public ObservableScrollView(Context context) {         super(context);    

  • Springcloud RestTemplate服务调用代码实例

    1.服务productservices @RestController public class ProductController { @RequestMapping("/product/findAll") public Map findAll(){ Map map = new HashMap(); map.put("111","苹果手机"); map.put("222","苹果笔记本"); return

  • Logback日志基础及自定义配置代码实例

    Logback日志基础配置 logback日志配置有很多介绍,但是有几个非常基础的,容易忽略的.下面是最简单的一个配置,注意加粗的描述 <?xml version="1.0" encoding="UTF-8"?> <configuration debug="true" scan="true" scanPeriod="30 seconds"> <!--log.path定义的是局部

  • SpringCloud Ribbon负载均衡代码实例

    1.添加依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId&g

随机推荐