devbox
凡人多烦事01
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

springboot整合redis实现发送短信验证码_springboot redis批量发送短信池

作者：凡人多烦事01 | 2024-04-30 03:12:45

赞

踩

springboot redis批量发送短信池

    我用的短信平台是阿里云的，需要付费购买服务，购买地址：https://common-buy.aliyun.com/?spm=5176.8195934.907839.sms6.312c4183mzE9Yb&&commodityCode=newdysmsbag#/buy

    付费完成后，首先申请短信签名和短信模板：https://help.aliyun.com/document_detail/55327.html?spm=a2c4g.11186623.6.549.huzd56。

短信签名：根据用户属性来创建符合自身属性的签名信息。企业用户需要上传相关企业资质证明，个人用户需要上传证明个人身份的证明。注意：短信签名需要审核通过后才可以使用。

短信模板：短信模板，即具体发送的短信内容。短信模板可以支持验证码、短信通知、推广短信、国际/港澳台消息四种模式。验证码和短信通知，通过变量替换实现个性短信定制。推广短信不支持在模板中添加变量。短信模板需要审核通过后才可以使用。

短信示例：【阿里云】 验证码${number}，您正进行支付宝的身份验证，打死不告诉别人！这里的短信签名：阿里云，短信模板: 验证码${number}，您正进行支付宝的身份验证，打死不告诉别人！

    最后获取 asscessKeyId 和 accessKeySecret 。结合阿里云提供的开发者文档即可进行接口开发，短信开发api文档：https://help.aliyun.com/product/44282.html?spm=a2c4g.750001.6.1.T84wBi

一、安装redis

下载地址：Redis，下载最新稳定版本。

在/usr/local创建redis文件夹上传下载的安装包到redis目录下：

安装：

$ tar -zxvf redis-4.0.9.tar.gz
$ cd redis-4.0.9
$ make

安装完成后的目录：

$ cd  src
$ ./redis-server  ../redis.conf
./redis-server 这种方式启动redis 使用的是默认配置。可以通过启动参数告诉redis使用指定配置文件使用下面命令启动。

二、创建maven工程，目录结构如下：

三、pom.xml文件添加redis依赖

  1. <!--redis-->
  2. <dependency>
  3.     <groupId>org.springframework.boot</groupId>
  4.     <artifactId>spring-boot-starter-data-redis</artifactId>
  5. </dependency>

四、application.properties添加redis配置

五、随机生成验证码工具类

  1. public class IdentifyCodeUtil {
  2.  
  3.     public static String getRandom() {
  4.         String num = "";
  5.         for (int i = 0; i < 6; i++) {
  6.             num = num + String.valueOf((int) Math.floor(Math.random() * 9 + 1));
  7.         }
  8.         return num;
  9.     }
  10. }

