close
關注我,回復關鍵字「spring」,
免費領取Spring學習資料。

來源:DeepNoMind

一份好的設計文檔需要提供清晰的問題描述、整體的概要設計、涵蓋各個細節的詳細設計等。

這篇有趣的英文小短文通過一個簡單的小例子介紹了Google工程師是怎麼寫設計文檔的。本文為中文翻譯。原文鏈接如下:https://reurl.cc/ZrVD2A

寫文檔是我在谷歌學到的最重要的技能之一。在谷歌,文檔被用來討論問題、作為真實的信息源、組織知識。在我工作過的其他公司中,沒有一家對如何使用文檔進行協作有這樣深刻的理解。

這篇文章就是關於我在谷歌如何寫設計文檔的一個例子,這是一個真實的項目,用於在新冠疫情期間控制健身房現場人數。即使在新冠疫情結束後不需要預約健身房了,也可以訪問GitHub上的源代碼[1]。為了讓這篇文章更有趣,現在每個人都可以在谷歌文檔[2]上進行評論,而且谷歌文檔的格式也比Medium支持的要好。

問題描述

在新冠疫情期間,要求健身房控制現場會員總數,要求會員在去健身房之前先在網站上預訂。預約需要提前兩天,從午夜開始。例如,2021年04月01日的預訂將在當地時間2021年03月30日00:00 AM開放。

這個健身房裡的游泳池提供的位置非常有限。我嘗試了好幾次,都沒能預定到早上6點的時間,後來工作人員告訴我,由於需求量很大,必須在午夜預訂。但是熬夜到半夜會打亂我的生物鐘,所以我沒法接受。

而且我覺得僱人做這件事也很不好,因為在內心深處,我認為早睡是健康高效生活方式的核心習慣,用金錢剝奪別人的好習慣是不道德的。在被告知沒有別的辦法之後,我決定寫一個程序來為我做預訂。

我個人認為用機器人來做工作是對別人的不公平,所以我對這個決定一點兒也沒感到自豪。相反,我認為健身房應該提高一些場地的價格。但這顯然超出了設計文檔的範圍,而且是非常主觀的想法。

我們創建了一個高質量的技術交流群,與優秀的人在一起,自己也會優秀起來,趕緊點擊加群,享受一起成長的快樂。另外,如果你最近想跳槽的話,年前我花了2周時間收集了一波大廠面經,節後準備跳槽的可以點擊這裡領取!

需求

自動提前兩天在半夜預訂健身房
程序啟動後不需要人工交互,應該具有容錯性,能夠進行合理的重試
可以在Mac電腦上運行
用戶可以指定用戶名、密碼、預約的項目、日期和時間等

不在考慮範圍內:

只提前1或2天預訂,或當天預訂
容忍操作系統或網絡問題
在預約服務器停止運行後還要能夠工作
在網站結構(HTML)改變後,還要能夠工作

概要設計

瀏覽器自動化 vs 模擬請求

瀏覽器自動化是指通過程序來控制真實的瀏覽器,並在GUI上自動化操作。模擬請求是指讓程序通過HTTP與服務器交互,這個程序就像是一個Web瀏覽器(而不是控制一個瀏覽器)。

考慮到下面幾點,我認為瀏覽器自動化比模擬請求更好:

[優點] 瀏覽器自動化啟動了一個真實的瀏覽器實例,所以我們知道程序運行時發生了什麼,它使調試和開發更加容易。
[優點] 網站需要JavaScript加載控件,而這較難通過編程實現,可能需要控制一些渲染引擎。
[缺點] 瀏覽器自動化依賴於HTML結構,而模擬請求依賴於HTTP API,API相對穩定,不太可能改變。

顯然利大於弊。

系統概述

Selenium[3]是一個提供瀏覽器自動化解決方案的軟件庫。我們的程序將用Python編寫,並通過Python API控制Selenium,Selenium則通過它的Gecko驅動程序控制Firefox。

Caffeinate[4]是一個阻止操作系統進入睡眠狀態的程序。如果系統休眠,程序將無法在半夜運行。

詳細設計

用戶輸入

用戶名、密碼、日期等都是從命令行參數中輸入的。

重試

程序將捕獲所有異常(頁面未加載等)並重試100次直到預訂成功,成功的預訂通過確認DOM元素進行識別。

瀏覽器選擇

