Swagger2 + Swagger-ui + Spring + SpringMVC + Mybatis整合。代码、实例、图文解析，超详细！！！

写在前面：此处使用Maven来管理依赖，但同时也会给出不使用Maven时需要导入的依赖（花了几天时间整理出来的...）。然后为了呈现一种 往SSM框架中嵌套 Swagger 的感觉，所以待会儿我会先把 SSM框架的配置给完成（完成即指可以直接着手开始DAO、Service、Controller等类的编写，无特殊要求不需要再修改配置文件），然后再开始着手 配置Swagger，这样子可以让你们更了解到 Swagger的嵌套流程，方便大家理解和记忆。

 

1、创建Maven项目：SSM_Swagger_Maven_20200313，并在pom.xml中导入依赖

 

1.1、首先是SSM框架的全部依赖：

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.wnkj.ssm</groupId>
    <artifactId>SSM_Swagger_Maven_20200313</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>war</packaging>

    <!-- 配置编译环境 -->
    <build>
        <plugins>
            <!-- 处理项目JDK编译版本的问题 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
            <!-- 设置maven内置服务器为tomcat7 -->
            <plugin>
                <groupId>org.apache.tomcat.maven</groupId>
                <artifactId>tomcat7-maven-plugin</artifactId>
                <version>2.2</version>
            </plugin>
        </plugins>
    </build>

    <!-- 属性 -->
    <properties>
        <!-- 指定spring的版本 -->
        <spring.version>5.1.9.RELEASE</spring.version>
        <!-- 指定mybatis的版本 -->
        <mybatis.version>3.5.2</mybatis.version>
        <!-- 指定mybatis和spring整合依赖的版本 -->
        <mybatis.spring.version>2.0.2</mybatis.spring.version>
        <!-- 指定mysql数据库的版本 -->
        <mysql.version>8.0.17</mysql.version>
    </properties>

    <!-- 锁定版本 -->
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-webmvc</artifactId>
                <version>${spring.version}</version>
            </dependency>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-web</artifactId>
                <version>${spring.version}</version>
            </dependency>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-context</artifactId>
                <version>${spring.version}</version>
            </dependency>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-aspects</artifactId>
                <version>${spring.version}</version>
            </dependency>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-aop</artifactId>
                <version>${spring.version}</version>
            </dependency>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-beans</artifactId>
                <version>${spring.version}</version>
            </dependency>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-core</artifactId>
                <version>${spring.version}</version>
            </dependency>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-expression</artifactId>
                <version>${spring.version}</version>
            </dependency>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-tx</artifactId>
                <version>${spring.version}</version>
            </dependency>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-jdbc</artifactId>
                <version>${spring.version}</version>
            </dependency>
            <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-orm</artifactId>
                <version>${spring.version}</version>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <!-- 依赖 -->
    <dependencies>
        <!-- servlet-api依赖 -->
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>4.0.1</version>
            <scope>provided</scope>
        </dependency>

        <!-- jsp-api依赖 -->
        <dependency>
            <groupId>javax.servlet.jsp</groupId>
            <artifactId>jsp-api</artifactId>
            <version>2.2</version>
            <scope>provided</scope>
        </dependency>

        <!-- springmvc的依赖 -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>${spring.version}</version>
        </dependency>

        <!-- jstl标签库 -->
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>jstl</artifactId>
            <version>1.2</version>
        </dependency>

        <!-- spring在web.xml进行配置的依赖 -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-web</artifactId>
            <version>${spring.version}</version>
        </dependency>

        <!-- spring的IOC依赖 -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-beans</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-expression</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context-support</artifactId>
            <version>${spring.version}</version>
        </dependency>

        <!-- spring的AOP依赖 -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-aop</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <!-- spring对AspectJ框架的支持 -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-aspects</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>aopalliance</groupId>
            <artifactId>aopalliance</artifactId>
            <version>1.0</version>
        </dependency>
        <!-- 支持注解开发的aop -->
        <dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>aspectjweaver</artifactId>
            <version>1.9.4</version>
        </dependency>

        <!-- spring的声明式事务 -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-tx</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-orm</artifactId>
            <version>${spring.version}</version>
        </dependency>

        <!-- spring单元测试的依赖 -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-test</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <!-- junit测试依赖 -->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.12</version>
        </dependency>
        <!-- junit版本超过4.11，需要手动加hamcrest的依赖 -->
        <dependency>
            <groupId>org.hamcrest</groupId>
            <artifactId>hamcrest-core</artifactId>
            <version>1.3</version>
            <scope>test</scope>
        </dependency>

        <!-- mybatis框架的核心依赖 -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>${mybatis.version}</version>
        </dependency>
        <!-- mybatis框架的其他依赖
            mybatis版本3.4.x以上，已经自动整合了下面的部分依赖了
         -->
        <!-- <dependency>
            <groupId>org.ow2.asm</groupId>
            <artifactId>asm</artifactId>
            <version>7.1</version>
        </dependency>
        <dependency>
            <groupId>cglib</groupId>
            <artifactId>cglib</artifactId>
            <version>3.3.0</version>
        </dependency>
        <dependency>
            <groupId>org.javassist</groupId>
            <artifactId>javassist</artifactId>
            <version>3.25.0-GA</version>
        </dependency> -->
        <!-- debug或日志依赖 -->
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-api</artifactId>
            <version>2.12.1</version>
        </dependency>
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-core</artifactId>
            <version>2.12.1</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>1.8.0-beta4</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-log4j12</artifactId>
            <version>1.8.0-beta4</version>
        </dependency>

        <!-- mybatis和spring整合的依赖 -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis-spring</artifactId>
            <version>${mybatis.spring.version}</version>
        </dependency>

        <!-- dbcp连接池的依赖 -->
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-dbcp2</artifactId>
            <version>2.7.0</version>
        </dependency>
        <!-- dbcp连接池的其他依赖 -->
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-pool2</artifactId>
            <version>2.7.0</version>
        </dependency>
        <dependency>
            <groupId>commons-logging</groupId>
            <artifactId>commons-logging</artifactId>
            <version>1.2</version>
        </dependency>

        <!-- mysql数据库驱动 -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>${mysql.version}</version>
        </dependency>

    </dependencies>

