【Knife4j】小試牛刀，基于eureka的集成

knife4j是什么?可以關(guān)注一下官網(wǎng)，簡單說就是對基于swagger的增強(qiáng)版本?！?a target="_blank">官網(wǎng)】
本文基于以下基礎(chǔ)進(jìn)行集成：

  1. springboot 2.7.0（2.6.7+也可，推薦使用GA版本）
  2. knife4j3.0.3
  3. knife4j-aggregation 2.0.9
  4. spring cloud 2021.0.1
  5. 本文基于eureka集成（后續(xù)會介紹基于gateway的集成方式）

一、工程結(jié)構(gòu)

工程結(jié)構(gòu).png

使用到的工程說明：

  • eboot-center:eureka注冊中心（服務(wù)端）
  • eboot-knife4j:文檔服務(wù)
  • eboot-common:包含了一些基礎(chǔ)的認(rèn)證、全局異常等處理，本文暫不需要
  • eboot-gateway:spring-cloud-gateway，大多是情況下微服務(wù)均走網(wǎng)關(guān)，下一步會實(shí)現(xiàn)基于gateway的knife集成
  • eboot-modulars:即各個(gè)業(yè)務(wù)子系統(tǒng)，這里分了三個(gè)：認(rèn)證管理、文件管理、系統(tǒng)管理
  • eboo-ui：前端項(xiàng)目，本文不需要

二、eboot-center服務(wù)端

普通的eureka服務(wù)端配置

主要配置如下：

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
        </dependency>

server:
  port: 8761
eureka:
  instance:
    hostname: localhost
    appname: eboot-provider
    leaseRenewalIntervalInSeconds: 1
    lease-expiration-duration-in-seconds: 2
    prefer-ip-address: true
  client:
    registerWithEureka: false
    fetchRegistry: false
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/
spring:
  boot:
    admin:
      client:
        url: http://localhost:8888
  application:
    name: boot-provider

三、eboot-knife4j服務(wù)配置

文檔服務(wù)的主要配置均在此，其實(shí)它只是一個(gè)web工程，詳細(xì)配置參數(shù)見【eureka參數(shù)配置】

主要配置如下：

       <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-aggregation-spring-boot-starter</artifactId>
        </dependency>

請注意以下的serviceName和location:
1. serviceName：eureka是根據(jù)這個(gè)進(jìn)行接口統(tǒng)計(jì)請求的，因此這個(gè)一定一定要正確，和對應(yīng)服務(wù)中的對應(yīng)起來。
2. location：業(yè)務(wù)系統(tǒng)起來之后可以訪問下這個(gè)地址試試是否可以正常返回json數(shù)據(jù)，注意group，未配置的話是default，如果配置了使用業(yè)務(wù)系統(tǒng)配置的即可（例如：boot-auth的分組我使用了auth）

server:
  port: 9999
knife4j:
  enableAggregation: true
  setting:
    footerCustomContent: Copyright 2022-2023 【小塵哥】
  eureka:
    enable: true
    serviceUrl: http://127.0.0.1:8761/eureka/
    routeAuth:
      enable: true
      username: admin
      password: 123456
    routes:
      - name: 認(rèn)證體系
        serviceName: boot-auth
        location: http://localhost:9091/auth/v2/api-docs?group=auth
        servicePath: /auth
      - name: 文件服務(wù)
        serviceName: boot-file
        location: http://localhost:9092/file/v2/api-docs?group=default
        servicePath: /file
      - name: 系統(tǒng)服務(wù)
        serviceName: boot-system
        location: http://localhost:9093/system/v2/api-docs?group=default
        servicePath: /system

放行靜態(tài)資源和解決跨域問題

注意：跨域問題在每個(gè)服務(wù)中均需解決，否則接口請求報(bào)錯(cuò)

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        //配置攔截器訪問靜態(tài)資源
        registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/favicon.ico").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }

    private CorsConfiguration buildConfig() {
        CorsConfiguration corsConfiguration = new CorsConfiguration();
        corsConfiguration.addAllowedOrigin("*");
        corsConfiguration.addAllowedHeader("*");
        corsConfiguration.addAllowedMethod("*");
        return corsConfiguration;
    }

    @Bean
    public CorsFilter corsFilter() {
        UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
        source.registerCorsConfiguration("/**", buildConfig());
        return new CorsFilter(source);
    }

四、業(yè)務(wù)系統(tǒng)系統(tǒng)

