前後臺分離式開發(swagger)

来源:https://www.cnblogs.com/Harriss/archive/2019/04/23/10755091.html
-Advertisement-
Play Games

這裡演示的是前期框架的搭建,剩下的Controller就很簡單了 ...


一.前後臺分離開發(swagger)

1.安裝maven

  配置的maven環境變數   

    M2_HOME/MAVEN_HOME

    Path

      %M2_HOME%/bin

    打開運行視窗:輸入mvn -v,查看是否安裝好。

  settings中的設置倉庫的位置,倉庫我已經給出,在我的百度網盤下載即可   

      鏈接:https://pan.baidu.com/s/193SKtpG62Fyq3vQgTgPgGA

      提取碼:ksa5

2.eclipse中配置maven

  eclipse中配置maven,配置過程在網上搜索“eclipse maven配置過程”,這裡不在詳述

  jdk配置這裡不再詳述,在網上搜索即可

3.eclipse更改jdk環境

      

4.創建項目,引入的依賴,暫時引入基本的幾個依賴

  註:整個項目的創建過程必須在聯網狀態,他會自動下載些依賴和jar

      

5.在項目中新建以下幾個包,用於存放自動生成的bean類、映射介面和映射文件

      

6.插入文件generatorConfig.xml,代碼如下

         

  註:代碼中有幾個地方需要更改

    在第七行是自己配置的倉庫中的jar包,註意路徑別寫錯了。

    jdbcConnection標簽的屬性需要更改,填寫自己的遠程或者本地的mysql資料庫

     javaModelGenerator標簽的targetPackage屬性要更改(存放自動生成的bean類)
     sqlMapGenerator,標簽的屬性targetPackage值要更改(自動生成的*Mapper.xml文件存放路徑
   javaClientGenerator標簽屬性targetPackage值要更改(自動生成的*Mapper.java存放路徑)
   在最後的映射配置塊中:根據資料庫中表以及業務邏輯情況自動生成bean類、映射介面和映射文件
 1 <?xml version="1.0" encoding="UTF-8"?>
 2 <!DOCTYPE generatorConfiguration
 3   PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
 4   "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
 5 <!-- mybatis-generator的核心配置文件 -->
 6 <generatorConfiguration>
 7   <classPathEntry location="D:\android\repository\mysql\mysql-connector-java\8.0.15\mysql-connector-java-8.0.15.jar" />
 8 
 9   <context id="DB2Tables" targetRuntime="MyBatis3">
10 
11     <!--自己的遠程或者本地的mysql伺服器-->
12     <jdbcConnection driverClass="com.mysql.jdbc.Driver"
13                     connectionURL="jdbc:mysql://127.0.0.1:3306/course" 
14                     userId="root"
15                     password="root">
16       <property name="useInformationSchema" value="true"/>
17     </jdbcConnection>
18     <!--指定生成的類型為java類型,避免資料庫中number等類型欄位 -->
19     <javaTypeResolver >
20       <property name="forceBigDecimals" value="false" />
21     </javaTypeResolver>
22 
23     <!--自動生成的實體的存放包路徑 -->
24     <javaModelGenerator targetPackage="com.briup.apps.app01.bean" targetProject="./src/main/java">
25       <property name="enableSubPackages" value="true" />
26       <property name="trimStrings" value="true" />
27     </javaModelGenerator>
28 
29     <!--自動生成的*Mapper.xml文件存放路徑 -->
30     <sqlMapGenerator targetPackage="mapper"  targetProject="./src/main/resources">
31       <property name="enableSubPackages" value="true" />
32     </sqlMapGenerator>
33 
34     <!--自動生成的*Mapper.java存放路徑 -->
35     <javaClientGenerator type="XMLMAPPER" targetPackage="com.briup.apps.app01.mapper"  targetProject="./src/main/java">
36       <property name="enableSubPackages" value="true" />
37     </javaClientGenerator>
38 
39     
40     <!-- 映射配置 -->
41     <table tableName="c_user" domainObjectName="User" ></table>
42     <table tableName="c_course" domainObjectName="Course" ></table>
43     <table tableName="c_student_course" domainObjectName="StudentCourse" ></table>
44 
45   </context>
46 </generatorConfiguration>

 7.在pom.xml文件中添加依賴、添加插件

    在<build>中的<plugins>標簽中添加mybatis-generator插件,代碼如下:

<plugin>
     <groupId>org.mybatis.generator</groupId>
     <artifactId>mybatis-generator-maven-plugin</artifactId>
     <version>1.3.5</version>
</plugin>

    dependencys標簽中添加swagger2的依賴,代碼如下:

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.6.1</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.6.1</version>
</dependency>

 Ctrl+s保存,等eclipse最下方的進度條完了之後在進行下一步操作。

    

8.修改application.properties

#本地
#spring.datasource.driverClassName=com.mysql.jdbc.Driver
#spring.datasource.url=jdbc:mysql://localhost:3306/course?serverTimezone=UTC
#spring.datasource.username=root
#spring.datasource.password=root

#遠程
spring.datasource.driverClassName=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://*.*.*.*:3306/course?useUnicode=true&characterEncoding=utf-8
spring.datasource.username=root
spring.datasource.password=root

server.port=8888

mybatis.mapper-locations= classpath:/mapper/**/*.xml 

 9.打開命令視窗,執行generatorConfig.xml文件

  mvn -Dmybatis.generator.overwrite=true mybatis-generator:generate

   

  相應的目錄中會生成相應的beanmapper映射文件

  ......

10.創建Swagger2配置類

1)config包中創建Swagger2的配置類Swagger2

      