</project>

 

1.2、其次加入支持Restful风格的请求URL的依赖

        <!-- jackson，用于RESTful风格的请求url
            其中jackson-databind是主要，其他依赖通常会作为辅助依赖自动加入-->
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-core</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-annotations</artifactId>
            <version>2.9.0</version>
        </dependency>
        <dependency>
            <groupId>org.codehaus.jackson</groupId>
            <artifactId>jackson-mapper-asl</artifactId>
            <version>1.9.13</version>
        </dependency>
        <dependency>
            <groupId>org.codehaus.jackson</groupId>
            <artifactId>jackson-core-asl</artifactId>
            <version>1.9.13</version>
        </dependency>

1.3、最后加入Swagger2框架的依赖

之所以前面需要加入支持Restful风格的请求URL，是因为Swagger框架仅支持Restful风格的请求方式。

下面是Swagger2框架的依赖。

        <!-- swagger2核心依赖，必须同时导入支持Restful风格的请求url的依赖 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <!-- swagger-ui为项目提供api展示及测试的界面 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

1.4、如果你不使用Maven，则请自行下载jar包，链接我下面也有，或者自己找找

如果被屏蔽，自己在浏览器打开。

SSM框架的全部依赖     提取码：b0y8

https://pan.baidu.com/s/1Qiufb3_xjmFd__i2OKs5YA

支持Restful风格的请求URL的依赖    提取码：wqbb

https://pan.baidu.com/s/1QPmqYD82SA0L4IahpJazXg

   jar包如下：

Swagger2框架的依赖    提取码：vih4

https://pan.baidu.com/s/1ZBoqZOW2Zjm8q7pmCKgnTA

   jar包如下：

2、在src/main/java目录下创建好各个层的包，如下所示

包名根据自己习惯来。

 

3、在resources目录下准备属性文件和各个框架的配置文件

 

