軟件目錄開發規範-Day4
一、背景
“設計項目目錄結構”和“代碼編碼風格”一樣，屬於個人風格問題。對於這種風格上的規範，一直都存在兩種態度：
- 這種個人風格問題“無關緊要”。理由是能讓程序工作就好，風格問題根本不是問題
- 規範化更好的控制程序結構，讓程序具有更高的可讀性
個人更偏向後者，因為項目的可讀性、可維護性很重要。“項目目錄結構”其實也是屬於“可讀性和可維護性”的範疇。
二、設計層次目錄結構的好處
- 可讀性高：不熟悉這個項目代碼的人，一眼就能看懂目錄結構，知道程序啟動腳本是哪個，測試目錄在哪兒，配置文件在哪兒等等。從而非常快速的了解這個項目。
- 可維護性高：定義好組織規則後，維護者就能很明確地知道，新增的哪個文件和代碼應該放在什麽目錄之下。這個好處是，隨著時間的推移，代碼/配置的規模增加，項目結構不會混亂，仍然能夠組織良好。
所以，我認為，保持一個層次清晰的目錄結構是有必要的。更何況組織一個良好的工程目錄，其實是一件很簡單的事兒。
三、目錄組織方式
1、目錄結構
假設你的項目名是atm，我比較建議的最方便快捷目錄結構的方式：
Atm/ |-- bin/ | |-- atm | |-- core/ | |-- 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
簡單解釋一下：
- bin/：存放項目的一些可執行文件，當然你可以起名script/之類的也行
- core/：存放項目的所有源代碼。（1）源代碼中的所有模塊、包都應該放在此目錄。不要置於頂層目錄。（2）其子目錄test/存放單元測試代碼。（3）程序的入口最好命名為main.py
- conf/：存放項目的一些配置文件
- logs/：存放項目執行的日誌信息
- docs/：存放一些文檔
- setup.py：安裝、部署、打包的腳本
- requirements.txt：存放軟件依賴的外部python包列表
- README：項目說明文件
除此之外，有一些方案給出了更加多的內容。比如LICENSE.txt，Changelog.txt文件等，我沒有列在這裏，因為這些東西主要是項目開源的時候需要用到。如果你想寫一個開源軟件，目錄該如何組織。
四、關於README的內容
這個個人覺得每個項目都應該有的一個文件，目的是能簡要描述該項目的信息，讓讀者快速了解這個項目。
它需要說明一下幾個事項：
- 軟件定位，軟件的基本功能
- 運行代碼的方法：安裝環境、啟動命令等
- 簡要的使用說明
- 代碼目錄結構說明，更詳細點可以說明軟件的基本原理
- 常見問題說明
在軟件開發初期，由於開發過程中以上內容可能不明確或者發生變化，並不是一定要在一開始就將所有信息都補全。但是在項目完結的時候，是需要撰寫這樣的一個文檔的。
可以參考Redis源碼中Readme的寫法，這裏面簡潔但是清晰的描述了Redis功能和源碼結構。
五、關於requirements.txt和setup.py
1、setup.py
一般來說，用setup.py來管理代碼的打包、安裝、部署問題。業界的標準寫法是用python流行的打包工具setuptools來管理這些事情。這種方式普遍應用於開源項目中。不過這裏的核心思想不是用標準化的工具來解決這些問題，而是說，一個項目一定要有一個安裝部署工具，能快速便捷的在一臺新機器上將環境裝好、代碼部署好和將程序運行起來。
個人剛開始接觸python寫項目的時候，安裝環境、部署代碼、運行程序這個過程全是手工完成，遇到過一下問題：
- 安裝環境是經常忘了最近又添加了一個新的python包，結果一到線上運行，程序就報錯了。
- python包的版本依賴問題，有時候我們程序中使用的是一個版本的python包，但是官方的已經是最新的包了，通過手動安裝就可能裝錯了。
- 如果依賴的包很多的話，一個一個安裝這些依賴是很費時的事情
- 新同學開始寫項目的時候，將程序跑取來非常麻煩，因為可能經常忘了要怎麽安裝何種依賴。
setup.py可以將這些事情自動化起來，提高效率、減少出錯的概率。“復雜的東西自動化，能自動化的東西一定要自動化。”是一個非常好的習慣
setuptools的文檔比較龐大，剛接觸的話，可能不太好找到切入點。學習技術的方式就是看他人是怎麽用的，可以參考一下Python的一個Web框架，flask是如何寫的: setup.py
當然，簡單點自己寫個安裝腳本（deploy.sh）替代setup.py也未嘗不可。
2、requirements.txt
這個文件存在的目的是:
- 方便開發者維護軟件的包依賴。將開發過程中新增的包添加進這個列表中，避免在
setup.py安裝依賴時漏掉軟件包。 - 方便讀者明確項目使用了哪些Python包。
這個文件的格式是每一行包含一個包依賴的說明，通常是flask>=0.10這種格式，要求是這個格式能被pip識別，這樣就可以簡單的通過 pip install -r requirements.txt來把所有Python包依賴都裝好了。具體格式說明： 猛擊這裏。
六、關於配置文件的使用方法
註意，在上面的目錄結構中，沒有將conf.py放在源碼目錄下，而是放在docs/目錄下。
很多項目對配置文件的使用做法是:
- 配置文件寫在一個或多個python文件中，比如此處的conf.py。
- 項目中哪個模塊用到這個配置文件就直接通過
import conf這種形式來在代碼中使用配置。
這種做法我不太贊同:
- 這讓單元測試變得困難（因為模塊內部依賴了外部配置）
- 另一方面配置文件作為用戶控制程序的接口，應當可以由用戶自由指定該文件的路徑。
- 程序組件可復用性太差，因為這種貫穿所有模塊的代碼硬編碼方式，使得大部分模塊都依賴
conf.py這個文件。
所以，我認為配置的使用，更好的方式是，
- 模塊的配置都是可以靈活配置的，不受外部配置文件的影響。
- 程序的配置也是可以靈活控制的。
能夠佐證這個思想的是，用過nginx和mysql的同學都知道，nginx、mysql這些程序都可以自由的指定用戶配置。
所以，不應當在代碼中直接import conf來使用配置文件。上面目錄結構中的conf.py，是給出的一個配置樣例，不是在寫死在程序中直接引用的配置文件。可以通過給main.py啟動參數指定配置路徑的方式來讓程序讀取配置內容。當然，這裏的conf.py你可以換個類似的名字，比如settings.py。或者你也可以使用其他格式的內容來編寫配置文件，比如settings.yaml之類的
軟件目錄開發規範-Day4