@Configuration
@EnableSwagger2
public class Swagger2 {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.briup.apps.app01.web"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Spring Boot中使用Swagger2構建RESTful APIs")
                .description("更多Spring Boot相關文章請關註:http://blog.didispace.com/")
                .termsOfServiceUrl("http://blog.didispace.com/")
                .contact("程式猿DD")
                .version("1.0")
                .build();
    }
}

   如上代碼所示,通過@Configuration註解,讓Spring來載入該類配置。再通過@EnableSwagger2註解來啟用Swagger2.

再通過createRestApi函數創建Docket的Bean之後,apiInfo()用來創建該Api的基本信息(這些基本信息會展現在文檔頁面中)

2)添加文檔內容(後期的業務邏輯中,首次框架搭建這裡可以跳過)

  在controller中使用註解

  @ApiOperation註解來給API增加說明

  @ApiImplicitParams、@ApiImplicitParam註解來給參數增加說明

  如下截圖所示

  

11.添加@MapperScan註釋的類(用戶掃描mapper包下的所有mapper映射介面類)

          

 

  代碼如下

package com.briup.apps.app01.config;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Configuration;

@Configuration
//掃面com.briup.apps.app01.mapper包下的所有的mapper映射介面 @MapperScan(
"com.briup.apps.app01.mapper") public class MybatisConfig { }

12.運行項目:mvn spring-boot:run

    

    打開瀏覽器測試是否運行成功。

    

13.項目打包

  如果項目要進行打包,這裡打成war包,

1)pom.xml文件中更改包的類型

    

2).pom.xml文件中添加跳過測試

    

3).打包

    Goals中輸入:package

      

  得到包:

      

  運行測試包

     

4).打開瀏覽器進行測試,是否成功

    


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 轉自:https://www.cnblogs.com/kidsitcn/p/7182274.html 比例尺函數是這樣的javascript函數: 接收通常是數字,日期,類別等data輸入並且: 返回一個代表可視化元素的值,比如坐標,顏色,長度或者半徑等 比例尺通常用於變換(或者說映射)抽象的數據值 ...
  • 做法就是使用iframe標簽 1.text,pdf的文件預覽 <iframe class="filename" :src="文件的地址" width='100%' height='600' frameborder='1' ></iframe> 2.doc,xls,ppt等office的預覽 <ifr ...
  • 一、對象的擴展 1.1對象屬性名錶達式 ES6可以在JSON中使用[]包裹一個key的名字。此時這個key將用表達式作為屬性名(被當做變數求值),這個key值必須是字元串。 1.2 Object.assign()方法 該方法用於對象的合併,將源對象的所有可枚舉的屬性,複製到目標對象。 Object. ...
  • 譯者按: 為什麼偏要用 符號? 原文 : "JavaScript's new private class fields" 譯者 : "Fundebug" 本文采用意譯,版權歸原作者所有 "proposal class fields" 與 "proposal private methods" 定義了 ...
  • 文章首發: "結構型模式:組合模式" 七大結構型模式之三:組合模式。 簡介 姓名 :組合模式 英文名 :Composite Pattern 價值觀 :專門解決各種樹形疑難雜症 個人介紹 : Compose objects into tree structures to represent part ...
  • 1 三次作業的設計策略 經過了上一單元的訓練,我也積累了一些設計策略上的經驗。在這一單元的一開始,我便儘可能地把問題中的各個功能實體區分開來,分別封裝成類,以便於隨後作業中新需求的加入。與此同時,我也在有意地控制住方法的規模,依照程式邏輯層次化地設計方法,使得每個方法都不至於過分臃腫,從而增加代碼的 ...
  • 1. " java爬蟲系列第一講 爬蟲入門(爬取動作片列表)" 2. " java爬蟲系列第二講 爬取最新動作電影《海王》迅雷下載地址" 3. " java爬蟲系列第三講 獲取頁面中絕對路徑的各種方法" 4. " java爬蟲系列第四講 採集"極客時間"專欄文章、視頻專輯" 5. "java爬蟲系列 ...
  • [TOC] 電梯作業總結 程式結構與複雜度的分析 第一次作業 1.設計思路 第一次作業是電梯作業的第一次,也是我多線程變成的第一次實踐。任務是編寫一個多線程實時電梯系統,採用FAFS的調度方式。由於第一次作業中沒有涉及到多部電梯以及捎帶的情況,因此來說是比較簡單的。我採用的是指導書提示部分中的模式, ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...