CodeIgniter 3 User Agent 類庫實戰(zhàn)指南識別瀏覽器、移動設(shè)備與爬蟲訪問【免費下載鏈接】CodeIgniterOpen Source PHP Framework (originally from EllisLab)項目地址: https://gitcode.com/gh_mirrors/co/CodeIgniterUser Agent 類庫是 CodeIgniter 框架內(nèi)置的客戶端識別組件通過解析 HTTP 請求頭中的User-Agent字符串幫助開發(fā)者判斷訪問者的瀏覽器類型與版本、操作系統(tǒng)平臺、是否為移動設(shè)備或搜索引擎爬蟲并進(jìn)一步獲取來源頁Referrer、瀏覽器接受的語言與字符集信息。閱讀完本文你將掌握 User Agent 類庫的初始化方式、四個用戶代理定義數(shù)組的定制方法、全部類方法的用法與返回約定并通過源碼級剖析理解其底層匹配算法從而在移動端分流、SEO 統(tǒng)計、訪問日志分析等場景中落地實踐。User Agent 類庫能做什么在 Web 開發(fā)中User-Agent字符串是客戶端瀏覽器、手機(jī)、爬蟲主動上報的自我描述內(nèi)容形如Mozilla/5.0 (Macintosh; U; Intel Mac OS X; en-US; rv:1.8.0.4) Gecko/20060613 Camino/1.0.2CodeIgniter 的 User Agent 類CI_User_agent實現(xiàn)于 system/libraries/User_agent.php負(fù)責(zé)解析這類字符串并輸出以下信息瀏覽器名稱與版本號如 Safari 533.20.27、Firefox 13.0平臺操作系統(tǒng)信息Windows、Linux、Mac OS X、Android、iOS 等移動設(shè)備手機(jī)品牌或設(shè)備類型iPhone、Nokia、Samsung、PlayStation 等機(jī)器人/爬蟲搜索引擎蜘蛛等Googlebot、Baiduspider、Bing 等來源與偏好來源頁面Referrer、接受的Accept-Language語言列表、接受的Accept-Charset字符集列表。它本質(zhì)上是一套基于正則/子串匹配的分類引擎將當(dāng)前請求的 User-Agent 字符串與預(yù)置定義數(shù)組逐項比對命中后記錄類型并輸出規(guī)范化名稱。所有定義均可在配置文件中自由擴(kuò)充無需修改框架核心代碼。初始化 User Agent 類庫與 CodeIgniter 大多數(shù)類庫一致User Agent 類在控制器中通過$this-load-library()加載$this-load-library(user_agent);加載完成后實例會以$this-agent的形式掛載到當(dāng)前控制器可通過 Loader 的庫加載機(jī)制全局訪問。加載時構(gòu)造函數(shù)即開始工作見 system/libraries/User_agent.php調(diào)用_load_agent_file()讀取配置文件中的定義數(shù)組若$_SERVER[HTTP_USER_AGENT]存在將其存入$this-agent并調(diào)用_compile_data()完成平臺、機(jī)器人、瀏覽器、移動設(shè)備的分類判定寫入一條User Agent Class Initialized的 info 級日志。如果請求沒有攜帶HTTP_USER_AGENT頭類仍會正常初始化只是各類型標(biāo)志位保持默認(rèn)的FALSE相關(guān)取值方法返回空字符串。用戶代理定義文件application/config/user_agents.php所有識別規(guī)則集中在配置文件 application/config/user_agents.php 中類庫通過 system/libraries/User_agent.php 的_load_agent_file()加載它。加載邏輯支持兩層配置默認(rèn)讀取APPPATH.config/user_agents.php若存在APPPATH.config/.ENVIRONMENT./user_agents.php環(huán)境專屬配置則追加覆蓋實現(xiàn)按development/testing/production環(huán)境差異化定制。配置文件中包含四個關(guān)聯(lián)數(shù)組數(shù)組的鍵用于在 User-Agent 字符串中匹配的特征片段數(shù)組的值用于輸出為可讀名稱數(shù)組變量用途匹配方式見源碼$platforms操作系統(tǒng)/平臺識別preg_quote($key)轉(zhuǎn)義后正則匹配$browsers瀏覽器識別并提取版本鍵作為正則模式.*?([0-9\.])捕獲版本號$mobiles移動設(shè)備識別大小寫不敏感的stripos子串匹配$robots爬蟲/機(jī)器人識別preg_quote($key)轉(zhuǎn)義后正則匹配$platforms平臺定義$platforms array( windows nt 10.0 Windows 10, windows nt 6.3 Windows 8.1, windows nt 6.1 Windows 7, android Android, iphone iOS, ipad iOS, os x Mac OS X, linux Linux, // ... );平臺匹配由_set_platform()system/libraries/User_agent.php完成將每個鍵preg_quote轉(zhuǎn)義后與 User-Agent 字符串做大小寫不敏感正則比對首個命中即寫入$this-platform。一個值得注意的細(xì)節(jié)是數(shù)組中同時存在windows nt 6.3 Windows 8.1等帶具體版本號的鍵以及windows Unknown Windows OS這類兜底鍵因此數(shù)組順序即匹配優(yōu)先級——具體版本應(yīng)排在籠統(tǒng)鍵之前。全部未命中時返回Unknown Platform。$browsers瀏覽器定義與版本提取// 順序不要更改許多瀏覽器會在 UA 中上報多個類型須先識別子類型 $browsers array( OPR Opera, Edge Edge, Chrome Chrome, Opera.*?Version Opera, // Opera 10 上報 Opera/9.80真實版本在 Version/ 后 Opera Opera, MSIE Internet Explorer, Firefox Firefox, Safari Safari, Mozilla Mozilla, // ... );配置文件頂部特別注釋強(qiáng)調(diào)數(shù)組順序不應(yīng)更改——許多瀏覽器會在同一 UA 中上報多個類型例如 Chrome 的 UA 里同時包含Mozilla/5.0與Safari/537.36因此必須把子類型Chrome、Edge、Opera排在通用兜底項Mozilla之前。_set_browser()system/libraries/User_agent.php使用模式|.$key..*?([0-9\.])|i匹配命中后置$this-is_browser TRUE用捕獲組([0-9\.])提取版本號存入$this-version將定義值存入$this-browser。值得注意的特殊條目Opera.*?VersionOpera 10 的 UA 恒為Opera/9.80 (...)并追加Version/真實版本因此用正則鍵提取其后真實版本號這正是配置鍵可含正則語法的典型例證。$mobiles移動設(shè)備定義$mobiles array( motorola Motorola, nokia Nokia, nexus Nexus, iphone Apple iPhone, ipad iPad, blackberry BlackBerry, samsung Samsung, huawei Huawei, xiaomi Xiaomi, oppo Oppo, vivo Vivo, android Android, windows ce Windows CE, operamini Opera Mini, opera mini Opera Mini, mobile Generic Mobile, // 兜底 wireless Generic Mobile, j2me Generic Mobile, // ... );列表覆蓋手機(jī)廠商、操作系統(tǒng)與移動瀏覽器三類并以mobile、wireless、j2me、midp、cldc等通用詞作為兜底。_set_mobile()system/libraries/User_agent.php使用stripos做大小寫不敏感子串匹配首個命中即返回TRUE。$robots爬蟲定義// 爬蟲有數(shù)百種這里只收錄最常見的 $robots array( googlebot Googlebot, msnbot MSNBot, baiduspider Baiduspider, bingbot Bing, slurp Inktomi Slurp, yahoo Yahoo, yandex YandexBot, ia_archiver Alexa Crawler, MJ12bot Majestic-12, UptimeRobot UptimeRobot, // ... );如官方文檔所述爬蟲數(shù)量龐大數(shù)百種逐一收錄并不現(xiàn)實因此該庫僅內(nèi)置最常見的蜘蛛。若你的站點常被某些未收錄的爬蟲訪問直接在application/config/user_agents.php的$robots數(shù)組中追加鍵值對即可無需修改框架源碼。典型實戰(zhàn)示例類型分流與平臺輸出官方文檔給出的標(biāo)準(zhǔn)示例完整覆蓋了三種類型的判斷分支與平臺輸出可直接放入控制器方法中使用$this-load-library(user_agent); if ($this-agent-is_browser()) { $agent $this-agent-browser(). .$this-agent-version(); } elseif ($this-agent-is_robot()) { $agent $this-agent-robot(); } elseif ($this-agent-is_mobile()) { $agent $this-agent-mobile(); } else { $agent Unidentified User Agent; } echo $agent; echo $this-agent-platform(); // 平臺信息Windows、Linux、Mac 等該示例也反映了類庫的內(nèi)部判定順序構(gòu)造函數(shù)中的_compile_data()system/libraries/User_agent.php先固定執(zhí)行_set_platform()隨后按_set_robot()→_set_browser()→_set_mobile()的順序依次嘗試一旦某個方法返回TRUE立即break即同一 UA 在機(jī)器人→瀏覽器→移動設(shè)備三個類別中只歸屬首個命中的類別。這是is_browser()、is_robot()、is_mobile()三類互斥判斷的底層依據(jù)。類方法參考Class Reference類型判斷方法is_browser([$key NULL])返回布爾值判斷當(dāng)前 UA 是否為已知瀏覽器傳入$key時可進(jìn)一步判斷是否為指定瀏覽器if ($this-agent-is_browser(Safari)) { echo You are using Safari.; } elseif ($this-agent-is_browser()) { echo You are using a browser.; }注意Safari這類字符串就是 application/config/user_agents.php 中$browsers數(shù)組的鍵。源碼實現(xiàn)system/libraries/User_agent.php中$key NULL時直接返回is_browser標(biāo)志否則校驗$this-browser $this-browsers[$key]即當(dāng)前瀏覽器名與定義值完全一致才返回TRUE。is_mobile([$key NULL])返回布爾值判斷是否為已知移動設(shè)備可傳入設(shè)備鍵精確匹配。典型場景是按設(shè)備類型分流視圖if ($this-agent-is_mobile(iphone)) { $this-load-view(iphone/home); } elseif ($this-agent-is_mobile()) { $this-load-view(mobile/home); } else { $this-load-view(web/home); }is_robot([$key NULL])返回布爾值判斷是否為已知爬蟲可傳入機(jī)器人鍵精確匹配。由于內(nèi)置列表僅含最常見爬蟲若發(fā)現(xiàn)常訪問站點的機(jī)器人缺失可在配置文件的$robots數(shù)組中補(bǔ)充。is_referral()返回布爾值判斷訪問者是否從其他站點跳轉(zhuǎn)而來。源碼實現(xiàn)system/libraries/User_agent.php使用parse_url()解析HTTP_REFERER與config_item(base_url)的主機(jī)名并比較HTTP_REFERER存在且其主機(jī)與本站base_url主機(jī)不同才判定為外部來源。判定結(jié)果緩存于$this-referer同一請求內(nèi)重復(fù)調(diào)用不再重新解析。信息獲取方法方法返回說明browser()string瀏覽器名稱未識別返回空字符串version()string瀏覽器版本號未識別返回空字符串mobile()string移動設(shè)備品牌/名稱未識別返回空字符串robot()string爬蟲名稱未識別返回空字符串platform()string操作系統(tǒng)名稱Linux、Windows、OS X 等未識別返回Unknown Platformreferrer()string來源頁完整 URL無HTTP_REFERER時返回空字符串a(chǎn)gent_string()string完整的原始 User-Agent 字符串其中referrer()的典型用法是配合is_referral()if ($this-agent-is_referral()) { echo $this-agent-referrer(); }而agent_string()直接返回構(gòu)造/解析時保存的原始 UA如Mozilla/5.0 (Macintosh; U; Intel Mac OS X; en-US; rv:1.8.0.4) Gecko/20060613 Camino/1.0.2可用于日志記錄與原始審計。語言與字符集方法accept_lang([$lang en])判斷訪問者是否接受指定語言。默認(rèn)參數(shù)為enif ($this-agent-accept_lang(en)) { echo You accept English!; }實現(xiàn)system/libraries/User_agent.php為in_array(strtolower($lang), $this-languages(), TRUE)的嚴(yán)格匹配。languages()首次調(diào)用時觸發(fā)_set_languages()system/libraries/User_agent.php解析HTTP_ACCEPT_LANGUAGE用正則/(;\s?q[0-9\.])|\s/i剔除q權(quán)重值與空白后按逗號拆分全部轉(zhuǎn)為小寫請求頭缺失時返回array(Undefined)。accept_charset([$charset utf-8])判斷訪問者是否接受指定字符集if ($this-agent-accept_charset(utf-8)) { echo You browser supports UTF-8!; }charsets()首次調(diào)用時由_set_charsets()system/libraries/User_agent.php解析HTTP_ACCEPT_CHARSET同樣剔除q權(quán)重并按逗號拆分缺省返回array(Undefined)?？煽啃蕴崾竟俜轿臋n明確指出accept_lang()與accept_charset()并非總是可靠——部分瀏覽器不發(fā)送語言/字符集信息即便發(fā)送也未必準(zhǔn)確。它們更適合做漸進(jìn)增強(qiáng)判斷不應(yīng)作為業(yè)務(wù)硬性依賴。languages() / charsets()分別返回訪問者接受的語言列表與字符集列表數(shù)組形式未提供相應(yīng)請求頭時返回array(Undefined)。parse($string)解析自定義 User-Agent$this-agent-parse(Mozilla/5.0 (Android; Mobile; rv:13.0) Gecko/13.0 Firefox/13.0);parse()system/libraries/User_agent.php允許解析與當(dāng)前訪問者不同的自定義 UA 字符串典型場景是測試、日志重放或離線分析。它會先將is_browser、is_robot、is_mobile、browser、version、mobile、robot全部重置再寫入新字符串并重新執(zhí)行_compile_data()傳入空字符串時僅重置不解析。測試用例驗證行為與預(yù)期倉庫測試 tests/codeigniter/libraries/Useragent_test.php 覆蓋了上述核心行為可用于對照理解類庫語義test_is_functions()以Mozilla/5.0 (Macintosh; ...) AppleWebKit/533.20.25 ... Version/5.0.4 Safari/533.20.27為基線斷言is_browser()與is_browser(Safari)為TRUE、is_browser(Firefox)為FALSE、is_robot()與is_mobile()為FALSEtest_browser_info()同一 UA 下斷言platform()為Mac OS X、browser()為Safari、version()為533.20.27驗證.*?([0-9\.])正則對版本號的提取test_referrer()設(shè)置外部來源HTTP_REFERER后斷言is_referral()為TRUE且referrer()返回完整 URL清除請求頭后兩者分別返回FALSE與空字符串test_accept_lang()/test_charsets()驗證語言與字符集解析包括q權(quán)重剔除、Undefined兜底test_parse()傳入 Firefox/Android 自定義 UA斷言平臺為Android、瀏覽器為Firefox、版本為13.0、移動設(shè)備為Android且is_mobile(android)為TRUE。測試基類CI_TestCase通過 VFS 克隆application/config/user_agents.php后實例化CI_User_agent說明配置定義是類庫行為的直接輸入也印證了擴(kuò)展配置即可擴(kuò)展識別能力的設(shè)計理念。擴(kuò)展與最佳實踐建議綜合文檔與源碼給出以下幾點落地建議新增識別項只需改配置在 application/config/user_agents.php 的對應(yīng)數(shù)組中追加鍵UA 特征片段/值可讀名稱即可。新增平臺/爬蟲時鍵會被preg_quote轉(zhuǎn)義可按字面片段書寫新增瀏覽器時鍵會被當(dāng)作正則模式可像Opera.*?Version一樣編寫正則但要留意版本捕獲組([0-9\.])的配合。注意數(shù)組順序$platforms中籠統(tǒng)鍵如windows應(yīng)排在具體鍵如windows nt 10.0之后$browsers中通用兜底鍵如Mozilla必須排在子類型之后否則識別結(jié)果會被兜底項搶占。環(huán)境差異化配置可通過application/config/{ENVIRONMENT}/user_agents.php為指定環(huán)境覆蓋定義例如生產(chǎn)環(huán)境追加內(nèi)部監(jiān)控爬蟲的識別。結(jié)合日志與分析用agent_string()保留原始 UA用is_robot()過濾爬蟲流量使訪問統(tǒng)計更貼近真實用戶。保持審慎User-Agent 可由客戶端任意偽造類庫判定結(jié)果僅代表UA 聲稱的身份涉及安全、計費等敏感邏輯時應(yīng)另行核驗如配合 Input 類 的 IP 與請求校驗?？偨Y(jié)CodeIgniter 的 User Agent 類庫以配置文件定義 正則/子串匹配的輕量架構(gòu)為瀏覽器、移動設(shè)備、爬蟲與平臺識別提供了開箱即用的能力加載一行$this-load-library(user_agent)即可通過$this-agent調(diào)用十余個語義清晰的方法。其全部識別規(guī)則集中在 application/config/user_agents.php實現(xiàn)位于 system/libraries/User_agent.php并有 Useragent_test.php 提供行為回歸保障——理解這三者的協(xié)作關(guān)系你就能在移動端分流、SEO 分析與訪問統(tǒng)計中快速落地一套可擴(kuò)展的客戶端識別方案?！久赓M下載鏈接】CodeIgniterOpen Source PHP Framework (originally from EllisLab)項目地址: https://gitcode.com/gh_mirrors/co/CodeIgniter創(chuàng)作聲明：本文部分內(nèi)容由AI輔助生成（AIGC），僅供參考