沒什麼技術含量的Remove Before Flight

来源:https://www.cnblogs.com/Autumoon/archive/2018/03/04/8506702.html
-Advertisement-
Play Games

航空業有很多值得我們借鑒和學習的工作方式,將來有時間我會給大家引薦更多實例。 仔細觀察每架停泊著的飛機,會發現機身很多地方都掛著細長的紅布條,上面寫著“REMOVE BEFORE FLIGHT”,中文翻譯成“飛行前拆除”。這種布條沒什麼技術含量,但是非常重要! 比如,為了避免雜物或者昆蟲進入皮托管, ...


航空業有很多值得我們借鑒和學習的工作方式,將來有時間我會給大家引薦更多實例。

Remove before flight!

仔細觀察每架停泊著的飛機,會發現機身很多地方都掛著細長的紅布條,上面寫著“REMOVE BEFORE FLIGHT”,中文翻譯成“飛行前拆除”。這種布條沒什麼技術含量,但是非常重要!

比如,為了避免雜物或者昆蟲進入皮托管,一般會給皮托管戴上套子,但是起飛前必須取下套子,否則飛行員就無法獲得空速數據,從而導致事故。還有起落架安全插銷,預防飛機在地面時起落架意外收起,但是忘記拔掉的話,起飛後就會因為無法收起起落架而被迫返航,雖然不至於墜毀,但是燃油損耗(包括可能需要進行空中放油)、折舊(比如輪胎、剎車的磨損)等,成本咂舌。

在這些不起眼但又不能跟隨飛機上天的部件上掛一根紅布條,便是為了機務人員做航前檢查時避免疏漏。

觸類旁通,這根小小的布條,對於程式員朋友們也很有實用價值。掛在衝鋒衣上?掛在雙肩包上?Stop,說正事兒!

我們在調試代碼的時候,常常會寫死一些變數的值,比如GPS坐標、資料庫查詢條件、輪詢時間間隔、版本號等等,這些定值方便了調試工作,但是就像皮托管套和起落架銷子一樣,是絕對不能隨著軟體更新發佈出去的——嚴格地講,甚至都禁止合併到主幹代碼。

不幸的是,人是不可靠的。很多時候我們都會因為忘了將這些定值移除結果導致程式無法正常工作。其實都是些低級錯誤。

分享一下我的做法,沒啥技術含量,希望能給你帶來些許啟發。當然,也歡迎更好的建議!

假設有一個定時刷新數據的功能,實際業務要求每2小時檢查一次,時間間隔定義如下:

private static final long INTEVAL_DATA_RELOAD = 2 * 3600 * 1000;

調試的時候,為了縮短等待時間,我們可以設為5秒一次。

private static final long INTEVAL_DATA_RELOAD = 5_000;

於是這裡就存在一個隱患,2小時被縮短為5秒鐘,代碼本身沒有問題,所以別人在審核這段代碼的時候,除非對業務需求很瞭解,否則不大可能註意到5秒只是調試代碼,不能提交到伺服器更不能打包發佈。

我的慣用做法就是,同時保留兩段代碼:

private static final long INTEVAL_DATA_RELOAD = 5_000;  // TODO: Remove before flight!
// private static final long INTEVAL_DATA_RELOAD = 2 * 3600 * 1000;

我會告訴我的同事,code review的時候,任何帶有“Remove before flight!”標記的代碼,除非是註釋掉的,否則都不能提交。並且我也鼓勵他們使用同樣的標記來標註代碼。

上面代碼有個好處,使用快捷鍵,刪一行、取消註釋一行,兩步操作迅速恢複原貌。

所以我在提交代碼前,會全文搜索“Remove before flight!”,然後逐一刪除或註釋掉。當然也可以從TODO框里直接定位,不過如果項目里還有很多其它TODO標記,那還是全文搜索比較保險。

為了方便添加這個標記,我會使用代碼模板功能,以Android Studio為例,在Live Templates里添加模板:
Remove Before Flight Template

這樣就只需在要添加這個標記的位置輸入“rbf”,然後一Tab就出來了。

