java

一文詳解!實現springboot介面等冪性校驗?安排!

一 前言

本篇內容的內容是實現介面等冪次校驗。

二 實現方案

主流的實現方案如下

2.1 唯一索引

給表加唯一索引,次方法最簡單,當資料重複插入時,直接報SQL異常,對應用影響不大;

alter table 表名 add unique(欄位)

示例,兩個欄位為唯一索引,如果出現完全一樣的 order_name, create_time 就直接重複報異常;

alter table `order`  add unique(order_name,create_time)

2.2 鎖

分散式鎖也可以實現介面等冪次校驗,知識追尋者有寫過一篇使用redis實現分散式鎖思路的一篇檔案,小夥伴們可以參考下《為什麼你不會redis分散式鎖?因為你沒看到這篇文章》

使用樂觀鎖(基於版本號實現),或者 悲觀鎖(表鎖或者行鎖)實現;

2.3 先查詢後判斷

入庫時先查詢是否有該資料,無插入,否則不插入;

2.4 token 機制

token 機制 也就是本篇文章的重點;大致實現思路就是 發起請求的時候先去 redis 獲取 token , 將獲取的token 放入 請求的hearder , 當請求到達服務端的時候攔截請求,對請求的 hearder 中的token,進行校驗,如果校驗透過則 放開攔截,刪除token,否則 使用自定義異常返回錯誤資訊;

三 使用redis 實現 介面等冪性校驗

3.1 redis 工具類

關於 RedisTemplate 的配置可以參考知識追尋者釋出的文章 《springboot整合redis(基礎篇)》

/**
 * @Author lsc
 * <p> </p>
 */

@Component
public class RedisUtils {

    @Autowired
    private RedisTemplate<String, Object> redisTemplate;

