2. 程式人生 > 程式設計 >SpringSecurity & OAuth2實現簡訊驗證碼方式獲取AccessToken

SpringSecurity & OAuth2實現簡訊驗證碼方式獲取AccessToken

阿新 • • 發佈：2020-06-24

Spring提供的原生的OAuth2依賴內建了幾種比較常用的授權方式：password、authorization-code、client_credentials、refresh_token、implicit等，雖然可以滿足我們日常的需求，不過針對一些特殊的需求還是捉襟見肘，有點無奈，比如：微信登入、簡訊登入...，針對這一點ApiBoot通過修改Spring OAuth2依賴的原始碼，可以根據業務進行自定義新增grantType。

建立專案

我們先來使用IDEA建立本章的專案，pom.xml新增的依賴如下所示：

<dependencies>
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
  </dependency>
  <dependency>
    <groupId>org.minbox.framework</groupId>
    <artifactId>api-boot-starter-security-oauth-jwt</artifactId>
  </dependency>
  <dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
  </dependency>
  <dependency>
    <groupId>com.zaxxer</groupId>
    <artifactId>HikariCP</artifactId>
  </dependency>
  <dependency>
    <groupId>org.minbox.framework</groupId>
    <artifactId>api-boot-starter-mybatis-enhance</artifactId>
  </dependency>
</dependencies>
<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>org.minbox.framework</groupId>
      <artifactId>api-boot-dependencies</artifactId>
      <version>2.2.0.RELEASE</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>複製程式碼

ApiBoot MyBatis Enhance使用檔案詳見ApiBoot Mybatis Enhance官網檔案。

本章的原始碼在ApiBoot零程式碼整合Spring Security的JDBC方式獲取AccessToken基礎上進行修改，將之前章節原始碼的application.yml、SystemUser、SystemUserEnhanceMppaer、UserService檔案複製到本章專案對應的目錄內。

驗證碼登入邏輯

本章來講下使用ApiBoot怎麼完成自定義簡訊驗證碼登入的授權方式。

在簡訊驗證碼登入的邏輯中，大致的流程如下所示：

  1. 使用者在獲取驗證碼時，系統會將驗證碼儲存到資料庫內
  2. 當使用者輸入驗證碼後提交登入時，讀取驗證碼並判斷有效性後
  3. 最後獲取手機號對應的使用者資訊完成登入邏輯。
  4. 返回請求令牌

根據驗證碼登入的流程來看我們首先需要建立一個驗證碼資料表，用來儲存使用者傳送的驗證碼資料，在第3步中需要通過手機號獲取對應的使用者資訊，所以我們還要修改之前章節建立的表結構，新增一列，下面我們開始進行改造。

驗證碼錶結構

在資料庫內建立一個名為phone_code的資料表，並初始化一條驗證碼資料（模擬已經使用者已經發送了驗證碼），SQL如下所示：

