実際の開発プロジェクトでは、公開されたインターフェースが多くの要求に直面することがよくあります。べき等の概念を説明しましょう。任意の数の実行の影響は、1回の実行の影響と同じです。この意味によると、最終的な意味は、データベースへの影響は1回だけであり、繰り返すことはできないということです。べき等性を確保する方法には、通常、次の手段があります。
-
データベースは一意のインデックスを確立して、最終的に1つのデータのみがデータベースに挿入されるようにします。
-
トークンメカニズムでは、最初に各インターフェースリクエストの前にトークンを取得し、次にこのトークンを次のリクエストのリクエストのヘッダー本文に追加し、バックグラウンドで検証します。検証でトークンの削除に合格すると、トークンは次のようになります。次回も審査しました。
-
ペシミスティックロックまたはオプティミスティックロック、ペシミスティックロックは、他のSQLが更新のたびにデータを更新できないようにすることができます(データベースエンジンがinnodbの場合、テーブル全体がロックされないように、selectの条件は一意のインデックスである必要があります)
-
まず確認してから判断するまずデータベースにデータがあるか確認する存在証明書が要求されている場合は直接拒否され、存在しない場合は初めて入ってきて許可するそれは直接行きます。
Redisは、自動べき等の概略図を実現します。
redisサービスAPIを構築する
-
1つ目は、redisサーバーを構築することです。
-
また、springbootからredisステータスを導入することも、Springによってパッケージ化されたjedisを導入することもできます。後で使用される主なAPIは、setメソッドとexistsメソッドです。ここでは、springbootパッケージ化されたredisTemplateを使用します。
/**
* 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
注釈をカスタマイズします。この注釈を定義する主な目的は、べき等である必要があるメソッドに注釈を追加することです。メソッドに注釈が付けられている場合、自動的にべき等になります。このアノテーションがリフレクションを使用してバックグラウンドでスキャンされる場合、このメソッドを処理して自動べき等性を実現します。メタアノテーションElementType.METHODを使用して、メソッドにのみ配置できることを示し、attentionPolicy.RUNTIMEは実行中であることを示します。
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface AutoIdempotent {
}
トークンの作成と検証
-
トークンサービスインターフェース:トークンサービスを作成するための新しいインターフェースを作成します。主に2つのメソッドがあり、1つはトークンの作成に使用され、もう1つはトークンの検証に使用されます。トークンの作成は主に文字列であり、トークンの検証は主にリクエストオブジェクトを伝達することですが、なぜリクエストオブジェクトを渡したいのですか?主な機能は、ヘッダー内のトークンを取得し、チェックして、スローされた例外を介して特定のエラーメッセージを取得し、それをフロントエンドに返すことです。
public interface 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を実装するWeb構成クラスは、主に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()メソッドを呼び出して、トークンが正しいかどうかを確認することです。例外がキャッチされると、例外情報が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();
}
}
}
テストケース
-
ビジネスリクエストクラスをシミュレートするには、最初に/ get / tokenパスを介してgetToken()メソッドを介して特定のトークンを取得する必要があり、次にtestIdempotenceメソッドを呼び出します。このメソッドには@AutoIdempotentアノテーションが付けられ、インターセプターがインターセプトします。すべてのリクエスト。処理メソッドにアノテーションがあると、TokenServiceのcheckToken()メソッドが呼び出されます。例外がキャッチされると、例外が呼び出し元にスローされます。以下のリクエストをシミュレートしてみましょう。
@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;
}
}
-
postmanリクエストを使用するには、最初にget / tokenパスにアクセスして、特定のトークンを取得します。
-
を使用してトークンを取得し、それを特定のリクエストヘッダーに配置すると、最初のリクエストが成功したことがわかり、2回目のリクエストが行われます。
-
2番目の要求であるreturnは反復操作であり、反復検証に合格していることがわかります。最初は成功させ、2回目は失敗させます。
総括する
このブログでは、スプリングブート、インターセプター、およびredisを使用して、インターフェイスのべき等をエレガントに実装する方法を紹介しています。インターフェイスは無数のクライアントから呼び出される可能性があるため、実際の開発プロセスでのべき等にとって非常に重要です。バックグラウンドに影響を与えないようにする方法ビジネス処理では、データに1回だけ影響を与えるようにする方法が非常に重要です。これにより、ダーティまたは乱雑なデータの生成を防ぐことができ、同時実行の量を減らすこともできます。これは実際には非常に有益です。従来の方法では、毎回データを判断する方法でしたが、インテリジェントで自動化されていないため、面倒です。また、今日の自動処理により、プログラムのスケーラビリティも向上します。