基于spring的sms4j短信集成推送

本文介绍了基于spring的sms4j短信集成推送的实战方法

1、购买短信包

创建签名，获取密钥。如腾讯云短信包

2、sms4j依赖

<dependency>
    <groupId>org.dromara.sms4j</groupId>
    <artifactId>sms4j-spring-boot-starter</artifactId>
</dependency>

3、短信发送工具类方法

import com.common.utils.StringUtils;
import org.dromara.sms4j.api.SmsBlend;
import org.dromara.sms4j.api.entity.SmsResponse;
import org.dromara.sms4j.core.factory.SmsFactory;
import org.springframework.stereotype.Service;

import java.util.LinkedHashMap;
import java.util.List;

/**
 * @Description Sms4j短信发送服务
 */
@Service
public class Sms4JService {

    private static final String DEFAULT_CONFIG_ID = "SmsService1";

    /**
     * 发送单条短信，使用默认短信服务商，使用系统配置的固定模板
     * @param phoneNumber
     * @param text
     * @return
     */
    public SmsResponse sendMessage(String phoneNumber, String text){
        return this.sendMessage(DEFAULT_CONFIG_ID, phoneNumber, text);
    }

    /**
     * 发送单条短信，如有多个短信服务商，根据指定服务器发送短信，使用系统配置的固定模板
     * @param phoneNumber
     * @param text
     * @return
     */
    public SmsResponse sendMessage(String configId, String phoneNumber, String text){
        if(StringUtils.isBlank(configId)){
            configId = DEFAULT_CONFIG_ID;
        }
        SmsBlend blend = SmsFactory.getSmsBlend(configId);
        return blend.sendMessage(phoneNumber, text);
    }

    /**
     * 异步发送单条短信，使用默认短信服务商，使用系统配置的固定模板
     * @param phoneNumber
     * @param text
     * @return
     */
    public void sendMessageAsync(String phoneNumber, String text){
        this.sendMessageAsync(DEFAULT_CONFIG_ID, phoneNumber, text);
    }

    /**
     * 异步发送单条短信，如有多个短信服务商，根据指定服务器发送短信，使用系统配置的固定模板
     * @param phoneNumber
     * @param text
     * @return
     */
    public void sendMessageAsync(String configId, String phoneNumber, String text){
        if(StringUtils.isBlank(configId)){
            configId = DEFAULT_CONFIG_ID;
        }
        SmsBlend blend = SmsFactory.getSmsBlend(configId);
        blend.sendMessageAsync(phoneNumber, text);
    }

    /**
     * <p>说明：群发固定模板短信，使用默认服务商
     * massTexting
     *
     * @author :Wind
     */
    public SmsResponse massTexting(List<String> phones, String message){
        return this.massTexting(DEFAULT_CONFIG_ID, phones, message);
    }

    /**
     * <p>说明：群发固定模板短信，指定服务商
     * massTexting
     *
     * @author :Wind
     */
    public SmsResponse massTexting(String configId, List<String> phones, String message){
        if(StringUtils.isBlank(configId)){
            configId = DEFAULT_CONFIG_ID;
        }
        SmsBlend blend = SmsFactory.getSmsBlend(configId);
        return blend.massTexting(phones, message);
    }

    /**
     * <p>说明：使用自定义模板群发短信
     * massTexting
     * @param templateId: 模板id
     * @param messages: key为模板变量名称, value为模板变量值
     * @author :Wind
     */
    public SmsResponse massTextingUseTemplate(List<String> phones, String templateId, LinkedHashMap<String, String> messages){
        return this.massTextingUseTemplate(DEFAULT_CONFIG_ID, phones, templateId, messages);
    }


    /**
     * <p>说明：使用自定义模板群发短信
     * massTexting
     * @param templateId: 模板id
     * @param messages: key为模板变量名称, value为模板变量值
     * @author :Wind
     */
    public SmsResponse massTextingUseTemplate(String configId, List<String> phones, String templateId, LinkedHashMap<String, String> messages){
        if(StringUtils.isBlank(configId)){
            configId = DEFAULT_CONFIG_ID;
        }
        SmsBlend blend = SmsFactory.getSmsBlend(configId);
        return blend.massTexting(phones, templateId, messages);
    }

    /**
     * 发送单条短信，使用默认短信服务商，使用自定义短信模板Id
     * @param phoneNumber
     * @param templateId: 模板id
     * @param messages: key为模板变量名称, value为模板变量值
     * @return
     */
    public SmsResponse sendMessageUseTemplate(String phoneNumber, String templateId, LinkedHashMap<String, String> messages){
        return this.sendMessageUseTemplate(DEFAULT_CONFIG_ID, phoneNumber, templateId, messages);
    }

    /**
     * 发送单条短信，使用指定短信服务商，使用自定义短信模板Id
     * @param phoneNumber
     * @param templateId: 模板id
     * @param messages: key为模板变量名称, value为模板变量值
     * @return
     */
    public SmsResponse sendMessageUseTemplate(String configId, String phoneNumber, String templateId, LinkedHashMap<String, String> messages){
        if(StringUtils.isBlank(configId)){
            configId = DEFAULT_CONFIG_ID;
        }
        SmsBlend blend = SmsFactory.getSmsBlend(configId);
        return blend.sendMessage(phoneNumber, templateId, messages);
    }

    /**
     * 异步发送单条短信，使用默认短信服务商，使用自定义短信模板Id
     * @param phoneNumber
     * @param templateId: 模板id
     * @param messages: key为模板变量名称, value为模板变量值
     * @return
     */
    public void sendMessageUseTemplateAsync(String phoneNumber, String templateId, LinkedHashMap<String, String> messages){
        this.sendMessageUseTemplateAsync(DEFAULT_CONFIG_ID, phoneNumber, templateId, messages);
    }


    /**
     * 异步发送单条短信，使用指定短信服务商，使用自定义短信模板Id
     * @param phoneNumber
     * @param templateId: 模板id
     * @param messages: key为模板变量名称, value为模板变量值
     * @return
     */
    public void sendMessageUseTemplateAsync(String configId, String phoneNumber, String templateId, LinkedHashMap<String, String> messages){
        if(StringUtils.isBlank(configId)){
            configId = DEFAULT_CONFIG_ID;
        }
        SmsBlend blend = SmsFactory.getSmsBlend(configId);
        blend.sendMessageAsync(phoneNumber, templateId, messages);
    }

}

4、调用方法

@Autowired
private Sms4JService sms4JService;



List<String> phones = new ArrayList<>(phonenumberSet);
sms4JService.massTexting(phones, content);