問題

微服務化的時代，我們整個項目工程下面都會有很多的子系統，對於每個應用都有暴露 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維修中心

今天我們再來看看RocketMQ的另外兩個小功能，消息的批量發送和過濾。這兩個小功能提升了我們使用RocketMQ的效率。

批量發送

以前我們發送消息的時候，都是一個一個的發送，這樣效率比較低下。能不能一次發送多個消息呢？當然是可以的，RocketMQ為我們提供了這樣的功能。但是它也有一些使用的條件：

• 同一批發送的消息的Topic必須相同；
• 同一批消息的waitStoreMsgOK 必須相同；
• 批量發送的消息不支持延遲，就是上一節說的延遲消息；
• 同一批次的消息，大小不能超過1MiB；

好了，只要我們滿足上面的這些限制，就可以使用批量發送了，我們來看看發送端的代碼吧，

@Test
public void producerBatch() throws Exception {

    List<Message> messages = new ArrayList<>();
    for (int i = 0;i<3;i++) {
        MessageExt message = new MessageExt();
        message.setTopic("cluster-topic");
        message.setKeys("key-"+i);
        message.setBody(("this is batchMQ,my NO is "+i+"---"+new Date()).getBytes());
        messages.add(message);
    }
    SendResult sendResult = defaultMQProducer.send(messages);
    System.out.println("sendResult:" + sendResult.getSendStatus().toString());
}

• 其實批量發送很簡單，我們只是把消息放到一個List當中，然後統一的調用send方法發送就可以了。

再來看看消費端的代碼，

@Bean(initMethod = "start",destroyMethod = "shutdown")
public DefaultMQPushConsumer pushConsumer()  {
    try {
        DefaultMQPushConsumer consumer = new DefaultMQPushConsumer("DefaultMQPushConsumer");
        consumer.setNamesrvAddr("192.168.73.130:9876;192.168.73.131:9876;192.168.73.132:9876;");
        consumer.subscribe("cluster-topic", "*");
        consumer.registerMessageListener(new MessageListenerConcurrently() {
            @Override
            public ConsumeConcurrentlyStatus consumeMessage(List<MessageExt> msgs, ConsumeConcurrentlyContext context) {
                System.out.println("msgs.size():"+msgs.size());
                if (msgs != null && msgs.size() > 0) {
                    for (MessageExt msg : msgs) {
                        System.out.println(new String(msg.getBody()));
                    }
                }
                return ConsumeConcurrentlyStatus.CONSUME_SUCCESS;
            }
        });
        return consumer;
    }catch (Exception e) {
        e.printStackTrace();
    }
    return null;
}

• 消費端的代碼沒有任何的變化，正常的接收消息就可以了，我們只是打印出了msgs.size()，看看一次接收一個消息，還是一次可以批量的接收多個消息。

我們啟動項目，批量發送一下，看看效果吧，

發送端的日誌如下：

sendResult:SEND_OK

發送成功，看來我們批量發送的3個消息都進入到了隊列中，再看看消費端，是一次消費一個，還是一次消費3個，如下：

msgs.size():1
this is batchMQ,my NO is 0---Mon Jun 15 09:31:04 CST 2020
msgs.size():1
this is batchMQ,my NO is 1---Mon Jun 15 09:31:04 CST 2020
msgs.size():1
this is batchMQ,my NO is 2---Mon Jun 15 09:31:04 CST 2020

看樣子是一次只消費了一個消息，那麼能不能一次消費3個消息呢？當然是可以的，不過要進行特殊的設置，

consumer.setConsumeMessageBatchMaxSize(5);

在消費端，我們設置批量消費消息的數量是5，這個值默認是1。我們再看看消費端的日誌，

msgs.size():3
this is batchMQ,my NO is 0---Mon Jun 15 09:35:47 CST 2020
this is batchMQ,my NO is 1---Mon Jun 15 09:35:47 CST 2020
this is batchMQ,my NO is 2---Mon Jun 15 09:35:47 CST 2020

這次一次消費了3個消息，如果消息比較多的話，最大一次能消費5個。這就是RocketMQ的批量發送和批量消費。

消息過濾

其實我們在大多數情況下，使用tag標籤就能夠很好的實現消息過濾。雖然tag標籤咱們並沒有過多的介紹，其實也很好理解，就是一個子Topic的概念，咱們在構建消息message的時候，message.setTags("xxx")。然後在消費的時候，訂閱Topic的時候，也可以指定訂閱的tag，

consumer.subscribe("cluster-topic", "*");

