如何成為一名優秀的工程師（語義篇）

張金寶發布于2019-07-01 12:33 / 2763人閱讀

摘要：好的語義表達是團隊協作中高效迭代的潤滑劑，好的語義表達是線上未知代碼問題排查的指南針。日常中應該多多刻意提升自己語義表達，百利而無一害。注釋更多參考函數方法案例先說明一句，不好的代碼不妨礙它成為一個優秀的軟件。這是非常不友好的語義表達。

好的語義表達是團隊協作中高效迭代的潤滑劑，好的語義表達是線上未知代碼問題排查的指南針。

本篇文章巨長，如果你比較“懶”，來我講給你聽（直播中有更多細節）回放地址 看完這個還不過癮？學習使你快樂？還想學習？快上車

不要讓其他人讀不懂你的代碼，其他人可能就是一周后的你。時刻以“如果你寫的這段代碼出現故障，一個陌生人接手你的代碼需要多久能處理完這個bug”來監督自己。

日常中應該多多刻意提升自己語義表達，百利而無一害。那么我們應該從哪些細節去做好語義表達呢？

以下代碼全為我的藝術創作，不屬于任何實際項目

命名 案例1

function getGoods($query, $shopId)
{
    $goodsId = Goods::add($query["uid"], $query["name"]);
    return Shop::add($goodsId, $shopId);
}

class Goods
{
    public static function add($uid, $name)
    {
        $id = mt_rand(1, 100000);
        return $id;
    }
}

class Shop
{
    public static function add($goodsId, $shopId)
    {
        $id = mt_rand(1, 100000);
        return $id;
    }
}

案例2

function getUserInfo($teamId, $youId = [])
{

}

如果僅僅有這個函數名和參數名，誰能猜到參數的意義呢？

案例3

class Db
{
    /**
     * @param string $table 數據庫表名
     * @param array  $data  新增數據
     *
     * @return int 新增主鍵
     */
    public static function insert(string $table, array $data)
    {
        $id = mt_rand(1, 1000);
        return $id;
    }
}

class ViewLogStore
{
    private $table = "view_log";

    function setHistory($data)
    {
        Db::insert($this->table, $data);
    }
}

案例4

假如業務代碼里有這些類

class WechatUserModel{

}

class WechatGroupModel{

}

class WechatMessageModel{

}

而我們查詢數據庫發現

這樣我們根據業務代碼就非常不方便找到對應的表，而且其他人接手我們項目的時候，也會摸不著頭腦?；蛘哒f這可能是三個人三次迭代開發造成的，那么他們彼此都沒有去參考前面人的命名規則。

來自靈魂的拷問

注釋

說完命名，下面說下注釋。注釋里還有什么學問？Are you kidding me?
一個數組對象成員，你知道怎么寫嗎？
類的魔術方法調用的注釋，你知道怎么寫嗎？

對象數組

/**
 * @var Ads[]
 */
public $adsList = [];

$blocks = [];/** @var $blocks Block[] **/

@method 的使用

/**
 * @link http://manual.phpdoc.org/HTMLframesConverter/default/
 *
 * @method static int search(string $query, $limit = 10, $offset = 0)
 */
class SearchServiceProxy
{
    public static function __callStatic($method, $arguments)
    {
        if (!method_exists("SearchService", $method)) {
            throw new LogicException(__CLASS__ . "::" . $method . " not found");
        }

        try {
            $data = call_user_func_array(["SearchService", $method], $arguments);
        } catch (Exception $e) {
            error_log($e->getMessage());
            return false;
        }

        return $data;
    }
}

@deprecated 使用

class SearchService
{

    /**
     * @param string $query
     * @param int    $limit
     * @param int    $offset
     *
     * @return array
     * @deprecated
     */
    public static function search(string $query, $limit = 10, $offset = 0)
    {
        return [
            ["id" => 1, "aaa"],
            ["id" => 2, "bbb"],
        ];
    }
}

注釋其他注意事項

注釋解釋張冠李戴，方法名更新，方法的功能業務注釋沒更新；復制別人的代碼把 @author 信息也復制過來了，錯誤了還要把鍋甩給別人。

注釋更多參考 http://manual.phpdoc.org/HTML...

函數、方法 案例1

先說明一句，不好的代碼不妨礙它成為一個優秀的軟件。PHP MySQL 爛代碼多的去了。
找到一個開源軟件里面的代碼，功能非常搶到，但是這個方法內容太多，一些不足點我標注出來了。

案例2

拿上面我舉例子，還記得下面這種圖嗎？

優化方案1

class ArrayUtils{
    public static function fetch($arr, $keys, $setNull = false)
    {
        $ret = array();
        foreach($keys as $key)
        {
            if ($setNull)
            {
                $ret[$key] = $arr[$key];
            }
            else
            {
                isset($arr[$key]) && $ret[$key] = $arr[$key];
            }
        }
        return $ret;
    }
}