3.1、创建属性文件，填写数据库的参数配置：dbConfig.properties

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC&useSSL=false&allowMultiQueries=true
jdbc.username=root
jdbc.password=dearest

3.2、创建属性文件，用于控制台打印日志记录：log4j.properties

# Global logging configuration
log4j.rootLogger=DEBUG, stdout
# Console output...
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n

 

3.3、创建mybatis目录，在其中准备Mybatis框架的配置文件：mybatis-config.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <!-- 控制台打印sql语句 -->
    <settings>
        <setting name="logImpl" value="STDOUT_LOGGING"></setting>
    </settings>

</configuration>

顺便在mybatis目录下，再创建mapper目录，主要用作存储mapper映射文件的目录。

 

3.4、创建spring目录，在其中准备Spring框架的配置文件

 

3.4.1、applicationContext-main.xml

该Spring配置文件主要用于读取属性文件

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="
       http://www.springframework.org/schema/beans  
       http://www.springframework.org/schema/beans/spring-beans.xsd">

    <!-- PropertyPlaceholderConfigurer类可批量读取属性文件 -->
    <bean class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
        <property name="locations">
            <list>
                <value>classpath:dbConfig.properties</value>
            </list>
        </property>
    </bean>

</beans>

3.4.2、applicationContext-dao.xml

该Spring配置文件主要配置DAO层

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="
       http://www.springframework.org/schema/beans  
       http://www.springframework.org/schema/beans/spring-beans.xsd">

    <!-- 会话工厂 -->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <!-- 用于指定mybatis框架的全局配置文件所在路径 -->
        <property name="configLocation" value="classpath:mybatis/mybatis-config.xml" />
        <!-- 用于指定mapper映射文件所在路径 -->
        <property name="mapperLocations" value="classpath:mybatis/*/*.xml" />
        <!-- 用于指定某个包路径下的类型可在mapper映射文件中使用别名 -->
        <property name="typeAliasesPackage" value="com.wnkj.ssm.entity" />
        <!-- 用于指定数据源 -->
        <property name="dataSource" ref="dataSource" />
    </bean>

    <!-- 数据源 -->
    <bean id="dataSource" class="org.apache.commons.dbcp2.BasicDataSource">
        <!-- 用于指定Driver的驱动类型 -->
        <property name="driverClassName" value="${jdbc.driver}" />
        <!-- 用于指定用于连接数据库的url -->
        <property name="url" value="${jdbc.url}" />
        <!-- 用于指定用于连接数据库的用户名 -->
        <property name="username" value="${jdbc.username}" />
        <!-- 用于指定用于连接数据库的密码 -->
        <property name="password" value="${jdbc.password}" />
    </bean>

    <!-- mapper接口批量扫描器 -->
    <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <!-- 用于指定mapper接口所在的包路径 -->
        <property name="basePackage" value="com.wnkj.ssm.dao" />
        <!-- 用于关联会话工厂实例 -->
        <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory" />
    </bean>

</beans>

3.4.3、applicationContext-service.xml

该Spring配置文件主要配置Service层

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="
       http://www.springframework.org/schema/beans  
       http://www.springframework.org/schema/beans/spring-beans.xsd 
       http://www.springframework.org/schema/context  
       http://www.springframework.org/schema/context/spring-context.xsd">

    <!-- 用于扫描指定包路径下的注解 -->
    <context:component-scan base-package="com.wnkj.ssm.service" />

</beans>

3.4.4、applicationContext-transaction.xml

