1 對使用者輸入做過多的約定和假設
配置檔案App.config中有一個設定報表路徑的配置節：
|
1 |
<add key="ReportPath" value="C:\Users\Administrator"/> |
在程式中有一個銷售報表檔案SalesReport.rpt，用程式碼呼叫這個報表，可能會寫成：
|
1 |
string salesReport=ReportPath + "SalesReport.rpt"; |
因為路徑末尾沒有加反斜線，會丟擲找不到報表檔案的異常(FileNotFoundException)。
經過修改，可以考慮在配置前的末尾強制要加反斜線\，修改之後的配置節如下：
|
1 |
<add key="ReportPath" value="C:\Users\Administrator\"/> |
經過這樣的修改，上面程式碼執行正常。
為此，我認為應該在程式中考慮增加一個判斷，對於路徑預設沒有帶反斜線\的，給它加一個。程式程式碼也就是一行：
|
1 2 |
if (!reportPath.EndsWith("\\")) reportPath += "\\"; |
這個例子也可以通過呼叫方法System.IO.Path.Combine實現，避免使用者沒有輸入反斜線的問題。
再舉一個例子，比如IP地址後如果使用者沒有加埠號碼，程式中做一個簡單的判斷，加上預設的埠號，不強制約定使用者的輸入的值，比較下面的兩種配置方法。
|
1 2 |
<add key="RemotServerHost" value="192.168.1.99"/> <add key="RemotServerHost" value="192.168.1.100:21"/> |
2 在資料庫伺服器中可以處理的查詢，移動到程式端處理
這一條產生的原因在於C#有很好用的foreach語句，永遠不會丟擲越界異常。所以就產生了一些偷懶的做法，寧願把資料讀到程式中處理，也不想優化SQL語句查詢。參考下面的程式碼，我遇到後都是直接強制要求重寫。
|
1 2 3 4 5 6 7 8 9 10 11 12 |
IPrefetchPath2 prefetchPath=new PrefetchPath2((int)EntityType.SalesOrderEntity); prefetchPath.Add(PartEntity.PrefetchPathSalesOrderDetail); SalesOrderEntity order=salesOrderManager.GetPart("SC201507",prefetchPath); string description=string.Empty; foreach(SalesOrderDetailEntity orderDetail in order.SalesOrderDetail) { if(orderDetail.ItemNo="FLEX102030009") { description=entity.Description; break; } } |
能在資料庫伺服器中做的事情，就不應該移動到程式碼中處理，這樣沒有效率，程式碼沒有質量。
3 資料庫SQL語句未考慮到重複執行或是自動化部署
壞味道的程式碼：
|
1 |
ALTER TABLE JobOrder ADD FiscalYear DECIMAL(4,0), PeriodNo DECIMAL(2,0) |
應該修改成下面的程式碼。
|
1 2 3 4 |
IF NOT EXISTS(SELECT C.NAME FROM DBO.SYSCOLUMNS C, DBO.SYSOBJECTS O WHERE O.ID = C.ID AND O.NAME = 'CompanyParameter' AND C.NAME = 'POApprovalRequired') BEGIN Alter Table CompanyParameter ADD POApprovalRequired [nvarchar] (1) DEFAULT 'N' END |
4 DataTable 的用法中，用數字作索引，在維護時很難看見數字列名的含義
壞味道的程式碼：
|
1 2 3 4 |
string cachePath=string.Empty; DataTable table =queryManager.FetchTableBySqlCommand(query); foreach (DataRow row in table.Rows) cachePath = row.ItemArray[2].ToString(); |
應該修改成用列名作索引：
|
1 2 3 4 |
string cachePath=string.Empty; DataTable table =queryManager.FetchTableBySqlCommand(query); foreach (DataRow row in table.Rows) cachePath = row.ItemArray[“CachePath"].ToString(); |
5 字串操作沒有考慮大小寫
字串判斷比較可以用等號(=)操作符，我推薦的寫法是用Equal方法，傳入引數是否區分大小寫。
字串搜尋也需要考慮大小寫問題，比如下面的程式碼，不區大小寫搜尋。
|
1 2 |
string findWath="SO2015"; if (txtOrderNo.Text.IndexOf(findWhat, 0, StringComparison.InvariantCultureIgnoreCase) != -1) |
字串空值判斷用string.IsNullOrWhiteSpace，字串設空值用string.Empty。
6 長時間執行任務時，沒有設定游標為等待狀態，控制元件的狀態也未變灰
執行任務前
|
1 2 |
UseWaitCursor = true; btnAdd.Enable=false; |
任務執行完成之後
|
1 2 |
UseWaitCursor = false; btnAdd.Enable=true; |
7 開啟檔案對話方塊沒有設定合適的標題和檔案型別過濾器
這是個小細節的地方，從stackoverflow中搜尋幾個filter供參考用。
|
1 2 3 |
public const string ImageFilter = "Image files (*.jpg, *.jpeg, *.jpe, *.jfif, *.png,*.gif,*.bmp) | *.jpg; *.jpeg; *.jpe; *.jfif; *.png;*.gif;*bmp"; public const string PDFFilter = "PDF files (*.pdf) | *.pdf"; public const string ExcelFilter = "Excel Files|*.xls;*.xlsx;*.xlsm"; |
8 刪除資料時，如非必要，不用先讀取到客戶端再執行刪除。
如有驗證邏輯，考慮用過濾條件傳遞到資料庫中驗證資料，代替讀取資料到程式中執行驗證。
9 日期時間沒有考慮到小時分鐘值
DateTime.Now 是帶小時分鐘的, DateTime.Today是不帶時間的。曾經有一段時間，總是查不到今天做的日記帳資料，總是要求客戶把時間查詢時間範圍提前一天，原因是DateTime.Now帶有小時分鐘值。
10 SQL指令碼檔案編碼
需要儲存的格式是UTF8，避免GB2312或是BIG5導致亂碼。
11 同一個資料庫中出現多種命名習慣
- SalesOrder 首字母大寫
- Sales_Order 單詞用下劃線分開
- SL_Sales_Order 加模組字首
12 系統預設值來源沒有依據
採購訂單稅率預設為17點，一年定期銀行利息是2.25，ABC分析的三個值依次是85,15,5。
這些預設值都應該加一個功能來儲存，而不是直接在程式碼中寫死預設值。
13 常量值不統一
主要是日期時間最大最小值，推薦下面的程式碼，用於設定公共變數值。
|
1 2 3 4 5 6 7 8 9 10 |
private static readonly DateTime _dateTimeMinValue = new DateTime(1753, 1, 1, 0, 0, 0, 0); private static readonly DateTime _dateTimeMaxValue = new DateTime(2099, 12, 31, 0, 0, 0, 0); public static DateTime DateTimeMinValue { get { return _dateTimeMinValue; } } public static DateTime DateTimeMaxValue { get { return _dateTimeMaxValue; } } |
資料庫中時間值為空值欄位，可以設定值為NULL，也可以用DateTimeMinValue。
對於特殊類財務報表，必須要有一個時間範圍，用DateTimeMinValue。
myEntity.SetNewFieldValue((int)MyEntityFieldIndex.MyDateField, null);
14 沒有發揮資料繫結的的威力
WinForms的資料繫結是雙向的，可以將實體物件通過資料來源控制元件取到DataGridView控制元件中。
壞味道的程式碼：
|
1 |
string customerName=gridQuotation.Rows[0].Cell[0].Value; |
應該是:
|
1 2 3 4 5 |
QuotationEntity quotation= detailBindingSource.Current as QuotationEntity; QuotationEntity quotation = this.gridQuotation.GetRowListObject(row) as QuotationEntity; string customerName=quotation.CustomerName |
15 資料驗證沒有藉助於.NET的正規表示式。
壞味道：
|
1 2 3 4 5 6 7 8 9 |
try { Convert.ToDecimal("123abc456"); return true; } catch { return false; } |
應該是
|
1 2 3 4 5 6 |
Regex regex = new Regex("a{1,2}"); Match m = regex.Match("123abc456") if(m.Success) { //驗證成功 } |
這些驗證方式可以封裝為公共方法，實現程式碼複用。
16 資料庫查詢沒有考慮NULL值情況
壞味道的程式碼：
|
1 2 3 |
ResultsetFields fields = new ResultsetFields(1); fields.DefineField(PurchaseRequisitionDetailFields.Qty, 0); |
應該是:
|
1 2 3 4 5 |
DbFunctionCall dbFunQty = new DbFunctionCall("ISNULL", new object[] { PurchaseRequisitionDetailFields.Qty, 0 }); EntityField2 efieldQty = new EntityField2(PurchaseRequisitionDetailFields.Qty.Name, dbFunQty); itemFields.DefineField(efieldQty, 0); |
相當於ISNULL函式呼叫 ISNULL(Qty,0) 。