    /**
     * 判斷key是否存在
     * @param key 鍵
     * @return boolean
     */
    public boolean hasKey(String key) {
        try {
            return redisTemplate.hasKey(key);
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }


      /**
     * 刪除key
     * @param key 鍵
     */
    public Boolean del(String key) {
        if (key != null && key.length() > 0) {
            return redisTemplate.delete(key);
        }else  {
            return false;
        }
    }


    /**
     * 普通快取獲取
     * @param key 鍵
     * @return 值
     */

    public Object get(String key) {

        return key == null ? null : redisTemplate.opsForValue().get(key);
    }


    /**
     * 普通快取放入並設定時間
     * @param key 鍵
     * @param value 值
     * @param time 時間(秒) time要大於0 如果time小於等於0 將設定無限期
     * @return true成功 false 失敗
     */

    public boolean set(String key, Object value, long time) {
        try {
            if (time > 0) {
                redisTemplate.opsForValue().set(key, value, time, TimeUnit.SECONDS);
            }
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

}

3.2 token 工具類

使用 uuid 生成 隨機字串,透過md5加密防止token被解密,保證token的唯一性與安全性;,設定過期時間為 30 秒,即在30秒內只能提交成功一次請求,根據不同的業務需求,讀者們自行處理;

/**
 * @Author lsc
 * <p> </p>
 */
@Component
public class TokenUtis {

    @Autowired
    RedisUtils redisUtils;

    // token 過期時間為30秒
    private final static Long TOKEN_EXPIRE = 30L;

    private final static String TOKEN_NAME = "token";
    /* *
     * @Author lsc
     * <p> 生成token 放入快取</p>
     * @Param []
     */
    public String generateToken() {
        String uuid = UUID.randomUUID().toString();
        String token = DigestUtils.md5DigestAsHex(uuid.getBytes());
        redisUtils.set(TOKEN_NAME,token,TOKEN_EXPIRE);
        return token;
    }
    /* *
     * @Author lsc
     * <p> token 校驗 </p>
     * @Param [request]
     */
    public boolean verifyToken(HttpServletRequest request) {
        String token = request.getHeader(TOKEN_NAME);
        // header中不存在token
        if(StringUtils.isEmpty(token)) {
           // 丟擲自定義異常
            System.out.println("token不存在");
            throw new GlobleException(CodeMsg.BAD_REQUEST);
        }
        // 快取中不出在 
        if(!redisUtils.hasKey(TOKEN_NAME)) {
            // 丟擲自定義異常
            System.out.println("token已經過期");
            throw new GlobleException(CodeMsg.BAD_REQUEST);
        }
        String cachToekn = (String)redisUtils.get(TOKEN_NAME);
        if (!token.equals(cachToekn)){
            // 丟擲自定義異常
            System.out.println("token校驗失敗");
            throw new GlobleException(CodeMsg.BAD_REQUEST);
        }
        // 移除token
        Boolean del = redisUtils.del(TOKEN_NAME);
        if (!del){
            // 丟擲自定義異常
            System.out.println("token刪除失敗");
            throw new GlobleException(CodeMsg.BAD_REQUEST);
        }
        return true;
    }
}

3.3 註解

定義註解,使用在方法上,當控制層的方法上被註釋時,表示該請求為等冪性請求;

/**
 * @Author lsc
 * <p> </p>
 */
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Idempotent {

}

3.4 攔截器配置

選擇 前置攔截器,每次請求都校驗 到達的方法上是否有等冪性註解,如果有則進行token 校驗;

/**
 * @Author lsc
 * <p> </p>
 */
@Component
public class IdempotentInterceptor implements HandlerInterceptor {

    @Autowired
    private TokenUtis tokenUtis;

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
        if (!(handler instanceof HandlerMethod)) {
            return true;
        }
        // 對有Idempotent註解的方法進行攔截校驗
        HandlerMethod handlerMethod = (HandlerMethod) handler;
        Method method = handlerMethod.getMethod();
        Idempotent methodAnnotation = method.getAnnotation(Idempotent.class);
        if (methodAnnotation != null) {
            // token 校驗
            tokenUtis.verifyToken(request);
        }
        return true;
    }


    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {

    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {

    }
}

對攔截器進行url模式匹配,並注入spring容器

/**
 * @Author lsc
 * <p> </p>
 */
@Configuration
public class WebConfiguration implements WebMvcConfigurer {

    @Autowired
    IdempotentInterceptor idempotentInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 攔截所有請求
        registry.addInterceptor(idempotentInterceptor).addPathPatterns("/**");
    }

3.5 控制層

對控制層進行編寫如下,發起請求時透過 getToken 方法獲取token,將獲取的token 放入 hearder 後 再請求 testIdempotent 方法

/**
 * @Author lsc
 * <p> </p>
 */
@RestController
public class ZszxzController {

    @Autowired
    TokenUtis tokenUtis;

    @GetMapping("zszxz/token")
    public ResultPage getToken(){
        String token = tokenUtis.generateToken();
        JSONObject jsonObject = new JSONObject();
        jsonObject.put("token",token);
        return ResultPage.sucess(CodeMsg.SUCESS,jsonObject);
    }

    @Idempotent
    @GetMapping("zszxz/test")
    public ResultPage testIdempotent(){
        return ResultPage.sucess(CodeMsg.SUCESS,"校驗成功");
    }
}

3.6 測試

請求獲取token

一文詳解、實現,springboot介面等冪性校驗?安排

 

已經被消耗的token,請求時報錯

一文詳解、實現,springboot介面等冪性校驗?安排

 

重新獲取token 請求成功

一文詳解、實現,springboot介面等冪性校驗?安排

 

對於高併發請求可以使用jmeter進行測試,本篇文章也可以使用aop攔截實現;

本文章已修改原文用詞符合繁體字使用者習慣使其容易閱讀

版權宣告:此處為CSDN博主「程式設計師阿軒」的原創文章,依據CC 4.0 BY-SA版權協議,轉載請附上原文出處連結及本宣告。

原文連結:https://blog.csdn.net/weixin_51954021/article/details/109626763