反爬蟲組件kk-anti-reptile的工作流程與使用方法

kk-anti-reptile 是適用于基于spring-boot開發(fā)的分布式系統(tǒng)的反爬蟲組件

系統(tǒng)要求

• 基于 spring-boot 開發(fā) (spring-boot1.x, spring-boot2.x 均可)
• 需要使用 redis

工作流程

kk-anti-reptile 使用基于 Servlet 規(guī)范的的 Filter 對請求進(jìn)行過濾，在其內(nèi)部通過 spring-boot 的擴(kuò)展點(diǎn)機(jī)制，實(shí)例化一個 Filter，并注入到 Spring 容器 FilterRegistrationBean 中，通過 Spring 注入到 Servlet 容器中，從而實(shí)現(xiàn)對請求的過濾

在 kk-anti-reptile 的過濾 Filter 內(nèi)部，又通過責(zé)任鏈模式，將各種不同的過濾規(guī)則織入，并提供抽象接口，可由調(diào)用方進(jìn)行規(guī)則擴(kuò)展

Filter 調(diào)用則鏈進(jìn)行請求過濾，如過濾不通過，則攔截請求，返回狀態(tài)碼 509，并輸出驗證碼輸入頁面，輸出驗證碼正確后，調(diào)用過濾規(guī)則鏈對規(guī)則進(jìn)行重置

目前規(guī)則鏈中有如下兩個規(guī)則

ip-rule

ip-rule 通過時間窗口統(tǒng)計當(dāng)前時間窗口內(nèi)請求數(shù)，小于規(guī)定的最大請求數(shù)則可通過，否則不通過。時間窗口、最大請求數(shù)、ip 白名單等均可配置

ua-rule

ua-rule 通過判斷請求攜帶的 User-Agent，得到操作系統(tǒng)、設(shè)備信息、瀏覽器信息等，可配置各種維度對請求進(jìn)行過濾

命中規(guī)則后

命中爬蟲和防盜刷規(guī)則后，會阻斷請求，并生成接除阻斷的驗證碼，驗證碼有多種組合方式，如果客戶端可以正確輸入驗證碼，則可以繼續(xù)訪問

驗證碼有中文、英文字母 + 數(shù)字、簡單算術(shù)三種形式，每種形式又有靜態(tài)圖片和 GIF 動圖兩種圖片格式，即目前共有如下六種，所有類型的驗證碼會隨機(jī)出現(xiàn)，目前技術(shù)手段識別難度極高，可有效阻止防止爬蟲大規(guī)模爬取數(shù)據(jù)

接入使用

后端接入非常簡單，只需要引用 kk-anti-reptile 的 maven 依賴，并配置啟用 kk-anti-reptile 即可

加入 maven 依賴

<dependency>
<groupId>cn.keking.projectgroupId>
<artifactId>kk-anti-reptileartifactId>
<version>1.0.0-SNAPSHOTversion>
dependency>

配置啟用 kk-anti-reptile

anti.reptile.manager.enabled=true

前端需要在統(tǒng)一發(fā)送請求的 ajax 處加入攔截，攔截到請求返回狀態(tài)碼 509 后彈出一個新頁面，并把響應(yīng)內(nèi)容轉(zhuǎn)出到頁面中，然后向頁面中傳入后端接口 baseUrl 參數(shù)即可，以使用 axios 請求為例：

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

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

exportdefaultaxios;

注意

1.apollo-client 需啟用 bootstrap

使用 apollo 配置中心的用戶，由于組件內(nèi)部用到 @ConditionalOnProperty，要在 application.properties/bootstrap.properties 中加入如下樣例配置，(apollo-client 需要 0.10.0 及以上版本）詳見 apollo bootstrap 說明

https://github.com/apolloconfig/apollo/wiki/

apollo.bootstrap.enabled=true

2.需要有 Redisson 連接

如果項目中有用到 Redisson，kk-anti-reptile 會自動獲取 RedissonClient 實(shí)例對象；如果沒用到，需要在配置文件加入如下 Redisson 連接相關(guān)配置

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

配置一覽表

在 spring-boot 中，所有配置在配置文件都會有自動提示和說明，如下圖

所有配置都以 anti.reptile.manager 為前綴，如下為所有配置項及說明