knife4j配置网关

墨蓝 2023-09-28 17:12 43阅读 0赞

第一步：加入依赖

<dependency>
                <groupId>com.github.xiaoymin</groupId>
                <artifactId>knife4j-spring-boot-starter</artifactId>
            </dependency>

第二步：添加一个配置文件

import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.cloud.gateway.route.RouteLocator;
    import org.springframework.stereotype.Component;
    import springfox.documentation.swagger.web.SwaggerResource;
    import springfox.documentation.swagger.web.SwaggerResourcesProvider;
    
    import java.util.ArrayList;
    import java.util.HashSet;
    import java.util.List;
    import java.util.Set;
    
    @Component
    public class SwaggerProvider implements SwaggerResourcesProvider {
        /**
         * 接口地址
         */
        public static final String API_URI = "/v2/api-docs";
        /**
         * 路由加载器
         */
        @Autowired
        private RouteLocator routeLocator;
        /**
         * 网关应用名称
         */
        @Value("${spring.application.name}")
        private String applicationName;
    
        @Override
        public List<SwaggerResource> get() {
            //接口资源列表
            List<SwaggerResource> resources = new ArrayList<>();
            //服务名称列表
            List<String> routeHosts = new ArrayList<>();
            // 获取所有可用的应用名称
            routeLocator.getRoutes().filter(route -> route.getUri().getHost() != null)
                    .filter(route -> !applicationName.equals(route.getUri().getHost()))
                    .subscribe(route -> routeHosts.add(route.getUri().getHost()));
            // 去重，多负载服务只添加一次
            Set<String> existsServer = new HashSet<>();
            routeHosts.forEach(host -> {
                // 拼接url
                String url = "/" + host + API_URI;
                //不存在则添加
                if (!existsServer.contains(url)) {
                    existsServer.add(url);
                    SwaggerResource swaggerResource = new SwaggerResource();
                    swaggerResource.setUrl(url);
                    swaggerResource.setName(host);
                    resources.add(swaggerResource);
                }
            });
            return resources;
        }
    }

第三步：添加一个控制器方法

import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.http.HttpStatus;
    import org.springframework.http.ResponseEntity;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    import reactor.core.publisher.Mono;
    import springfox.documentation.swagger.web.*;
    
    import java.util.Optional;
    
    @RestController
    @RequestMapping("/swagger-resources")
    public class SwaggerController {
        @Autowired(required = false)
        private SecurityConfiguration securityConfiguration;
        @Autowired(required = false)
        private UiConfiguration uiConfiguration;
    
        private final SwaggerResourcesProvider swaggerResources;
        @Autowired
        public SwaggerController(SwaggerResourcesProvider swaggerResources) {
            this.swaggerResources = swaggerResources;
        }
        @GetMapping("/configuration/security")
        public Mono<ResponseEntity<SecurityConfiguration>> securityConfiguration() {
            return Mono.just(new ResponseEntity<>(
                    Optional.ofNullable(securityConfiguration).orElse(SecurityConfigurationBuilder.builder().build()), HttpStatus.OK));
        }
        @GetMapping("/configuration/ui")
        public Mono<ResponseEntity<UiConfiguration>> uiConfiguration() {
            return Mono.just(new ResponseEntity<>(
                    Optional.ofNullable(uiConfiguration).orElse(UiConfigurationBuilder.builder().build()), HttpStatus.OK));
        }
        @GetMapping("")
        public Mono<ResponseEntity> swaggerResources() {
            return Mono.just((new ResponseEntity<>(swaggerResources.get(), HttpStatus.OK)));
        }
    }

第四步：添加一个过滤器方法

import org.springframework.cloud.gateway.filter.GatewayFilter;
    import org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory;
    import org.springframework.http.server.reactive.ServerHttpRequest;
    import org.springframework.stereotype.Component;
    import org.springframework.util.StringUtils;
    import org.springframework.web.server.ServerWebExchange;
    
    @Component
    public class SwaggerHeaderFilter extends AbstractGatewayFilterFactory {
        private static final String HEADER_NAME = "X-Forwarded-Prefix";
    
        /**
         * swagger2默认的url后缀
         */
        private static final String URI = "/v2/api-docs";
    
        @Override
        public GatewayFilter apply(Object config) {
            return (exchange, chain) -> {
                ServerHttpRequest request = exchange.getRequest();
                String path = request.getURI().getPath();
                if (!StringUtils.endsWithIgnoreCase(path,URI )) {
                    return chain.filter(exchange);
                }
                String basePath = path.substring(0, path.lastIndexOf(URI));
                ServerHttpRequest newRequest = request.mutate().header(HEADER_NAME, basePath).build();
                ServerWebExchange newExchange = exchange.mutate().request(newRequest).build();
                return chain.filter(newExchange);
            };
        }
    }

第五步：测试

1.1 当前网关端口号为30000

![81b73d51b37d40eaa54df5c52c89138f.png][]

1.2 几个模块的名字分别为

![da755b948bfe4a42957b3d79658d8124.png][]

![3e5cd897bcbe42bdb94d6d8e96b521cc.png][]

![6c83940fe56b45e3b415e09cd8f352a9.png][]

![eb55908022d648e0b352b25949763a97.png][]

在浏览器访问时地址栏输入 : http://localhost:30000/application中配置的模块名称/doc.html\#/home

![376cd2d307574eb0b557b840cac7caac.png][]

![90f33faae8874cce8b1a0875a419fd06.png][]

[81b73d51b37d40eaa54df5c52c89138f.png]: https://img-blog.csdnimg.cn/81b73d51b37d40eaa54df5c52c89138f.png
[da755b948bfe4a42957b3d79658d8124.png]: https://img-blog.csdnimg.cn/da755b948bfe4a42957b3d79658d8124.png
[3e5cd897bcbe42bdb94d6d8e96b521cc.png]: https://img-blog.csdnimg.cn/3e5cd897bcbe42bdb94d6d8e96b521cc.png
[6c83940fe56b45e3b415e09cd8f352a9.png]: https://img-blog.csdnimg.cn/6c83940fe56b45e3b415e09cd8f352a9.png
[eb55908022d648e0b352b25949763a97.png]: https://img-blog.csdnimg.cn/eb55908022d648e0b352b25949763a97.png
[376cd2d307574eb0b557b840cac7caac.png]: https://img-blog.csdnimg.cn/376cd2d307574eb0b557b840cac7caac.png
[90f33faae8874cce8b1a0875a419fd06.png]: https://img-blog.csdnimg.cn/90f33faae8874cce8b1a0875a419fd06.png