CREATE TABLE `phone_code` (
  `pc_id` int(11) NOT NULL AUTO_INCREMENT COMMENT '主鍵自增',`pc_phone` varchar(11) COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '手機號',`pc_code` varchar(6) COLLATE utf8mb4_general_ci DEFAULT NULL COMMENT '驗證碼內容',`pc_create_time` timestamp NULL DEFAULT CURRENT_TIMESTAMP COMMENT '驗證碼生成時間',PRIMARY KEY (`pc_id`)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci COMMENT='手機號驗證碼資訊表';
-- 初始化驗證碼資料
INSERT INTO `phone_code` VALUES (1,'17111111111','123123','2019-12-04 03:01:05');複製程式碼

驗證碼實體

對應phone_code表結構編寫一個資料實體，如下所示：


/**
 * 手機號驗證碼資訊表
 *
 * @author 恆宇少年
 */
@Data
@Table(name = "phone_code")
public class PhoneCode {
    /**
     * 驗證碼主鍵
     */
    @Column(name = "pc_id")
    @Id(generatorType = KeyGeneratorTypeEnum.AUTO)
    private Integer id;
    /**
     * 手機號
     */
    @Column(name = "pc_phone")
    private String phone;
    /**
     * 驗證碼內容
     */
    @Column(name = "pc_code")
    private String code;
    /**
     * 建立時間
     */
    @Column(name = "pc_create_time")
    private Timestamp createTime;
}複製程式碼

驗證碼資料介面

為PhoneCode驗證碼資料實體新增一個查詢的資料介面，實現ApiBoot MyBatis Enhance提供的EnhanceMapper,id>介面，如下所示：

/**
 * 手機號驗證碼資料介面
 *
 * @author 恆宇少年
 */
public interface PhoneCodeEnhanceMapper extends EnhanceMapper<PhoneCode,Integer> {
    /**
     * 查詢手機號驗證碼資訊
     *
     * @param phone {@link PhoneCode#getPhone()}
     * @param code  {@link PhoneCode#getCode()}
     * @return {@link PhoneCode}
     */
    PhoneCode findByPhoneAndCode(@Param("phone") String phone,@Param("code") String code);
}複製程式碼

通過ApiBoot MyBatis Enhance提供的方法命名規則查詢語法，我們可以根據指定的phone、code查詢出對應的記錄。

驗證碼業務邏輯

為驗證碼查詢提供一個業務邏輯實現類，如下所示：

/**
 * 驗證碼業務邏輯實現
 *
 * @author 恆宇少年
 */
@Service
public class PhoneCodeService {
    /**
     * 手機號驗證碼資料介面
     */
    @Autowired
    private PhoneCodeEnhanceMapper mapper;

    /**
     * 查詢手機號驗證碼
     *
     * @param phone {@link PhoneCode#getPhone()}
     * @param code  {@link PhoneCode#getCode()}
     * @return
     */
    public PhoneCode findPhoneCode(String phone,String code) {
        return mapper.findByPhoneAndCode(phone,code);
    }
}複製程式碼

修改使用者表結構

我們在ApiBoot零程式碼整合Spring Security的JDBC方式獲取AccessToken文章內建立的system_user使用者表的基礎上新增一個欄位，如下所示：

alter table system_user
    add su_phone varchar(11) null comment '手機號';複製程式碼

欄位新增後初始化表內yuqiyu這條資料的列值，我在phone_code表內新增的手機號為17111111111，所以我需要更新su_phone欄位的值為17111111111。

瞭解ApiBootOauthTokenGranter

基礎的程式碼實現我們都已經準備好了，下面我們來介紹下本章的主角ApiBootOauthTokenGranter介面，該介面為自定義GrantType而生，由ApiBoot OAuth2提供，原始碼如下所示：

/**
 * ApiBoot Integrates Oauth2 to Realize Custom Authorization to Acquire Token
 *
 * @author：恆宇少年 - 於起宇
 * <p>
 * DateTime：2019-05-28 09:57
 * Blog：http://blog.yuqiyu.com
 * WebSite：http://www.jianshu.com/u/092df3f77bca
 * Gitee：https://gitee.com/hengboy
 * GitHub：https://github.com/hengboy
 */
public interface ApiBootOauthTokenGranter extends Serializable {
    /**
     * oauth2 grant type for ApiBoot
     *
     * @return grant type
     */
    String grantType();

    /**
     * load userDetails by parameter
     *
     * @param parameters parameter map
     * @return UserDetails
     * @throws ApiBootTokenException
     * @see UserDetails
     */
    UserDetails loadByParameter(Map<String,String> parameters) throws ApiBootTokenException;
}複製程式碼

  • grantType()：該方法的返回值用於告知OAuth2自定義的GrantType是什麼，根據自己的業務邏輯而定。
  • loadByParameter：該方法是自定義GrantType的業務實現，parameters引數內包含了自定義授權請求/oauth/token時所攜帶的全部引數，如：/oauth/token?grant_type=phone_code&phone=xx&code=xx，會把phone、code引數一併傳遞給該方法。

實現簡訊驗證碼授權方式

下面我們來建立一個名為PhoneCodeGrantType的自定義授權類，實現ApiBootOauthTokenGranter介面，如下所示：


/**
 * 手機驗證碼OAuth2的認證方式實現
 *
 * @author 恆宇少年
 * @see ApiBootOauthTokenGranter
 */
@Component
public class PhoneCodeGrantType implements ApiBootOauthTokenGranter {
    /**
     * 手機號驗證碼方式的授權方式
     */
    private static final String GRANT_TYPE_PHONE_CODE = "phone_code";
    /**
     * 授權引數：手機號
     */
    private static final String PARAM_PHONE = "phone";
    /**
     * 授權引數：驗證碼
     */
    private static final String PARAM_CODE = "code";
    /**
     * 手機號驗證碼業務邏輯
     */
    @Autowired
    private PhoneCodeService phoneCodeService;
    /**
     * 系統使用者業務邏輯
     */
    @Autowired
    private UserService userService;

    @Override
    public String grantType() {
        return GRANT_TYPE_PHONE_CODE;
    }

    /**
     * 根據自定義的授權引數進行查詢使用者資訊
     *
     * @param parameters
     * @return
     * @throws ApiBootTokenException
     */
    @Override
    public UserDetails loadByParameter(Map<String,String> parameters) throws ApiBootTokenException {
        String phone = parameters.get(PARAM_PHONE);
        String code = parameters.get(PARAM_CODE);
        PhoneCode phoneCode = phoneCodeService.findPhoneCode(phone,code);
        if (ObjectUtils.isEmpty(phoneCode)) {
            throw new ApiBootTokenException("登入失敗，驗證碼：" + code + "，已過期.");
        }
        UserDetails userDetails = userService.findByPhone(phone);
        if (ObjectUtils.isEmpty(userDetails)) {
            throw new ApiBootTokenException("使用者：" + phone + "，不存在.");
        }
        return userDetails;
    }
}複製程式碼

在loadByParameter方法內，我們首先獲取到了本次登入的手機號（phone）、驗證碼（code）這兩個引數，查詢是否存在這條驗證碼的記錄（PS：這裡沒做驗證碼過期時間限制，自己的業務請把這塊加上），驗證碼驗證通過後查詢出手機號對應的使用者資訊並將使用者返回交付給ApiBoot OAuth2框架來完成驗證。

在驗證業務邏輯方法內如果出現異常可以直接使用ApiBootTokenException異常進行丟擲。

執行測試

將我們的專案執行起來，下面通過CURL的方式嘗試獲取AccessToken，如下所示：

➜ ~ curl -X POST hengboy:chapter@localhost:9090/oauth/token -d 'grant_type=phone_code&phone=17111111111&code=123123'
{"access_token":"30e3f7d0-8c53-4dfe-b1ff-523a1db7b9eb","token_type":"bearer","refresh_token":"4b1f0ad5-f869-46ca-8b45-0231e69316b3","expires_in":7194,"scope":"api"}複製程式碼

使用postman方式獲取AccessToken，如下圖所示：

敲黑板，劃重點

本章根據簡訊驗證碼登入的例子來給大家講解了使用ApiBoot OAuth2怎麼進行自定義授權方式來獲取AccessToken，例子講解注重點是在自定義GrantType，在生產使用時還請根據各種情況進行驗證，保證資料的安全性。

程式碼示例

如果您喜歡本篇文章請為原始碼倉庫點個Star，謝謝！！！本篇文章示例原始碼可以通過以下途徑獲取，目錄為apiboot-define-oauth-grant-type：

作者個人 部落格

使用開源框架 ApiBoot 助你成為Api介面服務架構師

相關推薦

SpringSecurity &amp; OAuth2實現簡訊驗證碼方式獲取AccessToken

Spring提供的原生的OAuth2依賴內建了幾種比較常用的授權方式：password、authorization-code、client_credentials、refresh_token、implicit等，雖然可以滿足我們日常的需求，不過針對一些特殊的需求還是捉襟見肘，有

SpringCloud微服務實戰——搭建企業級開發框架（二十六）：自定義擴充套件OAuth2實現簡訊驗證碼登入

現在手機驗證碼登入似乎是每個網站必備的功能，OAuth2支援擴充套件自定義授權模式，前面介紹瞭如何在系統整合簡訊通知服務，這裡我們進行OAuth2的授權模式自定義擴充套件，使系統支援簡訊驗證碼登入。

Android自定義控制元件實現簡訊驗證碼自動填充

VerifyCodeView VerifyCodeView是一個用於輸入驗證碼的Android自定義控制元件，它支援數字型別的驗證碼，支援自定義外觀，並且支援簡訊驗證碼自動填充。

Flask專案中實現簡訊驗證碼和郵箱驗證碼功能

Flask是一個用Python編寫的Web應用程式框架，Flask是python的web框架，最大的特徵是輕便，讓開發者自由靈活的相容要開發的feature。它由Armin Ronacher開發，他領導一個名為Pocco的國際Python愛好者團隊。Flask基於W

vue實現簡訊驗證碼輸入框

本文例項為大家分享了vue實現簡訊驗證碼輸入框的具體程式碼，供大家參考，具體內容如下

python對接ihuyi實現簡訊驗證碼傳送

在日常生活中我們經常會遇到接收簡訊驗證碼的場景，Python也提供了簡便的方法實現這個功能，下面就用程式碼來實現這個功能。

Spring Security 實現簡訊驗證碼登入功能

之前文章都是基於使用者名稱密碼登入，第六章圖形驗證碼登入其實還是使用者名稱密碼登入，只不過多了一層圖形驗證碼校驗而已；Spring Security預設提供的認證流程就是使用者名稱密碼登入，整個流程都已經固定了，雖

SpringSceurity實現簡訊驗證碼功能的示例程式碼

一、思考 1、設計思路 在獲取簡訊驗證碼功能和圖形驗證碼還是有很多相似的地方,所以這裡在設計獲取簡訊驗證的時候，將之前開發好的的圖形驗證碼進一步整合、抽象與重構。

SpringSceurity實現簡訊驗證碼登陸

一、簡訊登入驗證機制原理分析 瞭解簡訊驗證碼的登陸機制之前,我們首先是要了解使用者賬號密碼登陸的機制是如何的,我們來簡要分析一下Spring Security是如何驗證基於使用者名稱和密碼登入方式的，

Flutter之Timer實現簡訊驗證碼獲取60s倒計時功能的程式碼

先看下效果： 兩種需求場景： 1.廣告頁3s後跳轉到首頁 2.簡訊驗證碼60s倒計時 第一種的話，根據需求我們可以知道，我們想要的效果就是3s結束做出一個動作。

基於PHP實現簡訊驗證碼傳送次數限制

　　對使用者獲取簡訊驗證碼的手機號、ip、和瀏覽器（使用唯一標識）進行限制。本文介紹的方法是對使用者每天只能通過同一瀏覽器或同一ip地址獲取驗證碼10次或者同一手機號只能獲取3次簡訊驗證碼，三種限制為“或”關

springboot實現簡訊驗證碼的傳送

我使用的是阿里雲簡訊服務 程式碼前的準備 1. 申請阿里雲的簡訊服務 2. 添加簽名,這裡需要等待稽核通過

Java實現簡訊驗證碼--設定傳送間隔時間，以及有效時間（Java+Redis）

Java實現簡訊驗證碼--設定傳送間隔時間，以及有效時間（Java+Redis） 這篇文章，實現了Java傳送手機簡訊驗證碼傳送的間隔時間，以及手機驗證碼的有效時間和手機驗證碼格式的合法性驗證，可以防止惡意刷介面

如何用雲開發高效快捷地實現簡訊驗證碼登入？

雲開發擴充套件能力之簡訊驗證碼登入 簡訊驗證碼登入支援在客戶端使用簡訊驗證碼進行登入，封裝了簡訊驗證碼的生成、傳送、校驗和定時清理邏輯，幫助開發者進行鑑權。登入成功後，使用者身份將轉化為正式使用者。

go使用Gin框架利用阿里雲實現簡訊驗證碼

第一步，呼叫阿里雲Api傳送簡訊並存入資料庫或者是redis當中 阿里雲簡訊平臺網址

基於SpringBoot和Redis實現簡訊驗證碼功能

技術標籤：《一起實戰吧！》系列javaredisspringspringboot專案 聽說微信搜尋《Java魚仔》會變更強哦！

實現簡訊驗證碼的傳送[JAVA]

如何實現簡訊驗證碼的傳送 一、基礎知識補充 1、編碼 2、URL 3、位元組流與字元流

vue_drf實現簡訊驗證碼

目錄一、需求1，需求二、sdk引數配置　　1，目錄結構三、程式碼實現1，後端程式碼2,前端程式碼一、需求

用vue實現註冊頁效果 vue實現簡訊驗證碼登入

本文例項為大家分享了實現註冊頁效果 的具體程式碼，供大家參考，具體內容如下

laravel passport api認證, 用簡訊驗證碼登入獲取 token

laravel api 認證使用了 passport 的密碼驗證方式,在做手機簡訊驗證碼登入時,由於獲取不到 明文密碼,無法獲取 token