《代码整洁之道》的概要梳理(一)

阅前提醒

本人 phper 不善 java,虽然能看懂本书中大部分的例子,但关于 java 特有的一些讲解暂时没有触及,并且我会对一些优化方案提出自己的一些主观看法,并不会完全按照书中的优化方法去做。


命名 (part.1)

计算机界有两大难题:缓存和命名。一个好的命名是对事物最准确的描述,代表了程序最清晰的表达,命名是最简单的实现,却又是最难做好的事情。关于如果有一个好的命名,书中提到了一些方法论,不管是函数名、变量名、类名......凡是用到名字的,都是可以参考的。

  • 命名能够体现上下文的关联
$goodsNumber = 10;
$price = 2.5;
$a = $goodsNumber * $price;

$a 对于程序执行不会产生任何影响,但从代码可读性上来说,它和上下文没有任何关联,本来可以一扫而过的代码却要被迫深入的看下逻辑,增加阅读难度。

  • 避免使用数据类型、系统关键字、相似度高的名字
$orderList = Order::query();

$define = 'haohaoxuexi';

$order0bserver = Order::boot();
$orderObserver = Order::boot();

$orderList 中的 list 有可能是被人认为是指代链表这个数据结构的,用 $orders 或 $orderGroup 来表示一个数据集合更好,define 在 php 中是一个定义常量的函数名,至于最后一个例子,数字 0 和字母 O 会造成混淆。

主观看法:关于名字中包含 list 的问题,说实话工作中见到了太多这样的代码,一般多见于列表相关的逻辑块中,查下列表的翻译,第一个就是list,更多人在命名时想到的是业务相关列表而不是数据结构,硬说是数据集合也解释的通,总之我是不提倡,不反对

  • 名字精简不要废话
$nameString = 'zhangsan';

名字只能是字符串,总不能是布尔值吧,命名也要遵循常识,$name 就可以了。

  • 要能读出来的名字
$hahahahaha = 'kaixin';

名称完全表达了内容,但是在大庭广众真的能念出来吗?

主观看法:平时真没什么人直接念的,命名不要太离谱就行了

  • 遍历中的变量多次使用可以起个合适的名字
foreach ($orders as $value) {
  $price = $value->price;
  $sn = $value->order_sn;
  $address = $value->address;
  express::send($value);
}

遍历中最常见的用 $value、$item、$v 作为元素,但是在遍历中用更有意义的名称观看会更直观,尤其是在遍历体中的逻辑代码较多时,没有意义的名称让人困惑。

  • 代码前缀
$m_order = Member::order();
$a_order = Administrator::order();

用前缀来区分是普通成员还是管理员订单,只能说偷懒吧,除了当事人,没人能明白什么意思。

  • 类名应该是名词,方法名是动词
class Buy {}

类代表了一个事物的抽象,应该用名词表示,可以放入 Person 这个类下作为一个动作

  • 每个概念对应一个名字
$order = Order::query();
$goods = Goods::select();
$express = Express::find();

个人的编码风格,在同一套代码中能尽量保持一致的话,阅读会很舒适,查询如果都是 query 或是其他,不管代码用在何处,阅读代码都会顺畅很多。

主观看法:纯粹个人编码风格的培养,长时间的代码生涯都有自己的一套逻辑,如果团队有要求就按规定,没有就随意

  • 英文变量名要表达准确
$orderHao = '2020210229999999';

这是真实的出自一位5年后端之手的代码,原意是想表示一个订单号。中国人不为难中国人,就是全拼我也是能理解的,但是这样中英文混用的就真的无法接收了。这个不是书中的方案,只是个人实际工作中的总结。

函数 (part.2)
  • 保持短小
function orderTotal () {
  //去掉参数空值和页码
        $condition = $this->filterParam();
        $query_time = $this->formatTime();
        //设置分页用参数
        $page_query = $condition;
        $page_query['create_time'] = $query_time['create_time'];

        $orderList = OrderModel::where($condition)->whereTime('create_time',[$query_time['start_time'],$query_time['end_time']])->paginate(10,false,[
            'query' => $page_query //绑定额外参数
        ]);

        $orderGoodsSingle = OrderGoodsSingleModel::getInstance();

        //遍历添加订单商品
        foreach($orderList as $key => $order){
            $orderGoods = $orderGoodsSingle::where('order_id',$order->order_id)->field('name_cn,name_shop,number,main_picture,link')->select();
            $orderList[$key]['goods'] = $orderGoods;
        }

        $page = $orderList->render();
        $total = $orderList->total();
        $websiteList = WebsiteModel::all();

        $this->assign('websiteList',$websiteList);
        $this->assign('param',$condition);
        $this->assign('query_time',$query_time);
        $this->assign('page',$page);
        $this->assign('total',$total);
        $this->assign('orderList',$orderList);

        $this->title = '订单统计';
        $this->assign('title',$this->title);
        return view();
}

函数体的代码不宜过长,当出现过长的代码也意味着可以考虑封装了,建议是不超过20行

主观看法:20行只是个建议,不一定适用所有业务场景,但一个函数体搞个上百行代码就过分了

  • 流程控制语句不要嵌套太多层级
if ($order) {
  if ($order->total > 100) {
    if ($order->address == 'shanghai') {
      //逻辑
    }
  }
}

流程控制是编程复杂性的一大来源,减少层级嵌套是最为直接对代码优化的做法

  • 函数应该只做一件事
function createOrder () {
  //创建订单
  OrderService::create();
  //给下单人发邮件
  $customer = Order::getCustomer();
  Notificatoin::send($customer);
}

该函数是负责创建订单的逻辑,但是在该函数中还有发送邮件的逻辑,所谓“同一件事”就是处于同一抽象层级的,发邮件和订单生成不属于统一抽象层,应该封装后分离。

主观看法:什么是统一的抽象层级,书中并没有给更多的例子来说明,函数的拆分粒度我觉得需要根据代码复用情况来进行,没有人能一步到位写出好的代码,项目前期还是要以功能实现为首要任务,后期如由必要可通过重构来优化

  • 向下规则
function calculateOrderAmount () 
{
  orderGoodsPrice();
  discount();
  expressPrice();
}
function orderGoodsPrice () {}
function discount() {}
function expressPrice() {}

函数按照向下规则,依次排布,看的时候方便点。

主观看法:感觉作用不大,排顺序本来就是个增加工作量的事情,再一个现在 IDE 都有追溯的功能,直接跳转也很方便
  • 参数尽量少
function sendOrderBill ($customerName, $email, $orderTotal, $billAddress) {
  //给客户发账单
  .....
  Notification::send();
}

给客户发订单账单,参数均为订单相关信息,过多的参数给外部调用增加很大负担,调用者需要弄清楚每一个参数的含义,并且如果函数扩展,参数和外部调用者都需要修改。如果只传入一个订单对象,就解决了这些问题。

  • 参数不要包含布尔
function createOrder ($isCancel = false|true)  {
  if ($isCancel === true) {
    Order::cancel();  
  } else {
    Order::create();
  }
}

通过传入是否取消订单的布尔值,执行不同的创建订单还是取消订单操作,其实这个还是强调函数只做一件事。

主观看法:有时候确实需要,毕竟是参考,以实际情况为准,先实现后优化

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,752评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,100评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,244评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,099评论 1 286
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,210评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,307评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,346评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,133评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,546评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,849评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,019评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,702评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,331评论 3 319
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,030评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,260评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,871评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,898评论 2 351

推荐阅读更多精彩内容