分享下我写不需要太严谨的项目的代码风格

public static Common.DB.ResultList GetList(Common.DB.NVCollection queryParams)
{

//string pageString = queryParams["page"] as string ?? "1";
//string psString = queryParams["pagesize"] as string ?? string.Empty;
//string cidString = queryParams["cid"] as string ?? string.Empty;

string sort = queryParams["sort"] as string ?? string.Empty;
string cate = queryParams["cate"] as string ?? string.Empty;
string type = queryParams["type"] as string ?? string.Empty;
string ch = queryParams["ch"] as string ?? string.Empty;
string kind = queryParams["kind"] as string ?? string.Empty;

string andwhere = "1=1";
string rootKey = null;
switch (type)
{
case "appsoft":
rootKey = "iphones";
break;
case "appgame":
rootKey = "iphoneg";
break;
case "azsoft":
rootKey = "soft";
break;
case "azgame":
rootKey = "game";
break;
}

var pnvc = new Common.DB.NVCollection();

if (rootKey != null)
{
var pcate = DBCache.SoftCategoryCache.Get(rootKey);
if (pcate != null)
{
andwhere += " and charIndex(@path,categoryPath)>0 ";
pnvc["path"] = "/" + pcate.ID + "/";
}
}

if (ch == "az")
{
andwhere += " and (charIndex(@path1,categoryPath)>0 or charIndex(@path2,categoryPath)>0)";
pnvc["path1"] = "/" + DBCache.SoftCategoryCache.Get("game").ID + "/";
pnvc["path2"] = "/" + DBCache.SoftCategoryCache.Get("soft").ID + "/";
}
else if (ch == "app")
{
andwhere += " and (charIndex(@path1,categoryPath)>0 or charIndex(@path2,categoryPath)>0)";
pnvc["path1"] = "/" + DBCache.SoftCategoryCache.Get("appgame").ID + "/";
pnvc["path2"] = "/" + DBCache.SoftCategoryCache.Get("appsoft").ID + "/";
}

if (!string.IsNullOrEmpty(cate) && !string.IsNullOrEmpty(rootKey))
{
var cateEnt = DBCache.SoftCategoryCache.Get(rootKey, cate);

if (cateEnt != null)
{
andwhere += " and categoryid=@cid ";
pnvc["cid"] = cateEnt.ID;
}
}

int cid = (queryParams["cid"] as int?) ?? 0;
if (cid > 0)
{
var cateEnt = DBCache.SoftCategoryCache.Get(cid);

if (cateEnt != null)
{
andwhere += " and categoryid=@cid ";
pnvc["cid"] = cateEnt.ID;
}
}

string orderby = " id desc";
switch (sort)
{
case "new":
orderby = " id desc";
break;
case "hot":
orderby = " viewTimes desc,id desc";
break;
case "rank":
orderby = " downWeekTimes desc,id desc";

break;
default:
break;
}

switch (kind)
{
case "number":
andwhere += " and number>0";
orderby = " number desc,id desc ";
break;
case "hprec":
andwhere += " and recommend=1 and homepage=1 and number=0 ";
orderby = " viewtimes desc,id desc ";
break;
case "recnothp":
andwhere += " and recommend=1 and homepage=0 and number=0 ";
orderby = " viewtimes desc,id desc ";
break;
case "rec":
andwhere += " and recommend=1 ";
break;

case "all":

break;

case "normal":
default:
andwhere += " and recommend=0 and homepage=0 and number=0 ";
//orderby = " id desc ";
break;
}

int page = (queryParams["page"] as int?) ?? 1;
if (page <= 0)
{
page = 1;
}

int pagesize = (queryParams["pagesize"] as int?) ?? 10;

if (pagesize <= 0)
{
pagesize = 10;
}

Common.DB.ResultList result = new Common.DB.ResultList(pagesize);

var dbh = Common.DB.Factory.Default;

//List<Common.DB.NVCollection> list = new List<Common.DB.NVCollection>(pagesize);

var query = Common.DB.Factory.DefaultPagerQuery;
query.AbsolutePage = page;
query.Fields = "id,name,version,viewtimes,categoryid";
query.PageSize = pagesize;
query.Sort = orderby;
query.Table = "soft";
query.Where = andwhere;

string csql = query.GetCountQueryString();
string qsql = query.GetQueryString();

int rc = dbh.ExecuteScalar<int>(csql, pnvc);
var ls = dbh.GetDataList(qsql, pnvc);

int pc = Convert.ToInt32(Math.Ceiling((decimal)rc / (decimal)pagesize));

result.Page = page;
result.PageCount = pc;
result.RecordCount = rc;
result.PageSize = pagesize;

for (int i = 0; i < ls.Count; i++)
{
var o = ls[i];

var ent = new Common.DB.NVCollection();
var entcate = DBCache.SoftCategoryCache.Get((int)o["categoryid"]);

ent["id"] = o["id"];
ent["name"] = o["name"];
ent["version"] = o["version"];
ent["cid"] = o["categoryid"];
ent["cpath"] = Services.PathService.GetListPath(entcate);
ent["cname"] = entcate.Name;
ent["path"] = Services.PathService.GetPath(entcate, (int)o["id"]);
ent["dtimes"] = o["viewtimes"];

result.Add(ent);
}

return result;
}

