快捷導(dǎo)航

基于 antd pro 的短信驗(yàn)證碼登錄功能(流程分析)

更新時(shí)間：2021年05月08日 14:43:51 作者：千里之行，始于足下

這篇文章主要介紹了基于 antd pro 的短信驗(yàn)證碼登錄功能(流程分析),本文通過(guò)實(shí)例代碼流程分析給大家介紹的非常詳細(xì)，具有一定的參考借鑒價(jià)值，需要的朋友可以參考下

概要

最近使用 antd pro 開(kāi)發(fā)項(xiàng)目時(shí)遇到個(gè)新的需求, 就是在登錄界面通過(guò)短信驗(yàn)證碼來(lái)登錄, 不使用之前的用戶(hù)名密碼之類(lèi)登錄方式.

這種方式雖然增加了額外的短信費(fèi)用, 但是對(duì)于安全性確實(shí)提高了不少. antd 中并沒(méi)有自帶能夠倒計(jì)時(shí)的按鈕,
但是 antd pro 的 ProForm components 中倒是提供了針對(duì)短信驗(yàn)證碼相關(guān)的組件.
組件說(shuō)明可參見(jiàn): https://procomponents.ant.design/components/form

整體流程

通過(guò)短信驗(yàn)證碼登錄的流程很簡(jiǎn)單:

請(qǐng)求短信驗(yàn)證碼(客戶(hù)端)
生成短信驗(yàn)證碼, 并設(shè)置驗(yàn)證碼的過(guò)期時(shí)間(服務(wù)端)
調(diào)用短信接口發(fā)送驗(yàn)證碼(服務(wù)端)
根據(jù)收到的短信驗(yàn)證碼登錄(客戶(hù)端)
驗(yàn)證手機(jī)號(hào)和短信驗(yàn)證碼, 驗(yàn)證通過(guò)之后發(fā)行 jwt-token(服務(wù)端)

前端

頁(yè)面代碼

import React, { useState } from 'react';
  import { connect } from 'umi';
   import { message } from 'antd';
  import ProForm, { ProFormText, ProFormCaptcha } from '@ant-design/pro-form';
 import { MobileTwoTone, MailTwoTone } from '@ant-design/icons';
  import { sendSmsCode } from '@/services/login';
 
 const Login = (props) => {
    const [countDown, handleCountDown] = useState(5);
    const { dispatch } = props;
    const [form] = ProForm.useForm();
    return (
      <div
        style={{
          width: 330,
          margin: 'auto',
        }}
      >
        <ProForm
          form={form}
          submitter={{
            searchConfig: {
              submitText: '登錄',
            },
            render: (_, dom) => dom.pop(),
            submitButtonProps: {
              size: 'large',
              style: {
                width: '100%',
              },
            },
            onSubmit: async () => {
              const fieldsValue = await form.validateFields();
              console.log(fieldsValue);
              await dispatch({
                type: 'login/login',
                payload: { username: fieldsValue.mobile, sms_code: fieldsValue.code },
              });
            },
          }}
        >
          <ProFormText
            fieldProps={{
              size: 'large',
              prefix: <MobileTwoTone />,
            }}
            name="mobile"
            placeholder="請(qǐng)輸入手機(jī)號(hào)"
            rules={[
              {
                required: true,
                message: '請(qǐng)輸入手機(jī)號(hào)',
              },
              {
                pattern: new RegExp(/^1[3-9]\d{9}$/, 'g'),
                message: '手機(jī)號(hào)格式不正確',
              },
            ]}
          />
          <ProFormCaptcha
            fieldProps={{
              size: 'large',
              prefix: <MailTwoTone />,
            }}
            countDown={countDown}
            captchaProps={{
              size: 'large',
            }}
            name="code"
            rules={[
              {
                required: true,
                message: '請(qǐng)輸入驗(yàn)證碼！',
              },
            ]}
            placeholder="請(qǐng)輸入驗(yàn)證碼"
            onGetCaptcha={async (mobile) => {
              if (!form.getFieldValue('mobile')) {
                message.error('請(qǐng)先輸入手機(jī)號(hào)');
                return;
              }
              let m = form.getFieldsError(['mobile']);
              if (m[0].errors.length > 0) {
                message.error(m[0].errors[0]);
                return;
              }
              let response = await sendSmsCode(mobile);
              if (response.code === 10000) message.success('驗(yàn)證碼發(fā)送成功!');
              else message.error(response.message);
            }}
          />
        </ProForm>
      </div>
    );
  };
  
  export default connect()(Login);

請(qǐng)求驗(yàn)證碼和登錄的 service (src/services/login.js)

import request from '@/utils/request';

  export async function login(params) {
  return request('/api/v1/login', {
     method: 'POST',
     data: params,
   });
 }
 
  export async function sendSmsCode(mobile) {
    return request(`/api/v1/send/smscode/${mobile}`, {
      method: 'GET',
    });
  }

處理登錄的 model (src/models/login.js)