六、redis缓存配置类

     sprringboot启动类Application.java加入注解：@EnableCaching

   配置redis采用缓存，设置key和value的序列化方式

  1. package com.jp.tech.applet.ms.sms;
  2.  
  3. import com.fasterxml.jackson.annotation.JsonAutoDetect;
  4. import com.fasterxml.jackson.annotation.PropertyAccessor;
  5. import com.fasterxml.jackson.databind.ObjectMapper;
  6. import org.springframework.cache.CacheManager;
  7. import org.springframework.cache.annotation.CachingConfigurerSupport;
  8. import org.springframework.cache.annotation.EnableCaching;
  9. import org.springframework.context.annotation.Bean;
  10. import org.springframework.context.annotation.Configuration;
  11. import org.springframework.data.redis.cache.RedisCacheManager;
  12. import org.springframework.data.redis.connection.RedisConnectionFactory;
  13. import org.springframework.data.redis.core.RedisTemplate;
  14. import org.springframework.data.redis.core.StringRedisTemplate;
  15. import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;
  16.  
  17.  
  18. /**
  19.  * Redis缓存配置类
  20.  *
  21.  * @author yangfeng
  22.  */
  23. @Configuration
  24. @EnableCaching
  25. public class RedisConfig extends CachingConfigurerSupport {
  26.  
  27.     //缓存管理器
  28.     @Bean
  29.     public CacheManager cacheManager(@SuppressWarnings("rawtypes") RedisTemplate redisTemplate) {
  30.         RedisCacheManager cacheManager = new RedisCacheManager(redisTemplate);
  31.         //设置缓存过期时间
  32.         //cacheManager.setDefaultExpiration(20);
  33.         return cacheManager;
  34.     }
  35.  
  36.     @Bean
  37.     public RedisTemplate<String, String> redisTemplate(RedisConnectionFactory factory) {
  38.         StringRedisTemplate template = new StringRedisTemplate(factory);
  39.         setSerializer(template);//设置序列化工具
  40.         template.afterPropertiesSet();
  41.         return template;
  42.     }
  43.  
  44.     private void setSerializer(StringRedisTemplate template) {
  45.         @SuppressWarnings({"rawtypes", "unchecked"})
  46.         Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(Object.class);
  47.         ObjectMapper om = new ObjectMapper();
  48.         om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
  49.         om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
  50.         jackson2JsonRedisSerializer.setObjectMapper(om);
  51.         template.setValueSerializer(jackson2JsonRedisSerializer);
  52.     }
  53. }

七、redis接口类

      此接口用于连接redis操作生成的验证码，设置过期时间。

  1. public interface IRedisService {
  2.  
  3.     /**
  4.      * 设置key-value
  5.      * @param key
  6.      * @param value
  7.      */
  8.     void setKey(String key, String value);
  9.  
  10.     /**
  11.      * 获取key
  12.      * @param key
  13.      * @return
  14.      */
  15.     String getValue(String key);
  16.  
  17.     /**
  18.      * 删除key
  19.      * @param key
  20.      */
  21.     void delete(String key);
  22. }

八、redis接口实现类

      保存、获取、删除验证码接口实现方法。

  1. import com.jp.tech.applet.ms.sms.service.IRedisService;
  2. import org.springframework.data.redis.core.*;
  3. import org.springframework.stereotype.Service;
  4.  
  5. import javax.annotation.Resource;
  6. import java.util.List;
  7. import java.util.Map;
  8. import java.util.Set;
  9. import java.util.concurrent.TimeUnit;
  10.  
  11. @Service
  12. public class RedisService implements IRedisService {
  13.  
  14.     @Resource
  15.     private RedisTemplate redisTemplate;
  16.  
  17.     @Override
  18.     public void setKey(String key, String value) {
  19.         ValueOperations<String, String> ops = redisTemplate.opsForValue();
  20.         ops.set(key, value, 900, TimeUnit.SECONDS);//15分钟过期
  21.     }
  22.  
  23.     @Override
  24.     public String getValue(String key) {
  25.         ValueOperations<String, String> ops = redisTemplate.opsForValue();
  26.         return ops.get(key);
  27.     }
  28.  
  29.     @Override
  30.     public void delete(String key) {
  31.         redisTemplate.delete(key);
  32.     }
  33.  
  34. }

