JWT生成token模板及对接短信

浅浅的花香味﹌ 2024-04-03 13:03 120阅读 0赞

## JWT生成token模板及对接短信 ##

### 1 JWT概念 ###

> JWT工具:JWT（Json Web Token）是为了在网络应用环境间传递声明而执行的一种基于JSON的开放标准。  
> JWT的声明一般被用来在身份提供者和服务提供者间传递被认证的用户身份信息，以便于从资源服务器获取资源。比如用在用户登录上

JWT最重要的作用就是对 token信息的防伪作用。

JWT的原理，  
一个JWT由三个部分组成：公共部分、私有部分、签名部分。最后由这三者组合进行base64编码得到JWT。  
![在这里插入图片描述][d0f4df32a04b4e9db82ccc0601e25b0b.png]

其中签名部分是指编码格式，并不是对内容进行加密
    私有部分：存放的信息

1、	公共部分
    主要是该JWT的相关配置参数，比如签名的加密算法、格式类型、过期时间等等。 Key=ATGUIGU
    2、	私有部分
    用户自定义的内容，根据实际需要真正要封装的信息。
    userInfo{
        用户的Id，用户的昵称nickName}
    3、	签名部分
    SaltiP: 当前服务器的Ip地址!{
        linux 中配置代理服务器的ip}
    主要用户对JWT生成字符串的时候，进行加密{
        盐值}
    最终组成 key+salt+userInfo  token!
    base64编码，并不是加密，只是把明文信息变成了不可见的字符串。
    但是其实只要用一些工具就可以把base64编码解成明文，所以不要在JWT中放入涉及私密的信息。

### 2 集成JWT ###

#### ①导入依赖jjwt ####

<dependency>
        <groupId>io.jsonwebtoken</groupId>
        <artifactId>jjwt</artifactId>
    </dependency>

#### ②工具类 ####

public class JwtHelper {
        
        private static long tokenExpiration = 24*60*60*1000;
        //SigningKey不是用来加密的，jwt里不要放敏感信息，SigningKey只是用来验签
        private static String tokenSignKey = "123456";
    
        public static String createToken(Long userId, String userName) {
        
            String token = Jwts.builder()
                    .setSubject("YYGH-USER")
                    .setExpiration(new Date(System.currentTimeMillis() + tokenExpiration))
                    .claim("userId", userId)
                    .claim("userName", userName)
                    .signWith(SignatureAlgorithm.HS512, tokenSignKey)
                    .compressWith(CompressionCodecs.GZIP)
                    .compact();
            return token;
        }
        public static Long getUserId(String token) {
        
            if(StringUtils.isEmpty(token)) return null;
            Jws<Claims> claimsJws = Jwts.parser().setSigningKey(tokenSignKey).parseClaimsJws(token);
            Claims claims = claimsJws.getBody();
            Integer userId = (Integer)claims.get("userId");
            return userId.longValue();
        }
        public static String getUserName(String token) {
        
            if(StringUtils.isEmpty(token)) return "";
            Jws<Claims> claimsJws 
    = Jwts.parser().setSigningKey(tokenSignKey).parseClaimsJws(token);
            Claims claims = claimsJws.getBody();
            return (String)claims.get("userName");
        }
        public static void main(String[] args) {
        
            String token = JwtHelper.createToken(1L, "55");
            System.out.println(token);
            System.out.println(JwtHelper.getUserId(token));
            System.out.println(JwtHelper.getUserName(token));
        }
    }

注意：

> SigningKey不是用来加密的，jwt里不要放敏感信息，SigningKey只是用来验签

### 3 案例【对接短信验证码】 ###

> 此处我使用的是个人账号，因此推荐使用阿里云的自测账号或者容联云

#### ①注册容联云开发者账号、绑定测试手机号 ####

地址：https://www.yuntongxun.com/member/main  
![在这里插入图片描述][332a691c66914cc19c8e3094d41b8afb.png]

> 获取到AUTH TOKEN、RUL、APPID等信息  
> 绑定测试手机号

#### ②随机生成验证码工具类、导入依赖 ####

工具类：

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>();
    
            // 生成随机数字并存入HashMap
            for (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;
        }
    }

