目录
一、短信发送验证码
1、准备工作
2、项目整合容联云
2.1 引入依赖
2.2 编写配置文件,修改启动类
2.3.1 创建常量类
2.3.2、封装验证码生成类
2.3.3、Controller 层
2.3.4、Service层
二、邮箱验证码
1、准备工作
2、整合邮箱服务
1、引入依赖
2、开发接口
一、短信发送验证码
1、准备工作
注册容联运账号,当然可以选择其他云,目前本人发现其他云以及容联云现在都不能个人认证,但是相对其他云,容联云免费给我们提供8元的短信配额,我们可以免费使用,非常给力。当然愿意且有能力使用其他云的也是可以,自由选择(当然本人下面的所有步骤就会议容联云为主了)
注册完成后前往控制台首页,找到Accout sid、token、Url这三个值。AppID是默认应用的id,注册后会有默认应用,当然我们可以自己在应用管理中添加新的应用,如果使用新的应用,记住其AppID。此处应用可以选择不上线.
2、项目整合容联云
2.1 引入依赖
<dependencies><!--容联云短信服务--><dependency><groupId>com.cloopen</groupId><artifactId>java-sms-sdk</artifactId><version>1.0.4</version></dependency>
</dependencies>
2.2 编写配置文件,修改启动类
# 服务端口
server.port=8204
# 服务名
spring.application.name=service-msm#返回json的全局时间格式
spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
spring.jackson.time-zone=GMT+8spring.redis.host=127.0.0.1
spring.redis.port=6379
spring.redis.database= 0
spring.redis.timeout=1800000
spring.redis.lettuce.pool.max-active=20
spring.redis.lettuce.pool.max-wait=-1
#最大阻塞等待时间(负数表示没限制)
spring.redis.lettuce.pool.max-idle=5
spring.redis.lettuce.pool.min-idle=0# nacos服务地址
spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848# 在外使用@value(${key})读取常量值 此处的值为前面准备工作中所让记住的值
app.cloopen.accountSId=······
app.cloopen.accountToken=······
app.cloopen.appId=······
app.cloopen.restDevUrl=https://app.cloopen.com
由于通常情况下该模块我们不会调用数据库,所有并没有配置数据源,这就需要我们做出改变
@SpringBootApplication(exclude = DataSourceAutoConfiguration.class)//取消数据源自动配置
依据自己项目是否为微服务,自己修改网关信息。
2.3.1 创建常量类
因为以前写的很多代码不怎么规范,而且有时候常量用到的不算太多太集中,所以就哪里用到哪个类上去声明一个出来,这样虽然很方便,但是项目做大了,常量多了不便于寻找,且后期需要对常量中的内容进行一些修改的时候,维护起来也十分不方便,代码整体结构也不优雅,所以引入常量类
// 读取配置文件定义的常量值,实现springboot一启动我们的常量就读取加载数据
@Component
public class ConstantPropertiesUtils implements InitializingBean {@Value("${app.cloopen.accountSId}")private String accountSId;@Value("${app.cloopen.accountToken}")private String accountToken;@Value("${app.cloopen.appId}")private String appId;@Value("${app.cloopen.restDevUrl}")private String restDevUrl;/*** 定义三个常量属性对外暴露调用*/public static String ACCOUNTS_ID;public static String ACCOUNT_TOKEN;public static String APP_ID;public static String REST_DEV_URL;/*** 加载执行的方法* 对三个变量赋值** @throws Exception*/@Overridepublic void afterPropertiesSet() throws Exception {ACCOUNTS_ID = accountSId;ACCOUNT_TOKEN = accountToken;APP_ID = appId;REST_DEV_URL = restDevUrl;}
}
2.3.2、封装验证码生成类
可以自己写验证码规则,也可以在网上找一套生成验证码的代码。
public class RandomUtil {private static final Random random = new Random();private static final DecimalFormat fourdf = new DecimalFormat("0000");private static final DecimalFormat sixdf = new DecimalFormat("000000");public static String getFourBitRandom() {return fourdf.format(random.nextInt(10000));}public static String getSixBitRandom() {return sixdf.format(random.nextInt(1000000));}/*** 给定数组,抽取n个数据* @param list* @param n* @return*/public static ArrayList getRandom(List list, int n) {Random random = new Random();HashMap<Object, Object> hashMap = new HashMap<Object, Object>();// 生成随机数字并存入HashMapfor (int i = 0; i < list.size(); i++) {int number = random.nextInt(100) + 1;hashMap.put(number, i);}// 从HashMap导入数组Object[] robjs = hashMap.values().toArray();ArrayList r = new ArrayList();// 遍历数组并打印数据for (int i = 0; i < n; i++) {r.add(list.get((int) robjs[i]));System.out.print(list.get((int) robjs[i]) + "\t");}System.out.print("\n");return r;}
}
2.3.3、Controller 层
讲一下这块逻辑,为了防止用户一直点击向同一手机号发送验证码,我们会判断是否发送成功,进而将验证码以k 为该手机号v为验证码的形式存入redis中去并设置过期时间,这样在未过期时间内再次调用,我们会直接返回。可以按照自己项目的逻辑来设计这块。
@RestController
@RequestMapping("/api/msm/login")
public class MsmController {@Autowiredprivate msmService msmService;@Autowiredprivate RedisTemplate redisTemplate;@GetMapping("/send/{phone}")public Result sendCode(@PathVariable("phone") String phone){//检查redis中是否含有验证码信息String code = (String) redisTemplate.opsForValue().get(phone);//如果存在 直接返回不需要再次发送if (!StringUtils.isEmpty(code)){return Result.ok();}//如果获取不到,则发送//1、生成验证码code = RandomUtil.getSixBitRandom();//2、调用service 发送短信验证码boolean isSend = msmService.send(phone,code);//3、生成验证码放入redis中if (isSend){redisTemplate.opsForValue().set(phone,code,2, TimeUnit.MINUTES);return Result.ok();}else {return Result.fail().message("发送短信失败");}}
}
2.3.4、Service层
可以仿照容联云官网给出的案例来编写,当然自己项目有想实现的逻辑、业务可以添加.
public boolean send(String phone, String code) {if (StringUtils.isEmpty(phone) || StringUtils.isEmpty(code)){return false;}String restDevUrl = ConstantPropertiesUtils.REST_DEV_URL;String serverPort="8883";//主账号String accountsId = ConstantPropertiesUtils.ACCOUNTS_ID;//主账户令牌String accountToken = ConstantPropertiesUtils.ACCOUNT_TOKEN;//以创建应用的idString appId = ConstantPropertiesUtils.APP_ID;CCPRestSmsSDK sdk=new CCPRestSmsSDK();// 初始化服务器地址和端口,生产环境配置成app.cloopen.com,端口是8883.sdk.init(restDevUrl,serverPort);// 初始化主账号名称和主账号令牌,登陆云通讯网站后,可在控制首页中看到开发者主账号 ACCOUNT SID和主账号令牌AUTH TOKEN。sdk.setAccount(accountsId,accountToken);// 初始化管理控制台中已创建应用的APPID。sdk.setAppId(appId);sdk.setBodyType(BodyType.Type_JSON);String target=phone;//短信模板idString templateId = "1";//短信模板String[] datas = {"验证码:"+code+",打死都不要告诉别人哦!", "2"};//发送HashMap<String, Object> stringObjectHashMap = sdk.sendTemplateSMS(target, templateId, datas);if ("000000".equals(stringObjectHashMap.get("statusCode"))){//正常返回输出data包体信息(map)HashMap<String,Object> data = (HashMap<String, Object>) stringObjectHashMap.get("data");Set<String> keySet = data.keySet();for (String key : keySet) {Object object = data.get(key);System.out.println(key + " = " + object);}return true;}else {//异常返回输出错误码和错误信息System.out.println("错误码=" + stringObjectHashMap.get("statusCode") + " 错误信息= " + stringObjectHashMap.get("statusMsg"));return false;}}
二、邮箱验证码
其实邮箱发送有很多种方式,本人选择使用Hutool工具包以及java的mail工具类进行邮件发送。
1、准备工作
本人以QQ邮箱做测试,需要设置独立密码。
选择开启服务,并记住返回给我们的授权码。
PS:本人猜测独立密码和授权码可能会有某种联系,如果都产生后,修改独立密码后,授权码不在有效,发送邮件时会报说我们登陆有误。不设置独立密码直接产生授权码不确定能不能使用,本人并没有去做搜集资料认证该猜测。
2、整合邮箱服务
1、引入依赖
<dependency><groupId>cn.hutool</groupId><artifactId>hutool-all</artifactId><version>4.3.1</version>
</dependency><dependency><groupId>javax.mail</groupId><artifactId>mail</artifactId><version>1.4.7</version>
</dependency>
2、开发接口
此处只是核心的部分,其余部分逻辑业务同上面的短信发送验证码。
public class sendByEmail{public boolean sendByEmail(String email, String code){String form="xvibeliker@qq.com"; //发送者邮箱,一般为自己的邮箱MailAccount account=new MailAccount();account.setHost("smtp.qq.com");account.setPort(25);//端口号 默认为25account.setAuth(true); //默认trueaccount.setFrom(form); //发送者邮箱account.setUser("xvibeliker@qq.com"); // 用户名,写邮箱即可account.setPass("xxxx"); //前面设置的授权码ArrayList<String> mailList = CollUtil.newArrayList(email);try {/***第一个参数是mailAccount对象,也就是你上面new的*第二个参数是你要发送消息的邮箱,可以是一个String(一个邮箱),也可以是一个 *Collection多个邮箱的集合*第三个参数是发送邮件的主题*第四个参数是邮件内容。*第四个参数默认为false即可。*/ MailUtil.send(account,mailList,"登陆验证码","你的验证码为:"+code+" ,有效时间为2分钟,打死不要告诉别人!",false);return true;}catch (Exception e){System.out.println(e.getMessage());System.out.println(email+" --> 该邮箱无法送达,请确认邮箱填写正确");return false;}}
}
至此,短信验证以及邮箱验证的功能就实现了,本人也处于学习阶段只是简单测试,有什么问题或错误,欢迎大家指正。