knife4j3.0.3整合gateway和注冊中心的詳細過程
更新時間：2023年03月28日 08:54:23 作者：√Angelの愛灬
這篇文章主要介紹了knife4j3.0.3整合gateway和注冊中心的詳細過程，本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下
1. 項目依賴管理
<properties>
<java.version>1.8</java.version>
<spring-boot.version>2.3.12.RELEASE</spring-boot.version>
<spring-cloud.version>Hoxton.SR12</spring-cloud.version>
<spring-cloud-alibaba.version>2.2.10-RC1</spring-cloud-alibaba.version>
<knife4j.version>3.0.3</knife4j.version>
</properties>
<dependencyManagement>
<dependencies>
<!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-dependencies -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-dependencies</artifactId>
<version>${spring-boot.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<!-- https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-dependencies -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>${spring-cloud.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<!-- https://mvnrepository.com/artifact/com.alibaba.cloud/spring-cloud-alibaba-dependencies -->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-alibaba-dependencies</artifactId>
<version>${spring-cloud-alibaba.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<!-- https://mvnrepository.com/artifact/com.github.xiaoymin/knife4j-dependencies -->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-dependencies</artifactId>
<version>${knife4j.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
2. gateway項目
2.1 pom.xml
<!--網(wǎng)關-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<!--nacos注冊中心-->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>
<!--swagger美化——knife4j-->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
</dependency>2.2 application.yml
server:
port: 8888
spring:
main:
web-application-type: reactive
application:
name: gateway2.3 bootstrap.yml
spring:
cloud:
nacos:
server-addr: localhost:8848
username: nacos
password: nacos
discovery:
enabled: true
namespace: 776074db-06ad-4991-bb68-99b41ae971c9
gateway:
routes:
- id: news
uri: lb://news
predicates:
- Path=/news/**
filters:
- StripPrefix=12.4 獲取swagger資源的接口
import lombok.RequiredArgsConstructor;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import reactor.core.publisher.Mono;
import springfox.documentation.swagger.web.SwaggerResource;
import springfox.documentation.swagger.web.SwaggerResourcesProvider;
import java.util.List;
/**
* @author √Angelの愛灬
* @date 2023/3/23
*/
@RestController
@RequiredArgsConstructor
public class SwaggerController {
private final SwaggerResourcesProvider swaggerResources;
@GetMapping("/swagger-resources")
public Mono<ResponseEntity<List<SwaggerResource>>> swaggerResources() {
return Mono.just((new ResponseEntity<>(swaggerResources.get(), HttpStatus.OK)));
}
}2.5 swagger資源配置類
import com.msf.gateway.enums.ServiceEnum;
import lombok.RequiredArgsConstructor;
import org.springframework.cloud.gateway.config.GatewayProperties;
import org.springframework.cloud.gateway.route.RouteDefinition;
import org.springframework.cloud.gateway.support.NameUtils;
import org.springframework.context.annotation.Primary;
import org.springframework.stereotype.Component;
import springfox.documentation.swagger.web.SwaggerResource;
import springfox.documentation.swagger.web.SwaggerResourcesProvider;
import java.util.ArrayList;
import java.util.List;
/**
* 獲取網(wǎng)關路由判斷哪些路由需要使用文檔
*
* @author √Angelの愛灬
* @date 2023/3/23
*/
@Primary
@Component
@RequiredArgsConstructor
public class SwaggerResourceConfig implements SwaggerResourcesProvider {
private final String API_URI = "v2/api-docs";
private final GatewayProperties gatewayProperties;
@Override
public List<SwaggerResource> get() {
// 接口資源列表
List<SwaggerResource> resources = new ArrayList<>();
// resources為所有路由都加載到文檔，如果需要部分顯示，在下方使用filter進行過濾即可
for (RouteDefinition route : gatewayProperties.getRoutes()) {
route.getPredicates().stream()
.filter(predicateDefinition -> ("Path").equalsIgnoreCase(predicateDefinition.getName()))
.forEach(predicateDefinition -> resources.add(swaggerResource(ServiceEnum.getServiceName(route.getId()),
predicateDefinition.getArgs().get(NameUtils.GENERATED_NAME_PREFIX + "0").replace("**", API_URI))));
}
return resources;
}
private SwaggerResource swaggerResource(String name, String url) {
SwaggerResource swaggerResource = new SwaggerResource();
swaggerResource.setName(name);
swaggerResource.setLocation(url);
swaggerResource.setUrl(url);
swaggerResource.setSwaggerVersion("2.0");
return swaggerResource;
}
}
2.6 服務枚舉類
import lombok.AllArgsConstructor;
/**
* 服務列表
*
* @author √Angelの愛灬
* @date 2023/3/23
*/
@AllArgsConstructor
public enum ServiceEnum {
//新聞模塊
news("新聞模塊");
private final String serviceName;
public static String getServiceName(String name) {
for (ServiceEnum service : ServiceEnum.values()) {
if (name.equals(service.name())) {
return service.serviceName;
}
}
return "服務路由字典錯誤！";
}
}此后如果新增了其他子服務，在服務枚舉類中添加對應的模塊即可：枚舉name=spring.cloud.gateway.routes.id，serviceName=服務名稱
3. 子服務
3.1 pom.xml
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--nacos服務注冊發(fā)現(xiàn)-->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>
<!--swagger美化——knife4j-->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-micro-spring-boot-starter</artifactId>
<exclusions>
<exclusion>
<groupId>javax.validation</groupId>
<artifactId>validation-api</artifactId>
</exclusion>
</exclusions>
</dependency>3.2 application.yml
server:
port: 8080
spring:
application:
name: news3.3 bootstrap.yml
spring:
cloud:
nacos:
server-addr: localhost:8848
username: nacos
password: nacos
discovery:
enabled: true
namespace: 776074db-06ad-4991-bb68-99b41ae971c9
knife4j:
enable: true3.4 swagger配置類
import com.msf.common.constant.Constant;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.HttpMethod;
import springfox.documentation.builders.*;
import springfox.documentation.service.*;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import java.util.ArrayList;
import java.util.List;
/**
* Swagger配置
*
* @author √Angelの愛灬
* @date 2023/3/21
*/
@Slf4j
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Value("${spring.profiles.active:}")
private String active;
@Bean
public Docket docDocket() {
boolean enableSwagger = !Constant.SPRING_PROFILES_ACTIVE_PRO.equalsIgnoreCase(active);
return new Docket(DocumentationType.SWAGGER_2)
// 非生產(chǎn)環(huán)境啟用
.enable(enableSwagger)
.apiInfo(apiInfo())
.globalResponses(HttpMethod.GET, globalResponse())
.globalResponses(HttpMethod.POST, globalResponse())
.globalResponses(HttpMethod.PUT, globalResponse())
.globalResponses(HttpMethod.DELETE, globalResponse())
.select()
.apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
.paths(PathSelectors.any())
.build()
.globalRequestParameters(globalRequestParameters());
}
private ApiInfo apiInfo() {
String title = "新聞模塊";
String description = "<div style='font-size:14px;color:red;'>新聞模塊knife4j接口文檔</div>";
String version = "1.0.0";
String termsOfServiceUrl = "";
Contact contact = new Contact("√Angelの愛灬", "", "");
return new ApiInfoBuilder()
.title(title)
.description(description)
.version(version)
.termsOfServiceUrl(termsOfServiceUrl)
.contact(contact)
.build();
}
private List<Response> globalResponse(){
List<Response> responseList = new ArrayList<>();
responseList.add(new ResponseBuilder().code("401").description("未認證").build());
responseList.add(new ResponseBuilder().code("403").description("請求被禁止").build());
responseList.add(new ResponseBuilder().code("404").description("找不到資源").build());
return responseList;
}
private List<RequestParameter> globalRequestParameters() {
List<RequestParameter> parameters = new ArrayList<>();
RequestParameterBuilder requestParameterBuilder = new RequestParameterBuilder();
RequestParameter username = requestParameterBuilder
.name("username").description("用戶賬號").in(ParameterType.HEADER)
.build();
RequestParameter token = requestParameterBuilder
.name("token").description("token").in(ParameterType.HEADER)
.build();
parameters.add(username);
parameters.add(token);
return parameters;
}
}
4. 項目啟動
訪問http://{gateway.host}:{gateway.port}/doc.html
到此這篇關于knife4j3.0.3整合gateway和注冊中心的文章就介紹到這了,更多相關knife4j3.0.3整合gateway內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
下面小編就為大家?guī)硪黄猨ava對象類型轉換和多態(tài)性(實例講解)。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2017-10-10
詳解Java的Hibernat框架中的Map映射與SortedMap映射
這篇文章主要介紹了Java的Hibernat框架中的Map映射與SortedMap映射,Hibernat是Java的SSH三大web開發(fā)框架之一,需要的朋友可以參考下2015-12-12
Java 中文字符按Unicode排序的實現(xiàn)方法
這篇文章主要介紹了Java 中文字符按Unicode排序的實現(xiàn)方法，非常不錯，具有一定的參考借鑒價值,需要的朋友可以參考下2018-10-10
spring-gateway網(wǎng)關聚合swagger實現(xiàn)多個服務接口切換的示例代碼
這篇文章主要介紹了spring-gateway網(wǎng)關聚合swagger實現(xiàn)多個服務接口切換的示例代碼，本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2022-03-03
這篇文章主要介紹了Eclipse下Javassist正確使用方法代碼解析，javassist-3.15.0-ga.jar包是一款在java開發(fā)中十分重要的jar文件包，需要的朋友可以參考下，文中附下載鏈接。2017-12-12
這篇文章主要為大家介紹了java注解處理器學習在編譯期修改語法樹教程，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2022-09-09
今天給大家?guī)淼氖顷P于Java String的相關知識,文章圍繞著String類常用方法展開,文中有非常詳細的介紹及代碼示例,需要的朋友可以參考下2021-06-06
SpringData實現(xiàn)自定義Redis緩存的序列化機制和過期策略
Spring Data Redis緩存通過提供靈活的配置選項,使開發(fā)者能夠根據(jù)業(yè)務需求自定義序列化方式和過期策略,下面就來具體介紹一下,感興趣的可以了解一下2025-04-04
這篇文章主要介紹了Java實現(xiàn)雙保險線程的示例代碼，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2019-12-12
沒有編輯器的環(huán)境下是如何創(chuàng)建Servlet(Tomcat+Java)項目的?
今天給大家?guī)淼氖顷P于Java的相關知識,文章圍繞著在沒有編輯器的環(huán)境下如何創(chuàng)建Servlet(Tomcat+Java)項目展開,文中有非常詳細的介紹及代碼示例,需要的朋友可以參考下2021-06-06