Java/Kotlin 使用Redis模擬發送驗證碼

原文地址: Java/Kotlin 使用Redis模擬發送郵件驗證碼 - Stars-One的雜貨小窩 Java中常用語連接Redis的庫有lettuce和jredis，一般是推薦lettuce，其具有非同步性，下麵兩種都簡單來使用如何實現功能 jredis 1.引入依賴 <dependency> < ...

原文地址: Java/Kotlin 使用Redis模擬發送郵件驗證碼 - Stars-One的雜貨小窩

Java中常用語連接Redis的庫有lettuce和jredis，一般是推薦lettuce，其具有非同步性，下麵兩種都簡單來使用如何實現功能

jredis

1.引入依賴

<dependency>
    <groupId>redis.clients</groupId>
    <artifactId>jedis</artifactId>
    <version>3.2.0</version>
</dependency>

腳本使用：

fun main() {
    //1.測試連接
    val jedis = Jedis("127.0.0.1", 6379)
    val resp = jedis.ping()
    //為pong即為可用的
    if (resp == "PONG") {
        val key = "mykey"
        val value = "hello world"

        //寫入數據
        jedis[key]=value
        //讀數據
        val result = jedis[key]
        println(result)
        //  刪除指定key
        val row = jedis.del(key)
        //影響的行數
        println(row)
        
        //設置60s後過期
        jedis.setex(key,60,value)
        //設置60ms後過期
        jedis.psetex(key,60,value)
        
        //剩餘的過期時間，ttl返回時間單位為s，pttl則是ms
        val time = jedis.ttl(key)
        val time = jedis.pttl(key)
    }
}

通過setex或psetex方法來設置過期時間後，當數據過期後，再次去查詢該數據，就會得到null（即redis將數據刪除了）

上述也是簡單演示了redis資料庫的增刪改查功能，下麵就利用此資料庫來實現發送驗證碼的功能。

2.發送驗證碼

這裡我是實現了郵箱發送驗證碼的功能，驗證碼定為6位純數字隨機數，當然，你也可以加上大小寫字母來提高複雜性。

之後我們將郵箱和驗證碼存儲到redis中，並設置十分鐘過期時間，隨後通過調用郵箱發送郵件的方法，將驗證碼發送出去（這裡詳見JavaXMail發送郵件功能實現）

下麵是驗證碼生成方法：

//生成驗證碼
fun randomCode(): String {
    val sb = StringBuffer()
    repeat(6) {
        //0-9範圍
        val num = Random.nextInt(0, 10)
        sb.append(num)
    }
    return sb.toString()
}

//發送驗證碼方法
fun sendCode(email: String) {
    val code = randomCode()
    
    //先判斷redis是否有記錄
    val oldCode = RedisUtil.getValue(email)
    val action = {
        RedisUtil.setKeyValue(email, code)
        //調用郵箱發送郵件方法
        sendEmail(email, code)
    }
    if (oldCode.isBlank()) {
        action.invoke()
    } else {
        //判斷是否已過1分鐘
        //已過一分鐘，重新發送，否則不做操作
        val flag = RedisUtil.isGtOneMinutes(email)
        if (flag) {
            action.invoke()
        }
    }
}

object RedisUtil {
    private val url = "127.0.0.1"

    //10分鐘
    private const val expiredTime = 10 * 60
    private val redis by lazy {
        val jedis = Jedis(url, 6379)
        //如果有設置密碼
        //    jedis.auth("")
        jedis
    }

    /**
     * 獲取數據
     */
    fun getValue(key: String): String {
        return redis[key] ?: ""
    }

    /**
     * 存儲郵箱和驗證碼
     */
    fun setKeyValue(key: String, value: String) {
        redis.setex(key, 10 * 60, value)
    }

    /**
     * 獲取指定key的剩餘時間(s)
     */
    fun getSurplusTime(key: String): Long {
        return redis.ttl(key)
    }

    /**
     * key是否已過1分鐘
     */
    fun isGtOneMinutes(key: String): Boolean {
        val time = getSurplusTime(key)
        //小於九分鐘（說明已過1分鐘）
        return time <= expiredTime - 60
    }

}

這裡補充下，由於郵箱為用戶輸入，永遠不要對用戶輸入抱有期待，用戶可能輸入不是個email地址或者輸了個不存在的email地址，對於前者問題，我們可以通過在前端和後臺增加一個郵箱格式驗證，對於後者問題(不存在的email地址)，沒有什麼驗證辦法，只有發送了才知道這個郵箱地址是否可用（可以使用try catch來捕獲異常來處理）