class ViewLogStore
{
    private $table = "view_log";

    function record($data)
    {
        $fields = array(
            "uid",
            "url",
            "referer",
            "created_time"
        );
        $data = ArrayUtils::fetch($data, $fields);
        Db::insert($this->table, $data);
    }
}

優化方案2

class Db
{
    /**
     * @param string $table 數據庫表名
     * @param Entity $data  新增對象
     *
     * @return int 新增主鍵
     */
    public static function insert(string $table, Entity $data)
    {
        $array = $data->toArray();
        var_export($array); // test

        $id = mt_rand(1, 1000);
        return $id;
    }
}

class ArrayUtils
{
    /**
     * 針對成員都是私有屬性的對象
     *
     * @param      $obj
     * @param bool $removeNull 去掉空值
     * @param bool $camelCase
     *
     * @return array
     */
    public static function Obj2Array($obj, $removeNull = true, $camelCase = true)
    {
        $reflect = new ReflectionClass($obj);
        $props = $reflect->getProperties(ReflectionProperty::IS_PUBLIC | ReflectionProperty::IS_PRIVATE | ReflectionProperty::IS_PROTECTED);

        $array = [];
        foreach ($props as $prop) {
            $prop->setAccessible(true);
            $key = $prop->getName();

            // 如果不是駝峰命名方式，就把對象里面的 createTime 轉成 create_time
            if (!$camelCase) {
                $key = preg_replace_callback("/[A-Z]/", function ($matches) {
                    return "_" . strtolower($matches[0]);
                }, $key);
                $key = ltrim($key, "_");
            }

            $value = $prop->getValue($obj);

            if ($removeNull == true && $value === null) {
                continue;
            }

            if (is_object($value)) {
                $value = self::Obj2Array($value);
            }

            $array[$key] = $value;
        }

        return $array;
    }
}

class Entity
{
    public function toArray(){
        return ArrayUtils::Obj2Array($this);
    }
}

class ViewLogEntity extends Entity
{
    /**
     * @var int
     */
    private $uid;

    /**
     * @var string
     */
    private $url;

    /**
     * @var string
     */
    private $referer;

    /**
     * @var string
     */
    private $createdTime;

    /**
     * @param int $uid
     */
    public function setUid(int $uid)
    {
        $this->uid = $uid;
    }

    /**
     * @param string $url
     */
    public function setUrl(string $url)
    {
        $this->url = $url;
    }

    /**
     * @param string $referer
     */
    public function setReferer(string $referer)
    {
        $this->referer = $referer;
    }

    /**
     * @param string $createdTime
     */
    public function setCreatedTime(string $createdTime)
    {
        $this->createdTime = $createdTime;
    }
}


class ViewLogStore
{
    private $table = "view_log";

    function record(ViewLogEntity $viewLogEntity)
    {
        Db::insert($this->table, $viewLogEntity);
    }
}

// 測試

$viewLogEntity = new ViewLogEntity();
$viewLogEntity->setUid(1);
$viewLogEntity->setReferer("https://mengkang.net");
$viewLogEntity->setUrl("https://segmentfault.com/l/1500000018225727");
$viewLogEntity->setCreatedTime(date("Y-m-d H:i:s",time()));

$viewLogStore = new ViewLogStore();
$viewLogStore->record($viewLogEntity);

案例3

這還是函數嗎？（不僅僅是語義，屬于錯誤）

/**
 * @method mixed fetchList(string $sql, array $argv);
 */
class Model
{

    public function __construct($table)
    {

    }
}

function getUserList($startId, $lastId, $limit = 100)
{
    if ($lastId > 0) {
        $startId = $lastId;
    }

    $sql = "select * from `user` where id > ? order by id asc limit ?,?";

    $model = new Model("user");
    return $model->fetchList($sql, [intval($startId), intval($limit)]);
}

$startId和$lastId兩個參數重復

案例4

盡量減少參數引用

function bad($input1, $input2, &$input3)
{
    //...logic

    $input3 = "xxx";

    return true;
}

案例5

參數類型明確，返回值類型明確，不要出現 mixed。這個我直接拿官方的函數來舉例，對權威也要有懷疑的眼光。純屬個人看法。

案例6

上面例子中你會發現這個addUser寫得不想一個函數（方法）而像一個遠程api接口。而且在右邊的代碼中需要每次使用的時候都要用is_array來判斷。這是非常不友好的語義表達。PHP Java 這樣的高級語言有異常，我們要善用異常。

好的語義表達是團隊協作中高效迭代的潤滑劑，好的語義表達是線上未知代碼問題排查的指南針。這篇博客到這里就結束了，不知道你是否有一些收獲呢？

放三個二維碼

累死啦，原創博客不容易，如果覺得不錯，可以打賞下哈。謝謝。

GPU云服務器云服務器一名優秀成為一名如何成為全棧工程師如何成為web前端工程師

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://m.specialneedsforspecialkids.com/yun/30938.html