import { stringify } from 'querystring';
 import { history } from 'umi';
  import { login } from '@/services/login';
 import { getPageQuery } from '@/utils/utils';
 import { message } from 'antd';
  import md5 from 'md5';
 
  const Model = {
   namespace: 'login',
    status: '',
    loginType: '',
    state: {
      token: '',
    },
    effects: {
      *login({ payload }, { call, put }) {
        payload.client = 'admin';
        // payload.password = md5(payload.password);
        const response = yield call(login, payload);
        if (response.code !== 10000) {
          message.error(response.message);
          return;
        }
  
        // set token to local storage
        if (window.localStorage) {
          window.localStorage.setItem('jwt-token', response.data.token);
        }
  
        yield put({
          type: 'changeLoginStatus',
          payload: { data: response.data, status: response.status, loginType: response.loginType },
        }); // Login successfully
  
        const urlParams = new URL(window.location.href);
        const params = getPageQuery();
        let { redirect } = params;
  
        console.log(redirect);
        if (redirect) {
          const redirectUrlParams = new URL(redirect);
  
          if (redirectUrlParams.origin === urlParams.origin) {
            redirect = redirect.substr(urlParams.origin.length);
  
            if (redirect.match(/^\/.*#/)) {
              redirect = redirect.substr(redirect.indexOf('#') + 1);
            }
          } else {
            window.location.href = '/home';
          }
        }
        history.replace(redirect || '/home');
      },
  
      logout() {
        const { redirect } = getPageQuery(); // Note: There may be security issues, please note
  
        window.localStorage.removeItem('jwt-token');
        if (window.location.pathname !== '/user/login' && !redirect) {
          history.replace({
            pathname: '/user/login',
            search: stringify({
              redirect: window.location.href,
            }),
          });
        }
      },
    },
    reducers: {
      changeLoginStatus(state, { payload }) {
        return {
          ...state,
          token: payload.data.token,
          status: payload.status,
          loginType: payload.loginType,
        };
      },
    },
  };
  export default Model;

后端

后端主要就 2 個(gè)接口, 一個(gè)處理短信驗(yàn)證碼的發(fā)送, 一個(gè)處理登錄驗(yàn)證

路由的代碼片段:

apiV1.POST("/login", authMiddleware.LoginHandler)
 apiV1.GET("/send/smscode/:mobile", controller.SendSmsCode)

短信驗(yàn)證碼的處理

短信驗(yàn)證碼的處理有幾點(diǎn)需要注意:
生成隨機(jī)的固定長(zhǎng)度的數(shù)字調(diào)用短信接口發(fā)送驗(yàn)證碼保存已經(jīng)驗(yàn)證碼, 以備驗(yàn)證用
生成固定長(zhǎng)度的數(shù)字

以下代碼生成 6 位的數(shù)字, 隨機(jī)數(shù)不足 6 位前面補(bǔ) 0

r := rand.New(rand.NewSource(time.Now().UnixNano()))
 code := fmt.Sprintf("%06v", r.Int31n(1000000))

調(diào)用短信接口

這個(gè)簡(jiǎn)單, 根據(jù)購(gòu)買(mǎi)的短信接口的說(shuō)明調(diào)用即可

保存已經(jīng)驗(yàn)證碼, 以備驗(yàn)證用

這里需要注意的是驗(yàn)證碼要有個(gè)過(guò)期時(shí)間, 不能一個(gè)驗(yàn)證碼一直可用.
臨時(shí)存儲(chǔ)的驗(yàn)證碼可以放在數(shù)據(jù)庫(kù), 也可以使用 redis 之類(lèi)的 KV 存儲(chǔ), 這里為了簡(jiǎn)單, 直接在內(nèi)存中使用 map 結(jié)構(gòu)來(lái)存儲(chǔ)驗(yàn)證碼

package util

 import (
    "fmt"
   "math/rand"
   "sync"
  "time"
  )

  type loginItem struct {
    smsCode       string
    smsCodeExpire int64
  }
  
  type LoginMap struct {
    m           map[string]*loginItem
    l           sync.Mutex
  }
  
  var lm *LoginMap
  
  func InitLoginMap(resetTime int64, loginTryMax int) {
    lm = &LoginMap{
      m:           make(map[string]*loginItem),
    }
  }
  
  func GenSmsCode(key string) string {
    r := rand.New(rand.NewSource(time.Now().UnixNano()))
    code := fmt.Sprintf("%06v", r.Int31n(1000000))
  
    if _, ok := lm.m[key]; !ok {
      lm.m[key] = &loginItem{}
    }
  
    v := lm.m[key]
    v.smsCode = code
    v.smsCodeExpire = time.Now().Unix() + 600 // 驗(yàn)證碼10分鐘過(guò)期
  
    return code
  }
  
  func CheckSmsCode(key, code string) error {
    if _, ok := lm.m[key]; !ok {
      return fmt.Errorf("驗(yàn)證碼未發(fā)送")
    }
  
    v := lm.m[key]
  
    // 驗(yàn)證碼是否過(guò)期
    if time.Now().Unix() > v.smsCodeExpire {
      return fmt.Errorf("驗(yàn)證碼(%s)已經(jīng)過(guò)期", code)
    }
  
    // 驗(yàn)證碼是否正確
    if code != v.smsCode {
      return fmt.Errorf("驗(yàn)證碼(%s)不正確", code)
    }
  
    return nil
  }