该Spring配置文件主要配置事务管理

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:aop="http://www.springframework.org/schema/aop"
       xmlns:tx="http://www.springframework.org/schema/tx"
       xsi:schemaLocation="
       http://www.springframework.org/schema/beans  
       http://www.springframework.org/schema/beans/spring-beans.xsd 
       http://www.springframework.org/schema/aop
       http://www.springframework.org/schema/aop/spring-aop.xsd
       http://www.springframework.org/schema/tx  
       http://www.springframework.org/schema/tx/spring-tx.xsd">

    <!-- 事务管理器 -->
    <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
        <!-- 用于指定数据源 -->
        <property name="dataSource" ref="dataSource" />
    </bean>

    <!-- 事务驱动器 -->
    <tx:advice id="txAdvice" transaction-manager="transactionManager">
        <!-- 事务属性 -->
        <tx:attributes>
            <!-- 事务的传播行为 -->
            <tx:method name="find*" propagation="SUPPORTS" read-only="true" />
            <tx:method name="query*" propagation="SUPPORTS" read-only="true" />
            <tx:method name="select*" propagation="SUPPORTS" read-only="true" />
            <tx:method name="insert*" propagation="REQUIRED" read-only="false" />
            <tx:method name="add*" propagation="REQUIRED" read-only="false" />
            <tx:method name="edit*" propagation="REQUIRED" read-only="false" />
            <tx:method name="update*" propagation="REQUIRED" read-only="false" />
            <tx:method name="delete*" propagation="REQUIRED" read-only="false" />
        </tx:attributes>
    </tx:advice>

    <!-- aop切面配置 -->
    <aop:config>
        <!-- 配置切点 -->
        <aop:pointcut id="cut" expression="execution(* com.wnkj.ssm.service.*.*(..))" />
        <!-- 关联切点和切面（事务驱动器） -->
        <aop:advisor advice-ref="txAdvice" pointcut-ref="cut" />
    </aop:config>

    <!-- 事物注解驱动：用于支持注解型事务，即在类和方法上使用注解来配置事务
            若使用该标签，则上面的<tx:advice>和<aop:config>均可省略 -->
    <!--<tx:annotation-driven transaction-manager="transactionManager" />-->

</beans>

3.4.5、applicationContext-mvc.xml

该spring配置文件主要配置Controller层，即SpringMVC的配置文件。

此处没配置视图解析器，是因为当用作接口项目时，无需渲染为视图，直接返回数据而已。

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xsi:schemaLocation="
       http://www.springframework.org/schema/beans  
       http://www.springframework.org/schema/beans/spring-beans.xsd 
       http://www.springframework.org/schema/context  
       http://www.springframework.org/schema/context/spring-context.xsd 
       http://www.springframework.org/schema/mvc
       http://www.springframework.org/schema/mvc/spring-mvc.xsd">

    <!-- 扫描包路径下的注解 -->
    <context:component-scan base-package="com.wnkj.ssm.web.controller" />

    <!-- mvc注解驱动，可代替适配器映射器和适配器处理器 -->
    <mvc:annotation-driven />

</beans>

 

4、配置web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">

    <!-- Spring框架中用于处理POST乱码的过滤器，与此处Swagger无关，可有可无 -->
    <filter>
        <filter-name>characterEncoding</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        <init-param>
            <param-name>encoding</param-name>
            <param-value>utf-8</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>characterEncoding</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>


    <!-- 配置上下文参数，指定Spring框架的配置文件所在路径 -->
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:spring/applicationContext-*.xml</param-value>
    </context-param>
    <!-- 配置Spring框架的监听器，用于加载上下文参数所指定的Spring配置文件 -->
    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>


    <!-- SpringMVC框架的前端控制器 -->
    <servlet>
        <servlet-name>dispatcherServlet</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <!-- 初始化参数，用于指定SpringMVC框架的配置文件所在路径 -->
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:spring/applicationContext-mvc.xml</param-value>
        </init-param>
    </servlet>
    <!-- 为了支持Restful风格的请求URL，此处的URL映射格式必须为：/ -->
    <servlet-mapping>
        <servlet-name>dispatcherServlet</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

</web-app>

 

至此，我们的SSM框架全部配置完成，下面开始着手配置Swagger2框架，使其嵌入到我们的SSM框架中。

下面是目前的项目结构图，可以看看有没有什么遗漏的。

 

5、导框架的依赖

由于图方便，前面导SSM框架的时候，我们已经把依赖顺便给导入了，所以此步骤就可以跳过了。

日常开发中，要使用Swagger嵌入到我们的项目，也是从这一步骤开始，因此从这里开始，就需要开始记忆了。

 

