如何使用 SpringBoot + Redis 優雅的解決接口冪等性問題

時間  2020-03-08
標籤 如何 使用 springboot redis 優雅 解決 接口 問題 欄目 Spring 简体版
原文   原文鏈接
愛碼士人員
https://www.jianshu.com/p/f76...

前言:

在實際的開發項目中，一個對外暴露的接口每每會面臨，瞬間大量的重複的請求提交，若是想過濾掉重複請求形成對業務的傷害，那就須要實現冪等！html

咱們來解釋一下冪等的概念：

任意屢次執行所產生的影響均與一次執行的影響相同。按照這個含義，最終的含義就是對數據庫的影響只能是一次性的，不能重複處理。前端

  • 一、數據庫創建惟一性索引，能夠保證最終插入數據庫的只有一條數據
  • 二、token機制，每次接口請求前先獲取一個token，而後再下次請求的時候在請求的header體中加上這個token，後臺進行驗證，若是驗證經過刪除token，下次請求再次判斷token
  • 三、悲觀鎖或者樂觀鎖，悲觀鎖能夠保證每次for update的時候其餘sql沒法update數據(在數據庫引擎是innodb的時候,select的條件必須是惟一索引,防止鎖全表)
  • 四、先查詢後判斷，首先經過查詢數據庫是否存在數據，若是存在證實已經請求過了，直接拒絕該請求，若是沒有存在，就證實是第一次進來，直接放行。

Redis實現自動冪等的原理圖：web

1、搭建 Redis 的服務 Api

  • 一、首先是搭建redis服務器。
  • 二、引入springboot中到的redis的stater，或者Spring封裝的jedis也能夠，後面主要用到的api就是它的set方法和exists方法,這裏咱們使用springboot的封裝好的redisTemplate
/**
 * redis工具類
 */
@Component 
publicclassRedisService{
 @Autowired
 privateRedisTemplate redisTemplate;
 /**
     * 寫入緩存
     * @param key
     * @param value
     * @return
     */
 publicbooleanset(finalString key, Object value) {
 boolean result = false;
 try{
 ValueOperations<Serializable, Object> operations = redisTemplate.opsForValue();
            operations.set(key, value);
            result = true;
        } catch(Exception e) {
            e.printStackTrace();
        }
 return result;
    }
 /**
     * 寫入緩存設置時效時間
     * @param key
     * @param value
     * @return
     */
 publicboolean setEx(finalString key, Object value, Long expireTime) {
 boolean result = false;
 try{
 ValueOperations<Serializable, Object> operations = redisTemplate.opsForValue();
            operations.set(key, value);
            redisTemplate.expire(key, expireTime, TimeUnit.SECONDS);
            result = true;
        } catch(Exception e) {
            e.printStackTrace();
        }
 return result;
    }
 /**
     * 判斷緩存中是否有對應的value
     * @param key
     * @return
     */
 publicboolean exists(finalString key) {
 return redisTemplate.hasKey(key);
    }
 /**
     * 讀取緩存
     * @param key
     * @return
     */
 publicObjectget(finalString key) {
 Object result = null;
 ValueOperations<Serializable, Object> operations = redisTemplate.opsForValue();
        result = operations.get(key);
 return result;
    }
 /**
     * 刪除對應的value
     * @param key
     */
 publicboolean remove(finalString key) {
 if(exists(key)) {
 Booleandelete= redisTemplate.delete(key);
 returndelete;
        }
 returnfalse;
    }
}

2、自定義註解AutoIdempotent

自定義一個註解，定義此註解的主要目的是把它添加在須要實現冪等的方法上，凡是某個方法註解了它，都會實現自動冪等。後臺利用反射若是掃描到這個註解，就會處理這個方法實現自動冪等，使用元註解ElementType.METHOD表示它只能放在方法上，RetentionPolicy.RUNTIME表示它在運行時。redis

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public@interfaceAutoIdempotent{
}

3、token建立和檢驗

一、token服務接口

咱們新建一個接口，建立token服務，裏面主要是兩個方法，一個用來建立token，一個用來驗證token。建立token主要產生的是一個字符串，檢驗token的話主要是傳達request對象，爲何要傳request對象呢？主要做用就是獲取header裏面的token,而後檢驗，經過拋出的Exception來獲取具體的報錯信息返回給前端。算法

