跳到主要內容

多應用下 Swagger 的使用，這可能是最好的方式!

問題


微服務化的時代，我們整個項目工程下面都會有很多的子系統，對於每個應用都有暴露 Api 接口文檔需要，這個時候我們就會想到 Swagger 這個優秀 jar 包。但是我們會遇到這樣的問題，假如說我們有5個應用，難道說我們每個模塊下面都要去引入這個 jar 包嗎？我作為一個比較懶的程序感覺這樣好麻煩，於是乎我思考了一種我認為比較好的方式，如果大家覺得有什麼不太好的地方希望指正，謝謝！


基礎


開始之前大家首先要了解一些基礎，主要有以下幾個方面:



  1. 單應用下 Swagger 的集成與使用

  2. 條件裝配 @Conditional 介紹

  3. 配置文件參數獲取 @ConfigurationProperties


單體應用下 Swagger 集成與使用

關於這部分從3方面講起分別是：什麼是、為什麼、如何用


什麼是 Swagger ？

Swagger 是一個規範且完整的框架，用於生成、描述、調用和可視化 RESTful 風格的 Web 服務。


為什麼使用 Swagger ？

主要的優點:



  1. 支持 API 自動生成同步的在線文檔：使用 Swagger 后可以直接通過代碼生成文檔，不再需要自己手動編寫接口文檔了，對程序員來說非常方便，可以節約寫文檔的時間去學習新技術。

  2. 提供 Web 頁面在線測試 API：光有文檔還不夠，Swagger 生成的文檔還支持在線測試。參數和格式都定好了，直接在界面上輸入參數對應的值即可在線測試接口。


缺點的話就是但凡引入一個 jar 需要去了解下原理和使用，對於這個缺點我感覺相比於優點就是大巫見小巫，我簡單看了一下源碼，其實不算太難。


如何使用 Swagger

關於 Swagger 的使用其實也就是3板斧，大家一定很熟悉的；


第一板斧就是引入 jar 包，這裏我使用的是2.9.2版本


        <!-- swagger 相關 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>${swagger2.version}</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>${swagger2.version}</version>
        </dependency>

第二板斧就是SpringBoot自動掃描配置類


/**
 * SwaggerConfig
 *
 * @author wangtongzhou
 * @since 2020-06-09 09:41
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                //生產環境的時候關閉 Swagger 比較安全
                .apiInfo(apiInfo())
                .select()
                //Api掃描目錄
                .apis(RequestHandlerSelectors.basePackage("com.springboot2.learning"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("learn")
                .description("learn")
                .version("1.0")
                .build();
    }
}

第三板斧使用 Swagger 註解


/**
 * 用戶相關接口
 *
 * @author wangtongzhou
 * @since 2020-06-12 07:35
 */
@RestController
@RequestMapping("/user")
@Api(value = "用戶相關接口")
public class UserController {

    @PostMapping("/")
    @ApiOperation("添加用戶的接口")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "userName", value = "用戶名", defaultValue =
                    "wtz"),
            @ApiImplicitParam(name = "age", value = "年齡", defaultValue = "20")
    })
    public User addUser(String userName, Integer age) {
        User user = new User();
        user.setAge(age);
        user.setUserName(userName);
        return user;
    }

    @GetMapping("/{userId}")
    @ApiOperation("根據用戶id查詢用戶信息")
    @ApiImplicitParam(name = "userId", value = "用戶id", defaultValue = "20")
    public User queryUserByUserId(@PathVariable Long userId) {
        User user = new User();
        user.setUserId(userId);
        return user;
    }
}
/**
 * 用戶實體
 *
 * @author wangtongzhou
 * @since 2020-06-12 07:45
 */
@ApiModel
public class User {

    @ApiModelProperty(value = "用戶名稱")
    private String userName;

    @ApiModelProperty(value = "年齡")
    private Integer age;

    @ApiModelProperty(value = "用戶id")
    private Long userId;

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public Long getUserId() {
        return userId;
    }