九、发送短信接口类

  1. package com.jp.zpzc.service;
  2.  
  3. import com.aliyuncs.dysmsapi.model.v20170525.QuerySendDetailsResponse;
  4. import com.aliyuncs.dysmsapi.model.v20170525.SendSmsResponse;
  5. import com.aliyuncs.exceptions.ClientException;
  6. import com.jp.framework.common.model.ServiceResult;
  7.  
  8. public interface ISmsService {
  9.  
  10.     /**
  11.      * 发送短信接口
  12.      *
  13.      * @param phoneNums     手机号码
  14.      * @param signName      模板签名
  15.      * @param templeteCode  模板代码
  16.      * @param templateParam 模板替换参数
  17.      * @param outId         提供给业务方扩展字段
  18.      * @return
  19.      * @throws ClientException
  20.      */
  21.     SendSmsResponse sendSms(String phoneNums, String signName, String templeteCode,
  22.                             String templateParam, String outId) throws ClientException;
  23.  
  24.     /**
  25.      * 查询短信发送明细
  26.      *
  27.      * @param phoneNumber
  28.      * @param bizId       业务流水号
  29.      * @return
  30.      * @throws ClientException
  31.      */
  32.     QuerySendDetailsResponse querySendDetails(String phoneNumber, String bizId) throws ClientException;
  33.  
  34.     /**
  35.      * 发送短信服务
  36.      *
  37.      * @param mobile 手机号
  38.      * @return
  39.      */
  40.     ServiceResult<Object> sendMessage(String mobile);
  41.  
  42.  
  43.     /**
  44.      * 判断验证码是否正确
  45.      *
  46.      * @param mobile
  47.      * @param identifyCode
  48.      * @return
  49.      */
  50.     ServiceResult<Boolean> checkIsCorrectCode(String mobile, String identifyCode);
  51.  
  52. }

十、短信接口实现类

pom中引入阿里云短信SDK：

  1.         <!--阿里云短信服务平台-->
  2.         <dependency>
  3.             <groupId>com.aliyun</groupId>
  4.             <artifactId>aliyun-java-sdk-core</artifactId>
  5.             <version>3.3.1</version>
  6.         </dependency>
  7.         <dependency>
  8.             <groupId>com.aliyun</groupId>
  9.             <artifactId>aliyun-java-sdk-dysmsapi</artifactId>
  10.             <version>1.1.0</version>
  11.         </dependency>

application.properties加入调用接口的认证信息：

  1. aliyun.sms.accessKeyId=LTAIr0fPaMi66tCy111
  2. aliyun.sms.accessKeySecret=bQ9Re8uV14yRKKhWdWAbbUO15EM7w1​111

这里我用的是阿里云短信平台，根据提供的demo自己整理后的接口实现。

smsService.sendSms(phoneName, "XXXXXX", "XXXXXXX", JSON.toJSONString(codeMap), null)