publicinterfaceTokenService{
 /**
     * 建立token
     * @return
     */
 public String createToken();
 /**
     * 檢驗token
     * @param request
     * @return
     */
 publicboolean checkToken(HttpServletRequest request) throwsException;
}

二、token的服務實現類

token引用了redis服務，建立token採用隨機算法工具類生成隨機uuid字符串,而後放入到redis中(爲了防止數據的冗餘保留,這裏設置過時時間爲10000秒,具體可視業務而定)，若是放入成功，最後返回這個token值。checkToken方法就是從header中獲取token到值(若是header中拿不到，就從paramter中獲取)，如若不存在,直接拋出異常。這個異常信息能夠被攔截器捕捉到，而後返回給前端。spring

@Service
publicclassTokenServiceImplimplementsTokenService{
 @Autowired
 privateRedisService redisService;
 /**
     * 建立token
     *
     * @return
     */
 @Override
 publicString createToken() {
 String str = RandomUtil.randomUUID();
 StringBuilder token = new StringBuilder();
 try{
            token.append(Constant.Redis.TOKEN_PREFIX).append(str);
            redisService.setEx(token.toString(), token.toString(),10000L);
 boolean notEmpty = StrUtil.isNotEmpty(token.toString());
 if(notEmpty) {
 return token.toString();
            }
        }catch(Exception ex){
            ex.printStackTrace();
        }
 returnnull;
    }
 /**
     * 檢驗token
     *
     * @param request
     * @return
     */
 @Override
 publicboolean checkToken(HttpServletRequest request) throwsException{
 String token = request.getHeader(Constant.TOKEN_NAME);
 if(StrUtil.isBlank(token)) {// header中不存在token
            token = request.getParameter(Constant.TOKEN_NAME);
 if(StrUtil.isBlank(token)) {// parameter中也不存在token
 thrownewServiceException(Constant.ResponseCode.ILLEGAL_ARGUMENT, 100);
            }
        }
 if(!redisService.exists(token)) {
 thrownewServiceException(Constant.ResponseCode.REPETITIVE_OPERATION, 200);
        }
 boolean remove = redisService.remove(token);
 if(!remove) {
 thrownewServiceException(Constant.ResponseCode.REPETITIVE_OPERATION, 200);
        }
 returntrue;
    }
}

4、攔截器的配置

  • 一、web配置類，實現WebMvcConfigurerAdapter，主要做用就是添加AutoIdempotentInterceptor到配置類中，這樣咱們到攔截器才能生效，注意使用@Configuration註解，這樣在容器啓動是時候就能夠添加進入context中
@Configuration
public class WebConfiguration extends WebMvcConfigurerAdapter{
 @Resource
 private AutoIdempotentInterceptor autoIdempotentInterceptor;
 /**
     * 添加攔截器
     * @param registry
     */
 @Override
 publicvoid addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(autoIdempotentInterceptor);
 super.addInterceptors(registry);
    } 
}
  • 二、攔截處理器：主要的功能是攔截掃描到AutoIdempotent到註解到方法,而後調用tokenService的checkToken()方法校驗token是否正確，若是捕捉到異常就將異常信息渲染成json返回給前端
/**
 * 攔截器
 */
@Component
publicclassAutoIdempotentInterceptorimplementsHandlerInterceptor{
 @Autowired
 privateTokenService tokenService;
 /**
     * 預處理
     *
     * @param request
     * @param response
     * @param handler
     * @return
     * @throws Exception
     */
 @Override
 publicboolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throwsException{
 if(!(handler instanceofHandlerMethod)) {
 returntrue;
        }
 HandlerMethod handlerMethod = (HandlerMethod) handler;
 Method method = handlerMethod.getMethod();
 //被ApiIdempotment標記的掃描
 AutoIdempotent methodAnnotation = method.getAnnotation(AutoIdempotent.class);
 if(methodAnnotation != null) {
 try{
 return tokenService.checkToken(request);// 冪等性校驗, 校驗經過則放行, 校驗失敗則拋出異常, 並經過統一異常處理返回友好提示
            }catch(Exception ex){
 ResultVo failedResult = ResultVo.getFailedResult(101, ex.getMessage());
                writeReturnJson(response, JSONUtil.toJsonStr(failedResult));
 throw ex;
            }
        }
 //必須返回true,不然會被攔截一切請求
 returntrue;
    }
 @Override
 publicvoid postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throwsException{
    }
 @Override
 publicvoid afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throwsException{
    }
 /**
     * 返回的json值
     * @param response
     * @param json
     * @throws Exception
     */
 privatevoid writeReturnJson(HttpServletResponse response, String json) throwsException{
 PrintWriter writer = null;
        response.setCharacterEncoding("UTF-8");
        response.setContentType("text/html; charset=utf-8");
 try{
            writer = response.getWriter();
            writer.print(json);
        } catch(IOException e) {
        } finally{
 if(writer != null)
                writer.close();
        }
    }
}