    public void setUserId(Long userId) {
        this.userId = userId;
    }
}

效果如下:

實體註解

接口描述

接口參數

執行接口

返回地址
條件裝配 @Conditional 介紹

@Conditional 是Spring4.0提供的註解，位於 org.springframework.context.annotation 包內，它可以根據代碼中設置的條件裝載不同的bean。比如說當一個接口有兩個實現類時，我們要把這個接口交給Spring管理時通常會只選擇實現其中一個實現類，這個時候我們總不能使用if-else吧，所以這個@Conditional的註解就出現了。


@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
public @interface Conditional {

    Class<? extends Condition>[] value();

}

使用方法

這裏介紹一個MySQL和Oracle選擇方式，開始之前首先在properties文件中增加sql.name=mysql的配置，接下來步驟如下



  1. 實現Conditional接口, 實現matches方法


/**
 * mysql條件裝配
 *
 * @author wangtongzhou
 * @since 2020-06-13 08:01
 */
public class MysqlConditional implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        String sqlName = context.getEnvironment().getProperty("sql.name");
        if ("mysql".equals(sqlName)){
            return true;
        }
        return false;
    }
}
/**
 * oracle條件裝配
 *
 * @author wangtongzhou
 * @since 2020-06-13 08:02
 */
public class OracleConditional implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        String sqlName=context.getEnvironment().getProperty("sql.name");
        if ("oracle".equals(sqlName)){
            return true;
        }
        return false;
    }
}


  1. 在需要判斷條件的bean上，加上@Conditional(***.class)即可在滿足條件的時候加載對應的類


/**
 * conditional
 *
 * @author wangtongzhou
 * @since 2020-06-13 08:01
 */
@Configuration
public class ConditionalConfig {

    @Bean
    @Conditional(MysqlConditional.class)
    public Mysql mysql() {
        return new Mysql();
    }

    @Bean
    @Conditional(OracleConditional.class)
    public Oracle oracle() {
        return new Oracle();
    }
}


  1. 調用測試


@RunWith(SpringRunner.class)
@SpringBootTest
public class ConditionalTests {

    @Autowired
    private ApplicationContext applicationContext;

    @Test
    public void test_conditional() {
        Mysql mysql = (Mysql) applicationContext.getBean("mysql");
        Assert.assertNotNull(mysql);
        Assert.assertTrue("mysql".equals(mysql.getSqlName()));
    }
}

其他擴展註解


  1. @@ConditionalOnClass({Docket.class, ApiInfoBuilder.class})
    當存在Docket和ApiInfoBuilder類的時候才加載Bean;

  2. @ConditionalOnMissingClass不存在某個類的時候才會實例化Bean;

  3. @ConditionalOnProperty(prefix = "swagger", value = "enable", matchIfMissing = true)當存在swagger為前綴的屬性，才會實例化Bean;

  4. @ConditionalOnMissingBean當不存在某個Bean的時候才會實例化;


這裏就介紹這幾個常用，org.springframework.boot.autoconfigure.condition這個下面包含全部的關於@Conditional相關的所有註解

@Conditional擴展

註解介紹
配置文件參數獲取 @ConfigurationProperties

@ConfigurationProperties是SpringBoot加入的註解，主要用於配置文件中的指定鍵值對映射到一個Java實體類上。關於這個的使用就在下面的方式引出。


比較好的方式


關於開篇中引入的問題，解題流程主要是以下3步:



  1. 抽象一個公共 Swagger jar；

  2. 如何定製化 Swagger jar；

  3. 使用定製化完成以後的 Swagger jar;


抽象一個公共 Swagger jar

主要是就是將 Swagger jar 和一些其他需要的 jar 進行引入，使其成為一個公共的模塊，軟件工程中把這個叫做單一原則；



Maven包的引入

 


    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
        </dependency>
    </dependencies>

如何定製化 Swagger jar；

