解析大型.NET ERP系統 代碼的壞味道

1  對用戶輸入做過多的約定和假設

配置文件App.config中有一個設定報表路徑的配置節：

<add key="ReportPath" value="C:\Users\Administrator"/>

在程序中有一個銷售報表文件SalesReport.rpt，用代碼調用這個報表，可能會寫成：

string salesReport=ReportPath + "SalesReport.rpt";

因為路徑末尾沒有加反斜線，會拋出找不到報表文件的異常(FileNotFoundException)。

經過修改，可以考慮在配置前的末尾強制要加反斜線\，修改之后的配置節如下：

<add key="ReportPath" value="C:\Users\Administrator\"/>

經過這樣的修改，上面代碼運行正常。

為此，我認為應該在程序中考慮增加一個判斷，對於路徑默認沒有帶反斜線\的，給它加一個。程序代碼也就是一行：

if (!reportPath.EndsWith("\\")) 
    reportPath += "\\";

這個例子也可以通過調用方法System.IO.Path.Combine實現，避免用戶沒有輸入反斜線的問題。

再舉一個例子，比如IP地址后如果用戶沒有加端口號碼，程序中做一個簡單的判斷，加上默認的端口號，不強制約定用戶的輸入的值，比較下面的兩種配置方法。

<add key="RemotServerHost" value="192.168.1.99"/>
<add key="RemotServerHost" value="192.168.1.100:21"/>

2  在數據庫服務器中可以處理的查詢，移動到程序端處理

這一條產生的原因在於C#有很好用的foreach語句，永遠不會拋出越界異常。所以就產生了一些偷懶的做法，寧願把數據讀到程序中處理，也不想優化SQL語句查詢。參考下面的代碼，我遇到后都是直接強制要求重寫。

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語句未考慮到重復執行或是自動化部署

壞味道的代碼：

ALTER TABLE JobOrder  ADD FiscalYear DECIMAL(4,0),  PeriodNo DECIMAL(2,0)

應該修改成下面的代碼。

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 的用法中，用數字作索引，在維護時很難看見數字列名的含義

壞味道的代碼：

string cachePath=string.Empty;
DataTable table =queryManager.FetchTableBySqlCommand(query);
foreach (DataRow row in table.Rows)
      cachePath = row.ItemArray[2].ToString();

應該修改成用列名作索引：

string cachePath=string.Empty;
DataTable table =queryManager.FetchTableBySqlCommand(query);
foreach (DataRow row in table.Rows)
      cachePath = row.ItemArray[“CachePath"].ToString();

5   字符串操作沒有考慮大小寫

字符串判斷比較可以用等號(=)操作符，我推薦的寫法是用Equal方法，傳入參數是否區分大小寫。

字符串搜索也需要考慮大小寫問題，比如下面的代碼，不區大小寫搜索。

string findWath="SO2015";
if (txtOrderNo.Text.IndexOf(findWhat, 0, StringComparison.InvariantCultureIgnoreCase) != -1)

字符串空值判斷用string.IsNullOrWhiteSpace，字符串設空值用string.Empty。

 

6  長時間運行任務時，沒有設置光標為等待狀態，控件的狀態也未變灰

執行任務前

UseWaitCursor = true;
btnAdd.Enable=false;

任務執行完成之后

UseWaitCursor = false;
btnAdd.Enable=true;

 

7  打開文件對話框沒有設置合適的標題和文件類型過濾器

這是個小細節的地方，從stackoverflow中搜索幾個filter供參考用。

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   常量值不統一

主要是日期時間最大最小值，推薦下面的代碼，用於設定公共變量值。

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控件中。

壞味道的代碼：

string customerName=gridQuotation.Rows[0].Cell[0].Value;

應該是:

QuotationEntity  quotation= detailBindingSource.Current as QuotationEntity;
QuotationEntity quotation = this.gridQuotation.GetRowListObject(row) as QuotationEntity; 
string customerName=quotation.CustomerName

 

15  數據驗證沒有借助於.NET的正則表達式。

壞味道：

try
{  
   Convert.ToDecimal("123abc456");
   return true;
}
catch
{
    return false;
}

應該是

Regex regex = new Regex("a{1,2}");  
Match m = regex.Match("123abc456") 
if(m.Success) 
{
      //驗證成功 
}

這些驗證方式可以封裝為公共方法，實現代碼復用。

16 數據庫查詢沒有考慮NULL值情況

壞味道的代碼：

ResultsetFields fields = new ResultsetFields(1);
fields.DefineField(PurchaseRequisitionDetailFields.Qty, 0);

應該是:

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)。