快捷導(dǎo)航

SpringMVC整合kinfe4j及問題解決分析

更新時(shí)間：2023年09月12日 11:19:23 作者：不減30斤不改名_TC

這篇文章主要為大家介紹了SpringMVC整合kinfe4j及問題解決分析,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪

引言

以前的SpringMVC代碼都是使用showdoc來記錄接口文檔，正好這次開啟一個(gè)新項(xiàng)目，準(zhǔn)備整合進(jìn)swagger，以免編寫接口文檔的痛苦。而前段時(shí)間又正好看到很多人使用kinfe4j來替換swagger的文章，索性一步到位用上了kinfe4j。

整合的步驟

現(xiàn)在的項(xiàng)目都是用Spring Boot框架的比較多，而Spring Boot整合kinfe4j網(wǎng)上的文章也比較多，而且相對(duì)比較容易，而隨著時(shí)間的推移，SpringMVC用的越來越少，相對(duì)而言資料也越來越少。這次整合也耗費(fèi)了我半天的時(shí)間，下面記錄一下整合的步驟及需要注意的問題。

首先導(dǎo)入maven

<dependency>
      <groupId>io.swagger</groupId>
      <artifactId>swagger-models</artifactId>
      <version>1.5.21</version>
    </dependency>
    <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger-ui</artifactId>
      <version>2.9.2</version>
    </dependency>
    <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger2</artifactId>
      <version>2.9.2</version>
        <exclusions>
            <exclusion>
                <groupId>io.swagger</groupId>
                <artifactId>swagger-models</artifactId>
            </exclusion>
        </exclusions>
    </dependency>
    <dependency>
      <groupId>com.github.xiaoymin</groupId>
      <artifactId>swagger-bootstrap-ui</artifactId>
      <version>1.9.3</version>
    </dependency>
    <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-bean-validators</artifactId>
      <version>2.9.2</version>
    </dependency>
    <dependency>
      <groupId>javax.validation</groupId>
      <artifactId>validation-api</artifactId>
      <version>1.1.0.Final</version>
    </dependency>

第二步，編寫config文件：

@EnableSwagger2
@EnableSwaggerBootstrapUI
@Import(BeanValidatorPluginsConfiguration.class)
@EnableWebMvc
public class SwaggerConfig extends WebMvcConfigurerAdapter {
    public Docket defaultApi(){
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .groupName("2.x 版本")
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.ruida.cloud.sys.controller"))
            .paths(PathSelectors.any())
            .build();
        return docket;
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("管理后臺(tái)接口文檔")
                .description("管理后臺(tái)接口文檔")
                .termsOfServiceUrl("http://localhost:8090/swagger/doc.html")
                .version("1.0.0")
                .build();
    }
}

這些配置都比較簡單。

第三步spring-mvc.xml文件中，進(jìn)行bean的注冊(cè)：

<bean id="SwaggerConfig" class="xxx.sys.controller.config.SwaggerConfig" />
接下來在web.xml中進(jìn)行配置：
```xml
<filter>
    <filter-name>swaggerProductionFilter</filter-name>
    <filter-class>com.github.xiaoymin.swaggerbootstrapui.filter.ProductionSecurityFilter</filter-class>
    <init-param>
      <param-name>production</param-name>
      <param-value>false</param-value>
    </init-param>
  </filter>
  <filter-mapping>
    <filter-name>swaggerProductionFilter</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>
  <!--Swagger資源的Basic認(rèn)證保護(hù)策略-->
  <filter>
    <filter-name>swaggerSecurityBasic</filter-name>
    <filter-class>com.github.xiaoymin.swaggerbootstrapui.filter.SecurityBasicAuthFilter</filter-class>
    <!--開啟basic認(rèn)證-->
    <init-param>
      <param-name>enableBasicAuth</param-name>
      <param-value>true</param-value>
    </init-param>
    <!--用戶名&密碼-->
    <init-param>
      <param-name>userName</param-name>
      <param-value>123</param-value>
    </init-param>
    <init-param>
      <param-name>password</param-name>
      <param-value>123</param-value>
    </init-param>
  </filter>
  <filter-mapping>
    <filter-name>swaggerSecurityBasic</filter-name>
    <url-pattern>/swagger/*</url-pattern>
  </filter-mapping>

這個(gè)時(shí)候啟動(dòng)，如果訪問xxx/doc.html顯示404，需要配置靜態(tài)資源映射路徑，這邊在config里面一并完成，繼承WebMvcConfigurerAdapter，重寫下面的方法：

 @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/static/**").addResourceLocations("classpath:/static/");
        registry.addResourceHandler("/swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }

還有一點(diǎn)需要注意的：如果配置了shiro等權(quán)限的話，需要將kinfe4j用到的靜態(tài)文件權(quán)限放開：

<bean id="shiroFilter" class="org.apache.shiro.spring.web.ShiroFilterFactoryBean">
        <property name="securityManager" ref="securityManager"/>
        <property name="loginUrl" value="/login"/>
        <property name="successUrl" value="/"/>
        <property name="unauthorizedUrl" value="/login"/>
        <property name="filterChainDefinitions">
            <value>
                /captcha = anon
                /login = authc
                /logout = logout
                /uploadFile = user
                /swagger-ui.html = anon
                /doc.html = anon
                /swagger-resources/** = anon
                /v2/** = anon
                /static/** = anon
                /webjars/** = anon
                /** = user
            </value>
        </property>
        <property name="filters">
            <map>
                <entry key="authc" value-ref="formAuthenticationFilter"/>
            </map>
        </property>
    </bean>

其他類似的權(quán)限校驗(yàn)的組件也是同樣的操作，不再贅述。至此，整合完成。

在實(shí)體類，和接口類配置好相關(guān)的注解后，訪問：