如何成為一名優秀的程序員

摘要：前言羅子雄如何成為一名優秀設計師董明偉工程師的入門和進階董明偉基于自己實踐講的知乎為新人提供了很多實用建議，他推薦的羅子雄如何成為一名優秀設計師的演講講的非常好，總結了設計師從入門到提高的優秀實踐。前言羅子雄：如何成為一名優秀設計師董明偉：Python 工程師的入門和進階董明偉基于自己實踐講的知乎live為Python新人提供了很多實用建議，他推薦的羅子雄：如何成為一名優秀...

keelii 2019-07-25 11:17 評論0 收藏0
如何成為一名優秀的web前端工程師（前端攻城師）？

摘要：我從沒有聽到有人問如何做一名優秀甚至卓越的前端工程師。作為一個優秀的前端工程師還需要深入了解以及學會處理的這些缺陷。再者，優秀的前端工程師需要具備良好的溝通能力，因為前端工程師至少都要滿足四類客戶的需求。　　我所遇到的前端程序員分兩種：　　第一種一直在問：如何學習前端？　　第二種總說：前端很簡單，就那么一點東西。　　我從沒有聽到有人問：如何做一名優秀、甚至卓越的WEB前端工程師...

Turbo 2019-08-20 17:21 評論0 收藏0
如何成為一名優秀的web前端工程師（前端攻城師）？

摘要：我從沒有聽到有人問如何做一名優秀甚至卓越的前端工程師。作為一個優秀的前端工程師還需要深入了解以及學會處理的這些缺陷。再者，優秀的前端工程師需要具備良好的溝通能力，因為前端工程師至少都要滿足四類客戶的需求。　　我所遇到的前端程序員分兩種：　　第一種一直在問：如何學習前端？　　第二種總說：前端很簡單，就那么一點東西。　　我從沒有聽到有人問：如何做一名優秀、甚至卓越的WEB前端工程師...

rubyshen 2019-08-29 12:47 評論0 收藏0
如何成為一名優秀的web前端工程師（前端攻城師）？

摘要：我從沒有聽到有人問如何做一名優秀甚至卓越的前端工程師。作為一個優秀的前端工程師還需要深入了解以及學會處理的這些缺陷。再者，優秀的前端工程師需要具備良好的溝通能力，因為前端工程師至少都要滿足四類客戶的需求。　　我所遇到的前端程序員分兩種：　　第一種一直在問：如何學習前端？　　第二種總說：前端很簡單，就那么一點東西。　　我從沒有聽到有人問：如何做一名優秀、甚至卓越的WEB前端工程師...

mingzhong 2019-08-01 17:00 評論0 收藏0

發表評論

登陸后可評論

0條評論

張金寶

男|高級講師

我要關注我要私信

TA的文章

CSS選擇器

閱讀 2054·2019-08-30 15:52
css 阻斷合并及其他影響

閱讀 2445·2019-08-29 18:37
浮動(Float)

閱讀 798·2019-08-29 12:33
magix中的2種事件綁定方式

閱讀 2845·2019-08-29 11:04
NPM酷庫051：xml2js，解析XML格式數據

閱讀 1535·2019-08-27 10:57
Node 引入 ESM 新方案

閱讀 2101·2019-08-26 13:38
瀏覽器輸入url到發起http請求所經歷的過程

閱讀 2768·2019-08-26 12:25
JavaScript對象內部屬性及其特性總結

閱讀 2454·2019-08-26 12:23

国产xxxx99真实实拍_久久不雅视频_高清韩国a级特黄毛片_嗯老师别我我受不了了小说

資訊專欄INFORMATION COLUMN

上云采購季！| 2核2G4M爆款云服務器低至59元/年，更有多臺、長期優惠，快來選購！

如何成為一名優秀的工程師（語義篇）

相關文章

如何成為一名優秀的程序員

**如何成為一名優秀的web前端工程師（前端攻城師）？**

**如何成為一名優秀的web前端工程師（前端攻城師）？**

**如何成為一名優秀的web前端工程師（前端攻城師）？**

發表評論

0條評論

張金寶

男|高級講師

TA的文章

CSS選擇器

css 阻斷合并及其他影響

浮動(Float)

magix中的2種事件綁定方式

NPM酷庫051：xml2js，解析XML格式數據

Node 引入 ESM 新方案

瀏覽器輸入url到發起http請求所經歷的過程

JavaScript對象內部屬性及其特性總結

最新活動

資訊專欄INFORMATION COLUMN

上云采購季！| 2核2G4M爆款云服務器低至59元/年，更有多臺、長期優惠，快來選購！

如何成為一名優秀的工程師（語義篇）

相關文章

發表評論

0條評論

男|高級講師

TA的文章

最新活動

上云采購季！| 2核2G4M爆款云服務器低至59元/年，更有多臺、長期優惠，快來選購！