定製化就是將 Swagger 相關的屬性進行配置化的處理，這裏也可以分為兩步；



  1. 將公共的屬性抽象成配置化的類，這裏就是關於@ConfigurationProperties的使用,將配置文件中的 swagger 開頭的屬性映射到配置類的屬性當中;


/**
 * Swagger基本屬性
 *
 * @author wangtongzhou
 * @since 2020-05-24 16:58
 */
@ConfigurationProperties("swagger")
public class SwaggerProperties {

    /**
     * 子系統
     */
    private String title;

    /**
     * 描述
     */
    private String description;

    /**
     * 版本號
     */
    private String version;

    /**
     * api包路徑
     */
    private String basePackage;

    public String getTitle() {
        return title;
    }

    public SwaggerProperties setTitle(String title) {
        this.title = title;
        return this;
    }

    public String getDescription() {
        return description;
    }

    public SwaggerProperties setDescription(String description) {
        this.description = description;
        return this;
    }

    public String getVersion() {
        return version;
    }

    public SwaggerProperties setVersion(String version) {
        this.version = version;
        return this;
    }

    public String getBasePackage() {
        return basePackage;
    }

    public SwaggerProperties setBasePackage(String basePackage) {
        this.basePackage = basePackage;
        return this;
    }
}


  1. 公共屬性賦值配置到 Swagger 的配置類中，該配置類中進行一些類條件的判斷和插件Bean是否已經注入過，然後就是將配置類中的屬性，賦值到 Swagger 的初始化工程中；


/**
 * Swagger自動配置類
 *
 * @author wangtongzhou
 * @since 2020-05-24 16:35
 */
@Configuration
@EnableSwagger2
@ConditionalOnClass({Docket.class, ApiInfoBuilder.class})
@ConditionalOnProperty(prefix = "swagger", value = "enable", matchIfMissing = true)
@EnableConfigurationProperties(SwaggerProperties.class)
public class SwaggerConfig {

    @Bean
    @ConditionalOnMissingBean
    public SwaggerProperties swaggerProperties() {
        return new SwaggerProperties();
    }

    @Bean
    public Docket createRestApi() {
        SwaggerProperties properties = swaggerProperties();
        return new Docket(DocumentationType.SWAGGER_2)
                //生產環境的時候關閉 Swagger 比較安全
                .apiInfo(apiInfo(properties))
                .select()
                //Api掃描目錄
                .apis(RequestHandlerSelectors.basePackage(properties.getBasePackage()))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo(SwaggerProperties properties) {
        return new ApiInfoBuilder()
                .title(properties.getTitle())
                .description(properties.getDescription())
                .version(properties.getVersion())
                .build();
    }

}

完成以上兩步，就完成了 Swagger 模塊的定製化開發，接下來還要做一件事情，作為一個公共的模塊，我們要讓他自己進行自動化裝配，解放我們的雙手，我們在 resources 目錄下增加一個 spring.factories 配置文件，內容如下:


org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.springcloud.study.swagger.config.SwaggerConfig

到此我們完成所有的開發;


使用定製化完成以後的 Swagger jar;

關於使用也分為兩步，



  1. 引入 jar;


        <dependency>
            <groupId>com.springcloud.study</groupId>
            <artifactId>common-swagger</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>


  1. 定製化的屬性配置;


# Swagger 配置項
swagger:
  title: 用戶模塊
  description: 用戶子系統
  version: 1.0.0
  base-package: com.springcloud.study.user.controller

完成這兩步就可以開啟正常的使用了；


後續的規劃



  1. 註解整理
    後續會將 Spring 註解進行一個統一的整理，包含一些使用說明或者原理等等，希望到時候能幫助到大家吧，目前計劃兩周一個吧；

