1 Star 1 Fork 1

营口大唐圣殿文化发展有限公司 / sms-spring-boot-project

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

sms-spring-boot-project

短信服务 Spring Boot Starter,目前只支持腾讯和阿里短信服务,腾讯和阿里云短信均已验证,期待各位小伙伴合作完善这个 starter。

前言

短信服务在用户注册、登录、找回密码等相关操作中,可以让用户使用更加便捷,越来越多的公司都采用短信验证的方式让用户进行操作,从而提高用户的实用性。

相对于 0.0.1 版本区别

  1. 由于v0.0.1版本是直接将三个版本依赖同时引入,属于强依赖,因此在使用的过程中需要配置指定使用哪个短信服务商地址, 考虑到在使用短信发送的过程中带来一定的不方便,将所有相关的强依赖移除,从而减轻依赖关系。
  2. 使用的方式相对v0.0.1的区别不大,只是需要单独引入对应的短信服务商的依赖即可快速上手。

短信服务 Starter

1. 开发工具及编译

  • IntelliJ IDEA 2018.2.5
  • Maven 3.5
  • JDK 1.8

2. 如何使用 sms-spring-boot-starter

(1). 在 pom 文件中引入

<dependency>
   <groupId>com.github.jackieonway.sms</groupId>
   <artifactId>sms-spring-boot-starter</artifactId>
   <version>0.0.2</version>
   <!-- 腾讯短信依赖 -->
  <!--  <dependency>
          <groupId>com.tencentcloudapi</groupId>
          <artifactId>tencentcloud-sdk-java</artifactId>
          <version>3.1.83</version>
       </dependency>-->

   <!-- 阿里短信依赖 -->
   <!--<dependency>
       <groupId>com.aliyun</groupId>
       <artifactId>aliyun-java-sdk-core</artifactId>
       <version>4.4.1</version>
   </dependency>-->

   <!-- 云之讯短信依赖 -->
   <!--<dependency>
       <groupId>com.github.jackieonway.sms</groupId>
       <artifactId>ucpass-client</artifactId>
       <version>0.0.2</version>
   </dependency>-->
   <!-- 赛邮短信依赖 -->
       <!--<dependency>
           <groupId>com.github.jackieonway.sms</groupId>
           <artifactId>submail-client</artifactId>
           <version>0.0.2</version>
   </dependency>-->
</dependency>

(2). 在 application.yml 中进行配置

spring:
  jackieonway:
    sms:
      sms-type: tencent  # 短信服务商,默认为ali
      security-key: your security-key # 短信的私钥
      appid: your appid # 短信的应用id
      sign: your sign # 短信的签名
      region: 

如果是阿里云短信,请参考以下配置:

spring:
  jackieonway:
    sms:
      sms-type: ali  # 短信服务商,默认为ali
      access-key: your aliyun access-key-id # 阿里云短信服务的公钥
      security-key: your aliyun access-key-secret # 阿里云短信服务的私钥
      domain: # 阿里云 域名
      region: cn-hangzhou # 阿里云短信服务的区域id
      version: 

如果是云之讯短信,请参考以下配置:

spring:
  jackieonway:
    sms:
      sms-type: ucpass  # 短信服务商 ,默认为ali
      appid: 
      access-key: your ucpass access-key-id #云之讯短信服务的公钥
      security-key: your ucpass access-key-secret # 云之讯短信服务的私钥
      domain: open.ucpaas.com # 云之讯短信服务地址 such as open.ucpaas.com

如果是赛邮,请参考以下配置:

spring:
  jackieonway:
    sms:
      sms-type: submail  # 短信服务商,默认为ali
      appid:   # 赛邮appId
      security-key: # 赛邮appkey

(3). 在 Springboot 主程序上加入注解

@SpringBootApplication
@EnabledSmsAutoConfiguration
public class SmsDemoApplication {

   public static void main(String[] args) {
       SpringApplication.run(SmsDemoApplication.class, args);
   }

}

(4). 创建发送短信程序

相对于 0.0.1 版本的短信服务,从 0.0.2 开始,依赖取消了版本的强依赖性,这样就需要在使用的时候显示引入相关依赖,使用注入 SmsService 时,直接注入即可 现在支持 阿里、腾讯、云之讯短信服务

    @Autowired
    private SmsService smsService;

参考示例如下:

@RestController
public class HelloController {

    @Autowired
    private SmsService smsService;

    @GetMapping("/tencent")
    public Object tencent() {
        // 具体配置请参照具体运营商
        // your template params
        String[] paramst = {"5678","5"};
        TencentSmsRequest tencentSmsRequest = new TencentSmsRequest();
        tencentSmsRequest.setPhoneNumber(new String[]{"your cellphone"});
        tencentSmsRequest.setParams(paramst);
        return smsService.sendTemplateSms("328921", tencentSmsRequest);
    }

