Общедоступный номер: Java Xiaokasiu, веб-сайт:www.javaxks.com, источник: jianshu.com/p/c806003a8530
предисловие
В реальных проектах разработки открытый интерфейс часто сталкивается со многими запросами.Давайте объясним концепцию идемпотентности: влияние любого количества выполнений такое же, как влияние одного выполнения. Согласно этому смыслу, окончательный смысл заключается в том, что воздействие на базу данных может быть только разовым и не может обрабатываться повторно. Как обеспечить его идемпотентность обычно существуют следующие средства:
База данных устанавливает уникальный индекс, чтобы гарантировать, что только один фрагмент данных будет окончательно вставлен в базу данных. Механизм токена, сначала получите токен перед каждым запросом интерфейса, а затем добавьте токен в тело заголовка запроса в следующем запросе и проверьте в фоновом режиме.Если проверка проходит, удалите токен и снова оцените токен в следующий запрос. Пессимистическая блокировка или оптимистическая блокировка, пессимистическая блокировка может гарантировать, что другой SQL не сможет обновлять данные каждый раз для обновления (когда механизм базы данных - innodb, условие выбора должно быть уникальным индексом, чтобы предотвратить блокировку всей таблицы) Сначала проверьте, а потом судите.Сначала проверьте, есть ли данные в базе данных.Если они есть, это доказывает, что запрос был запрошен, а запрос напрямую отклонен. Схематическая диаграмма Redis, реализующая автоматическую идемпотентность:
Создание API службы Redis
Первый — создать сервер Redis.
Также можно использовать статер redis, представленный в Springboot, или jedis, упакованный Spring.Основным API, используемым позже, является его метод set и метод exists.Здесь мы используем упакованный redisTemplate из Springboot.
/**
* redis工具类
*/
@Component
public class RedisService {
@Autowired
private RedisTemplate redisTemplate;
/**
* 写入缓存
* @param key
* @param value
* @return
*/
public boolean set(final String 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
*/
public boolean setEx(final String 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
*/
public boolean exists(final String key) {
return redisTemplate.hasKey(key);
}
/**
* 读取缓存
* @param key
* @return
*/
public Object get(final String key) {
Object result = null;
ValueOperations<Serializable, Object> operations = redisTemplate.opsForValue();
result = operations.get(key);
return result;
}
/**
* 删除对应的value
* @param key
*/
public boolean remove(final String key) {
if (exists(key)) {
Boolean delete = redisTemplate.delete(key);
return delete;
}
return false;
}
}
Пользовательская аннотация AutoIdempotent
Настройте аннотацию. Основная цель определения этой аннотации — добавить ее к методу, который должен достичь идемпотентности. Любой метод, аннотированный с ней, будет достигать автоматической идемпотентности. Если эта аннотация сканируется путем отражения в фоновом режиме, этот метод будет обработан для достижения автоматической идемпотентности.
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface AutoIdempotent {
}
создание и проверка токена
Интерфейс службы токенов: мы создаем новый интерфейс для создания службы токенов.Существует два основных метода: один используется для создания токена, а другой используется для проверки токена. Основной результат создания токена это строка.При проверке токена он в основном передает объект запроса.Зачем передавать объект запроса? Основная функция - получить токен в заголовке, а затем проверить его, получить конкретное сообщение об ошибке через выброшенное исключение и вернуть его во внешний интерфейс. общедоступный интерфейс TokenService {
/**
* 创建token
* @return
*/
public String createToken();
/**
* 检验token
* @param request
* @return
*/
public boolean checkToken(HttpServletRequest request) throws Exception;
} Класс реализации службы токена: токен относится к службе redis, и токен создается с использованием класса инструментов случайного алгоритма для генерации случайной строки uuid, а затем помещается в redis (во избежание сохранения избыточных данных время истечения срока действия равно установите здесь значение 10000 секунд, которое можно указать следующим образом: в зависимости от бизнеса), если вставка прошла успешно, в конце будет возвращено значение токена. Метод checkToken заключается в том, чтобы получить токен из заголовка в значение (если заголовок не может быть получен, он будет получен из параметра), если он не существует, будет выброшено исключение напрямую. Эта информация об исключении может быть перехвачена перехватчиком и возвращена во внешний интерфейс.
@Service
public class TokenServiceImpl implements TokenService {
@Autowired
private RedisService redisService;
/**
* 创建token
*
* @return
*/
@Override
public String createToken() {
String str = RandomUtil.randomUUID();
StrBuilder token = new StrBuilder();
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();
}
return null;
}
/**
* 检验token
*
* @param request
* @return
*/
@Override
public boolean checkToken(HttpServletRequest request) throws Exception {
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
throw new ServiceException(Constant.ResponseCode.ILLEGAL_ARGUMENT, 100);
}
}
if (!redisService.exists(token)) {
throw new ServiceException(Constant.ResponseCode.REPETITIVE_OPERATION, 200);
}
boolean remove = redisService.remove(token);
if (!remove) {
throw new ServiceException(Constant.ResponseCode.REPETITIVE_OPERATION, 200);
}
return true;
}
}
Конфигурация перехватчика
Класс веб-конфигурации реализует WebMvcConfigurerAdapter. Основная функция — добавить autoIdempotentInterceptor в класс конфигурации, чтобы перехватчик мог сработать. Обратите внимание на аннотацию @Configuration, чтобы ее можно было добавить в контекст при запуске контейнера.
@Configuration
public class WebConfiguration extends WebMvcConfigurerAdapter {
@Resource
private AutoIdempotentInterceptor autoIdempotentInterceptor;
/**
* 添加拦截器
* @param registry
*/
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(autoIdempotentInterceptor);
super.addInterceptors(registry);
}
}
拦截处理器：主要的功能是拦截扫描到AutoIdempotent到注解到方法,然后调用tokenService的checkToken()方法校验token是否正确，如果捕捉到异常就将异常信息渲染成json返回给前端
/**
* 拦截器
*/
@Component
public class AutoIdempotentInterceptor implements HandlerInterceptor {
@Autowired
private TokenService tokenService;
/**
* 预处理
*
* @param request
* @param response
* @param handler
* @return
* @throws Exception
*/
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
if (!(handler instanceof HandlerMethod)) {
return true;
}
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,否则会被拦截一切请求
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 {
}
/**
* 返回的json值
* @param response
* @param json
* @throws Exception
*/
private void writeReturnJson(HttpServletResponse response, String json) throws Exception{
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();
}
}
}
прецедент
Чтобы имитировать класс бизнес-запроса, сначала нам нужно получить конкретный токен с помощью метода getToken() по пути /get/token, а затем мы вызываем метод testIdempotence, который аннотирован @AutoIdempotent, и перехватчик перехватит все запросы. Когда метод обработки имеет эту аннотацию, будет вызван метод checkToken () в TokenService. Если исключение поймано, исключение будет передано вызывающей стороне. Давайте смоделируем запрос:
@RestController
public class BusinessController {
@Resource
private TokenService tokenService;
@Resource
private TestService testService;
@PostMapping("/get/token")
public String getToken(){
String token = tokenService.createToken();
if (StrUtil.isNotEmpty(token)) {
ResultVo resultVo = new ResultVo();
resultVo.setCode(Constant.code_success);
resultVo.setMessage(Constant.SUCCESS);
resultVo.setData(token);
return JSONUtil.toJsonStr(resultVo);
}
return StrUtil.EMPTY;
}
@AutoIdempotent
@PostMapping("/test/Idempotence")
public String testIdempotence() {
String businessResult = testService.testIdempotence();
if (StrUtil.isNotEmpty(businessResult)) {
ResultVo successResult = ResultVo.getSuccessResult(businessResult);
return JSONUtil.toJsonStr(successResult);
}
return StrUtil.EMPTY;
}
}
Используя запрос почтальона, сначала получите доступ к пути get/token, чтобы получить конкретный токен:
Используем полученный токен, а затем в шапку помещаем конкретный запрос, вы можете видеть, что первый запрос прошел успешно, а затем запрашиваем второй раз:
Для второго запроса возврат — это повторяющаяся операция, видно, что повторная проверка пройдена, когда запрос делается несколько раз, мы делаем его успешным только в первый раз, а во второй раз — с ошибкой:
Суммировать
В этом блоге рассказывается об использовании Springboot, перехватчиков и Redis для элегантной реализации идемпотентности интерфейса.Это очень важно для идемпотентности в фактическом процессе разработки, поскольку интерфейс может вызываться бесчисленным количеством клиентов, как убедиться, что это не так. важно убедиться, что бизнес-обработка в фоновом режиме затрагивается только один раз.Это может предотвратить создание грязных данных или хаотических данных, а также может уменьшить количество параллелизма, что очень полезно. Традиционный метод состоит в том, чтобы оценивать данные каждый раз, что недостаточно интеллектуально и автоматизировано, а также более проблематично. А современная автоматизация также может улучшить масштабируемость программы.