  2. 開源項目
    Spring Cloud 的學習過於碎片化，希望通過自己搞一個開源項目，提升對各個組件的掌握能力，同時也能產出一套通用化權限管理系統，具備很高的靈活性、擴展性和高可用性，並且簡單易用，這塊是和未來做企業数字化轉型相關的事是重合的，慢慢的會做一些企業級通用化的的功能開發；前端部分的話希望是採用Vue,但是這塊有一個學習成本，還沒有進行研究，目前還沒排上日程。整體的里程碑是希望在6.22離職之前完成整套後端的開發，7月中旬完成第一次Commit。


點點關注


這邊文章限於篇幅，過多的關注於使用了，後續會把上面幾個註解的原理分析講講，歡迎大家點點關注，點點贊，感謝!

本站聲明:網站內容來源於博客園,如有侵權,請聯繫我們,我們將及時處理

【其他文章推薦】



※為什麼 USB CONNECTOR 是電子產業重要的元件?



※網頁設計一頭霧水該從何著手呢? 台北網頁設計公司幫您輕鬆架站!



※台北網頁設計公司全省服務真心推薦



※想知道最厲害的網頁設計公司"嚨底家"!



※推薦評價好的iphone維修中心



Orignal From: 多應用下 Swagger 的使用，這可能是最好的方式!

留言

張貼留言

這個網誌中的熱門文章

有了四步解題法模板，再也不害怕動態規劃！（看不懂算我輸）

導言 動態規劃問題一直是算法面試當中的重點和難點，並且動態規劃這種通過空間換取時間的算法思想在實際的工作中也會被頻繁用到，這篇文章的目的主要是解釋清楚 什麼是動態規劃 ，還有就是面對一道動態規劃問題，一般的 思考步驟 以及其中的注意事項等等，最後通過幾道題目將理論和實踐結合。 什麼是動態規劃 如果你還沒有聽說過動態規劃，或者僅僅只有耳聞，或許你可以看看 Quora 上面的這個 回答 。 How to explain dynamic 用一句話解釋動態規劃就是 " 記住你之前做過的事 "，如果更準確些，其實是 " 記住你之前得到的答案 "。 我舉個大家工作中經常遇到的例子。 在軟件開發中，大家經常會遇到一些系統配置的問題，配置不對，系統就會報錯，這個時候一般都會去 Google 或者是查閱相關的文檔，花了一定的時間將配置修改好。 過了一段時間，去到另一個系統，遇到類似的問題，這個時候已經記不清之前修改過的配置文件長什麼樣，這個時候有兩種方案，一種方案還是去 Google 或者查閱文檔，另一種方案是借鑒之前修改過的配置，第一種做法其實是萬金油，因為你遇到的任何問題其實都可以去 Google，去查閱相關文件找答案，但是這會花費一定的時間，相比之下，第二種方案肯定會更加地節約時間，但是這個方案是有條件的，條件如下： 之前的問題和當前的問題有着關聯性，換句話說，之前問題得到的答案可以幫助解決當前問題 需要記錄之前問題的答案 當然在這個例子中，可以看到的是，上面這兩個條件均滿足，大可去到之前配置過的文件中，將配置拷貝過來，然後做些細微的調整即可解決當前問題，節約了大量的時間。 不知道你是否從這些描述中發現，對於一個動態規劃問題，我們只需要從兩個方面考慮，那就是 找出問題之間的聯繫 ，以及 記錄答案 ，這裏的難點其實是找出問題之間的聯繫，記錄答案只是順帶的事情，利用一些簡單的數據結構就可以做到。 概念 上面的解釋如果大家可以理解的話，接    動態規劃 算法是通過拆分問題，定義問題狀態和狀態之間的關係，使得問題能夠以遞推（或者說分治）的方式去解決。它的幾個重要概念如下所述。    階段： 對於一個完整的問題過程，適當的切分為若干個相互聯繫的子問題，每次在求解一個子問題...
張貼留言
閱讀完整內容

程序員需要了解的硬核知識之操作系統入門

對於程序員來說，最莫大的榮耀莫過於自己的軟件被大多數人使用了吧。 歷史文章請戳 本篇文章作為操作系統的入門文章，可能入門都算不上吧，畢竟操作系統太龐大和複雜了。本篇文章主要帶你了解一下我們常用的操作系統環境。 操作系統環境 程序中包含着 運行環境 這一內容，可以說 運行環境 = 操作系統 + 硬件 ，操作系統又可以被稱為軟件，它是由一系列的指令組成的。我們不介紹操作系統，我們主要來介紹一下硬件的識別。 我們肯定都玩兒過遊戲，你玩兒遊戲前需要干什麼？是不是需要先看一下自己的筆記本或者電腦是不是能肝的起遊戲？下面是一個遊戲的配置（懷念一下 wow） 圖中的主要配置如下 操作系統版本：說的就是應用程序運行在何種系統環境，現在市面上主要有三種操作系統環境，Windows 、Linux 和 Unix ，一般我們玩兒的大型遊戲幾乎都是在 Windows 上運行，可以說 Windows 是遊戲的天堂。Windows 操作系統也會有區分，分為32位操作系統和64位操作系統，互不兼容。 處理器：處理器指的就是 CPU，你的電腦的計算能力，通俗來講就是每秒鐘能處理的指令數，如果你的電腦覺得卡帶不起來的話，很可能就是 CPU 的計算能力不足導致的。想要加深理解，請閱讀博主的另一篇文章： 顯卡：顯卡承擔圖形的輸出任務，因此又被稱為圖形處理器（Graphic Processing Unit，GPU），顯卡也非常重要，比如我之前玩兒的 劍靈 開五檔（其實就是圖像變得更清晰）會卡，其實就是顯卡显示不出來的原因。 內存：內存即主存，就是你的應用程序在運行時能夠動態分析指令的這部分存儲空間，它的大小也能決定你電腦的運行速度，想要加深理解，請閱讀博主的另一篇文章 存儲空間：存儲空間指的就是應用程序安裝所佔用的磁盤空間，由圖中可知，此遊戲的最低存儲空間必須要大於 5GB，其實我們都會遺留很大一部分用來安裝遊戲。 從程序的運行環境這一角度來考量的話，CPU 的種類是特別重要的參數，為了使程序能夠正常運行，必須滿足 CPU 所需的最低配置。 CPU 只能解釋其自身固有的語言。不同的 CPU 能解釋的機器語言的種類也是不同的。機器語言的程序稱為 本地代碼(native code) ，程序員用 C 等高級語言編寫的程...
張貼留言
閱讀完整內容

步伐密集 易事特再建江蘇充電樁專案

易事特今日發佈公告稱，與江蘇高淳經濟開發區開發總公司就新能源汽車充電樁設備研發製造、IDC整體機房研發製造、智慧微電網等項目投資達成一致意見並簽署協議書。易事特承諾新辦企業固定資產投資總額為6億元人民幣（約新臺幣30億），畝均稅收不低於20萬元（約新臺幣101萬），首期建築面積不低於30000平方米。高淳經濟開發區將供地約120畝，使用年限為50年。   易事特佈局充電樁可謂步伐密集。今年8月13日，易事特與馬鞍山經濟技術開發區管理委員會簽訂了《投資框架協議書》，擬在對方區域內投資建設資料中心、分散式發電設備與系統集成和新能源汽車充電站（樁）項目。 本站聲明:網站內容來源於EnergyTrend https://www.energytrend.com.tw/ev/,如有侵權,請聯繫我們,我們將及時處理 【其他文章推薦】 ※ USB CONNECTOR 掌控什麼技術要點? 帶您認識其相關發展及效能 ※ 台北網頁設計 公司這麼多該如何選擇? ※智慧手機時代的來臨，RWD 網頁設計 為架站首選 ※評比 南投搬家公司費用 收費行情懶人包大公開 ※幫你省時又省力, 新北清潔 一流服務好口碑 ※回頭車 貨運 收費標準 Orignal From: 步伐密集 易事特再建江蘇充電樁專案
張貼留言
閱讀完整內容