第一个XXXXX代表申请的短信签名名称，第二个代表申请的短信模板编码，改成自己申请的即可。

  1. package com.jp.zpzc.service.impl;
  2.  
  3. import com.alibaba.fastjson.JSON;
  4. import com.aliyuncs.DefaultAcsClient;
  5. import com.aliyuncs.IAcsClient;
  6. import com.aliyuncs.dysmsapi.model.v20170525.QuerySendDetailsRequest;
  7. import com.aliyuncs.dysmsapi.model.v20170525.QuerySendDetailsResponse;
  8. import com.aliyuncs.dysmsapi.model.v20170525.SendSmsRequest;
  9. import com.aliyuncs.dysmsapi.model.v20170525.SendSmsResponse;
  10. import com.aliyuncs.exceptions.ClientException;
  11. import com.aliyuncs.profile.DefaultProfile;
  12. import com.aliyuncs.profile.IClientProfile;
  13. import com.jp.framework.common.model.ServiceResult;
  14. import com.jp.framework.common.model.ServiceResultHelper;
  15. import com.jp.framework.common.util.Constant;
  16. import com.jp.framework.common.util.IdentifyCodeUtil;
  17. import com.jp.zpzc.service.IRedisService;
  18. import com.jp.zpzc.service.ISmsService;
  19. import org.apache.commons.lang3.StringUtils;
  20. import org.slf4j.Logger;
  21. import org.slf4j.LoggerFactory;
  22. import org.springframework.beans.factory.annotation.Value;
  23. import org.springframework.stereotype.Service;
  24.  
  25. import javax.annotation.Resource;
  26. import java.text.SimpleDateFormat;
  27. import java.util.Date;
  28. import java.util.HashMap;
  29. import java.util.Map;
  30.  
  31. @Service
  32. public class SmsService implements ISmsService {
  33.  
  34.     private Logger logger = LoggerFactory.getLogger(this.getClass());
  35.  
  36.     //产品名称:云通信短信API产品,开发者无需替换
  37.     static final String product = "Dysmsapi";
  38.     //产品域名,开发者无需替换
  39.     static final String domain = "dysmsapi.aliyuncs.com";
  40.  
  41.     @Value("${aliyun.sms.accessKeyId}")
  42.     private String accessKeyId;
  43.     @Value("${aliyun.sms.accessKeySecret}")
  44.     private String accessKeySecret;
  45.  
  46.     @Resource
  47.     private IRedisService redisService;
  48.  
  49.     /**
  50.      * 发送短信服务
  51.      *
  52.      * @param mobile
  53.      * @return
  54.      */
  55.     public ServiceResult<Object> sendMessage(String mobile) {
  56.         if (StringUtils.isEmpty(mobile)) {
  57.             return ServiceResultHelper.genResultWithFaild(Constant.ErrorCode.INVALID_PARAM_MSG, Constant.ErrorCode.INVALID_PARAM_CODE);
  58.         }
  59.         String identifyCode;
  60.         //1. 判断是否缓存该账号验证码
  61.         String returnCode = redisService.getValue(mobile + Constant.SMS_LOGIN_IDENTIFY_CODE);
  62.         if (!StringUtils.isEmpty(returnCode)) {
  63.             identifyCode = returnCode;
  64.         } else {
  65.             identifyCode = IdentifyCodeUtil.getRandom();
  66.         }
  67.         //2.发送短信
  68.         Map<String, String> codeMap = new HashMap<>();
  69.         codeMap.put("code", identifyCode);
  70.         SendSmsResponse response;
  71.         try {
  72.             response = sendSms(mobile, XXXXX, XXXXX, JSON.toJSONString(codeMap), null);
  73.             //短信发送成功后存入redis
  74.             if (response != null && Constant.SMS_SEND_STATUS_OK.equalsIgnoreCase(response.getCode()) && StringUtils.isEmpty(returnCode)) {
  75.                 redisService.setKey(mobile + Constant.SMS_LOGIN_IDENTIFY_CODE, identifyCode);
  76.             }
  77.             return ServiceResultHelper.genResultWithSuccess(response);
  78.         } catch (Exception e) {
  79.             logger.error("sendMessage method invoke error: {}", e.getMessage());
  80.         }
  81.         return ServiceResultHelper.genResultWithFaild("短信发送失败", null);
  82.     }
  83.  
  84.     /**
  85.      * 发送短信接口
  86.      *
  87.      * @param phoneNums
  88.      * @param signName      模板签名
  89.      * @param templeteCode  模板代码
  90.      * @param templateParam 模板替换参数
  91.      * @param outId         提供给业务方扩展字段
  92.      * @return
  93.      * @throws ClientException
  94.      */
  95.     @Override
  96.     public SendSmsResponse sendSms(String phoneNums, String signName, String templeteCode, String templateParam, String outId) throws ClientException {
  97.         //可自助调整超时时间
  98.         System.setProperty("sun.net.client.defaultConnectTimeout", "10000");
  99.         System.setProperty("sun.net.client.defaultReadTimeout", "10000");
  100.  
  101.         //初始化acsClient,暂不支持region化
  102.         IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou", accessKeyId, accessKeySecret);
  103.         DefaultProfile.addEndpoint("cn-hangzhou", "cn-hangzhou", product, domain);
  104.         IAcsClient acsClient = new DefaultAcsClient(profile);
  105.  
  106.         //组装请求对象-具体描述见控制台-文档部分内容
  107.         SendSmsRequest request = new SendSmsRequest();
  108.         //必填:待发送手机号
  109.         request.setPhoneNumbers(phoneNums);
  110.         //必填:短信签名-可在短信控制台中找到
  111.         request.setSignName(signName);//众评众测
  112.         //必填:短信模板-可在短信控制台中找到
  113.         request.setTemplateCode(templeteCode);
  114.         //可选:模板中的变量替换JSON串,如模板内容为"亲爱的${name},您的验证码为${code}"时,此处的值为
  115.         request.setTemplateParam(templateParam);//{"code":"152745"}
  116.  
  117.         //选填-上行短信扩展码(无特殊需求用户请忽略此字段)
  118.         //request.setSmsUpExtendCode("90997");
  119.  
  120.         //可选:outId为提供给业务方扩展字段,最终在短信回执消息中将此值带回给调用者
  121.         request.setOutId(outId);//zpzc
  122.  
  123.         //hint 此处可能会抛出异常，注意catch
  124.  
  125.         SendSmsResponse sendSmsResponse = acsClient.getAcsResponse(request);
  126.         acsClient.getAcsResponse(request);
  127.         return sendSmsResponse;
  128.     }
  129.  
  130.     /**
  131.      * 判断验证码是否正确
  132.      *
  133.      * @param mobile
  134.      * @param identifyCode
  135.      * @return
  136.      */
  137.     public ServiceResult<Boolean> checkIsCorrectCode(String mobile, String identifyCode) {
  138.         if (StringUtils.isEmpty(mobile) || StringUtils.isEmpty(identifyCode)) {
  139.             return ServiceResultHelper.genResultWithFaild(Constant.ErrorCode.INVALID_PARAM_MSG, Constant.ErrorCode.INVALID_PARAM_CODE);
  140.         }
  141.         String returnCode = redisService.getValue(mobile + Constant.SMS_LOGIN_IDENTIFY_CODE);
  142.         if (!StringUtils.isEmpty(returnCode) && returnCode.equals(identifyCode)) {
  143.             return ServiceResultHelper.genResultWithSuccess();
  144.         }
  145.         return ServiceResultHelper.genResultWithFaild();
  146.     }
  147.  
  148.     /**
  149.      * 查询短信发送明细
  150.      *
  151.      * @param phoneNumber
  152.      * @param bizId
  153.      * @return
  154.      * @throws ClientException
  155.      */
  156.     @Override
  157.     public QuerySendDetailsResponse querySendDetails(String phoneNumber, String bizId) throws ClientException {
  158.         //可自助调整超时时间
  159.         System.setProperty("sun.net.client.defaultConnectTimeout", "10000");
  160.         System.setProperty("sun.net.client.defaultReadTimeout", "10000");
  161.  
  162.         //初始化acsClient,暂不支持region化
  163.         IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou", accessKeyId, accessKeySecret);
  164.         DefaultProfile.addEndpoint("cn-hangzhou", "cn-hangzhou", product, domain);
  165.         IAcsClient acsClient = new DefaultAcsClient(profile);
  166.  
  167.         //组装请求对象
  168.         QuerySendDetailsRequest request = new QuerySendDetailsRequest();
  169.         //必填-号码
  170.         request.setPhoneNumber(phoneNumber);
  171.         //可选-流水号
  172.         request.setBizId(bizId);
  173.         //必填-发送日期 支持30天内记录查询，格式yyyyMMdd
  174.         SimpleDateFormat ft = new SimpleDateFormat("yyyyMMdd");
  175.         request.setSendDate(ft.format(new Date()));
  176.         //必填-页大小
  177.         request.setPageSize(10L);
  178.         //必填-当前页码从1开始计数
  179.         request.setCurrentPage(1L);
  180.  
  181.         //hint 此处可能会抛出异常，注意catch
  182.         QuerySendDetailsResponse querySendDetailsResponse = acsClient.getAcsResponse(request);
  183.         return querySendDetailsResponse;
  184.     }
  185. }

