• 微服务项目：尚融宝（19）（后端搭建：阿里云短信服务整合）

    认清现实，放弃幻想，准备斗争

     

    阿里云短信服务

    一、使用RAM子用户

    1、进入子用户管理页面

    2、添加用户 

    3、获取子用户key

    AccessKeyId, AccessKeySecret

    这个玩意是找不回来的，创建的时候就应该马上保存下来，并且这玩意一般越久越不安全

    4、设置用户权限

    授权：AliyunDysmsFullAccess

    二、开通短信服务

    1、开通

    2、添加签名 

     3、添加模板

    一般个人来说，很难申请到的，可以用他自带的玩意先弄，自带也有模板什么的 

    4、套餐

    free.aliyun.com

    5、快速学习

    三、测试短信发送

    1、查找使用示例 

     2、测试短信发送

    3、查看发送结果

    短信服务->业务统计->发送记录查询

    创建短信微服务

    需求

    一、创建项目

    1、创建模块

    service-sms

    2、配置 pom.xml

    1. <dependencies>
    2.  
    3.     <dependency>
    4.         <groupId>com.atguigugroupId>
    5.         <artifactId>service-baseartifactId>
    6.         <version>0.0.1-SNAPSHOTversion>
    7.     dependency>
    8.  
    9.     <dependency>
    10.         <groupId>org.springframework.bootgroupId>
    11.         <artifactId>spring-boot-starter-webartifactId>
    12.     dependency>
    13.  
    14.     
    15.     <dependency>
    16.         <groupId>org.projectlombokgroupId>
    17.         <artifactId>lombokartifactId>
    18.     dependency>
    19.  
    20.     
    21.     <dependency>
    22.         <groupId>com.aliyungroupId>
    23.         <artifactId>aliyun-java-sdk-coreartifactId>
    24.     dependency>
    25.  
    26. dependencies>

    3、application.yml

    resources目录下创建文件

    1.  
    2. spring:
    3.   profiles:
    4.     active: dev # 环境设置
    5.   application:
    6.     name: service-sms # 服务名
    7.  
    8.   #spring:
    9.   redis:
    10.     host: 192.168.100.100
    11.     port: 6379
    12.     database: 0
    13.     password: 123456 #默认为空
    14.     timeout: 3000ms #最大等待时间，超时则抛出异常，否则请求一直等待
    15.     lettuce:
    16.       pool:
    17.         max-active: 20  #最大连接数，负值表示没有限制，默认8
    18.         max-wait: -1    #最大阻塞等待时间，负值表示没限制，默认-1
    19.         max-idle: 8     #最大空闲连接，默认8
    20.         min-idle: 0     #最小空闲连接，默认0
    21.  
    22. #阿里云短信
    23. aliyun:
    24.   sms:
    25.     region-id: cn-hangzhou
    26.     key-id: 你的keyid
    27.     key-secret: 你的keysecret
    28.     template-code: 你的短信模板code
    29.     sign-name: 你的短信模板签名

     4、logback-spring.xml

    1. "1.0" encoding="UTF-8"?>
    2. <configuration>
    3.  
    4.     <contextName>atguiguSrbcontextName>
    5.  
    6.     
    7.     <property name="log.path" value="D:/project/test/srb_log/sms" />
    8.  
    9.     
    10.     
    11.     
    12.     
    13.     
    14.     
    15.     <property name="CONSOLE_LOG_PATTERN"
    16.               value="%yellow(%date{yyyy-MM-dd HH:mm:ss}) %highlight([%-5level]) %green(%logger) %msg%n"/>
    17.  
    18.     
    19.     <property name="FILE_LOG_PATTERN"
    20.               value="%date{yyyy-MM-dd HH:mm:ss} [%-5level] %thread %file:%line %logger %msg%n" />
    21.  
    22.     
    23.     <property name="ENCODING"
    24.               value="UTF-8" />
    25.  
    26.     
    27.     <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
    28.         <encoder>
    29.             <pattern>${CONSOLE_LOG_PATTERN}pattern>
    30.             <charset>${ENCODING}charset>
    31.         encoder>
    32.     appender>
    33.  
    34.     
    35.     <appender name="FILE" class="ch.qos.logback.core.FileAppender">
    36.         <file>${log.path}/log.logfile>
    37.         <append>trueappend>
    38.         <encoder>
    39.             <pattern>${FILE_LOG_PATTERN}pattern>
    40.             <charset>${ENCODING}charset>
    41.         encoder>
    42.     appender>
    43.  
    44.     <appender name="ROLLING_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    45.  
    46.         
    47.         <file>${log.path}/log-rolling.logfile>
    48.         <encoder>
    49.             <pattern>${FILE_LOG_PATTERN}pattern>
    50.             <charset>${ENCODING}charset>
    51.         encoder>
    52.  
    53.  
    54.         
    55.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
    56.             
    57.             <fileNamePattern>${log.path}/info/log-rolling-%d{yyyy-MM-dd}.%i.logfileNamePattern>
    58.             
    59.             <maxHistory>15maxHistory>
    60.  
    61.             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
    62.                 <maxFileSize>1000KBmaxFileSize>
    63.             timeBasedFileNamingAndTriggeringPolicy>
    64.         rollingPolicy>
    65.  
    66.     appender>
    67.  
    68.  
    69.     
    70.     
    71.     
    72.     
    73.  
    74.     
    75.     <springProfile name="dev,test">
    76.         <logger name="com.atguigu" level="INFO">
    77.             <appender-ref ref="CONSOLE" />
    78.         logger>
    79.     springProfile>
    80.  
    81.     
    82.     <springProfile name="prod">
    83.         <logger name="com.atguigu" level="ERROR">
    84.             <appender-ref ref="CONSOLE" />
    85.             <appender-ref ref="ROLLING_FILE" />
    86.         logger>
    87.     springProfile>
    88. configuration>

    5、创建SpringBoot启动类

    1. @SpringBootApplication
    2. @ComponentScan({"com.atguigu.srb", "com.atguigu.common"})
    3. public class ServiceSmsApplication {
    4.     
    5.     public static void main(String[] args) {
    6.         SpringApplication.run(ServiceSmsApplication.class, args);
    7.     }
    8. }

    二、自定义配置

    1、从配置文件读取常量

    创建常量读取工具类：SmsProperties.java+

    1. @Setter
    2. @Getter //idea2020.2.3版配置文件自动提示需要这个
    3. @Component
    4. //注意prefix要写到最后一个 "." 符号之前
    5. //调用setter为成员赋值
    6. @ConfigurationProperties(prefix = "aliyun.sms")
    7. public class SmsProperties implements InitializingBean {
    8.  
    9.     private String regionId;
    10.     private String keyId;
    11.     private String keySecret;
    12.     private String templateCode;
    13.     private String signName;
    14.  
    15.     public static String REGION_Id;
    16.     public static String KEY_ID;
    17.     public static String KEY_SECRET;
    18.     public static String TEMPLATE_CODE;
    19.     public static String SIGN_NAME;
    20.  
    21.     //当私有成员被赋值后，此方法自动被调用，从而初始化常量
    22.     @Override
    23.     public void afterPropertiesSet() throws Exception {
    24.         REGION_Id = regionId;
    25.         KEY_ID = keyId;
    26.         KEY_SECRET = keySecret;
    27.         TEMPLATE_CODE = templateCode;
    28.         SIGN_NAME = signName;
    29.     }
    30. }

    Idea报告如下错误信息（不影响程序的编译和运行）：

    解决方案参考文档：

    解决步骤：

    step1：添加 
    3. <dependency>
    4.     <groupId>org.springframework.bootgroupId>
    5.     <artifactId>spring-boot-configuration-processorartifactId>
    6.     <optional>trueoptional>
    7. dependency>

    step2：启动processor

    • step3：重新编译模块
    • step4：这样就可以在yml文件中有自定义配置的提示信息啦

       2、测试工具类

    创建测试类 UtilsTests，测试配置信息是否能正常获取

    1. @SpringBootTest
    2. @RunWith(SpringRunner.class)
    3. public class UtilsTests {
    4.  
    5.     @Test
    6.     public void testProperties(){
    7.         System.out.println(SmsProperties.KEY_ID);
    8.         System.out.println(SmsProperties.KEY_SECRET);
    9.         System.out.println(SmsProperties.REGION_Id);
    10.     }
    11. }

     

    三、发送短信

    1、短信发送业务

    接口：创建 SmsService

    1. public interface SmsService {
    2.  
    3.     void send(String mobile, String templateCode, Map param);
    4. }

    实现：创建 SmsServiceImpl 

    1. @Service
    2. @Slf4j
    3. public class SmsServiceImpl implements SmsService {
    4.  
    5.     @Override
    6.     public void send(String mobile, String templateCode, Map param) {
    7.  
    8.         //创建远程连接客户端对象
    9.         DefaultProfile profile = DefaultProfile.getProfile(
    10.                 SmsProperties.REGION_Id,
    11.                 SmsProperties.KEY_ID,
    12.                 SmsProperties.KEY_SECRET);
    13.         IAcsClient client = new DefaultAcsClient(profile);
    14.  
    15.         //创建远程连接的请求参数
    16.         CommonRequest request = new CommonRequest();
    17.         request.setSysMethod(MethodType.POST);
    18.         request.setSysDomain("dysmsapi.aliyuncs.com");
    19.         request.setSysVersion("2017-05-25");
    20.         request.setSysAction("SendSms");
    21.         request.putQueryParameter("RegionId", SmsProperties.REGION_Id);
    22.         request.putQueryParameter("PhoneNumbers", mobile);
    23.         request.putQueryParameter("SignName", SmsProperties.SIGN_NAME);
    24.         request.putQueryParameter("TemplateCode", templateCode);
    25.  
    26.         Gson gson = new Gson();
    27.         String json = gson.toJson(param);
    28.         request.putQueryParameter("TemplateParam", json);
    29.  
    30.         try {
    31.             //使用客户端对象携带请求对象发送请求并得到响应结果
    32.             CommonResponse response = client.getCommonResponse(request);
    33.             boolean success = response.getHttpResponse().isSuccess();
    34.             //ALIYUN_RESPONSE_FAIL(-501, "阿里云响应失败"),
    35.             Assert.isTrue(success, ResponseEnum.ALIYUN_RESPONSE_FAIL);
    36.  
    37.             String data = response.getData();
    38.             HashMap resultMap = gson.fromJson(data, HashMap.class);
    39.             String code = resultMap.get("Code");
    40.             String message = resultMap.get("Message");
    41.             log.info("阿里云短信发送响应结果：");
    42.             log.info("code：" + code);
    43.             log.info("message：" + message);
    44.  
    45.             //ALIYUN_SMS_LIMIT_CONTROL_ERROR(-502, "短信发送过于频繁"),//业务限流
    46.             Assert.notEquals("isv.BUSINESS_LIMIT_CONTROL", code, ResponseEnum.ALIYUN_SMS_LIMIT_CONTROL_ERROR);
    47.             //ALIYUN_SMS_ERROR(-503, "短信发送失败"),//其他失败
    48.             Assert.equals("OK", code, ResponseEnum.ALIYUN_SMS_ERROR);
    49.  
    50.         } catch (ServerException e) {
    51.             log.error("阿里云短信发送SDK调用失败：");
    52.             log.error("ErrorCode=" + e.getErrCode());
    53.             log.error("ErrorMessage=" + e.getErrMsg());
    54.             throw new BusinessException(ResponseEnum.ALIYUN_SMS_ERROR , e);
    55.         } catch (ClientException e) {
    56.             log.error("阿里云短信发送SDK调用失败：");
    57.             log.error("ErrorCode=" + e.getErrCode());
    58.             log.error("ErrorMessage=" + e.getErrMsg());
    59.             throw new BusinessException(ResponseEnum.ALIYUN_SMS_ERROR , e);
    60.         }
    61.     }
    62. }

    2、引入工具类

    RegexValidateUtils.java：常用正则表达式验证，这里提供了手机号码验证
    guigu-common中创建util包，引入工具类：
    RandomUtils.java：生成四位或六位的验证码

     3、创建controller

    创建controller.api包，创建类ApiSmsController 
    1. @RestController
    2. @RequestMapping("/api/sms")
    3. @Api(tags = "短信管理")
    4. @CrossOrigin //跨域
    5. @Slf4j
    6. public class ApiSmsController {
    7.  
    8.     @Resource
    9.     private SmsService smsService;
    10.  
    11.     @Resource
    12.     private RedisTemplate redisTemplate;
    13.  
    14.     @ApiOperation("获取验证码")
    15.     @GetMapping("/send/{mobile}")
    16.     public R send(
    17.             @ApiParam(value = "手机号", required = true)
    18.             @PathVariable String mobile){
    19.  
    20.         //MOBILE_NULL_ERROR(-202, "手机号不能为空"),
    21.         Assert.notEmpty(mobile, ResponseEnum.MOBILE_NULL_ERROR);
    22.         //MOBILE_ERROR(-203, "手机号不正确"),
    23.         Assert.isTrue(RegexValidateUtils.checkCellphone(mobile), ResponseEnum.MOBILE_ERROR);
    24.  
    25.         //生成验证码
    26.         String code = RandomUtils.getFourBitRandom();
    27.         //组装短信模板参数
    28.         Map param = new HashMap<>();
    29.         param.put("code", code);
    30.         //发送短信
    31.         smsService.send(mobile, SmsProperties.TEMPLATE_CODE, param);
    32.  
    33.         //将验证码存入redis
    34.         redisTemplate.opsForValue().set("srb:sms:code:" + mobile, code, 5, TimeUnit.MINUTES);
    35.  
    36.         return R.ok().message("短信发送成功");
    37.     }
    38. }

    四、配置Swagger

    1、添加配置

    service-base中添加网站端api的配置

    1.     @Bean
    2.     public Docket apiConfig(){
    3.  
    4.         return new Docket(DocumentationType.SWAGGER_2)
    5.                 .groupName("api")
    6.                 .apiInfo(apiInfo())
    7.                 .select()
    8.                 //只显示admin路径下的页面
    9.                 .paths(Predicates.and(PathSelectors.regex("/api/.*")))
    10.                 .build();
    11.  
    12.     }
    13.  
    14.     private ApiInfo apiInfo(){
    15.  
    16.         return new ApiInfoBuilder()
    17.                 .title("尚融宝-API文档")
    18.                 .description("本文档描述了尚融宝接口")
    19.                 .version("1.0")
    20.                 .contact(new Contact("Helen", "http://atguigu.com", "55317332@qq.com"))
    21.                 .build();
    22.     }

    2、测试

    测试正确发送

    测试手机号码不正确

    测试业务限流

    今日bug

    2022-09-05 11:37:25 [ERROR] com.atguigu.common.exception.UnifiedExceptionHandler Unable to connect to Redis; nested exception is org.springframework.data.redis.connection.PoolException: Could not get a resource from the pool; nested exception is io.lettuce.core.RedisConnectionException: Unable to connect to 192.168.231.137:6379

    Injection of resource dependencies failed; nested exception is org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'redisTemplate' defined in class path resource [com/atguigu/srb/base/config/RedisConfig.class]: Unsatisfied dependency expressed through method 'redisTemplate' parameter 0; nested exception is org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'org.springframework.data.redis.connection.lettuce.LettuceConnectionFactory' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: {} 

     原因和解决

    redis版本冲突出现问题，在base模块中引新的的依赖解决

    1. <dependency>
    2.     <groupId>org.springframework.bootgroupId>
    3.     <artifactId>spring-boot-starter-data-redisartifactId>
    4.     <version>2.1.3.RELEASEversion>
    5. dependency>
    6.  
    7. <dependency>
    8.     <groupId>redis.clientsgroupId>
    9.     <artifactId>jedisartifactId>
    10.     <version>2.9.1version>
    11. dependency>

  • 相关阅读:
    Spring循环依赖
    植物大战僵尸各种僵尸攻略
    常规的知识积累
    c++ 线程类
    C++项目：仿mudou库one thread one loop式并发服务器实现
    RabbitMQ-简述
    《树莓派项目实战》第六节 使用超声波模块测距
    Nginx rtmp&&Centos FFmpeg安装配置
    说说Flink双流join
    java之流程控制
  • 原文地址：https://blog.csdn.net/m0_62436868/article/details/126715130