6、创建Swagger框架的配置类：SwaggerConfig.java

创建一个包名为swagger，然后在其中创建配置类，类名自定义。

package com.wnkj.ssm.swagger;

import org.springframework.context.annotation.Bean;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())  //显示所有类
                //.apis(RequestHandlerSelectors.withClassAnnotation(Api.class))  //只显示添加@Api注解的类
                .build()
                .apiInfo(apiInfo());
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Swagger2框架的测试接口API")  //大标题
                .description("对外开放接口")   //标题描述
                .version("1.0.0")   //当前API版本
                .termsOfServiceUrl("http://xxx.xxx.com")
                .license("作者的CSDN博客首页")   //链接名称
                .licenseUrl("https://blog.csdn.net/weixin_43978412")   //链接地址
                .build();
    }

}

 

7、在applicationContext-mvc.xml配置文件中注册该配置类

<!-- Swagger2框架的配置类 -->
<bean class="com.wnkj.ssm.swagger.SwaggerConfig" />

  代码如下：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xsi:schemaLocation="
       http://www.springframework.org/schema/beans  
       http://www.springframework.org/schema/beans/spring-beans.xsd 
       http://www.springframework.org/schema/context  
       http://www.springframework.org/schema/context/spring-context.xsd 
       http://www.springframework.org/schema/mvc
       http://www.springframework.org/schema/mvc/spring-mvc.xsd">

    <!-- 扫描包路径下的注解 -->
    <context:component-scan base-package="com.wnkj.ssm.web.controller" />

    <!-- mvc注解驱动，可代替适配器映射器和适配器处理器 -->
    <mvc:annotation-driven />
    
    <!-- Swagger2框架的配置类 -->
    <bean class="com.wnkj.ssm.swagger.SwaggerConfig" />

</beans>

 

 

8、在applicationContext-mvc.xml中配置支持访问swagger-ui框架的静态资源

 提示：前面我们导入的  springfox-swagger-ui-2.9.2.jar 包，其中包含swagger-ui内置的静态资源页面，为了使我们能访问到其内置的静态资源，我们需要在applicationContext-mvc.xml中配置允许访问swagger-ui框架的静态资源。

    <!-- 配置允许访问swagger-ui框架的静态资源 -->
    <mvc:resources mapping="/swagger-ui.html" location="classpath:META-INF/resources/" />
    <mvc:resources mapping="/webjars/**" location="classpath:META-INF/resources/webjars/"/>

当我们访问的URL为：http://localhost:8080/项目名/xxx.html 时，如果  mapping = “/swagger-ui.html”  ，那么当且仅当 xxx.html 等于 swagger-ui.html 的时候，会将其映射到项目中的真实路径，即location指定的路径，此时  location = "classpath:META-INF/resources/" ，那么就会映射到类路径下的 META-INF/resources 目录下去找寻 swagger-ui.html

代码如下：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xsi:schemaLocation="
       http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd
       http://www.springframework.org/schema/context
       http://www.springframework.org/schema/context/spring-context.xsd
       http://www.springframework.org/schema/mvc
       http://www.springframework.org/schema/mvc/spring-mvc.xsd">

    <!-- 扫描包路径下的注解 -->
    <context:component-scan base-package="com.wnkj.ssm.web.controller" />

    <!-- mvc注解驱动，可代替适配器映射器和适配器处理器 -->
    <mvc:annotation-driven />

    <!-- Swagger2框架的配置类 -->
    <bean class="com.wnkj.ssm.swagger.SwaggerConfig" />

    <!-- 配置允许访问swagger-ui框架的静态资源 -->
    <mvc:resources mapping="/swagger-ui.html" location="classpath:META-INF/resources/" />
    <mvc:resources mapping="/webjars/**" location="classpath:META-INF/resources/webjars/"/>

</beans>

至此，整合完成。下面开始测试。

 

9、测试阶段

 

9.1、创建实体类：User.java

 在com.wnkj.ssm.entity包中创建实体类：User.java

package com.wnkj.ssm.entity;

