day4-軟體目錄開發規範

派森發表於2017-10-19

一、背景

軟體開發是一個系統工程，當然編碼實現是其中尤其重要的一個環節，關乎到功能需求的實現好壞。這個環節中除了編碼這一硬功之外，與之相關的編碼風格這一柔道，雖然沒有直接決定功能的實現與否，但卻在很大程度上決定了的專案程式碼整體的可讀性、健壯性、移植性、可維護性等重要特性。編碼風格不僅涉及到程式碼如何編寫，也涉及到程式碼模組的分佈組織，即專案程式碼目錄的設計。

好的程式碼目錄設計可以直觀展現開發者的邏輯條理，提高程式碼的可讀性、可維護性、移植性甚至是健壯性，不好的程式碼目錄設計就不細說了，邏輯層次混亂不清，程式碼拷貝到其他環境不能執行等是最常見的問題了。

今天就來談談軟體目錄開發設計規範相關的事宜。

二、設計軟體目錄開發規範的重要性和必要性

在上文中略微提到軟體專案程式碼目錄設計規範對專案的一些影響，這裡細化展開一下其重要性和必要性，大致為以下幾點：

  • 可讀性高：好的程式碼目錄設計，可以讓剛接觸專案的人員通過目錄即可大致瞭解開發者的邏輯條理，明確程式入口檔案、測試樣例、說明幫助文件、配置檔案等的分佈位置，從而可以最快的速度熟悉專案。
  • 可維護性強：當前的目錄設計規範可以明確地提示維護者新增的程式碼檔案、配置檔案等該設計在哪個目錄下，以便更好的維護專案。這樣可確保隨著時間的推移和人員的變更，專案本身的可維護性依然很強。
  • 可移植性：當專案上到一定規模或變得複雜時，通過不同的層級目錄來分佈不同用途的檔案顯得異常重要，這樣可以確保程式碼包拷貝到其他環境後，儘可能地避免因模組依賴、配置檔案缺少、目錄呼叫失敗等問題導致的執行失敗問題。

    • 三、軟體開發目錄組織方式

    僅以Python為例，談談建議的軟體開發目錄組織結構：

    Foo/
|-- bin/
|   |-- foo
|
|-- foo/
|   |-- tests/
|   |   |-- __init__.py
|   |   |-- test_main.py
|   |
|   |-- __init__.py
|   |-- main.py
|
    |--conf/
    |  |-- __init__.py
    |　|-- settings.py
    |
    |--logs/
    |
