Spring Cloud Gateway重写请求

在Spring Cloud中,有时候需要对前端直接调用的微服务,进行请求内容重组,这时候可以通过自定义org.springframework.cloud.gateway.filter.GlobalFilter,org.springframework.cloud.gateway.filter.factory.rewrite.RewriteFunction,来满足需求。
下面的例子,是前端通过Gateway调用后端的文件服务,获取上传OSS的一些必要信息。通过重组,可以简化和规范使用。

自定义RewriteFunction


import java.io.IOException;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;

import org.apache.commons.lang3.StringUtils;
import org.reactivestreams.Publisher;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.BeanUtils;
import org.springframework.cloud.gateway.filter.factory.rewrite.RewriteFunction;
import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;

import reactor.core.publisher.Mono;

@Component
public class FileServiceRequestRewriteFunction implements RewriteFunction<byte[], byte[]> {
    private static final Logger logger = LoggerFactory.getLogger(FileServiceRequestRewriteFunction.class);

    private Environment environment;
    private ObjectMapper objectMapper;
    private FileServiceProperties fileServiceProperties;

    public FileServiceRequestRewriteFunction(Environment environment, ObjectMapper objectMapper,
            FileServiceProperties fileServiceProperties) {
        this.environment = environment;
        this.objectMapper = objectMapper;
        this.fileServiceProperties = fileServiceProperties;
    }

    @Override
    public Publisher<byte[]> apply(ServerWebExchange t, byte[] u) {
        UploadTokenRequest uploadTokenRequest = new UploadTokenRequest();

        try {
            uploadTokenRequest = objectMapper.readValue(u, UploadTokenRequest.class);
        } catch (IOException e) {
            logger.error("转换异常", e);

            return Mono.just(u);
        }

        var ossUploadFile = new OssUploadFile();

        BeanUtils.copyProperties(uploadTokenRequest, ossUploadFile);

        ossUploadFile.bucket = fileServiceProperties.getTypeBuckets().getOrDefault(uploadTokenRequest.getType(),
                fileServiceProperties.getDefaultBucket());

        ossUploadFile.prefix = getPrefix(uploadTokenRequest.getType(), uploadTokenRequest.getPrefix());

        try {
            return Mono.just(objectMapper.writeValueAsBytes(ossUploadFile));
        } catch (JsonProcessingException e) {
            logger.error("转换异常", e);

            return Mono.just(u);
        }
    }

    private String getActiveProfile() {
        var profiles = environment.getActiveProfiles();

        return profiles.length > 0 ? profiles[0] : "";
    }

    private String getPrefix(String type, String prefix) {
        var activeProfile = getActiveProfile();
        var sb = new StringBuilder();

        if (StringUtils.isNotBlank(activeProfile) && !activeProfile.equalsIgnoreCase("prod")) {
            sb.append(activeProfile.toLowerCase());
        }

        if (StringUtils.isNotBlank(type)) {
            if (!sb.isEmpty()) {
                sb.append("/");
            }

            sb.append(type.toLowerCase());
        }

        if (StringUtils.isNotBlank(prefix)) {
            if (!sb.isEmpty()) {
                sb.append("/");
            }

            sb.append(prefix);
        } else {
            if (!sb.isEmpty()) {
                sb.append("/");
            }

            sb.append(LocalDateTime.now().format(DateTimeFormatter.ofPattern("yyyyMMdd")));
        }

        return sb.toString();
    }

    static class UploadTokenRequest {
        private String type;
        private String bucket;
        private String prefix;
        private String fileKey;
        private String sourceFile;
        private Long sourceFileSize;
        private String sourceFileType;
        private Integer useSourceFilename;
        private Long expiredInSec;

        public String getType() {
            return type;
        }

        public void setType(String type) {
            this.type = type;
        }

        public String getBucket() {
            return bucket;
        }

        public void setBucket(String bucket) {
            this.bucket = bucket;
        }

        public String getPrefix() {
            return prefix;
        }

        public void setPrefix(String prefix) {
            this.prefix = prefix;
        }

        public String getFileKey() {
            return fileKey;
        }

        public void setFileKey(String fileKey) {
            this.fileKey = fileKey;
        }

        public String getSourceFile() {
            return sourceFile;
        }

        public void setSourceFile(String sourceFile) {
            this.sourceFile = sourceFile;
        }

