开源项目kk-anti-reptile常见问题解决方案

开源项目kk-anti-reptile常见问题解决方案

kk-anti-reptile kk-anti-reptile是凯京科技研发的，适用于基于spring-boot开发的分布式系统的反爬虫、防接口盗刷组件。 项目地址: https://gitcode.com/gh_mirrors/kk/kk-anti-reptile

kk-anti-reptile 是一个适用于基于 Spring Boot 开发的分布式系统的开源反爬虫接口防刷组件。该项目主要使用 Java 语言开发。

1. 项目基础介绍

kk-anti-reptile 组件旨在帮助开发者防御爬虫和接口盗刷。它通过 Spring MVC 拦截器对请求进行过滤，并通过责任链模式将不同的过滤规则织入，从而实现对请求的有效控制。主要功能包括：

• IP 规则（ip-rule）：统计时间窗口内的请求次数，超过设定的最大请求数则拦截。
• 用户代理规则（ua-rule）：根据请求的 User-Agent 信息进行过滤。

项目使用 Apache-2.0 开源协议。

2. 新手常见问题及解决步骤

问题一：项目依赖和配置

问题描述： 新手在使用项目时，不知道如何添加依赖和配置。

解决步骤：

1. 在项目的 pom.xml 文件中添加以下依赖：

   <dependency>
       <groupId>cn.keking.project</groupId>
       <artifactId>kk-anti-reptile</artifactId>
       <version>1.0.0-RELEASE</version>
   </dependency>
   

2. 在 Spring Boot 的配置文件 application.properties 或 application.yml 中加入以下配置：

   anti-reptile.manager.enabled=true
   

问题二：配置反爬接口

问题描述： 新手不知道如何配置需要反爬的接口。

解决步骤：

1. 使用配置文件方式，在 Spring Boot 配置文件中加入以下配置项：

   anti-reptile.manager.include-urls=/client/list,/user/list,^/admin/.*
   

2. 使用注解方式，在需要反爬的接口的 Controller 上加上 @AntiReptile 注解：

   @RestController
   @RequestMapping("/demo")
   public class DemoController {
       @AntiReptile
       @GetMapping("")
       public String demo() {
           return "Hello World";
       }
   }
   

问题三：前端验证码处理

问题描述： 新手不知道如何在前端处理验证码页面。

解决步骤：

1. 在前端统一发送请求的 AJAX 处理中加入拦截，拦截到请求返回状态码 509 后弹出验证码页面。

2. 以使用 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;
           }
           return Promise.reject(error);
       }
   );
   
   export default axios;
   

通过上述步骤，新手可以顺利解决在使用 kk-anti-reptile 项目过程中遇到的基础问题。

kk-anti-reptile kk-anti-reptile是凯京科技研发的，适用于基于spring-boot开发的分布式系统的反爬虫、防接口盗刷组件。 项目地址: https://gitcode.com/gh_mirrors/kk/kk-anti-reptile