    /* @GetMapping("/ali")
     public Object ali() {
         // 具体配置请参照具体运营商
         AliSmsRequest aliSmsRequest = new AliSmsRequest();
         aliSmsRequest.setPhoneNumbers(new String[]{"18600000000"});
         aliSmsRequest.setTemplateParam("{\"code\":\"123456\"}");
         aliSmsRequest.setSignName("xx科技");
         return smsService.sendTemplateSms("SMS_148614533",aliSmsRequest);
     }*/
}

(5). 发送

访问 http://localhost:8080/tencent 发送结果

访问 http://localhost:8080/ali ,短信发送成功:

image-20200311121852665

3. SmsService 接口

    /**
     *  单个发送短信
     * @param params 根据对应的短信服务商所需信息填写
     */
    public Object sendSms(Integer type,Object params);

    /**
     * 单个发送模板短信
     * @param tempalteId 短信模板id
     * @param params 根据对应的短信服务商所需信息填写
     */
    public Object sendTemplateSms(String tempalteId, Object params);

    /**
     *  批量发送短信
     * @param params 根据对应的短信服务商所需信息填写
     */
    public Object sendBatchSms(int type,Object params);

    /**
     * 批量发送模板短信
     * @param tempalteId 短信模板id
     * @param params 根据对应的短信服务商所需信息填写
     */
    public Object sendBatchTemplateSms(String tempalteId, Object params);

    /**
     * 异步发送模板短信
     * @param tempalteId 短信模板id
     * @param params 根据对应的短信服务商所需信息填写
     */
    void asyncSendTemplateSms(@NonNull String templateId, BaseRequest params);

    /**
     * 异步批量发送模板短信
     * @param tempalteId 短信模板id
     * @param params 根据对应的短信服务商所需信息填写
     */
    void asnycSendBatchTemplateSms(@NonNull String templateId, BaseRequest params);     

结语

目前腾讯短信服务、阿里云短信服务和云之讯短信服务均已验证成功,希望各位小伙伴共同完善该 starter,觉得有用请 starter 该项目。如果只想使用而腾讯云、阿里云等短信业务的话,按照 Demo 使用即可。

如何参与贡献

1. Fork 本仓库到自己的仓库
2. 从dev分支新建自己的分支
3. 修改或增加代码
4. 提交 Pull Requests ,等待审核合并

最新版本使用

(1). 在 pom 文件中引入

<dependency>
   <groupId>com.github.jackieonway.sms</groupId>
   <artifactId>sms-spring-boot-starter</artifactId>
   <version>0.0.3-SNAPSHOT</version>
   <!-- 腾讯短信依赖 -->
   <!--<dependency>
       <groupId>com.github.qcloudsms</groupId>
       <artifactId>qcloudsms</artifactId>
       <version>1.0.6</version>
   </dependency>-->

   <!-- 阿里短信依赖 -->
   <!--<dependency>
       <groupId>com.aliyun</groupId>
       <artifactId>aliyun-java-sdk-core</artifactId>
       <version>4.4.1</version>
   </dependency>-->

   <!-- 云之讯短信依赖 -->
   <!--<dependency>
       <groupId>com.github.jackieonway.sms</groupId>
       <artifactId>ucpass-client</artifactId>
       <version>0.0.3-SNAPSHOT</version>
   </dependency>-->
  <!-- 赛邮短信依赖 -->
  <!--<dependency>
        <groupId>com.github.jackieonway.sms</groupId>
        <artifactId>submail-client</artifactId>
        <version>0.0.3-SNAPSHOT</version>
   </dependency>-->
</dependency>

指定使用 Snapshot Repository

    <repositories>
        <repository>
            <id>mavenRepoCenter</id>
            <name>Maven Development Snapshot Repository</name>
            <url>https://oss.sonatype.org/content/repositories/snapshots</url>
            <releases>
                <enabled>false</enabled>
            </releases>
            <snapshots>
                <enabled>true</enabled>
            </snapshots>
        </repository>
    </repositories>

感谢

感谢参与提出意见或参与贡献的小伙伴

云之讯短信服务提供: @bigbearLoveTingting 赛邮云短信服务提供: @hb0730

参与贡献人员 : @flanliulf @hb0730

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 [yyyy] [name of copyright owner] 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.

简介

短信服务Spring Boot Starter ,目前支持腾讯、阿里和云之讯短信服务,腾讯、阿里和云之讯短信均已验证,期待各位小伙伴合作完善这个项目 展开 收起
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/dtsd/sms-spring-boot-project.git
git@gitee.com:dtsd/sms-spring-boot-project.git
dtsd
sms-spring-boot-project
sms-spring-boot-project
dev

搜索帮助