        public Long getSourceFileSize() {
            return sourceFileSize;
        }

        public void setSourceFileSize(Long sourceFileSize) {
            this.sourceFileSize = sourceFileSize;
        }

        public String getSourceFileType() {
            return sourceFileType;
        }

        public void setSourceFileType(String sourceFileType) {
            this.sourceFileType = sourceFileType;
        }

        public Integer getUseSourceFilename() {
            return useSourceFilename;
        }

        public void setUseSourceFilename(Integer useSourceFilename) {
            this.useSourceFilename = useSourceFilename;
        }

        public Long getExpiredInSec() {
            return expiredInSec;
        }

        public void setExpiredInSec(Long expiredInSec) {
            this.expiredInSec = expiredInSec;
        }
    }

    static class OssUploadFile {
        private String bucket;
        private String prefix;
        private String fileKey;
        private String sourceFile;
        private Long sourceFileSize;
        private String sourceFileType;
        private Integer useSourceFilename;
        private Long expiredInSec;

        public String getBucket() {
            return bucket;
        }

        public void setBucket(String bucket) {
            this.bucket = bucket;
        }

        public String getPrefix() {
            return prefix;
        }

        public void setPrefix(String prefix) {
            this.prefix = prefix;
        }

        public String getFileKey() {
            return fileKey;
        }

        public void setFileKey(String fileKey) {
            this.fileKey = fileKey;
        }

        public String getSourceFile() {
            return sourceFile;
        }

        public void setSourceFile(String sourceFile) {
            this.sourceFile = sourceFile;
        }

        public Long getSourceFileSize() {
            return sourceFileSize;
        }

        public void setSourceFileSize(Long sourceFileSize) {
            this.sourceFileSize = sourceFileSize;
        }

        public String getSourceFileType() {
            return sourceFileType;
        }

        public void setSourceFileType(String sourceFileType) {
            this.sourceFileType = sourceFileType;
        }

        public Integer getUseSourceFilename() {
            return useSourceFilename;
        }

        public void setUseSourceFilename(Integer useSourceFilename) {
            this.useSourceFilename = useSourceFilename;
        }

        public Long getExpiredInSec() {
            return expiredInSec;
        }

        public void setExpiredInSec(Long expiredInSec) {
            this.expiredInSec = expiredInSec;
        }
    }
}

自定义GlobalFilter


import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.cloud.gateway.filter.factory.rewrite.ModifyRequestBodyGatewayFilterFactory;
import org.springframework.cloud.gateway.route.Route;
import org.springframework.cloud.gateway.support.ServerWebExchangeUtils;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;

import reactor.core.publisher.Mono;

/**
 * 文件服务全局过滤器
 */
@Component
public class FileServiceGatewayGlobalFilter implements GlobalFilter {
    private ModifyRequestBodyGatewayFilterFactory modifyRequestBodyGatewayFilterFactory;
    private FileServiceProperties fileServiceProperties;
    private FileServiceRequestRewriteFunction fileServiceRequestRewriteFunction;

    public FileServiceGatewayGlobalFilter(ModifyRequestBodyGatewayFilterFactory modifyRequestBodyGatewayFilterFactory,
            FileServiceProperties fileServiceProperties,
            FileServiceRequestRewriteFunction fileServiceRequestRewriteFunction) {
        this.modifyRequestBodyGatewayFilterFactory = modifyRequestBodyGatewayFilterFactory;
        this.fileServiceProperties = fileServiceProperties;
        this.fileServiceRequestRewriteFunction = fileServiceRequestRewriteFunction;
    }

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        Route route = exchange.getAttribute(ServerWebExchangeUtils.GATEWAY_ROUTE_ATTR);

        if (route != null && route.getUri() != null && route.getUri().getHost().equalsIgnoreCase("file-service")) {

            var requestPath = exchange.getRequest().getURI().getPath();

            if (requestPath.equalsIgnoreCase(fileServiceProperties.getUploadTokenPath())) {
                return modifyRequestBodyGatewayFilterFactory.apply(new ModifyRequestBodyGatewayFilterFactory()
                        .newConfig().setRewriteFunction(byte[].class, byte[].class, fileServiceRequestRewriteFunction))
                        .filter(exchange, chain);

            }
        }