import java.io.Serializable;

public class User implements Serializable {
    private String user_id;
    private String username;
    private String password;
    private String name;
    private String descent;
    private String creation_time;

    public User() {
    }

    public User(String user_id, String username, String password, String name, String descent, String creation_time) {
        this.user_id = user_id;
        this.username = username;
        this.password = password;
        this.name = name;
        this.descent = descent;
        this.creation_time = creation_time;
    }

    public String getUser_id() {
        return user_id;
    }

    public void setUser_id(String user_id) {
        this.user_id = user_id;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getDescent() {
        return descent;
    }

    public void setDescent(String descent) {
        this.descent = descent;
    }

    public String getCreation_time() {
        return creation_time;
    }

    public void setCreation_time(String creation_time) {
        this.creation_time = creation_time;
    }
}

 

 

9.2、创建mapper映射文件：UserMapper.xml

  在resources目录下的mybatis/mapper目录中创建mapper映射文件：UserMapper.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.wnkj.ssm.dao.UserMapper">
    <!-- 数据表名称 -->
    <sql id="table">
        user
    </sql>
    
    <!-- 数据表字段 -->
    <sql id="Field">
        user_id,
        username,
        password,
        name,
        descent,
        creation_time
    </sql>

    <!-- 数据表字段值 -->
    <sql id="FieldValue">
        #{user_id},
        #{username},
        #{password},
        #{name},
        #{descent},
        #{creation_time}
    </sql>

    <!-- 按用户ID查询用户 -->
    <select id="findById" parameterType="java.lang.String" resultType="User">
        SELECT
        <include refid="Field" />
        FROM
        <include refid="table" />
        WHERE
        user_id = #{user_id}
    </select>

    <!-- 查询所有用户 -->
    <select id="findAll" resultType="User">
        SELECT
            <include refid="Field" />
        FROM
            <include refid="table" />
        ORDER BY descent ASC
    </select>

    <!-- 新增用户 -->
    <insert id="add" parameterType="User">
        INSERT INTO
            <include refid="table" />
        (
            <include refid="Field" />
        ) VALUE (
            <include refid="FieldValue" />
        )
    </insert>

    <!-- 更新用户 -->
    <update id="edit" parameterType="User">
        UPDATE
            <include refid="table" />
        SET
            username = #{username},
            password = #{password},
            name = #{name},
            descent = #{descent},
            creation_time = #{creation_time},
            user_id = #{user_id}
        WHERE
            user_id = #{user_id}
    </update>

    <!-- 删除用户 -->
    <delete id="remove" parameterType="java.lang.String">
        DELETE FROM
            <include refid="table" />
        WHERE
            user_id = #{user_id}
    </delete>

</mapper>

 

9.3、创建持久层接口：UserMapper.java

在com.wnkj.ssm.dao包路径下创建持久层接口：UserMapper.java

package com.wnkj.ssm.dao;

import com.wnkj.ssm.entity.User;

import java.util.List;

/**
 * 用户模块的持久层接口
 */
public interface UserMapper {

    /**
     * 按用户ID查询用户
     * @param user_id
     * @return
     * @throws Exception
     */
    public User findById(String user_id) throws Exception;

    /**
     * 查询所有用户
     * @return
     * @throws Exception
     */
    public List<User> findAll() throws Exception;

    /**
     * 新增用户
     * @param user
     * @throws Exception
     */
    public void add(User user) throws Exception;

    /**
     * 更新用户
     * @param user
     * @throws Exception
     */
    public void edit(User user) throws Exception;

    /**
     * 删除用户
     * @param user_id
     * @throws Exception
     */
    public void remove(String user_id) throws Exception;

}

9.4、创建业务层接口和业务层实现类

在com.wnkj.ssm.service包路径下创建业务层接口：UserManager.java

在com.wnkj.ssm.service.impl包路径下创建业务层实现类：UserService.java

9.4.1、业务层接口：UserManager.java

package com.wnkj.ssm.service;

import com.wnkj.ssm.entity.User;

import java.util.List;

/**
 * 用户模块的业务层接口
 */
public interface UserManager {
    /**
     * 按用户ID查询用户
     * @param user_id
     * @return
     * @throws Exception
     */
    public User findById(String user_id) throws Exception;