|-- docs/
|   |-- conf.py
|   |-- abc.rst
|
|-- setup.py
|-- requirements.txt
|-- README

    解釋如下：
    1. bin/: 存放專案的一些可執行檔案，當然起名scripts/之類的也未嘗不可
    2. foo/: 存放專案的所有原始碼。(1) 原始碼中的所有模組、包都應該放在此目錄。不要置於頂層目錄。(2) 其子目錄tests/存放單元測試程式碼； (3) 程式的入口最  
        好命名為main.py。
    3. conf/: 存放配置檔案
    4. logs/: 作為日誌目錄存放程式執行中生成的各種日誌
    5. docs/:存放專案的幫助文件
    6. setup.py：安裝、部署、打包的指令碼，一般用於適配環境、解決依賴關係等
    7. requirements.txt: 存放軟體依賴的外部python包列表
    8. README：存放專案說明文件，下文詳述
    除此之外，有一些方案給出了更加多的內容。比如LICENSE.txt,ChangeLog.txt檔案等，其中LICENSE.txt主要是專案開源的時候需要用到。ChangeLog.txt可根據需要確定是否新增。

    四、README相關

    使用過開源軟體的朋友們都知道README可以給軟體的使用帶來很大的幫助，包括軟體介紹、功能定位、安裝啟動使用方法、有建議或bug怎麼聯絡作者等，其必要性和重要性不言而喻。

    因此每一個專案都應該有README說明，好的README應該至少包括以下幾方面的內容：

    • 軟體的簡要介紹、功能定位、適用場景等
    • 軟體的安裝、環境依賴、啟動方法、常見使用命令（使用說明）等
    • 程式碼的目錄結構說明
    • 常見問題說明
    • 遇到建議或bug如何聯絡作者或專案組

    如果再編寫的更詳細，可以考慮簡述軟體的基本原理。這方面最好的參考就是開源軟體的README，如nginx，redis等。

    五、requirements.txt和setup.py相關

    1. requirements

    requirements主要解決以下兩個問題：

    1. 方便開發者維護軟體包依賴
      有新的依賴包產生時直接新增進該列表即可，然後通過setup.py自動解決該依賴，避免遺漏
    2. 方便使用者明確依賴關係

    requirements.txt的格式是每一行包含一個包依賴的說明，通常是flask>=0.10這種格式，要求是這個格式能被pip識別，這樣就可以簡單的通過 pip install -r requirements.txt來把所有Python包依賴都裝好了。具體格式說明： 猛擊這裡。

    2.setup.py

    一般來說，用setup.py來管理程式碼的打包、安裝、部署問題。業界標準的寫法是用Python流行的打包工具setuptools來管理這些事情。這種方式普遍應用於開源專案中。不過這裡的核心思想不是用標準化的工具來解決這些問題，而是說，一個專案一定要有一個安裝部署工具，能快速便捷的在一臺新機器上將環境裝好、程式碼部署好和將程式執行起來。

    這個問題好比在linux通過yum來安裝一個軟體一樣，我們不得不承認，在解決環境依賴關係方面，yum安裝相對於原始碼編譯安裝更方便。

    在python專案方面，對於初學者來講，很多都經歷過以下問題:

    1. 安裝環境時忘了最近又新增了一個新的Python包，結果一到線上執行，程式就出錯了。
    2. Python包的版本依賴問題，有時候我們程式中使用的是一個版本的Python包，但是官方的已經是最新的包了，通過手動安裝就可能裝錯了。
    3. 如果依賴的包很多的話，一個一個安裝這些依賴是很費時的事情。
    4. 新同學開始寫專案的時候，將程式跑起來非常麻煩，因為可能經常忘了要怎麼安裝各種依賴。

    setup.py的目的是將這些事情自動化起來，統一自動化管理，提高效率並減少出錯的概率。"複雜的東西自動化，能自動化的東西一定要自動化。"是一個非常好的習慣。

    setuptools的文件比較龐大，剛接觸的話，可能不太好找到切入點。先從模仿開始吧，可以參考一下Python的一個Web框架，flask是如何寫的: setup.py

    如果開發的專案只是在Linux環境上執行，簡單點自己寫個安裝指令碼（deploy.sh）替代setup.py也未嘗不可。

    六、配置檔案相關

    注意，在上面的目錄結構中，沒有將conf.py放在原始碼目錄下，而是放在docs/目錄下。

    很多專案對配置檔案的使用做法是:

    1. 配置檔案寫在一個或多個python檔案中，比如此處的conf.py。
    2. 專案中哪個模組用到這個配置檔案就直接通過import conf這種形式來在程式碼中使用配置。

    這種做法我不太贊同:

    1. 這讓單元測試變得困難（因為模組內部依賴了外部配置）
    2. 另一方面配置檔案作為使用者控制程式的介面，應當可以由使用者自由指定該檔案的路徑。
    3. 程式元件可複用性太差，因為這種貫穿所有模組的程式碼硬編碼方式，使得大部分模組都依賴conf.py這個檔案。

    所以，我認為配置的使用，更好的方式是，

    1. 模組的配置都是可以靈活配置的，不受外部配置檔案的影響。
    2. 程式的配置也是可以靈活控制的。

    能夠佐證這個思想的是，用過nginx和mysql的同學都知道，nginx、mysql這些程式都可以自由的指定使用者配置。

    所以，不應當在程式碼中直接import conf來使用配置檔案。上面目錄結構中的conf.py，是給出的一個配置樣例，不是在寫死在程式中直接引用的配置檔案。可以通過給main.py啟動引數指定配置路徑的方式來讓程式讀取配置內容。當然，這裡的conf.py你可以換個類似的名字，比如settings.py。或者你也可以使用其他格式的內容來編寫配置檔案，比如settings.yaml之類的。

    相關文章