1. 系统要求

• 基于spring-boot开发(spring-boot1.x, spring-boot2.x均可)

• 需要使用redis
  

2. 工作流程

  kk-anti-reptile使用基于Servlet规范的的Filter对请求进行过滤，在其内部通过spring-boot的扩展点机制，实例化一个Filter，并注入到Spring容器FilterRegistrationBean中，通过Spring注入到Servlet容器中，从而实现对请求的过滤。

  在kk-anti-reptile的过滤Filter内部，又通过责任链模式，将各种不同的过滤规则织入，并提供抽象接口，可由调用方进行规则扩展。

  Filter调用则链进行请求过滤，如过滤不通过，则拦截请求，返回状态码509，并输出验证码输入页面，输出验证码正确后，调用过滤规则链对规则进行重置。

目前规则链中有如下两个规则

ip-rule

  ip-rule通过时间窗口统计当前时间窗口内请求数，小于规定的最大请求数则可通过，否则不通过。时间窗口、最大请求数、ip白名单等均可配置

ua-rule

  ua-rule通过判断请求携带的User-Agent，得到操作系统、设备信息、浏览器信息等，可配置各种维度对请求进行过滤

3. 接入使用

  后端接入非常简单，只需要引用kk-anti-reptile的maven依赖，并配置启用kk-anti-reptile即可。

加入maven依赖

  cn.keking.project
  kk-anti-reptile
  1.0.0-SNAPSHOT

4.配置启用 kk-anti-reptile

anti.reptile.manager.enabled=true

  前端需要在统一发送请求的ajax处加入拦截，拦截到请求返回状态码509后弹出一个新页面，并把响应内容转出到页面中，然后向页面中传入后端接口baseUrl参数即可，以使用axios请求为例：

import axios from 'axios';
import {baseUrl} from './config';

axios.interceptors.response.use(
 data => {
  return data;
 },
 error => {
  if (error.response.status === 509) {
   let html = error.response.data;
   let verifyWindow = window.open("","_blank","height=400,width=560");
   verifyWindow.document.write(html);
   verifyWindow.document.getElementById("baseUrl").value = baseUrl;
  }
 }
);

export default axios;

5. 注意

apollo-client需启用bootstrap

  使用apollo配置中心的用户，由于组件内部用到@ConditionalOnProperty，要在application.properties/bootstrap.properties中加入如下样例配置，(apollo-client需要0.10.0及以上版本）

apollo.bootstrap.enabled = true

需要有Redisson连接

  如果项目中有用到Redisson，kk-anti-reptile会自动获取RedissonClient实例对象; 如果没用到，需要在配置文件加入如下Redisson连接相关配置

spring.redisson.address=redis://192.168.1.204:6379
spring.redisson.password=xxx

6.命中规则后

  命中爬虫和防盗刷规则后，会阻断请求，并生成接除阻断的验证码，验证码有多种组合方式，如果客户端可以正确输入验证码，则可以继续访问