msg7086

2015-11-23 08:57:15 +08:00

用 Ruby 给你写了一个简单的例子，基于 Rails 的。

https://gist.github.com/msg7086/60e806bcccc00a49ecf4

我不敢说我的代码是可维护性好的代码，但是至少比你的代码要可维护得多。

比如说 Ruby 这边建议每个方法不应该超过 10 行，否则可维护性就会大大降低。我这边主函数将近 40 行，很明显的维护性就差很多。很多逻辑还可以抽离出来，使得结构更清晰。至于你这 180 行的函数我就不多说了，离讨论维护性这件事都差得很远。

读你的代码，首先第一个问题就是不知道这个函数到底接受哪些参数。（也就是你说的，连 IDE 都猜不透你函数到底接受什么东西。）这就意味着，一，新人要用你代码的时候，完全不知道该怎么用；二，你自己参数如果写错一个字母，你根本发现不了。等出了错你就慢慢 debug 吧。

其次是单函数结构。上面也说了，每个方法不应该超过 10 行。我们退一步讲，每个函数不应该超过 50 行好了。很多逻辑结构都可以抽出来做成单独的方法。看你这个 get_list ，应该是 Controller 方法吧，但是里面的很多逻辑是 Model 逻辑，应该放进 Model 类里。这样把函数拆开以后，还有一个好处就是做测试更方便了。
我不知道你的代码有多少自动化测试，不过我这边做开发，除非是做了就扔的项目，否则全都有做自动化测试覆盖。测试的代码量至少应该要达到项目代码量的一半甚至更多（通常是和项目代码量相同的级别）。这样项目在发布出去以后， bug 要少得多，哪怕用多一倍的时间去写测试，最后也会比不写测试要节约更多更多的时间。

最后就是拼接字符串，上面也说了不应该用字符串而应该用关系代数。用关系代数的话，可能会用到 ORM ，不过不用 ORM 应该也是可以做的，不知道 C#有没有可用的类库。但是用 C#不用 LINQ ，简直就是浪费了 C#在做 Web 上的最大优势之一了。（函数式， lambda ，延迟求值，匿名类，哪个不是超级好用的东西？）

你看我用了关系代数以后，根本不需要写一堆 AND ，不需要分 anywhere 和 orderby ，不需要考虑 WHERE 和 ORDER 的执行顺序，甚至连分页都不用我考虑了——因为有自动的分页插件，会自己往关系代数里注入合适的 LIMIT 子句。代码量轻松就掉了一半，开发速度更快了，而且出错的几率也下降了。

如上面很多人所说，程序员必然要经过很多个阶段，去反思自己的问题，才能向前走。你现在到达了封装参数发请求的阶段，自然觉得现在的方法是很不错。然而等你将来有机会接触了更好的方法，或者发现现有方法的各种坑了以后，才会知道更好的方法到底好在哪里。

把心态放平一些，然后多学习多看看吧。