共计 6283 个字符，预计需要花费 16 分钟才能阅读完成。
据说微信搜寻《Java 鱼仔》会变更强哦！
本文收录于 JavaStarter，外面有我残缺的 Java 系列文章，学习或面试都能够看看哦
每天一个知识点
什么是接口的幂等性，如何实现接口幂等性？
（一）幂等性概念
幂等性本来是数学上的概念，用在接口上就能够了解为：同一个接口，屡次收回同一个申请，必须保障操作只执行一次。
调用接口产生异样并且反复尝试时，总是会造成零碎所无奈接受的损失，所以必须阻止这种景象的产生。
比方上面这些状况，如果没有实现接口幂等性会有很重大的结果：
领取接口，反复领取会导致屡次扣钱
订单接口，同一个订单可能会屡次创立。
（二）幂等性的解决方案
惟一索引
应用惟一索引能够防止脏数据的增加，当插入反复数据时数据库会抛异样，保障了数据的唯一性。
乐观锁
这里的乐观锁指的是用乐观锁的原理去实现，为数据字段减少一个 version 字段，当数据须要更新时，先去数据库里获取此时的 version 版本号
select version from tablename where xxx更新数据时首先和版本号作比照，如果不相等阐明曾经有其余的申请去更新数据了，提醒更新失败。
update tablename set count=count+1,version=version+1 where version=#{version}乐观锁
乐观锁能够实现的往往用乐观锁也能实现，在获取数据时进行加锁，当同时有多个反复申请时其余申请都无奈进行操作
分布式锁
幂等的实质是分布式锁的问题，分布式锁失常能够通过 redis 或 zookeeper 实现；在分布式环境下，锁定全局惟一资源，使申请串行化，理论体现为互斥锁，避免反复，解决幂等。
token 机制
token 机制的核心思想是为每一次操作生成一个唯一性的凭证，也就是 token。一个 token 在操作的每一个阶段只有一次执行权，一旦执行胜利则保留执行后果。对反复的申请，返回同一个后果。token 机制的利用非常宽泛。
（三）token 机制的实现
这里展现通过 token 机制实现接口幂等性的案例：github 文末自取
首先引入须要的依赖：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-lang3</artifactId>
<version>3.4</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>3.1、配置申请的办法体和枚举类
首先配置一下通用的申请返回体
public class Response {
private int status;
private String msg;
private Object data;
// 省略 get、set、toString、无参有参构造方法
}以及返回 code
public enum ResponseCode {
// 通用模块 1xxxx
ILLEGAL_ARGUMENT(10000, "参数不非法"),
REPETITIVE_OPERATION(10001, "请勿反复操作"),
;
ResponseCode(Integer code, String msg) {
this.code = code;
this.msg = msg;
}
private Integer code;
private String msg;
public Integer getCode() {return code;}
public void setCode(Integer code) {this.code = code;}
public String getMsg() {return msg;}
public void setMsg(String msg) {this.msg = msg;}
}3.2 自定义异样以及配置全局异样类
public class ServiceException extends RuntimeException{
private String code;
private String msg;
// 省略 get、set、toString 以及构造方法
}配置全局异样捕捉器
@ControllerAdvice
public class MyControllerAdvice {
@ResponseBody
@ExceptionHandler(ServiceException.class)
public Response serviceExceptionHandler(ServiceException exception){Response response=new Response(Integer.valueOf(exception.getCode()),exception.getMsg(),null);
return response;
}
}3.3 编写创立 Token 和验证 Token 的接口以及实现类
@Service
public interface TokenService {public Response createToken();
public Response checkToken(HttpServletRequest request);
}具体实现类，外围的业务逻辑都写在正文中了
@Service
public class TokenServiceImpl implements TokenService {
@Autowired
private RedisTemplate redisTemplate;
@Override
public Response createToken() {
// 生成 uuid 当作 token
String token = UUID.randomUUID().toString().replaceAll("-","");
// 将生成的 token 存入 redis 中
redisTemplate.opsForValue().set(token,token);
// 返回正确的后果信息
Response response=new Response(0,token.toString(),null);
return response;
}
@Override
public Response checkToken(HttpServletRequest request) {
// 从申请头中获取 token
String token=request.getHeader("token");
if (StringUtils.isBlank(token)){
// 如果申请头 token 为空就从参数中获取
token=request.getParameter("token");
// 如果都为空抛出参数异样的谬误
if (StringUtils.isBlank(token)){throw new ServiceException(ResponseCode.ILLEGAL_ARGUMENT.getCode().toString(),ResponseCode.ILLEGAL_ARGUMENT.getMsg());
}
}
// 如果 redis 中不蕴含该 token，阐明 token 曾经被删除了，抛出申请反复异样
if (!redisTemplate.hasKey(token)){throw new ServiceException(ResponseCode.REPETITIVE_OPERATION.getCode().toString(),ResponseCode.REPETITIVE_OPERATION.getMsg());
}
// 删除 token
Boolean del=redisTemplate.delete(token);
// 如果删除不胜利（曾经被其余申请删除），抛出申请反复异样
if (!del){throw new ServiceException(ResponseCode.REPETITIVE_OPERATION.getCode().toString(),ResponseCode.REPETITIVE_OPERATION.getMsg());
}
return new Response(0,"校验胜利",null);
}
}3.4 配置自定义注解
这是比拟重要的一步，通过自定义注解在须要实现接口幂等性的办法上增加此注解，实现 token 验证
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface ApiIdempotent {}接口拦截器
public class ApiIdempotentInterceptor implements HandlerInterceptor {
@Autowired
private TokenService tokenService;
@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();
ApiIdempotent methodAnnotation=method.getAnnotation(ApiIdempotent.class);
if (methodAnnotation != null){
// 校验通过放行，校验不通过全局异样捕捉后输入返回后果
tokenService.checkToken(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 {}}3.5 配置拦截器以及 redis
配置 webConfig，增加拦截器
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {registry.addInterceptor(apiIdempotentInterceptor());
}
@Bean
public ApiIdempotentInterceptor apiIdempotentInterceptor() {return new ApiIdempotentInterceptor();
}
}配置 redis，使得中文能够失常传输
@Configuration
public class RedisConfig {
// 自定义的 redistemplate
@Bean(name = "redisTemplate")
public RedisTemplate<String,Object> redisTemplate(RedisConnectionFactory factory){
// 创立一个 RedisTemplate 对象，为了不便返回 key 为 string，value 为 Object
RedisTemplate<String,Object> template = new RedisTemplate<>();
template.setConnectionFactory(factory);
// 设置 json 序列化配置
Jackson2JsonRedisSerializer jackson2JsonRedisSerializer=new
Jackson2JsonRedisSerializer(Object.class);
ObjectMapper objectMapper=new ObjectMapper();
objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
objectMapper.activateDefaultTyping(LaissezFaireSubTypeValidator.instance);
//string 的序列化
StringRedisSerializer stringRedisSerializer=new StringRedisSerializer();
//key 采纳 string 的序列化形式
template.setKeySerializer(stringRedisSerializer);
//value 采纳 jackson 的序列化形式
template.setValueSerializer(jackson2JsonRedisSerializer);
//hashkey 采纳 string 的序列化形式
template.setHashKeySerializer(stringRedisSerializer);
//hashvalue 采纳 jackson 的序列化形式
template.setHashValueSerializer(jackson2JsonRedisSerializer);
template.afterPropertiesSet();
return template;
}
}最初是 controller
@RestController
@RequestMapping("/token")
public class TokenController {
@Autowired
private TokenService tokenService;
@GetMapping
public Response token(){return tokenService.createToken();
}
@PostMapping("checktoken")
public Response checktoken(HttpServletRequest request){return tokenService.checkToken(request);
}
}其余代码在文末 github 链接上自取
（四）后果验证
首先通过 token 接口创立一个 token 进去，此时 redis 中也存在了改 token
在 jmeter 中同时运行 50 个申请，咱们能够察看到，只有第一个申请校验胜利，后续的申请均提醒请勿反复操作。
jmeter 压测文件（Token Plan.jmx）和代码自取：github 自取
正文完
