1 Star 3 Fork 2

吴博 / 消息中间件

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

message-spring-boot-starter

star fork star fork

这是一个消息中间件
通过配置和编码,即可将相同的消息通过钉钉自定义机器人、钉钉消息、飞书自定义机器人、飞书消息、企业微信自定义机器人、企业微信消息以及邮箱消息通道进行发送
提供统一消息维护方式,发送时会按照对应的平台类型自动进行转换

代码示例

  1. 使用消息中间件实体SQL工具实现的消息发送代码示例
  2. 使用动态调度消息中间件动态编译加载执行工具实体SQL工具实现的在线编码、动态调度、发送钉钉群消息、快速构造web页面Demo

第一步 增加 JitPack 仓库

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

第二步 引入jar

1.1.0版本后升级到jdk 17 SpringBoot 3.2+

<dependency>
    <groupId>com.gitee.wb04307201</groupId>
    <artifactId>message-spring-boot-starter</artifactId>
    <version>1.1.3</version>
</dependency>

第三步 在启动类上加上@EnableMessage注解

@EnableMessage
@SpringBootApplication
public class MessageDemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringTestApplication.class, args);
    }
}

第四步 application.yml配置文件中添加以下相关配置,可以配置多个群

1. 配置钉钉自定义机器人

钉钉自定义机器人的配置请参考 自定义机器人接入 自定义机器人安全设置 获得access_token和secret

message:
  dingtalk:
    customRobot:
      - alias: alias #所有通道的别名不能重复
        accessToken: accessToken
        secret: secret

2. 配置钉钉消息

钉钉消息需要先注册企业内部应用,应用的配置请参考 基础概念 获得appkey、appsecret、agentId

message:
  dingtalk:
    message:
      - alias: alias #所有通道的别名不能重复
        appkey: appkey
        appsecret: appsecret
        agentId: agentId

3. 配置飞书自定义机器人

飞书自定义机器人的配置请参考 自定义机器人使用指南 获得hookid、secret

message:
  feishu:
    message:
      - alias: alias #所有通道的别名不能重复
        hookid: hookid
        secret: secret

4. 配置飞书消息

飞书消息需要先注册企业内部应用,应用的配置请参考 如何获取应用的 App ID 获得appId、secret

message:
  feishu:
    message:
      - alias: alias #所有通道的别名不能重复
        appId: appId
        appSecret: appSecret

5. 企业微信自定义机器人

企业微信自定义机器人的配置请参考 群机器人配置说明 获得key

message:
  weixin:
    message:
      - alias: alias #所有通道的别名不能重复
        key: key

6. 企业微信消息

企业微信消息需要先注册企业内部应用,应用的配置请参考 基本概念介绍 获得corpi、corpsecret、agentid

message:
  weixin:
    message:
      - alias: alias #所有通道的别名不能重复
        corpid: corpid
        corpsecret: corpsecret
        agentid: agentid

7. 邮箱

message:
  mail:
    smtp:
      - alias: alias #所有通道的别名不能重复
        host: host
        from: from
        username: username
        password: password

第五步 注入MessageService,编写消息内容,调用发送

1. 编写消息内容


@RestController
public class DemoController {

    @Autowired
    MessageService messageService;

    @GetMapping(value = "/message/send")
    public String send() {
        return messageService.send(
                RequestContent.buildMarkdown()
                        .addAlias("dd-1", "mail-1")  //通过配置的别名指定消息通道
                        .addMessageType(MessageType.DingtalkCustomRobot) //通过消息通道类型指定消息通道
                        .title("测试群发")
                        .addLine(SubLine.title("这是一行标题1", 1))
                        .addLine(SubLine.title("这是一行标题2", 2))
                        .addLine(SubLine.text("这是一行文本"))
                        .addLine(SubLine.link("这是一行链接", "https://gitee.com/wb04307201/message-spring-boot-starter"))
                        .addLine(SubLine.quote("这是一行引用"))
                        .addLine(SubLine.bold("这是一行加粗"))
        ).toString();
    }
}

