可以把 FolkMQ 内嵌到 SpringBoot3 项目里（可内嵌的消息中间件）

news2025/2/23 14:21:28

之前发了《把 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/ 来访问控制台。

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));
        }
    }
}