依赖：

<dependency>
        <groupId>com.cloopen</groupId>
        <artifactId>java-sms-sdk</artifactId>
        <version>1.0.1</version>
    </dependency>

#### ③service及serviceImpl ####

MsmService:

public interface MsmService {
        
    
        /**
         * 发送手机验证码【测试号】
         * @param phone
         * @param code
         * @return
         */
        boolean send(String phone, String code);
    }

MsmServiceImpl:

@Service
    public class MsmServiceImpl implements MsmService {
        
    
        /**
         * 发送手机验证码
         * @param phone 手机号
         * @param code 验证码
         * @return
         */
        @Override
        public boolean send(String phone, String code) {
        
            //判断手机号是否为空
            if(StringUtils.isEmpty(phone)){
        
                return false;
            }
            //整合容联云.....
            //生产环境请求地址：app.cloopen.com
            String serverIp="app.cloopen.com";
            //请求端口
            String serverPort="8883";
            //主账号,登陆云通讯网站后,可在控制台首页看到开发者主账号ACCOUNT SID和主账号令牌AUTH TOKEN
            String accountSId= "";
            String accountToken="";
            //请使用管理控制台中已创建应用的APPID
            String appId= "";
            CCPRestSmsSDK sdk=new CCPRestSmsSDK();
            sdk.init(serverIp,serverPort);
            sdk.setAccount(accountSId,accountToken);
            sdk.setAppId(appId);
            sdk.setBodyType(BodyType.Type_JSON);
            //发送短信至手机号
            String to=phone;
            //短信模板
            String templateId="1";
    //        //随机生成验证码
    //        String code=(int)((Math.code()*9+1)*100000)+"";
            
            //控制台输出验证码
            System.out.println("手机短信验证码--------------->"+code);
            //验证码为生成的随机数，5分钟内到期
            String[] datas={
        code,"5"};
            HashMap<String,Object> result = sdk.sendTemplateSMS(to,templateId,datas);
            if("000000".equals(result.get("statusCode"))){
        
                //正常返回输出data包体信息（map）
                HashMap<String,Object> data = (HashMap<String,Object>) result.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("错误码=" + result.get("statusCode") +" 错误信息= "+result.get("statusMsg"));
            }
            return false;
        }
    }

#### ④编写controller ####

@RestController
    @RequestMapping("/api/msm")
    @Api(value = "短信服务")
    public class MsmApiController {
        
    
        @Autowired
        private MsmService msmService;
    
        @Autowired
        private RedisTemplate<String,String> redisTemplate;
    
        //发送手机验证码
        @ApiOperation(value = "发送手机验证码")
        @GetMapping("/send/{phone}")
        public Result sendCode(@PathVariable String phone){
        
            //从redis中获取验证码，如果获取到，返回ok
            //key手机号     value验证码
            String code = redisTemplate.opsForValue().get(phone);
            System.out.println("code=============" + code);
            if(!StringUtils.isEmpty(code)){
        
                return Result.ok();
            }
            //如果验证码获取不到，就生成验证码
            code = RandomUtil.getFourBitRandom();//生成四位验证码
            //调用service方法，通过整合短信服务进行发送
            boolean isSend = msmService.send(phone, code);
            //生成的验证码存放到redis中，并设置有效时间
            if(isSend) {
        
                redisTemplate.opsForValue().set(phone, code, 2, TimeUnit.MINUTES);
                return Result.ok();
            } else {
        
                return Result.fail().message("发送短信失败");
            }
        }
    }

#### ⑤配置文件 ####

# 服务端口
    server.port=8204
    # 服务名
    spring.application.name=service-msm
    
    #返回json的全局时间格式
    spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
    spring.jackson.time-zone=GMT+8
    
    #redis
    spring.redis.host=192.168.145.13
    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

> 我们也可以将APPID、AUTH TOKEN等信息写在配置文件中，然后通过创建类+@Value($\{\})方式读取配置文件

[d0f4df32a04b4e9db82ccc0601e25b0b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/4abae25860024575ab33a160b4da625d.png
[332a691c66914cc19c8e3094d41b8afb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/9a7aa4ab6b4d48e09aa3f3cee3a4ee64.png