可以把 FolkMQ 內嵌到 SpringBoot3 專案裡(可內嵌的訊息中介軟體,純血國產)

带刺的坐椅發表於2024-06-20

之前發了《把 FolkMQ 內嵌到 SpringBoot2 專案裡(比如 “諾依” 啊)》。有人說都淘態了,有什麼好內嵌的。。。所以再發個 SpringBoot3


FolkMQ 是一個 “純血國產” 的訊息中介軟體。支援內嵌、單機、叢集、多重叢集等多種部署方式。

  • 內嵌版,就相當於 H2 或 SQLite 資料庫一樣。給一些小專案(或者特別需求)帶來了方便。
  • 大專案,則可以使用獨立部署的 “單機版” 或 “叢集版”

內嵌個訊息中介軟體,體積會不會太大啦?!!不會,才7Mb。好小的!

1、瞭解 FolkMQ 內嵌版

FolkMQ 內嵌版(帶 Web 控制檯介面的),體積增加 7Mb,就可以附加完整訊息中介軟體的能力嘍。比如你在用 “諾依” 開發個小專案,需要訊息中介軟體,但是又不想獨立部署。這就很適合呢!

  • 內嵌版與單機板,功能一模一樣
  • 控制檯介面是基於 Solon 框架 開發的,非常小巧。(可以用宿主專案的埠,也可以獨立埠)
  • 可以內嵌到 jFinal,Solon,SpringBoot2,SpringBoot3,Vert.X 等框架裡

說起來 Solon 真是中介軟體的控制檯良配,又小又強又可以內嵌。太愛了!

2、怎麼整合吶?

此例,我們的控制檯使用宿主專案的 HTTP 埠。所以需要與 SpringBoot2 的 Servlet 能力對接。

  • a) 引入兩個包
依賴包 說明
solon.web.servlet 負責與 SpringBoot2 的 Servlet 能力對接,為控制檯提供支援
folkmq-embedded 我們的主角,FolkMQ 內嵌版
<dependency>
    <groupId>org.noear</groupId>
    <artifactId>solon.web.servlet.jakarta</artifactId>
    <version>2.8.3</version>
</dependency>

<dependency>
    <groupId>org.noear</groupId>
    <artifactId>folkmq-broker-embedded</artifactId>
    <version>1.7.1</version>
</dependency>
  • b) 新增一個配置類 FolkMqConfig,就整合好了

專門安排它一個包名“folkmq”,可以縮小 solon 的掃描範圍。因為 solon 也是個容器型的框架嘛(只是比較小巧)。

package demoapp.folkmq;

@Configuration
public class FolkMqConfig {
    @PostConstruct
    public void start() {
        //啟動 solon
        Solon.start(FolkMqConfig.class, new String[]{});
    }

    @PreDestroy
    public void stop() {
        if (Solon.app() != null) {
            //停止 solon(根據配置,可支援兩段式安全停止)
            Solon.stopBlock(false, Solon.cfg().stopDelay());
        }
    }

    @Bean
    public FilterRegistrationBean folkmqAdmin(){
        //透過 Servlet Filter 實現 http 能力對接
        FilterRegistrationBean<SolonServletFilter> filter = new FilterRegistrationBean<>();
        filter.setName("SolonFilter");
        filter.addUrlPatterns("/folkmq/*");
        filter.setFilter(new SolonServletFilter());
        return filter;
    }
}
  • c) 然後,再加個配置檔案 folkmq.yml 來控制它

更多的配置,可以見官網的:配置參考

# 如果使用 servelt 則使用與 sprongboot 相同的等口
server.port: 8080

# 避免與其它 token 衝突
server.session.state.jwt.name: FOLKMQ-TOKEN

# 訊息控制檯賬號密碼
folkmq.admin: admin
# 訊息傳輸協議(tcp 或 ws)
folkmq.schema: tcp
# 訊息傳輸埠(預設為 server.port + 10000)
folkmq.transport.port: 0

3、看看內嵌的效果

專案執行後,可以透過 /folkmq/ 來訪問控制檯。

可以把 FolkMQ 內嵌到 SpringBoot3 專案裡(可內嵌的訊息中介軟體,純血國產)

4、然後測試下

訊息埠,是控制檯埠 + 10000。測試,我們就發10條普通訊息試試。

public class ClientTest {
    public static void main(String[] args) throws Exception {
        MqClient client = FolkMQ.createClient("folkmq://localhost:18080")
                .nameAs("demoapp")
                .connect();

        //訂閱訊息
        client.subscribe("demo.topic", message -> {
            System.out.println(message);
        });

        for (int i = 0; i < 10; i++) {
            //釋出訊息
            client.publish("demo.topic", new MqMessage("hello" + i));
        }
    }
}

測試效果:

可以把 FolkMQ 內嵌到 SpringBoot3 專案裡(可內嵌的訊息中介軟體,純血國產)

5、完整的示例程式碼

https://gitee.com/noear/folkmq-embedded-examples/tree/main/folkmq-embedded-springboot3

相關文章