十一、controller类

       调用redis存入随机生成的验证码，调用短信平台接口发送验证码。

  1. package com.jp.zpzc.controller.sms;
  2.  
  3. import com.jp.zpzc.service.ISmsService;
  4. import org.slf4j.Logger;
  5. import org.slf4j.LoggerFactory;
  6. import org.springframework.web.bind.annotation.RequestMapping;
  7. import org.springframework.web.bind.annotation.RequestParam;
  8. import org.springframework.web.bind.annotation.RestController;
  9.  
  10. import javax.annotation.Resource;
  11.  
  12.  
  13. /**
  14.  * 短信验证码接口
  15.  *
  16.  * @author yangfeng
  17.  * @date 2018-06-09 16:02
  18.  **/
  19. @RestController
  20. @RequestMapping("/smsVerifityCode")
  21. public class SmsVerifityCodeController {
  22.  
  23.     private Logger LOG = LoggerFactory.getLogger(this.getClass());
  24.  
  25.     @Resource
  26.     private ISmsService smsService;
  27.  
  28.     /**
  29.      * 发送短信验证码
  30.      *
  31.      * @param mobile
  32.      * @return
  33.      */
  34.     @RequestMapping("/sendMessage")
  35.     public Object sendMessage(@RequestParam String mobile) {
  36.         return smsService.sendMessage(mobile);
  37.     }
  38.  
  39.     /**
  40.      * 判断验证码是否正确
  41.      *
  42.      * @param mobile
  43.      * @param identifyCode
  44.      * @return
  45.      */
  46.     @RequestMapping("/checkIsCorrectCode")
  47.     public Object checkIsCorrectCode(@RequestParam String mobile, @RequestParam String identifyCode) {
  48.         return smsService.checkIsCorrectCode(mobile, identifyCode);
  49.     }
  50. }

