redis重复查看不存在的key redisatomiclong重复

转载

香奈儿 2023-09-30 00:50:31

文章标签 redis重复查看不存在的key redis spring boot java Redis 文章分类 Redis 数据库

文章目录

前言
一、搭建Redis服务
二、搭建Redis工具类
三、自定义注解AutoIdempotent
四、Token创建和校验
五、拦截器配置
六、测试用例
总结

前言

在本次管理的项目中遇到了恶意攻击，某个接口被多次请求导致数据库压力过大，故对这个接口进行改造，增加幂等性校验。
幂等的概念：任意多次执行所产生的影响均与一次执行的影响相同。按照这个说法，那么对数据库的影响只能是一次性的，不能重复处理。
如何保证其幂等性(本次采用第三种方式)：

数据库唯一索引
先查询后判断，如果存在数据则返回false直接拒绝请求，如果不存在则接受该请求
token机制，每次接口请求时先从后台获取token并存入Redis，然后在下次请求时带上token在后台进行验证，如果token存在则通过并删除Redis中的token，下次请求再次进行token的判断。

原理图：

redis重复查看不存在的key redisatomiclong重复_java

一、搭建Redis服务

下载Redis并依次启动服务端和客户端
新建spring boot项目并引入依赖
在application.yml中添加Redis项目配置

server:
  port: 9001
  servlet:
    context-path: /myRedis
spring:
  redis:
    host: localhost
    port: 6379

编写controller测试Redis连接

@Resource
    private RedisTemplate redisTemplate;

    @Resource
    private StringRedisTemplate stringRedisTemplate;

    // 添加数据到redis
    @PostMapping("/redis/addstring")
    public String addToRedis(String name, String value){

        // 操作redis中的string类型的数据， 先获取ValueOperation对象
        ValueOperations valueOperations = redisTemplate.opsForValue();
        // 添加数据到redis
        valueOperations.set(name, value);

        return "向redis添加string类型的数据";
    }

    @GetMapping("/redis/getKey")
    public String getData(String key) {
        ValueOperations valueOperations = redisTemplate.opsForValue();
        Object o = valueOperations.get(key);
        return "key:" + key + ",value:" + o;
    }
    @PostMapping("/redis/{k}/{v}")
    public String addStringKV(@PathVariable String k, @PathVariable String v) {
        stringRedisTemplate.opsForValue().set(k, v);
        return k + ":" + v;
    }

使用postman进行接口测试
在Redis客户端查看

二、搭建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> valueOperations = redisTemplate.opsForValue();
            valueOperations.set(key, value);
            result = true;
        }
        catch (Exception e) {
            e.fillInStackTrace();
        }
        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.fillInStackTrace();
        }
        return result;
    }

    /**
     * 判断缓存中是否存在key
     * @param key
     * @return
     */
    public boolean exists(final String key) {
        return redisTemplate.hasKey(key);
    }

    /**
     * 读取缓存
     * @param key
     * @return
     */
    public Object get(final String key) {
        ValueOperations valueOperations = redisTemplate.opsForValue();
        return valueOperations.get(key);
    }

    /**
     * 删除对应的value
     * @param key
     */
    public boolean remove(final String key) {
        if (exists(key)) {
            Boolean delete = redisTemplate.delete(key);
            return delete;
        }
        return false;
    }
}

三、自定义注解AutoIdempotent

自定义一个注解是为了将其添加到需要实现幂等的方法上。后台如果扫描到该注解，就会处理这个方法自动实现幂等。使用元注解ElementType.METHOD表示它只能放在方法上，etentionPolicy.RUNTIME表示它在运行时。

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

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

}

四、Token创建和校验

创建token服务，主要两个方法，一个是用来创建token，一个是用来验证token。

public interface TokenService {

    /**
     * 创建token
     * @return
     */
    public String createToken();

    /**
     * 检验token
     * @param request
     * @return
     */
    public boolean checkToken(HttpServletRequest request) throws Exception;
	/**
     * 业务代码
     * @return
     */
    public String testIdempotence();
}

token实现类
token引用了redis服务，创建token采用随机算法工具类生成随机uuid字符串,然后放入到redis中(为了防止数据的冗余保留,这里设置过期时间为10000秒,具体可视业务而定)，如果放入成功，最后返回这个token值。checkToken方法就是从header中获取token到值(如果header中拿不到，就从paramter中获取)，如果获取不到token值抛出异常，这个异常信息可以被拦截器捕捉到，然后返回给前端。

@Service
public class TokenServiceImpl implements TokenService {

    private static final String TOKEN_PREFIX = "redis_";

    private static final String TOKEN = "token";

    @Autowired
    private RedisService redisService;

    @Override
    public String createToken() {
        UUID uuid = UUID.randomUUID();
        StringBuffer token = new StringBuffer();
        try {
            token.append(TOKEN_PREFIX).append(uuid.toString());
            redisService.setEx(token.toString(), token.toString(),10000L);
            boolean notEmpty = !StringUtils.isEmpty(token.toString());
            if (notEmpty) {
                return token.toString();
            }
        }catch (Exception ex){
            ex.printStackTrace();
        }
        return null;
    }

    @Override
    public boolean checkToken(HttpServletRequest request) throws Exception {
        String token = request.getHeader(TOKEN);
        if (StringUtils.isEmpty(token)) {
            token = request.getParameter(TOKEN);
            if (StringUtils.isEmpty(token)) {
                throw new Exception("No token found.");
            }
        }
        if (!redisService.exists(token)) {
            throw new Exception("Repeatability check.");
        }
        boolean remove = redisService.remove(token);
        if (!remove) {
            throw new Exception("token remove failed.");
        }
        return true;
    }

    @Override
    public String testIdempotence() {
        return "gdfgdfgfdg";
    }

五、拦截器配置

web配置类，实现WebMvcConfigurerAdapter，主要作用就是添加autoIdempotentInterceptor到配置类中，这样我们到拦截器才能生效，注意使用@Configuration注解，这样在容器启动是时候就可以添加进入context中

@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){
                Map<String, String> result = new HashMap<>();
                result.put("resultCode", "0");
                result.put("resultDesc", "fail");
                result.put("resultData", ex.getMessage());
                writeReturnJson(response, JSONObject.toJSONString(result));
                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()方法去获取具体的token，然后我们调用testIdempotence方法，这个方法上面注解了@AutoIdempotent，拦截器会拦截所有的请求，当判断到处理的方法上面有该注解的时候，就会调用TokenService中的checkToken()方法，如果捕获到异常会将异常抛出调用者。

@RestController
public class TokenTestController {

    @Resource
    private TokenService tokenService;

    @PostMapping("/get/token")
    public String getToken() {
        String token = tokenService.createToken();
        if (!StringUtils.isEmpty(token)) {
            Map<String, String> result = new HashMap<>();
            result.put("resultCode", "0");
            result.put("resultDesc", "success");
            result.put("resultData", token);
            return JSONObject.toJSONString(result);
        }
        return "";
    }

    @AutoIdempotent
    @PostMapping("/test/Idempotence")
    public String testIdempotence() {
        String businessResult  = tokenService.testIdempotence();
        if (!StringUtils.isEmpty(businessResult)) {
            Map<String, String> result = new HashMap<>();
            result.put("resultCode", "0");
            result.put("resultDesc", "success");
            result.put("resultData", businessResult);
            return JSONObject.toJSONString(result);
        }
        return "";
    }
}