利用Redis實現(xiàn)防止接口重復(fù)提交功能

在劃水摸魚之際扩劝,突然聽到有的用戶反映增加了多條一樣的數(shù)據(jù)庸论,這用戶立馬就不干了,讓我們要馬上修復(fù)棒呛,不然就要投訴我們聂示。


在這里插入圖片描述

這下魚也摸不了了,只能去看看發(fā)生了什么事情条霜。據(jù)用戶反映催什,當(dāng)時網(wǎng)絡(luò)有點卡涵亏,所以多點了幾次提交宰睡,最后發(fā)現(xiàn)出現(xiàn)了十幾條一樣的數(shù)據(jù)。

只能說現(xiàn)在的人都太心急了气筋,連這幾秒的時間都等不了拆内,慣的。心里吐槽歸吐槽宠默,這問題還是要解決的麸恍,不然老板可不慣我。

在這里插入圖片描述

其實想想就知道為啥會這樣搀矫,在網(wǎng)絡(luò)延遲的時候抹沪,用戶多次點擊,最后這幾次請求都發(fā)送到了服務(wù)器訪問相關(guān)的接口瓤球,最后執(zhí)行插入融欧。

既然知道了原因,該如何解決卦羡。當(dāng)時我的第一想法就是用注解 + AOP噪馏。通過在自定義注解里定義一些相關(guān)的字段,比如過期時間即該時間內(nèi)同一用戶不能重復(fù)提交請求绿饵。然后把注解按需加在接口上欠肾,最后在攔截器里判斷接口上是否有該接口,如果存在則攔截拟赊。

解決了這個問題那還需要解決另一個問題刺桃,就是怎么判斷當(dāng)前用戶限定時間內(nèi)訪問了當(dāng)前接口。其實這個也簡單吸祟,可以使用Redis來做虏肾,用戶名 + 接口 + 參數(shù)啥的作為唯一鍵廓啊,然后這個鍵的過期時間設(shè)置為注解里過期字段的值。設(shè)置一個過期時間可以讓鍵過期自動釋放封豪,不然如果線程突然歇逼谴轮,該接口就一直不能訪問。

在這里插入圖片描述

這樣還需要注意的一個問題是吹埠,如果你先去Redis獲取這個鍵第步,然后判斷這個鍵不存在則設(shè)置鍵;存在則說明還沒到訪問時間缘琅,返回提示粘都。這個思路是沒錯的,但這樣如果獲取和設(shè)置分成兩個操作刷袍,就不滿足原子性了翩隧,那么在多線程下是會出錯的。所以這樣需要把倆操作變成一個原子操作呻纹。

分析好了堆生,就開干。


在這里插入圖片描述

1雷酪、自定義注解

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 防止同時提交注解
 */