還有一種情況也會產生大量冗餘代碼。當我們在調試一個調用關係很深,尤其是存在大量回調的bug時,常常不得不靠輸出很多日誌來觀察代碼的實際運行情況。一方面,這些Log的輸出可能是實際開發不需要的;另一方面,因為項目本身也存在很多日誌,比較容易混在在一起。如下是我的習慣:

public static final String TAG_BUG_9321 = "BUG9321";   // TODO: Remove before flight!

private void validate(String content) {
    Log.d(TAG_BUG_9321, String.format("Validate content: %s", content));

    doValidate(content, new ValidateCallback() {
        @Override
        public void onValidated(String result) {
            Log.d(TAG_BUG_9321, String.format("Validated result: %s", result));
        }
    });
}

因為TAG是公開級別,所以在其它類、包裡面,只要是這個bug牽扯到的地方,都可以使用同一個TAG,然後在Logcat里設置filter為“BUG9321”,就可以非常清楚地瞭解代碼的實際執行情況,提高修複問題的效率。搞定了bug之後,刪除標有RBF標識的代碼,所有臨時的日誌輸出調用立馬顯形,逐一刪除,確保代碼能夠成功編譯,就可以著手提交了。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 數據類型為set。可以保證set內數據唯一。場景:生成訂單號,因為要求訂單號是絕對不能重覆的,所以資料庫中要設置為unique索引。但是其實可以通過redis,set來做每天的訂單集合。比如A客戶的訂單號201803041,B客戶併發了相同的訂單號,但是A客戶插入了set集合,B客戶插入就會返回0, ...
  • 常用來製作隊列,當然lpush+rpop也能做棧 #將RPUSH RPUSHX LPUSH LPUSHX一併介紹(具體介紹RPUSH和RPUSHX,因為其實就是插入的方向的區別) RPUSH key value [value ...] 向存於 key 的列表的尾部插入所有指定的值。如果 key 不存 ...
  • 八皇後問題 :假設 將八個皇後放到國際象棋盤上,使其兩兩之間無法相互攻擊。共有幾種擺法? 基礎知識: 國際象棋里,棋盤為8X8格。 皇後每步可以沿直線、斜線 走任意格。 思路: 1.想把8個皇後放進去,肯定最終每行只有一個皇後,每列只有一個皇後。 2.設個二維數組chess [ i ] [ j ] ...
  • #設置值 SET key value [EX seconds] [PX milliseconds] [NX|XX] SET命令加上選項已經可以完全取代SETNX, SETEX, PSETEX的功能,所以在將來的版本中,redis可能會不推薦使用並且最終拋棄這幾個命令。 所以我依次介紹下set的不同模 ...
  • 不會造成迴圈引用的block 大部分GCD方法 因為self並沒有對GCD的block進行持有,沒有形成迴圈引用。目前我還沒碰到使用GCD導致迴圈引用的場景,如果某種場景self對GCD的block進行了持有,則才有可能造成迴圈引用。 block並不是屬性值,而是臨時變數 這裡因為block只是一個 ...
  • 1、概念理解和知識鋪墊 在Spring整體框架的核心概念中,容器是核心思想,就是用來管理Bean的整個生命周期的,而在一個項目中,容器不一定只有一個,Spring中可以包括多個容器,而且容器有上下層關係,目前最常見的一種場景就是在一個項目中引入Spring和SpringMVC這兩個框架,那麼它其實就 ...
  • 一、變數是什麼 變數就是一個存儲數據的記憶體空間對象,存儲的內容可以動態變化。定義一個變數,相當於向記憶體申請一個帶地址(變數名)的訪問空間對象,用來存儲數據,方便數據的查詢及運算。 二、變數名規則 1.變數名只能包括字母、數字和下劃線。變數名可以字母或下劃線開頭,不能以數字開頭,例如,可以將變數命名為 ...
  • 恢復內容開始 剛剛入門爬蟲,今天先對於單個圖集進行爬取,過幾天再進行翻頁爬取。 使用requests庫和BeautifulSoup庫 目標網站:妹子圖 今天是對於單個圖集的爬取,就選擇一個進行爬取,我選擇的鏈接為:http://www.mzitu.com/123114 首先網站的分析,該網站有一定的 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...