SpringCloud Zuul自定义filter代码实例
实现过滤器很简单,只需要继承ZuulFilter,并实现ZuulFilter中的抽象方法。
- filterType():定义过滤器的类型,它有4种类型,分别是pre、post、routing和error
- filterOrder():过滤顺序,它是一个Int类型的值,值越小,越早执行该过滤器
- shouldFilter():表示该过滤器是否过滤逻辑,如果为true,则执行run方法,如果为false,则不执行run方法
- Objectrun():写具体的过滤逻辑
注意重要说明,有些版本在转发post时,文件上传无法转法。只要升级下版本就可以了。
本示中使用的是springcloudEdgware.RELEASE对应springboot1.5.9
示例
1.pom中引用
4.0.0 com.company zuuldemo 0.0.1-SNAPSHOT jar zuuldemo http://maven.apache.org UTF-8 1.8 1.8 org.springframework.cloud spring-cloud-starter-parent Edgware.RELEASE org.springframework.boot spring-boot-starter-web org.springframework.cloud spring-cloud-starter-zuul commons-codec commons-codec org.apache.httpcomponents httpclient junit junit test com.google.guava guava com.alibaba fastjson 1.2.58
2.springcloud项目
2.1src/main/resources/application.yml
server: port:80 spring: application: name:api-geteway http: multipart: enabled:true#使用httpmultipart上传处理 file-size-threshold:1MB#当上传文件达到1MB的时候进行磁盘写入 max-request-size:10MB#设置最大的请求文件的大小 max-file-size:10MB#设置单个文件的最大长度 zuul: routes: weixin: path:/mypath/** url:https://www.baidu.com
2.2App.java
packagecom.company.zuuldemo;
importorg.springframework.boot.SpringApplication;
importorg.springframework.boot.autoconfigure.SpringBootApplication;
importorg.springframework.cloud.netflix.zuul.EnableZuulProxy;
importorg.springframework.context.annotation.Bean;
importcom.company.zuuldemo.filter.MyFilter;
/**
*Helloworld!
*
*/
@EnableZuulProxy
@SpringBootApplication
publicclassZuulApp{
//使用filter
@Bean
publicMyFiltermyFilter(){
returnnewMyFilter();
}
//@Bean
//publicFirstFilterfirstFilter(){
//returnnewFirstFilter();
//}
//
//@Bean
//publicSecondFiltersecondFilter(){
//returnnewSecondFilter();
//}
publicstaticvoidmain(String[]args){
//System.out.println("HelloWorld!");
SpringApplication.run(ZuulApp.class);
}
}
2.3MyFilter.java
packagecom.company.zuuldemo.filter;
importjava.util.Arrays;
importjava.util.Date;
importjava.util.HashMap;
importjava.util.List;
importjava.util.Map;
importorg.slf4j.Logger;
importorg.slf4j.LoggerFactory;
importcom.netflix.zuul.ZuulFilter;
importcom.netflix.zuul.context.RequestContext;
publicclassMyFilterextendsZuulFilter{
finalstaticLoggerlogger=LoggerFactory.getLogger(FirstFilter.class);
//这里可以依据url规则判断是否需要进行过滤true需要过滤进入run方法,false直接忽略
publicbooleanshouldFilter(){
RequestContextctx=RequestContext.getCurrentContext();
logger.info(ctx.getRequest().getRequestURI()+"getrequestpathinfo");
Stringurl=ctx.getRequest().getRequestURI().toLowerCase();
//这里判断url逻辑
if(url.startsWith("/login")){
returnfalse;
}
returntrue;
}
publicObjectrun(){
RequestContextctx=RequestContext.getCurrentContext();
//通过其它业务生成token
Stringaccess_token="user_name_token";
//使用1:向request的header中增加参数access_token
ctx.addZuulRequestHeader("access_token",access_token);
//使用2:向request的url里增加参数,示例增加access_token
Map>requestQueryParams=ctx.getRequestQueryParams();
if(requestQueryParams==null){
requestQueryParams=newHashMap<>();
}
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_tokenisnotcorrect!\"}");
//让下一个Filter看到上一个Filter的状态用于过滤器间的协调
ctx.set("my_filter_is_success",false);
returnnull;
}
//对该请求进行路由(默认就是true)
//ctx.setSendZuulResponse(true);
//ctx.setResponseStatusCode(200);
//让下一个Filter看到上一个Filter的状态用于过滤器间的协调
ctx.set("my_filter_is_success",false);
returnnull;//直接返回null即可
}
@Override
publicStringfilterType(){
//前置过滤器
//pre:可以在请求被路由之前调用
//route:在路由请求时候被调用
//post:在route和error过滤器之后被调用
//error:处理请求时发生错误时被调用
return"pre";
}
@Override
publicintfilterOrder(){
//优先级为0,数字越大,优先级越低
return0;
}
}
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持毛票票。