        return chain.filter(exchange);
    }

    static class UploadTokenRequest {
        private String type;
        private String bucket;
        private String prefix;
        private String fileKey;
        private String sourceFile;
        private Long sourceFileSize;
        private String sourceFileType;
        private Integer useSourceFilename;
        private Long expiredInSec;

        public String getType() {
            return type;
        }

        public void setType(String type) {
            this.type = type;
        }

        public String getBucket() {
            return bucket;
        }

        public void setBucket(String bucket) {
            this.bucket = bucket;
        }

        public String getPrefix() {
            return prefix;
        }

        public void setPrefix(String prefix) {
            this.prefix = prefix;
        }

        public String getFileKey() {
            return fileKey;
        }

        public void setFileKey(String fileKey) {
            this.fileKey = fileKey;
        }

        public String getSourceFile() {
            return sourceFile;
        }

        public void setSourceFile(String sourceFile) {
            this.sourceFile = sourceFile;
        }

        public Long getSourceFileSize() {
            return sourceFileSize;
        }

        public void setSourceFileSize(Long sourceFileSize) {
            this.sourceFileSize = sourceFileSize;
        }

        public String getSourceFileType() {
            return sourceFileType;
        }

        public void setSourceFileType(String sourceFileType) {
            this.sourceFileType = sourceFileType;
        }

        public Integer getUseSourceFilename() {
            return useSourceFilename;
        }

        public void setUseSourceFilename(Integer useSourceFilename) {
            this.useSourceFilename = useSourceFilename;
        }

        public Long getExpiredInSec() {
            return expiredInSec;
        }

        public void setExpiredInSec(Long expiredInSec) {
            this.expiredInSec = expiredInSec;
        }
    }

    static class OssUploadFile {
        private String bucket;
        private String prefix;
        private String fileKey;
        private String sourceFile;
        private Long sourceFileSize;
        private String sourceFileType;
        private Integer useSourceFilename;
        private Long expiredInSec;

        public String getBucket() {
            return bucket;
        }

        public void setBucket(String bucket) {
            this.bucket = bucket;
        }

        public String getPrefix() {
            return prefix;
        }

        public void setPrefix(String prefix) {
            this.prefix = prefix;
        }

        public String getFileKey() {
            return fileKey;
        }

        public void setFileKey(String fileKey) {
            this.fileKey = fileKey;
        }

        public String getSourceFile() {
            return sourceFile;
        }

        public void setSourceFile(String sourceFile) {
            this.sourceFile = sourceFile;
        }

        public Long getSourceFileSize() {
            return sourceFileSize;
        }

        public void setSourceFileSize(Long sourceFileSize) {
            this.sourceFileSize = sourceFileSize;
        }

        public String getSourceFileType() {
            return sourceFileType;
        }

        public void setSourceFileType(String sourceFileType) {
            this.sourceFileType = sourceFileType;
        }

        public Integer getUseSourceFilename() {
            return useSourceFilename;
        }

        public void setUseSourceFilename(Integer useSourceFilename) {
            this.useSourceFilename = useSourceFilename;
        }

        public Long getExpiredInSec() {
            return expiredInSec;
        }

        public void setExpiredInSec(Long expiredInSec) {
            this.expiredInSec = expiredInSec;
        }
    }
}

文件服务配置


import java.util.Map;

import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties(prefix = "file-service", ignoreUnknownFields = true)
public class FileServiceProperties {
    private String uploadTokenPath;

    private String defaultBucket;

    private Map<String, String> typeBuckets;

    public String getUploadTokenPath() {
        return uploadTokenPath;
    }

    public void setUploadTokenPath(String uploadTokenPath) {
        this.uploadTokenPath = uploadTokenPath;
    }

    public String getDefaultBucket() {
        return defaultBucket;
    }

    public void setDefaultBucket(String defaultBucket) {
        this.defaultBucket = defaultBucket;
    }

    public Map<String, String> getTypeBuckets() {
        return typeBuckets;
    }

    public void setTypeBuckets(Map<String, String> typeBuckets) {
        this.typeBuckets = typeBuckets;
    }
}
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,242评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,769评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,484评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,133评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,007评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,080评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,496评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,190评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,464评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,549评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,330评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,205评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,567评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,889评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,160评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,475评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,650评论 2 335

推荐阅读更多精彩内容