所以如果發送郵件出現錯誤，我們需要進行對應的處理，把那條存儲到redis數據刪除，然後介面返回一個錯誤提示信息即可。

而且，為了考慮到惡意用戶頻繁操作，導致我們郵箱服務頻繁發送郵件，我們也需要進行對應的考慮設置，這裡只能顧全用戶頻繁輸入單個郵箱的情況，如果是同個郵箱，我們設置驗證碼過了1分鐘的時間，才給重新發送（即現在各大APP手機驗證碼的操作一樣），前端和後臺介面都是需要做限制。

如果是重新發送的話，我們需要重新setex方法設置一下驗證碼，同時這步也將過期時間重置了。

3.校驗驗證碼

之後就是考慮校驗驗證碼的情況了，這裡也是比較簡單，通過拿到用戶輸入的驗證碼和redis裡面的進行比對就可校驗。

但可能會有特殊情況，比如redis驗證碼已經過期了，需要進行判斷，並自動重新發送郵件，且介面返回提示信息

fun checkCode(email: String, code: String):Boolean {
    val dbCode = RedisUtil.getValue(email)
    if (dbCode.isBlank()) {
        //重新發送郵件,併發送提示（這裡省略了發送提示）
        sendCode(email)
        return false
    } else {
        if (dbCode==code) {
            //驗證通過
            return true
        }
        return false
    }
}

lettuce

Lettuce是一個高性能基於Java編寫的Redis驅動框架，底層集成了Project Reactor提供天然的反應式編程，通信框架集成了Netty使用了非阻塞IO，5.x版本之後融合了JDK1.8的非同步編程特性，在保證高性能的同時提供了十分豐富易用的API，5.1版本的新特性如下：

支持Redis的新增命令ZPOPMIN, ZPOPMAX, BZPOPMIN, BZPOPMAX。
支持通過Brave模塊跟蹤Redis命令執行。
支持Redis Streams。
支持非同步的主從連接。
支持非同步連接池。
新增命令最多執行一次模式（禁止自動重連）。
全局命令超時設置（對非同步和反應式命令也有效）。

下麵這裡就稍微貼下代碼就好,具體的思路上面已經都有提及了,就不再過多贅述了。

1.引入依賴

如果項目為Spring Boot，只需要引用spring-data-redis依賴即可，其內置預設使用lettuce此庫來連接redis

<dependency>
    <groupId>org.springframework.data</groupId>
    <artifactId>spring-data-redis</artifactId>
    <version>2.0.5.RELEASE</version>
</dependency>

或者是單獨使用，則直接引用lettuce庫即可

<dependency>
  <groupId>io.lettuce</groupId>
  <artifactId>lettuce-core</artifactId>
  <version>5.0.2.RELEASE</version>
</dependency>

2.使用

val redisUri = RedisURI.builder() // <1> 創建單機連接的連接信息
    .withHost("localhost")
    .withPort(6379)
    .withTimeout(Duration.of(10, ChronoUnit.SECONDS))
    .build()

val redisClient = RedisClient.create(redisUri) // <2> 創建客戶端
val connection = redisClient.connect() // <3> 創建線程安全的連接
val redisCommands = connection.sync() // <4> 創建同步命令


//這裡的參數說明可以訪問http://redis.io/commands/set查看
//ex就是設置5s的過期時間
val setArgs = SetArgs.Builder.nx().ex(5)

//獲取剩餘過期時間
redisCommands.ttl("name")

//設置數據
val result = redisCommands.set("name", "throwable", setArgs)
if (result.toLowerCase() == "ok") {
    println("成功插入數據")
}

connection.close() // <5> 關閉連接

redisClient.shutdown() // <6> 關閉客戶端

Lettuce結構比較複雜,上面羅列的基本使用已經夠用了,就沒有深入研究下去了...

其他

不過最近找了一款後臺框架,寫的時候發現,它是用的RedisTemplate,似乎比Lettuce要早一些的技術棧了,稍微摸索了下也能使用,也沒去替換了那個後臺框架里的東西了

//存入數據並設置時間
stringRedisTemplate.opsForValue().set(key, value, timeout, TimeUnit.HOURS);

//刪除
stringRedisTemplate.delete(key);

//獲取剩餘到期時間
redisTemplate.getExpire(key, TimeUnit.MINUTES);

參考

提問之前，請先看提問須知點擊右側圖標發起提問

或者加入QQ群一起學習

TornadoFx學習交流群:1071184701