看到那個”*”了嗎？它就是訂閱的tag，”*”代表全部的tag，如果您想訂閱其中的一個或幾個，可以使用這種方式”tagA || tagB || tagC”，這是訂閱了cluster-topic下的3個tag，其他的tag是不會被消費的。

這裏我們所說的消息過濾比tag要高級很多，是可以支持sql的，怎麼樣？高級吧。比如：我們訂閱”a > 5 and b = ‘abc'”的消息，如下圖：

但是，RocketMQ畢竟不是數據庫，它只能支持一些基礎的SQL語句，並不是所有的SQL都支持，

• 数字型的支持，>, >=, <, <=, BETWEEN, =

• 字符串支持，=, <>, IN

• IS NULL或者IS NOT NULL

• 邏輯判斷，AND，OR，NOT；

字段的類型也只是簡單的幾種，

• 数字型，支持123，543.123，整型、浮點都可以；
• 字符串，必須使用單引號”括起來；
• 空值，NULL；
• 布爾型，TRUE或者FALSE；

並且對消費者的類型也有一定的限制，只能使用push consumer才可以進行消息過濾。好了，說了這麼多了，我們看看怎麼使用吧，消費端和生產端都要進行相應的改造，先看看生產端吧，

@Test
public void producerBatch() throws Exception {

    List<Message> messages = new ArrayList<>();
    for (int i = 0;i<3;i++) {
        MessageExt message = new MessageExt();
        message.setTopic("cluster-topic");
        message.setKeys("key-"+i);
        message.setBody(("this is batchMQ,my NO is "+i+"---"+new Date()).getBytes());

        int a = i+4;
        message.putUserProperty("a",String.valueOf(a));

        messages.add(message);
    }
    SendResult sendResult = defaultMQProducer.send(messages);
    System.out.println("sendResult:" + sendResult.getSendStatus().toString());
}

我們在之前批量發送的基礎上進行了修改，定義了a的值，等於i+4，這樣循環3次，a的值就是4，5，6。然後調用message.putUserProperty("a",String.valueOf(a))，注意，在使用消息過濾的時候，這些附加的條件屬性都是通過putUserProperty方法進行設置。這裏，我們設置了a的值。再看看消費端，

consumer.subscribe("cluster-topic", MessageSelector.bySql("a > 5"));

消費端，整體上沒有變化，只是在訂閱的方法中，使用MessageSelector.bySql("a > 5")，進行了條件的過濾。有的小夥伴可能會有疑問，我既想用sql過濾又想用tag過濾怎麼辦？當然也是可以，我們可以使用MessageSelector.bySql("a > 5").byTag("xx)，byTag和bySql不分前後，怎麼樣，很強大吧。我們運行一下程序，看看效果吧。

我們啟動一下服務，報錯了，怎麼回事？錯誤信息如下：

The broker does not support consumer to filter message by SQL92

隊列不支持過濾消息，我們查詢了RocketMQ源碼中的BrokerConfig類，這個類就是對broker的一些設置，其中發現了這兩個屬性，

// whether do filter when retry.
private boolean filterSupportRetry = false;
private boolean enablePropertyFilter = false;

• filterSupportRetry是在重試的時候，是否支持filter；
• enablePropertyFilter，這個就是是否支持過濾消息的屬性；

我們把這兩個屬性在broker的配置文件改為true吧，如下：

filterSupportRetry=true
enablePropertyFilter=true

然後，再重新部署一下我們兩主兩從的集群環境。環境部署完以後，我們再重啟應用，沒有報錯。在生產端發送一下消息看看吧，

sendResult:SEND_OK

生產端發送消息沒有問題，說明3個消息都發送成功了。再看看消費端的日誌，

msgs.size():1
this is batchMQ,my NO is 2---Mon Jun 15 10:59:37 CST 2020

只消費了一個消息，並且這個消息中i的值是2，那麼a的值就是2+4=6，它是>5的，滿足SQL的條件，所以被消費掉了。這完全符合我們的預期。

總結

今天的兩個小功能還是比較有意思的，但裡邊也有需要注意的地方，

• 消息的批量發送，只要我們滿足它的條件，然後使用List發送就可以了；批量消費，默認的消費個數是1，我們可以調整它的值，這樣就可以一次消費多個消息了；
• 過濾消息中，最大的坑就是隊列的配置里，需要設置enablePropertyFilter=true，否則消費端在啟動的時候報不支持SQL的錯誤；

我們在使用的時候，多加留意就可以了，有問題，評論區留言吧~

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

【其他文章推薦】

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

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

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

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

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