@Target({ElementType.PARAMETER, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface NoRepeatCommit {
    // key的過期時間3s
    int expire() default 3;
}

這里為了簡單一點淑仆,只定義了一個字段expire,默認值為3哥力,即3s內(nèi)同一用戶不允許重復(fù)訪問同一接口蔗怠。使用的時候也可以傳入自定義的值。

我們只需要在對應(yīng)的接口上添加該注解即可

@NoRepeatCommit
或者
@NoRepeatCommit(expire = 10)

2吩跋、自定義攔截器

自定義好了注解寞射,那就該寫攔截器了。

@Aspect
public class NoRepeatSubmitAspect {
    private static Logger _log = LoggerFactory.getLogger(NoRepeatSubmitAspect.class);
    RedisLock redisLock = new RedisLock();

    @Pointcut("@annotation(com.zheng.common.annotation.NoRepeatCommit)")
    public void point() {}

    @Around("point()")
    public Object doAround(ProceedingJoinPoint pjp) throws Throwable {
        // 獲取request
        RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
        ServletRequestAttributes servletRequestAttributes = (ServletRequestAttributes) requestAttributes;
        HttpServletRequest request = servletRequestAttributes.getRequest();
        HttpServletResponse responese = servletRequestAttributes.getResponse();
        Object result = null;

        String account = (String) request.getSession().getAttribute(UpmsConstant.ACCOUNT);
        User user = (User) request.getSession().getAttribute(UpmsConstant.USER);
        if (StringUtils.isEmpty(account)) {
            return pjp.proceed();
        }

        MethodSignature signature = (MethodSignature) pjp.getSignature();
        Method method = signature.getMethod();
        NoRepeatCommit form = method.getAnnotation(NoRepeatCommit.class);

        String sessionId = request.getSession().getId() + "|" + user.getUsername();
        String url = ObjectUtils.toString(request.getRequestURL());
        String pg = request.getMethod();
        String key = account + "_" + sessionId + "_" + url + "_" + pg;
        int expire = form.expire();
        if (expire < 0) {
            expire = 3;
        }

        // 獲取鎖
        boolean isSuccess = redisLock.tryLock(key, key + sessionId, expire);
        // 獲取成功
        if (isSuccess) {
            // 執(zhí)行請求
            result = pjp.proceed();
            int status = responese.getStatus();
            _log.debug("status = {}" + status);
            // 釋放鎖锌钮,3s后讓鎖自動釋放桥温,也可以手動釋放
            // redisLock.releaseLock(key, key + sessionId);
            return result;
        } else {
            // 失敗,認為是重復(fù)提交的請求
            return new UpmsResult(UpmsResultConstant.REPEAT_COMMIT, ValidationError.create(UpmsResultConstant.REPEAT_COMMIT.message));
        }
    }
}

攔截器定義的切點是NoRepeatCommit注解轧粟,所以被NoRepeatCommit注解標注的接口就會進入該攔截器策治。這里我使用了account + "_" + sessionId + "_" + url + "_" + pg作為唯一鍵,表示某個用戶訪問某個接口兰吟。

這樣比較關(guān)鍵的一行是boolean isSuccess = redisLock.tryLock(key, key + sessionId, expire);通惫。可以看看RedisLock這個類混蔼。

3履腋、Redis工具類

上面討論過了,獲取鎖和設(shè)置鎖需要做成原子操作,不然并發(fā)環(huán)境下會出問題遵湖。這里可以使用Redis的SETNX命令悔政。

/**
 * redis分布式鎖實現(xiàn)
 * Lua表達式為了保持數(shù)據(jù)的原子性
 */
public class RedisLock {

    /**
     * redis 鎖成功標識常量
     */
    private static final Long RELEASE_SUCCESS = 1L;
    private static final String SET_IF_NOT_EXIST = "NX";
    private static final String SET_WITH_EXPIRE_TIME = "EX";
    private static final String LOCK_SUCCESS= "OK";
    /**
     * 加鎖 Lua 表達式。
     */
    private static final String RELEASE_TRY_LOCK_LUA =
            "if redis.call('setNx',KEYS[1],ARGV[1]) == 1 then return redis.call('expire',KEYS[1],ARGV[2]) else return 0 end";
    /**
     * 解鎖 Lua 表達式.
     */
    private static final String RELEASE_RELEASE_LOCK_LUA =
            "if redis.call('get', KEYS[1]) == ARGV[1] then return redis.call('del', KEYS[1]) else return 0 end";

    /**
     * 加鎖
     * 支持重復(fù)延旧,線程安全
     * 既然持有鎖的線程崩潰谋国,也不會發(fā)生死鎖,因為鎖到期會自動釋放
     * @param lockKey    加鎖鍵
     * @param userId     加鎖客戶端唯一標識(采用用戶id, 需要把用戶 id 轉(zhuǎn)換為 String 類型)
     * @param expireTime 鎖過期時間
     * @return OK 如果key被設(shè)置了
     */
    public boolean tryLock(String lockKey, String userId, long expireTime) {
        Jedis jedis = JedisUtils.getInstance().getJedis();
        try {
            jedis.select(JedisUtils.index);
            String result = jedis.set(lockKey, userId, SET_IF_NOT_EXIST, SET_WITH_EXPIRE_TIME, expireTime);
            if (LOCK_SUCCESS.equals(result)) {
                return true;
            }
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            if (jedis != null)
                jedis.close();
        }

        return false;
    }

    /**
     * 解鎖
     * 與 tryLock 相對應(yīng)迁沫,用作釋放鎖
     * 解鎖必須與加鎖是同一人芦瘾,其他人拿到鎖也不可以解鎖
     *
     * @param lockKey 加鎖鍵
     * @param userId  解鎖客戶端唯一標識(采用用戶id, 需要把用戶 id 轉(zhuǎn)換為 String 類型)
     * @return
     */
    public boolean releaseLock(String lockKey, String userId) {
        Jedis jedis = JedisUtils.getInstance().getJedis();
        try {
            jedis.select(JedisUtils.index);
            Object result = jedis.eval(RELEASE_RELEASE_LOCK_LUA, Collections.singletonList(lockKey), Collections.singletonList(userId));
            if (RELEASE_SUCCESS.equals(result)) {
                return true;
            }
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            if (jedis != null)
                jedis.close();
        }

        return false;
    }
}

在加鎖的時候,我使用了String result = jedis.set(lockKey, userId, SET_IF_NOT_EXIST, SET_WITH_EXPIRE_TIME, expireTime);集畅。set方法如下

/* Set the string value as value of the key. The string can't be longer than 1073741824 bytes (1 GB).
Params:
        key –
        value –
        nxxx – NX|XX, NX -- Only set the key if it does not already exist. XX -- Only set the       key if it already exist.
        expx – EX|PX, expire time units: EX = seconds; PX = milliseconds
        time – expire time in the units of expx
Returns: Status code reply
*/
public String set(final String key, final String value, final String nxxx, final String expx,
      final long time) {
    checkIsInMultiOrPipeline();
    client.set(key, value, nxxx, expx, time);
    return client.getStatusCodeReply();
  }

在key不存在的情況下近弟,才會設(shè)置key,設(shè)置成功則返回OK挺智。這樣就做到了查詢和設(shè)置原子性祷愉。

需要注意這里在使用完jedis,需要進行close赦颇,不然耗盡連接數(shù)就完蛋了二鳄,我不會告訴你我把服務(wù)器搞掛了。


在這里插入圖片描述

4沐扳、其他想說的

其實做完這三步差不多了泥从,基本夠用句占。再考慮一些其他情況的話沪摄,比如在expire設(shè)置的時間內(nèi),我這個接口還沒執(zhí)行完邏輯咋辦呢纱烘?

其實我們不用自己在這整破輪子杨拐,直接用健壯的輪子不好嗎?比如Redisson擂啥,來實現(xiàn)分布式鎖哄陶,那么上面的問題就不用考慮了。有看門狗來幫你做哺壶,在鍵過期的時候屋吨,如果檢查到鍵還被線程持有,那么就會重新設(shè)置鍵的過期時間山宾。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末至扰,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子资锰,更是在濱河造成了極大的恐慌敢课,老刑警劉巖,帶你破解...
    沈念sama閱讀 216,402評論 6 499
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異直秆,居然都是意外死亡濒募,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,377評論 3 392
  • 文/潘曉璐 我一進店門圾结,熙熙樓的掌柜王于貴愁眉苦臉地迎上來瑰剃,“玉大人,你說我怎么就攤上這事筝野∨嗨” “怎么了?”我有些...
    開封第一講書人閱讀 162,483評論 0 353
  • 文/不壞的土叔 我叫張陵遗座,是天一觀的道長舀凛。 經(jīng)常有香客問我,道長途蒋,這世上最難降的妖魔是什么猛遍? 我笑而不...
    開封第一講書人閱讀 58,165評論 1 292
  • 正文 為了忘掉前任,我火速辦了婚禮号坡,結(jié)果婚禮上懊烤,老公的妹妹穿的比我還像新娘。我一直安慰自己宽堆,他們只是感情好腌紧,可當(dāng)我...
    茶點故事閱讀 67,176評論 6 388
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著畜隶,像睡著了一般壁肋。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上籽慢,一...
    開封第一講書人閱讀 51,146評論 1 297
  • 那天浸遗,我揣著相機與錄音,去河邊找鬼箱亿。 笑死跛锌,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的届惋。 我是一名探鬼主播髓帽,決...
    沈念sama閱讀 40,032評論 3 417
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼脑豹!你這毒婦竟也來了郑藏?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 38,896評論 0 274
  • 序言:老撾萬榮一對情侶失蹤晨缴,失蹤者是張志新(化名)和其女友劉穎译秦,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,311評論 1 310
  • 正文 獨居荒郊野嶺守林人離奇死亡筑悴,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,536評論 2 332
  • 正文 我和宋清朗相戀三年们拙,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片阁吝。...
    茶點故事閱讀 39,696評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡砚婆,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出突勇,到底是詐尸還是另有隱情装盯,我是刑警寧澤,帶...
    沈念sama閱讀 35,413評論 5 343
  • 正文 年R本政府宣布甲馋,位于F島的核電站埂奈,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏定躏。R本人自食惡果不足惜账磺,卻給世界環(huán)境...
    茶點故事閱讀 41,008評論 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望痊远。 院中可真熱鬧垮抗,春花似錦、人聲如沸碧聪。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,659評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽逞姿。三九已至辞嗡,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間哼凯,已是汗流浹背欲间。 一陣腳步聲響...
    開封第一講書人閱讀 32,815評論 1 269
  • 我被黑心中介騙來泰國打工楚里, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留断部,地道東北人。 一個月前我還...
    沈念sama閱讀 47,698評論 2 368
  • 正文 我出身青樓班缎,卻偏偏與公主長得像蝴光,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子达址,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,592評論 2 353

推薦閱讀更多精彩內(nèi)容