行数据类型与转换格式对照表

message 钉钉 微信 飞书 邮件
SubLine.text Markdown: 文字 Markdown: 文字 文本标签:text html: <p>
SubLine.title Markdown: 标题 Markdown: 标题 文本标签:text html: <h1>~<h6>
SubLine.link Markdown: 链接 Markdown: 链接 超链接标签:a html: <a>
SubLine.quote Markdown: 引用 Markdown: 引用 文本标签:text html: <blockquote>
SubLine.bold Markdown: 加粗 Markdown: 加粗 文本标签:text html: <strong>

2.根据别名、消息通道类型配置额外参数

在实际项目中使用消息通道时, 比如使用钉钉自定义机器人发送群消息时,会出现@所有人或者@某个人的需求 使用钉钉消息的时候,也需要指定特定用户 这是需要额外的参数协助消息发往正确的目标 下面的示例是为钉钉自定义机器人增加 @所有人 参数

                RequestContent.buildMarkdown()
                        .addDingtalkCustomRobot("isAtAll", Boolean.TRUE) //根据消息通道类型添加参数
                        .addDingtalkCustomRobot("dd-1", "isAtAll", Boolean.TRUE) //根据消息通道别名添加参数,优先级更大
                        .title("测试消息")
                        .addLine(SubLine.text("这是一行文本"));
1. 钉钉自定义机器人支持参数
参数 参数类型 说明
atMobiles List 被@人的手机号
atUserIds List 被@人的用户userid
isAtAll Boolean 是否@所有人
2. 钉钉消息支持参数
参数 参数类型 说明
userid_list String user123,user456 接收者的userid列表,最大用户列表长度100
dept_id_list String 123,345 接收者的部门id列表,最大列表长度20。接收者是部门ID时,包括子部门下的所有用户。
to_all_user Boolean 是否发送给企业全部用户(当设置为false时必须指定userid_list或dept_id_list其中一个参数的值)
3. 飞书机器人支持参数

@所有人 .addFeishuCustomRobot("all","所有人") @单个用户(填入用户的 Open ID,且必须是有效值,否则取名字展示,并不产生实际的 @ 效果) .addFeishuCustomRobot("ou_xxx","名字")

4. 飞书消息
参数 参数类型 说明
receive_id_type String 消息接收者id类型 open_id/user_id/union_id/email/chat_id
receive_id String 消息接收者的ID,ID类型应与查询参数receive_id_type 对应
5. 企业微信自定义机器人

暂无支持的额外参数

6. 企业微信消息
参数 参数类型 说明
touser String 指定接收消息的成员,成员ID列表(多个接收者用‘|’分隔,最多支持1000个)。特殊情况:指定为"@all",则向该企业应用的全部成员发送
toparty String 指定接收消息的部门,部门ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为"@all"时忽略本参数
totag String 指定接收消息的标签,标签ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为"@all"时忽略本参数
7. 邮箱
参数 参数类型 说明
to String 收件邮箱1,收件邮箱2

其他1:动态增减平台信息

//可以通过如下方法添加平台信息
messageService.add

//可以通过如下方法删除平台信息
messageService.removeByAlias
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright 2023 wubo Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

这是一个消息中间件, 通过配置和编码,即可将相同的消息通过钉钉自定义机器人、钉钉消息、飞书自定义机器人、飞书消息、企业微信自定义机器人、企业微信消息以及邮箱消息通道进行发送, 提供统一消息维护方式,发送时会按照对应的平台类型自动进行转换 展开 收起
Java
Apache-2.0
取消

发行版 (10)

全部

贡献者

全部

近期动态

加载更多
不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/wb04307201/message-spring-boot-starter.git
git@gitee.com:wb04307201/message-spring-boot-starter.git
wb04307201
message-spring-boot-starter
消息中间件
master

搜索帮助

344bd9b3 5694891 D2dac590 5694891