    /**
     * 查询所有用户
     * @return
     * @throws Exception
     */
    public List<User> findAll() throws Exception;

    /**
     * 新增用户
     * @param user
     * @throws Exception
     */
    public void add(User user) throws Exception;

    /**
     * 更新用户
     * @param user
     * @throws Exception
     */
    public void edit(User user) throws Exception;

    /**
     * 删除用户
     * @param user_id
     * @throws Exception
     */
    public void remove(String user_id) throws Exception;
}

9.4.2、业务层实现类：UserService.java

package com.wnkj.ssm.service.impl;

import com.wnkj.ssm.dao.UserMapper;
import com.wnkj.ssm.entity.User;
import com.wnkj.ssm.service.UserManager;
import org.springframework.stereotype.Service;

import javax.annotation.Resource;
import java.util.List;

/**
 * 用户模块的业务层实现类
 */
@Service(value = "userService")
public class UserService implements UserManager {

    /**
     * 持久层实例及依赖注入
     */
    @Resource(name = "userMapper")
    private UserMapper userMapper;

    /**
     * 按用户ID查询用户
     * @param user_id
     * @return
     * @throws Exception
     */
    public User findById(String user_id) throws Exception {
        return userMapper.findById(user_id);
    }

    /**
     * 查询所有用户
     * @return
     * @throws Exception
     */
    public List<User> findAll() throws Exception {
        return userMapper.findAll();
    }

    /**
     * 新增用户
     * @param user
     * @throws Exception
     */
    public void add(User user) throws Exception {
        userMapper.add(user);
    }

    /**
     * 更新用户
     * @param user
     * @throws Exception
     */
    public void edit(User user) throws Exception {
        userMapper.edit(user);
    }

    /**
     * 删除用户
     * @param user_id
     * @throws Exception
     */
    public void remove(String user_id) throws Exception {
        userMapper.remove(user_id);
    }

}

 

9.5、创建控制器类：UserController.java

package com.wnkj.ssm.web.controller;

import com.wnkj.ssm.entity.User;
import com.wnkj.ssm.service.UserManager;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiResponse;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;

import javax.annotation.Resource;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.List;
import java.util.UUID;

/**
 * 用户模块的控制器
 */
@Controller
@RequestMapping(value = "/user")
@Api(value = "UserController", tags = "用户模块的API")
public class UserController {

    /**
     * 业务层实例及依赖注入
     */
    @Resource(name = "userService")
    private UserManager userService;

    /**
     * 按用户ID查询用户
     * @param user_id
     * @return
     * @throws Exception
     */
    @RequestMapping(value = "/findById/{user_id}", method = RequestMethod.GET)
    @ApiOperation(value = "按用户ID查询用户", notes = "按用户ID查询用户", httpMethod = "GET", response = User.class)
    public ResponseEntity<User> findById(@PathVariable String user_id) throws Exception {
        User user = userService.findById(user_id);

        return ResponseEntity.ok(user);
    }

    /**
     * 查询所有用户
     * @return
     * @throws Exception
     */
    @RequestMapping(value = "/findAll", method = RequestMethod.GET)
    @ApiOperation(value = "查询所有用户信息", notes = "查询所有用户信息", httpMethod = "GET", response = User.class, responseContainer = "List")
    public ResponseEntity<List<User>> findAll() throws Exception {

        List<User> userList = userService.findAll();

        return ResponseEntity.ok(userList);
    }