十二、短信发送测试


短信发送成功。

附：

Constant类代码：

  1. package com.jp.tech.applet.common.constant;
  2.  
  3. public class Constant {
  4.     
  5.  
  6.     public static class ErrorCode {
  7.  
  8.         /**
  9.          * 无效参数
  10.          */
  11.         public static Integer INVALID_PARAM_CODE = -101;
  12.         public static String INVALID_PARAM_MSG = "无效参数";
  13.  
  14.         /**
  15.          * 没有权限
  16.          */
  17.         public static Integer PERMISSION_DENIED_CODE = -102;
  18.         public static String PERMISSION_DENIED_MSG = "没有权限";
  19.  
  20.         /**
  21.          * 通用错误
  22.          */
  23.         public static Integer COMMON_ERROR_CODE = -103;
  24.         public static String COMMON_ERROR_MSG = "服务器繁忙，请稍后再试";
  25.  
  26.         /**
  27.          * 登录失效
  28.          */
  29.         public static Integer INVALID_LOGIN_CODE = -104;
  30.         public static String INVALID_LOGIN_MSG = "登录失效";
  31.  
  32.         /**
  33.          * 数据库操作失败
  34.          */
  35.         public static Integer DATABASE_OPERATION_ERROR_CODE = -105;
  36.         public static String DATABASE_OPERATION_ERROR_MSG = "数据库操作失败";
  37.  
  38.         /**
  39.          * token失效
  40.          */
  41.         public static Integer INVALID_TOKEN_CODE = -106;
  42.         public static String INVALID_TOKEN_MSG = "用户未登录或登录信息已失效";
  43.  
  44.         /**
  45.          * 服务器异常
  46.          */
  47.         public static Integer SERVER_ERROR_CODE = -200;
  48.         public static String SERVER_ERROR_MSG = "服务器异常";
  49.  
  50.     }
  51.        
  52. }
  53.

 ServiceResultHelper 类：

  1. //
  2. // Source code recreated from a .class file by IntelliJ IDEA
  3. // (powered by Fernflower decompiler)
  4. //
  5.  
  6. package com.jp.framework.common.model;
  7.  
  8. import com.jp.framework.common.util.Constant;
  9.  
  10. public class ServiceResultHelper {
  11.     public ServiceResultHelper() {
  12.     }
  13.  
  14.     public static <T> ServiceResult<T> genResult(boolean succeed, int retCode, String msg, T obj) {
  15.         ServiceResult ret = new ServiceResult();
  16.         ret.setData(obj);
  17.         ret.setMsg(msg);
  18.         ret.setCode(retCode);
  19.         ret.setSucceed(succeed);
  20.         return ret;
  21.     }
  22.  
  23.     public static <T> boolean isSuccess(ServiceResult<T> result) {
  24.         return result != null && result.isSucceed() && result.getCode() == 0;
  25.     }
  26.  
  27.  
  28.     public static <T> ServiceResult<T> genResultWithSuccess(T obj) {
  29.         return genResult(true, Constant.SUCCESS, "成功", obj);
  30.     }
  31.  
  32.     public static <T> ServiceResult<T> genResultWithSuccess() {
  33.         return genResult(true, Constant.SUCCESS, "成功", (Object)null);
  34.     }
  35.  
  36.     public static <T> ServiceResult<T> genResultWithFaild() {
  37.         return genResult(false, Constant.FAILED, "失败", (Object)null);
  38.     }
  39.  
  40.     public static <T> ServiceResult<T> genResultWithFaild(String msg, Integer code) {
  41.         return genResult(false, code, msg, (Object)null);
  42.     }
  43.  
  44.     public static <T> ServiceResult<T> genResultWithDataNull() {
  45.         return genResult(false, Constant.SUCCESS, "数据为空", (Object)null);
  46.     }
  47.  
  48. }

