解析大型.NET ERP系統(tǒng) 代碼的壞味道
1 對(duì)用戶輸入做過多的約定和假設(shè)
配置文件App.config中有一個(gè)設(shè)定報(bào)表路徑的配置節(jié):
<add key="ReportPath" value="C:\Users\Administrator"/>
在程序中有一個(gè)銷售報(bào)表文件SalesReport.rpt,用代碼調(diào)用這個(gè)報(bào)表,可能會(huì)寫成:
string salesReport=ReportPath + "SalesReport.rpt";
因?yàn)槁窂侥┪矝]有加反斜線,會(huì)拋出找不到報(bào)表文件的異常(FileNotFoundException)。
經(jīng)過修改,可以考慮在配置前的末尾強(qiáng)制要加反斜線\,修改之后的配置節(jié)如下:
<add key="ReportPath" value="C:\Users\Administrator\"/>
經(jīng)過這樣的修改,上面代碼運(yùn)行正常。
為此,我認(rèn)為應(yīng)該在程序中考慮增加一個(gè)判斷,對(duì)于路徑默認(rèn)沒有帶反斜線\的,給它加一個(gè)。程序代碼也就是一行:
if (!reportPath.EndsWith("\\"))
reportPath += "\\";
這個(gè)例子也可以通過調(diào)用方法System.IO.Path.Combine實(shí)現(xiàn),避免用戶沒有輸入反斜線的問題。
再舉一個(gè)例子,比如IP地址后如果用戶沒有加端口號(hào)碼,程序中做一個(gè)簡單的判斷,加上默認(rèn)的端口號(hào),不強(qiáng)制約定用戶的輸入的值,比較下面的兩種配置方法。
<add key="RemotServerHost" value="192.168.1.99"/> <add key="RemotServerHost" value="192.168.1.100:21"/>
2 在數(shù)據(jù)庫服務(wù)器中可以處理的查詢,移動(dòng)到程序端處理
這一條產(chǎn)生的原因在于C#有很好用的foreach語句,永遠(yuǎn)不會(huì)拋出越界異常。所以就產(chǎn)生了一些偷懶的做法,寧愿把數(shù)據(jù)讀到程序中處理,也不想優(yōu)化SQL語句查詢。參考下面的代碼,我遇到后都是直接強(qiáng)制要求重寫。
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;
}
}
能在數(shù)據(jù)庫服務(wù)器中做的事情,就不應(yīng)該移動(dòng)到代碼中處理,這樣沒有效率,代碼沒有質(zhì)量。
3 數(shù)據(jù)庫SQL語句未考慮到重復(fù)執(zhí)行或是自動(dòng)化部署
壞味道的代碼:
ALTER TABLE JobOrder ADD FiscalYear DECIMAL(4,0), PeriodNo DECIMAL(2,0)
應(yīng)該修改成下面的代碼。
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 的用法中,用數(shù)字作索引,在維護(hù)時(shí)很難看見數(shù)字列名的含義
壞味道的代碼:
string cachePath=string.Empty;
DataTable table =queryManager.FetchTableBySqlCommand(query);
foreach (DataRow row in table.Rows)
cachePath = row.ItemArray[2].ToString();
應(yīng)該修改成用列名作索引:
string cachePath=string.Empty;
DataTable table =queryManager.FetchTableBySqlCommand(query);
foreach (DataRow row in table.Rows)
cachePath = row.ItemArray[“CachePath"].ToString();
5 字符串操作沒有考慮大小寫
字符串判斷比較可以用等號(hào)(=)操作符,我推薦的寫法是用Equal方法,傳入?yún)?shù)是否區(qū)分大小寫。
字符串搜索也需要考慮大小寫問題,比如下面的代碼,不區(qū)大小寫搜索。
string findWath="SO2015"; if (txtOrderNo.Text.IndexOf(findWhat, 0, StringComparison.InvariantCultureIgnoreCase) != -1)
字符串空值判斷用string.IsNullOrWhiteSpace,字符串設(shè)空值用string.Empty。
6 長時(shí)間運(yùn)行任務(wù)時(shí),沒有設(shè)置光標(biāo)為等待狀態(tài),控件的狀態(tài)也未變灰
執(zhí)行任務(wù)前
UseWaitCursor = true;
btnAdd.Enable=false;
任務(wù)執(zhí)行完成之后
UseWaitCursor = false;
btnAdd.Enable=true;
7 打開文件對(duì)話框沒有設(shè)置合適的標(biāo)題和文件類型過濾器
這是個(gè)小細(xì)節(jié)的地方,從stackoverflow中搜索幾個(gè)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";
#p#
8 刪除數(shù)據(jù)時(shí),如非必要,不用先讀取到客戶端再執(zhí)行刪除。
如有驗(yàn)證邏輯,考慮用過濾條件傳遞到數(shù)據(jù)庫中驗(yàn)證數(shù)據(jù),代替讀取數(shù)據(jù)到程序中執(zhí)行驗(yàn)證。
9 日期時(shí)間沒有考慮到小時(shí)分鐘值
DateTime.Now 是帶小時(shí)分鐘的, DateTime.Today是不帶時(shí)間的。曾經(jīng)有一段時(shí)間,總是查不到今天做的日記帳數(shù)據(jù),總是要求客戶把時(shí)間查詢時(shí)間范圍提前一天,原因是DateTime.Now帶有小時(shí)分鐘值。
10 SQL腳本文件編碼
需要保存的格式是UTF8,避免GB2312或是BIG5導(dǎo)致亂碼。
11 同一個(gè)數(shù)據(jù)庫中出現(xiàn)多種命名習(xí)慣
SalesOrder 首字母大寫
Sales_Order 單詞用下劃線分開
SL_Sales_Order 加模塊前綴
12 系統(tǒng)默認(rèn)值來源沒有依據(jù)
采購訂單稅率默認(rèn)為17點(diǎn),一年定期銀行利息是2.2***BC分析的三個(gè)值依次是85,15,5。
這些默認(rèn)值都應(yīng)該加一個(gè)功能來存儲(chǔ),而不是直接在代碼中寫死默認(rèn)值。
13 常量值不統(tǒng)一
主要是日期時(shí)間***最小值,推薦下面的代碼,用于設(shè)定公共變量值。
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; }
}
數(shù)據(jù)庫中時(shí)間值為空值字段,可以設(shè)置值為NULL,也可以用DateTimeMinValue。
對(duì)于特殊類財(cái)務(wù)報(bào)表,必須要有一個(gè)時(shí)間范圍,用DateTimeMinValue。
myEntity.SetNewFieldValue((int)MyEntityFieldIndex.MyDateField, null);
14 沒有發(fā)揮數(shù)據(jù)綁定的的威力
WinForms的數(shù)據(jù)綁定是雙向的,可以將實(shí)體對(duì)象通過數(shù)據(jù)源控件取到DataGridView控件中。
壞味道的代碼:
string customerName=gridQuotation.Rows[0].Cell[0].Value;
應(yīng)該是:
QuotationEntity quotation= detailBindingSource.Current as QuotationEntity;
QuotationEntity quotation = this.gridQuotation.GetRowListObject(row) as QuotationEntity;
string customerName=quotation.CustomerName
15 數(shù)據(jù)驗(yàn)證沒有借助于.NET的正則表達(dá)式。
壞味道:
try
{
Convert.ToDecimal("123abc456"); return true; } catch { return false;
}
應(yīng)該是
Regex regex = new Regex("a{1,2}"); Match m = regex.Match("123abc456") if(m.Success) { //驗(yàn)證成功
}
這些驗(yàn)證方式可以封裝為公共方法,實(shí)現(xiàn)代碼復(fù)用。
16 數(shù)據(jù)庫查詢沒有考慮NULL值情況
壞味道的代碼:
ResultsetFields fields = new ResultsetFields(1);
fields.DefineField(PurchaseRequisitionDetailFields.Qty, 0);
應(yīng)該是:
DbFunctionCall dbFunQty = new DbFunctionCall("ISNULL", new object[] { PurchaseRequisitionDetailFields.Qty, 0 }); EntityField2 efieldQty = new EntityField2(PurchaseRequisitionDetailFields.Qty.Name, dbFunQty);
itemFields.DefineField(efieldQty, 0);
相當(dāng)于ISNULL函數(shù)調(diào)用 ISNULL(Qty,0) 。