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