我們需要使用主流瀏覽器之一。我考慮並測試了Chrome、Firefox和Safari,Safari和Chrome都需要額外的步驟來使用相應的Selenium驅動程序,所以我選擇了Firefox。它也需要一些來自操作系統設置的認證,但只需要在最初幾次確認就可以了。

日誌

程序自動執行瀏覽器操作,就像是由用戶發起的一樣。本質上,它將在循環中執行以下操作:

查找某個元素
對元素進行操作(輸入文本、選擇選項或單擊)
等待預期結果,然後返回1

因此,每個日誌記錄將有兩項內容:

執行了什麼
在等待什麼

這樣的日誌記錄將使調試變得容易。

保持電腦持續運行

如果操作系統在程序啟動到午夜之間進入休眠狀態,則程序在午夜就無法運行了,Caffeinate可以防止這種情況發生。它是一個命令行工具,我們在Python中把它作為子進程啟動:

subprocess.Popen([『caffeinate』,『-d』,『-w』,『%d』%os.getpid()])

定位控制

Selenium提供了一組方法[5]來訪問特定的DOM元素,其中xpath的表達能力最強。因此,我們將使用find_element_by_xpath來定位DOM元素,如按鈕、輸入框等。

只要有可能,我們寧願依賴DOM的內部文本來定位它們。相對於DOM結構和屬性(類名等),內部文本的優勢並不是說它不太可能更改,而是如果它們發生更改,更容易調試。當然,我們必須對DOM結構做一些假設,比如我們需要點擊class='control'分區(div)下的class='logon'的第二個按鈕。

等待頁面加載

在發送每個HTTP請求後,程序需要等待加載頁面(通常是2~5秒,是的,這個站點很慢)。這是由WebDriverWait API[6]完成的。例如,以下代碼將等待120秒,直到<button ng-reflect-router-link= ' /Appointments ' >被加載並成為可被點擊的按鈕。

book_btn=WebDriverWait(driver,120).until(EC.element_to_be_clickable((By.XPATH,「//button[@ng-reflect-router-link=』/Appointments』]」)))

如果按鈕在120秒內加載失敗,將引發異常。

更多的實現細節

選擇正確的日期。假設我們想預定4月14日,我們無法在預訂日曆上選擇文本為『14』的單元格,因為3/14的單元格有類似的屬性。當前月份的單元格必須包含有class cal-in-month。

調整月份。預訂日曆顯示的是當月的當天,而不是我們打算預訂的月份。如果兩天後就是下個月,這就會有問題。因此,我們必須添加另一個步驟實現在這個邊界情況下選擇正確的月份。

操作流程

假設我想預訂4月14日的游泳池,需要在4月11日的任意時間運行以下命令:

pythonbook.py--usernamexxxxxx--passwordxxxxxx--day14--time『5:00PM』--sportsmall_pool

程序將每休眠1秒鐘被喚醒檢查一次時間,這個檢查不會有任何明顯的CPU消耗。Caffeinate將阻止操作系統進入睡眠狀態,直到午夜時分。

在4月12日午夜,它將啟動Firefox瀏覽器,並自動完成預訂。之後,Caffeinate進程和主進程都將退出,操作系統將正常進入休眠狀態。

4月12日的早上,我會看一下日誌,看看預訂是否成功。

一個有趣的事實

競爭確實非常激烈,通常在第1分鐘預約就結束了。每個時段總共只有6個名額,毫無疑問,在早上6點預訂是不可能的。


END


接口開發不用寫Controller、Service、Dao、Mapper、XML、VO,全自動生成!
MySQL去重3種方法,還有誰不會?
Spring Boot 整合 Prometheus
Git 不要只會 pull 和 push,試試這 5 條提高效率的命令!
IDEA 調試時候的操作如何回滾?

關注後端面試那些事,回復【2022面經】

獲取最新大廠Java面經


最後重要提示:高質量的技術交流群,限時免費開放,今年抱團最重要。想進群的,關注SpringForAll社區,回復關鍵詞:加群,拉你進群。




點擊「閱讀原文」領取2022大廠面經
↓↓↓
arrow
arrow
    全站熱搜
    創作者介紹
    創作者 鑽石舞台 的頭像
    鑽石舞台

    鑽石舞台

    鑽石舞台 發表在 痞客邦 留言(0) 人氣()