    /**
     * 新增用户
     * @param username
     * @param password
     * @param name
     * @param descent
     * @return
     * @throws Exception
     */
    @RequestMapping(value = "/add", method = RequestMethod.POST)
    @ApiOperation(value = "新增用户", notes = "新增用户", httpMethod = "POST", response = String.class)
    @ApiResponse(code = 404, message = "找不到相关资源或链接")
    public ResponseEntity<String> add(String username,
                                      String password,
                                      String name,
                                      String descent) throws Exception {
        String errorMsg = null;

        if("".equals(username) || username == null || username.trim().isEmpty()) {
            errorMsg = "USERNAME CAN NOT BE EMPTY!!!";
            return ResponseEntity.ok(errorMsg);
        }

        if("".equals(password) || password == null || password.trim().isEmpty()) {
            errorMsg = "PASSWORD CAN NOT BE EMPTY!!!";
            return ResponseEntity.ok(errorMsg);
        }

        if("".equals(name) || name == null || name.trim().isEmpty()) {
            errorMsg = "NAME CAN NOT BE EMPTY!!!";
            return ResponseEntity.ok(errorMsg);
        }

        if("".equals(descent) || descent == null || descent.trim().isEmpty()) {
            errorMsg = "DESCENT CAN NOT BE EMPTY!!!";
            return ResponseEntity.ok(errorMsg);
        }

        String user_id = UUID.randomUUID().toString().replace("-", "").toUpperCase();
        String creation_time = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date());

        User user = new User();
        user.setUser_id(user_id);
        user.setUsername(username);
        user.setPassword(password);
        user.setName(name);
        user.setDescent(descent);
        user.setCreation_time(creation_time);

        userService.add(user);

        return ResponseEntity.ok("NEW SUCCESS!!!");
    }

    /**
     * 更新用户
     * @param user
     * @return
     * @throws Exception
     */
    @RequestMapping(value = "/edit", method = RequestMethod.PUT)
    @ApiOperation(value = "更新用户信息", notes = "更新用户信息", httpMethod = "PUT", response = String.class)
    public ResponseEntity<String> edit(String user_id,
                                       String username,
                                       String password,
                                       String name,
                                       String descent) throws Exception {

        String errorMsg = null;

        if("".equals(user_id) || user_id == null || user_id.trim().isEmpty()) {
            errorMsg = "THE USER_ID OF THE USER TO BE DELETED CAN NOT BE EMPTY!!!";
            return ResponseEntity.ok(errorMsg);
        }

        User originalUser = userService.findById(user_id);
        if(originalUser == null) {
            errorMsg = "THE USER CORRESPONDING TO THE USER ID DOES NOT EXIST!!!";
            return ResponseEntity.ok(errorMsg);
        }

        User user = new User();
        user.setUser_id(user_id);
        user.setUsername(username);
        user.setPassword(password);
        user.setName(name);
        user.setDescent(descent);
        user.setCreation_time(originalUser.getCreation_time());

        userService.edit(user);

        return ResponseEntity.ok("UPDATE COMPLETED!!!");
    }

    /**
     * 根据用户ID删除用户信息
     * @param user_id
     * @return
     * @throws Exception
     */
    @RequestMapping(value = "/remove/{user_id}", method = RequestMethod.DELETE)
    @ApiOperation(value = "按用户ID删除用户", notes = "按用户ID删除用户", httpMethod = "DELETE", response = String.class)
    public ResponseEntity<String> remove(@PathVariable String user_id) throws Exception {

        String errorMsg = null;

        if("".equals(user_id) || user_id == null || user_id.trim().isEmpty()) {
            errorMsg = "要删除的用户ID不能为空！";
            return ResponseEntity.ok(errorMsg);
        }

        userService.remove(user_id);

        return ResponseEntity.ok("SUCCESSFULLY DELETED!!!");
    }
}

 

10、启动Tomcat，浏览器进行测试

浏览器输入：http://localhost:8080/SSM_Swagger_Maven_20200313/swagger-ui.html 进行访问。

格式：http://{ip地址}:{端口号}/项目名称/swagger-ui.html

 

至此，整合完成，比较啰嗦，但我希望因此能使一些刚接触swagger的朋友能少走弯路！

项目源码在下面，有兴趣可以拉下来了解一下，有问题及时沟通。

项目源码：https://pan.baidu.com/s/1dKEviPBbADD_mdeffKSEoA     提取码：p1q7

https://pan.baidu.com/s/1dKEviPBbADD_mdeffKSEoA