5、測試用例

一、模擬業務請求類

首先咱們須要經過/get/token路徑經過getToken()方法去獲取具體的token，而後咱們調用testIdempotence方法，這個方法上面註解了@AutoIdempotent，攔截器會攔截全部的請求，當判斷處處理的方法上面有該註解的時候，就會調用TokenService中的checkToken()方法，若是捕獲到異常會將異常拋出調用者，下面咱們來模擬請求一下：sql

@RestController
public class BusinessController {
    @Resource
    privateTokenService tokenService;
    @Resource
    private TestService testService;

    @PostMapping("/get/token")
    publicString getToken() {
        String token = tokenService.createToken();
        if (StrUtil.isNotEmpty(token)) {
            ResultVo resultVo = newResultVo();
            resultVo.setCode(Constant.code_success);
            resultVo.setMessage(Constant.SUCCESS);
            resultVo.setData(token);
            returnJSONUtil.toJsonStr(resultVo);
        }
        returnStrUtil.EMPTY;
    }

    @AutoIdempotent
    @PostMapping("/test/Idempotence")
    public String testIdempotence() {
        String businessResult = testService.testIdempotence();
        if (StrUtil.isNotEmpty(businessResult)) {
            ResultVo successResult = ResultVo.getSuccessResult(businessResult);
            returnJSONUtil.toJsonStr(successResult);
        }
        returnStrUtil.EMPTY;
    }
}

二、使用postman請求

首先訪問get/token路徑獲取到具體到token：數據庫

利用獲取到到token,而後放到具體請求到header中,能夠看到第一次請求成功，接着咱們請求第二次：json

第二次請求，返回到是重複性操做，可見重複性驗證經過，再屢次請求到時候咱們只讓其第一次成功，第二次就是失敗：api

6、總結

本篇介紹了使用 SpringBoot 和攔截器、Redis 來優雅的實現接口冪等，對於冪等在實際的開發過程當中是十分重要的，由於一個接口可能會被無數的客戶端調用，如何保證其不影響後臺的業務處理，如何保證其隻影響數據一次是很是重要的，它能夠防止產生髒數據或者亂數據，也能夠減小併發量，實乃十分有益的一件事。而傳統的作法是每次判斷數據，這種作法不夠智能化和自動化，比較麻煩。而今天的這種自動化處理也能夠提高程序的伸縮性。

粉絲福利

《架構文摘》精心準備了 12 套 微服務、Spring Boot、Spring Cloud 核心技術資料，這是部分資料目錄：

  • Spring Security 認證與受權
  • Spring Boot 項目實戰（中小型互聯網公司後臺服務架構與運維架構）
  • Spring Boot 項目實戰（企業權限管理項目））
  • Spring Cloud 微服務架構項目實戰（分佈式事務解決方案）
  • Spring Cloud + Spring Boot + Docker 全套視頻教程
  • Spring Cloud 網站項目實戰（房產銷售）
  • Spring Cloud 微服務項目實戰（大型電商架構系統）
  • 單點登錄基礎到實戰
  • Spring Boot 項目實戰（企業微信點餐系統）（初級實戰）
  • Spring Cloud 互聯網應用項目實戰（天氣預報系統）
  • Spring 源碼深度解析 + 註解開發全套視頻教程
  • Spring Boot 項目實戰（理財產品系統）

目錄截圖：

關注公衆號領取福利：

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程