中国 帮助

短信模块

版本与配置 版本 = 5.1.0(sms4j) 已完成 sms4j 集成,文档地址:https://sms4j.com/doc3/ 配置方式与厂商扩展请参考 sms4j 文档。 ![输入图片说明](https://for

短信模块
封面

> 本文整理自平台文档 docs/wujies/5.x/ruoyi-vue-plus/framework/extend/sms.mdx,用于站点内容演示。

(https://console.wujies.cn/remote-apps/cms-assets/doc-019bd80b403e-cover.svg)

  • - -

版本与配置

### 版本 >= 5.1.0(sms4j)

已完成 sms4j 集成,文档地址:https://sms4j.com/doc3/

配置方式与厂商扩展请参考 sms4j 文档。

![输入图片说明](https://foruda.gitee.com/images/1705573035997239848/2ca8512d_1766278.png "屏幕截图")

使用方式可参考 demo 模块示例:

![输入图片说明](https://foruda.gitee.com/images/1705573001447394180/2bd726d0_1766278.png "屏幕截图")

补充说明:

  • Vue 版本当前主流用法是 sms4j,配置位于各环境配置文件 application-*.yml 的 sms 节点。
  • blends 下可以同时配置多个厂商或多个账号,通过不同的配置 key 区分。
  • 发送时一般通过 SmsFactory.getSmsBlend("配置key") 选择具体通道。

### 版本 4.2.0(SPI 方式)

短信模块采用 SPI 加载,支持 阿里云、腾讯云,可提交 PR 扩展。

参考 ruoyi-demo 的 pom 配置:

![输入图片说明](https://foruda.gitee.com/images/1678979157797419426/cc9b7444_1766278.png "屏幕截图")

配置文件示例:

![输入图片说明](https://foruda.gitee.com/images/1678979163029635375/e5fd6e20_1766278.png "屏幕截图")

参数说明:

  • enabled:短信功能开关
  • endpoint:厂家域名
  • accessKeyId:密钥 ID
  • accessKeySecret:密钥
  • signName:签名
  • sdkAppId:应用 ID(腾讯专用)

功能使用

参考 demo 模块 SmsController 示例。 功能采用“模板模式”动态加载厂商模板,注入 SmsTemplate 即可使用。

![输入图片说明](https://foruda.gitee.com/images/1678979168699323982/e9301e84_1766278.png "屏幕截图")

补充说明:

  • 当前 demo 中已经演示了通过 SmsFactory.getSmsBlend("config1")、config2 分别调用不同短信通道。
  • 模板参数通常使用 LinkedHashMap 传入,字段名和顺序要符合供应商模板要求。

重点须知

不同厂家参数格式差异较大,请按规则配置:

![输入图片说明](https://foruda.gitee.com/images/1678979172581090456/ac1f10e8_1766278.png "屏幕截图")

补充说明:

  • 真实业务里还应配合黑名单、发送频控、验证码缓存时效一起使用,避免短信轰炸和恶意调用。

本文导览

(https://console.wujies.cn/remote-apps/cms-assets/doc-019bd80b403e-guide.svg)

章节导览
THE END

喜欢就支持以下吧

评论区需要浏览器启用 JavaScript 才能加载。

回到内容