ServiceResult 类:

  1.  
  2. import com.fasterxml.jackson.annotation.JsonInclude;
  3. import com.fasterxml.jackson.annotation.JsonInclude.Include;
  4. import com.backstage.core.constant.Constant;
  5. import org.apache.commons.lang3.builder.ToStringBuilder;
  6. import org.apache.commons.lang3.builder.ToStringStyle;
  7.  
  8. import java.util.HashMap;
  9. import java.util.Map;
  10.  
  11. @JsonInclude(Include.ALWAYS)
  12. public final class ServiceResult<T> {
  13.     private static final long serialVersionUID = 6977558218691386450L;
  14.     private boolean succeed = true;
  15.     private int code;
  16.     private int subCode;
  17.     private String msg;
  18.     private T data;
  19.     private Map<String, Object> additionalProperties;
  20.  
  21.     public ServiceResult() {
  22.         this.code = Constant.SUCCESS;
  23.         this.subCode = Constant.SUCCESS;
  24.         this.additionalProperties = new HashMap();
  25.     }
  26.  
  27.     public static ServiceResult<Boolean> error() {
  28.         return error(500, "未知异常，请联系管理员");
  29.     }
  30.  
  31.     public static ServiceResult<Boolean> error(String msg) {
  32.         return error(500, msg);
  33.     }
  34.  
  35.     public static ServiceResult<Boolean> error(int subCode, String msg) {
  36.         ServiceResult result = new ServiceResult();
  37.         result.setCode(Constant.FAILED);
  38.         result.setSubCode(subCode);
  39.         result.setSucceed(false);
  40.         result.setMsg(msg);
  41.         return result;
  42.     }
  43.  
  44.     public static ServiceResult ok() {
  45.         return ok(Constant.SUCCESS, "成功");
  46.     }
  47.  
  48.     public static ServiceResult ok(int code, String msg) {
  49.         ServiceResult result = new ServiceResult();
  50.         result.setCode(code);
  51.         result.setSucceed(true);
  52.         result.setMsg(msg);
  53.         return result;
  54.     }
  55.  
  56.     public static ServiceResult ok(Object data) {
  57.         ServiceResult d = new ServiceResult();
  58.         d.setSucceed(true);
  59.         d.setData(data);
  60.         d.setCode(Constant.SUCCESS);
  61.         d.setMsg("成功");
  62.         return d;
  63.     }
  64.  
  65.     public static ServiceResult ok(Object data, Map<String, Object> additionalProperties) {
  66.         ServiceResult d = new ServiceResult();
  67.         d.setSucceed(true);
  68.         d.setData(data);
  69.         d.setCode(Constant.SUCCESS);
  70.         d.setMsg("成功");
  71.         d.additionalProperties.putAll(additionalProperties);
  72.         return d;
  73.     }
  74.  
  75.     public ServiceResult(T data) {
  76.         this.code = Constant.SUCCESS;
  77.         this.subCode = Constant.SUCCESS;
  78.         this.additionalProperties = new HashMap();
  79.         this.data = data;
  80.     }
  81.  
  82.     public ServiceResult(boolean succeed, int code, String msg) {
  83.         this.code = Constant.SUCCESS;
  84.         this.subCode = Constant.SUCCESS;
  85.         this.additionalProperties = new HashMap();
  86.         this.succeed = succeed;
  87.         this.code = code;
  88.         this.msg = msg;
  89.     }
  90.  
  91.     public ServiceResult(boolean succeed, T data, String msg) {
  92.         this.code = Constant.SUCCESS;
  93.         this.subCode = Constant.SUCCESS;
  94.         this.additionalProperties = new HashMap();
  95.         this.succeed = succeed;
  96.         this.data = data;
  97.         this.msg = msg;
  98.     }
  99.  
  100.     public ServiceResult(boolean succeed, T data, int code, String msg) {
  101.         this.code = Constant.SUCCESS;
  102.         this.subCode = Constant.SUCCESS;
  103.         this.additionalProperties = new HashMap();
  104.         this.succeed = succeed;
  105.         this.data = data;
  106.         this.code = code;
  107.         this.msg = msg;
  108.     }
  109.  
  110.     public ServiceResult(boolean succeed, String msg) {
  111.         this.code = Constant.SUCCESS;
  112.         this.subCode = Constant.SUCCESS;
  113.         this.additionalProperties = new HashMap();
  114.         this.succeed = succeed;
  115.         this.msg = msg;
  116.     }
  117.  
  118.     public boolean isSucceed() {
  119.         return this.succeed;
  120.     }
  121.  
  122.     public void setSucceed(boolean succeed) {
  123.         this.succeed = succeed;
  124.     }
  125.  
  126.     public T getData() {
  127.         return this.data;
  128.     }
  129.  
  130.     public void setData(T data) {
  131.         this.data = data;
  132.     }
  133.  
  134.     public String toString() {
  135.         return ToStringBuilder.reflectionToString(this, ToStringStyle.MULTI_LINE_STYLE);
  136.     }
  137.  
  138.     public String getMsg() {
  139.         return this.msg;
  140.     }
  141.  
  142.     public void setMsg(String msg) {
  143.         this.msg = msg;
  144.     }
  145.  
  146.     public int getCode() {
  147.         return this.code;
  148.     }
  149.  
  150.     public void setCode(int code) {
  151.         this.code = code;
  152.     }
  153.  
  154.     public int getSubCode() {
  155.         return this.subCode;
  156.     }
  157.  
  158.     public void setSubCode(int subCode) {
  159.         this.subCode = subCode;
  160.     }
  161.  
  162.     public Map<String, Object> getAdditionalProperties() {
  163.         return this.additionalProperties;
  164.     }
  165.  
  166.     public void setAdditionalProperties(String name, Object value) {
  167.         this.additionalProperties.put(name, value);
  168.     }
  169.  
  170.     public Object getAdditionalProperties(String name) {
  171.         return this.additionalProperties.get(name);
  172.     }
  173. }

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/凡人多烦事01/article/detail/511157
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号