SpringMVC整合kinfe4j及问题解决分析

更新时间：2023年09月12日 11:19:23 作者：不减30斤不改名_TC

这篇文章主要为大家介绍了SpringMVC整合kinfe4j及问题解决分析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

引言

以前的SpringMVC代码都是使用showdoc来记录接口文档，正好这次开启一个新项目，准备整合进swagger，以免编写接口文档的痛苦。而前段时间又正好看到很多人使用kinfe4j来替换swagger的文章，索性一步到位用上了kinfe4j。

整合的步骤

现在的项目都是用Spring Boot框架的比较多，而Spring Boot整合kinfe4j网上的文章也比较多，而且相对比较容易，而随着时间的推移，SpringMVC用的越来越少，相对而言资料也越来越少。这次整合也耗费了我半天的时间，下面记录一下整合的步骤及需要注意的问题。

首先导入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("管理后台接口文档")
                .description("管理后台接口文档")
                .termsOfServiceUrl("http://localhost:8090/swagger/doc.html")
                .version("1.0.0")
                .build();
    }
}

这些配置都比较简单。

第三步spring-mvc.xml文件中，进行bean的注册：

<bean id="SwaggerConfig" class="xxx.sys.controller.config.SwaggerConfig" />
接下来在web.xml中进行配置：
```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认证保护策略-->
  <filter>
    <filter-name>swaggerSecurityBasic</filter-name>
    <filter-class>com.github.xiaoymin.swaggerbootstrapui.filter.SecurityBasicAuthFilter</filter-class>
    <!--开启basic认证-->
    <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>

这个时候启动，如果访问xxx/doc.html显示404，需要配置静态资源映射路径，这边在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/");
    }

还有一点需要注意的：如果配置了shiro等权限的话，需要将kinfe4j用到的静态文件权限放开：

<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>

其他类似的权限校验的组件也是同样的操作，不再赘述。至此，整合完成。

在实体类，和接口类配置好相关的注解后，访问：

以上就是SpringMVC整合kinfe4j及问题解决分析的详细内容，更多关于SpringMVC整合kinfe4j的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

解决复制springboot项目后,启动日志无颜色的问题
这篇文章主要介绍了解决复制springboot项目后,启动日志无颜色的问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-07-07
Java中字符序列的替换与分解的几种实现方法
本文主要介绍了Java中字符序列的替换与分解的几种实现方法，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2022-02-02
Java SpringBoot整合SpringCloud
SpringCloud专注于为典型的用例和扩展机制提供良好的开箱即用体验，今天小编就带大家认识SpringCloud都有些什么特点，感兴趣的小伙伴留下来阅读全文吧
2021-09-09
springboot实现跨域的五种方式总结
在Spring Boot中实现跨域,可以采用全局跨域和局部跨域两种方式,下面这篇文章主要给大家介绍了关于springboot实现跨域的五种方式,文中通过代码介绍的非常详细,需要的朋友可以参考下
2024-01-01
java实现人民币大小写转换方法分享
本文介绍java人民币数字大小写转换方法，代码中有注释，大家直接看代码吧
2014-01-01
JAVA中数组从小到大排序的2种方法实例
JAVA中在运用数组进行排序功能时一般有多种解决方案,下面这篇文章主要给大家介绍了关于JAVA中数组从小到大排序的2种方法,文中都给出了详细的实例代码,需要的朋友可以参考下
2023-03-03
Spring集成MongoDB的两种方法实例
最近使用到了Spring框架,考虑到数据的格式并非有固定的字段格式,因此考虑到使用MongoDB非关系型数据库存储数据,所以这篇文章主要给大家介绍了Spring集成MongoDB的两种方法,需要的朋友可以参考下
2021-09-09
Spring注解之@Import注解的使用和源码分析
今天主要介绍Spring @Import注解，在Spring中@Import使用得比较频繁，它得作用是导入bean，具体的导入方式有多种，特别在SpringBoot项目中，很多地方都使用到了@Import注解，感兴趣的小伙伴可以参考阅读
2023-04-04
SpringBoot返回前端Long类型字段丢失精度问题及解决方案
Java服务端返回Long整型数据给前端，JS会自动转换为Number类型，本文主要介绍了SpringBoot返回前端Long类型字段丢失精度问题及解决方案，感兴趣的可以了解一下
2024-03-03
Java中的@Conditional条件注解详细解析
这篇文章主要介绍了Java中的@Conditional条件注解详细解析,@Conditional是Spring4新提供的注解,它的作用是按照一定的条件进行判断,满足条件给容器注册bean,需要的朋友可以参考下
2023-11-11