基本和普通的集成swagger一樣，以下以eboot-auth為例，只列出關(guān)鍵配置

  1. 啟用eureka客戶端
  2. 集成knife
  3. 加入guava,否則swagger可能會有各種奇葩問題
  <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    </dependency>
    <dependency>
      <groupId>com.github.xiaoymin</groupId>
      <artifactId>knife4j-micro-spring-boot-starter</artifactId>
    </dependency>
    <dependency>
      <groupId>com.google.guava</groupId>
      <artifactId>guava</artifactId>
    </dependency>
  • knife4j.enable:啟用knife增強(qiáng)功能，否則就是普通的swagger
  • spring.mvc.pathmatch.matching-strategy，springboot 2.6.0開始MVC 處理映射匹配的默認(rèn)策略已從AntPathMatcher更改為PathPatternParser，但是knife依然是AntPathMatcher模式，因此需手動(dòng)修改回去，否則會出現(xiàn)“Failed to start bean ‘ documentationPluginsBootstrapper ‘”
  • 其他的eureka正常配置即可
eureka:
  client:
    serviceUrl:
      defaultZone: http://127.0.0.1:8761/eureka/
  instance:
    appname: boot-auth
    leaseRenewalIntervalInSeconds: 1
    lease-expiration-duration-in-seconds: 2
    prefer-ip-address: true
    instance-id: 127.0.0.1:9091
knife4j:
  enable: true
spring:
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher

swagger配置如下：

    @Bean
    @Order(value = 1)
    public Docket groupRestApi() {
        Contact contact = new Contact("小塵哥","http://localhost:9091/auth/","grq100296@163.com");
        Docket docket=new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(new ApiInfoBuilder()
                        .title("統(tǒng)一認(rèn)證服務(wù) RESTful APIs")
                        .description("統(tǒng)一認(rèn)證服務(wù)相關(guān)接口")
                        .termsOfServiceUrl("http://localhost:9091/auth/")
                        .contact(contact)
                        .version("1.0")
                        .build())
                //分組名稱
                .groupName("auth")
                .select()
                //這里指定Controller掃描包路徑
                .apis(RequestHandlerSelectors.basePackage("com.mos.eboot.auth.controller"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }

接口示例，請注意@ApiSupport即為knife增強(qiáng)注解，可以為當(dāng)前類或者接口增加作者、序號等。包括@DynamicParameter、@DynamicResponseParameters、ApiOperationSupport、@Ignore等

package com.mos.eboot.auth.controller;


import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.core.toolkit.Wrappers;
import com.github.xiaoymin.knife4j.annotations.ApiSupport;
import com.mos.eboot.auth.entity.SysUser;
import com.mos.eboot.auth.form.LoginBody;
import com.mos.eboot.auth.service.ISysUserService;
import com.mos.eboot.commom.core.auth.domain.LoginUser;
import com.mos.eboot.commom.core.result.ResultModel;
import com.mos.eboot.commom.core.result.ResultStatus;
import com.mos.eboot.commom.core.util.JwtUtils;
import com.mos.eboot.common.security.auth.AuthUtil;
import com.mos.eboot.common.security.service.TokenService;
import com.mos.eboot.common.security.util.SecurityUtils;
import com.xiaoleilu.hutool.util.ObjectUtil;
import com.xiaoleilu.hutool.util.StrUtil;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletRequest;
import java.util.Map;

/**
 * token 控制
 *
 * @author 小塵哥
 */
@Api(tags = "token認(rèn)證")
@ApiSupport(author = "小塵哥")
@RestController
public class TokenController {
    @Autowired
    private TokenService tokenService;

    @Autowired
    private ISysUserService sysUserService;

    @ApiImplicitParams({
            @ApiImplicitParam(name = "username",value = "用戶名",required = true),
            @ApiImplicitParam(name = "password",value = "密碼",required = true),
    })
    @ApiOperation(value = "登錄")
    @PostMapping("login")
    public ResultModel<Map<String, Object>> login(LoginBody form) {
        // 用戶登錄
        LambdaQueryWrapper<SysUser> entityWrapper = Wrappers.lambdaQuery();
        entityWrapper.eq(SysUser::getUsername, form.getUsername());
        SysUser sysUser = sysUserService.getOne(entityWrapper);
        LoginUser userInfo = new LoginUser();
        userInfo.setUserid(sysUser.getId());
        userInfo.setUsername(sysUser.getUsername());
        // TODO:  完善LoginUser信息，記錄登錄日志
        return ResultModel.defaultSuccessObj(tokenService.createToken(userInfo));
    }

}

五、界面展示

image.png
最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡書系信息發(fā)布平臺，僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容