軟體開發:你不會用到

最近在從事軟體開發時,常有兩種荒謬的感覺。

情境一


為了滿足新的需求,我需要寫一個類別。
總覺得可以多寫幾個函式,創造出某種漂亮的架構…算了,我先寫幾個蠢函式來用好了。
(動手寫code)…。
咦?突然就結束了。已經成功了,這幾個蠢函式已經滿足所有需求了。
不想進一步去改寫成什麼漂亮架構了。

真荒謬,我是不是只做了半成品就交差?

情境二


為了滿足新的需求,我需要寫一個類別。
總覺得可以多寫幾個函式,創造出某種漂亮的架構…算了,我先寫幾個蠢函式來用好了。
(動手寫code)…。
啊,解決一部份問題了,不過這幾個蠢函式果然不夠用。
只好把這幾個蠢函式全部刪掉重寫了。
(動手寫code)…。
多寫幾個函式,創造出漂亮的架構了。解決問題了!
我是不是一開始不應該寫那幾個蠢函式啊?
明明感覺不太夠用卻還繼續寫,果然全部刪掉重寫了。浪費了一些時間。

真荒謬,每次都硬從蠢函式開始寫。根本是刻意在浪費時間?

思考這個問題的時候,找到了一篇相關的文章。
翻譯出來跟各位分享。
原文:You Arent Gonna Need It


你不會用到

「你不會用到」是極限編程的一種實踐:

「永遠在你真正需要的時候才去實作,別預估需要就去實作。」

即使你非常、非常、非常確定你等一下就會需要這個功能,也不要現在就實作。事情通常有兩種發展:
一、你發現根本不需要
二、你發現真正需要的跟一開始預估的差很多

這不是在說軟體的彈性不重要。這是在說,你不應該根據你以為晚點需要的東西去過度設計。

這種實踐有兩個主要理由:

* 節省時間。因為你沒去寫那些最後發現並不需要的程式碼。
* 讓程式碼更漂亮。因為你沒讓一開始那多少有點弄錯的預估去汙染你的程式碼。

RonJeffries提出一個情境說明:
你正在寫某個類別。你剛加上幾個你需要的功能。你知道你晚點會需要其他幾個功能。如果你現在不需要,就不要現在加進去。
為什麼?

「好吧,Sam,你幹嘛現在加上去?」
「呃,Ron,這會讓我們節省一些時間啊。」

除非你我活在平行宇宙,不然你無法現在多做事情,卻在「節省」時間。除非晚點做這件事比現在做更花時間。所以你的意思是:

「如果現在多花點功夫做好它,最後總共花的時間會比較少。」

除非你我的專案長不一樣,不然專案都是那副德性:現在要做的事情總是有夠多。在事情很多的時候還想做更多,是非常糟糕的。

然後除非你我的腦袋構造長不一樣,不然很有可能你最後會發現根本用不著,或是你用到的時候必須重寫、修正這些程式碼。不管哪個發生了,總體來看你都是在浪費時間,還導致你到時無法把真正需要的東西加進去。

「可是,Ron,我現在知道怎麼做,晚點我可能會忘記。」
「所以,Sam,你是在說你寫的類別複雜到你本人也無法維護?」

保持簡單。如果你需要,晚點再加上去即可。如果你不需要,根本別費這功夫了。今天就好好休息吧。

(Photo via Héctor García, CC licensed.)

Composer設計原理與基本用法

相信有在用PHP的朋友近年來常聽到composer這個套件管理工具。
它到底是做什麼用的?又是為了解決什麼問題而存在呢?
要瞭解這個,得先從歷史開始說起…。

PHP最早讀取套件的方法

初學PHP時,最早會面對的問題之一就是require與include差別何在?
require_once與include_once又是什麼?
弄懂這些問題之後,如果不使用framework,直接開發,便常出現類似這樣的code:

// whatever.php
// 這檔案需要用到幾個類別
require 'xxx_class.php';
require 'yyy_class.php';
require 'zzz_class.php';
// ...

然後在其他檔案會出現:

// another.php
// 這檔案需要用到幾個類別
require 'yyy_class.php';
require 'zzz_class.php';
// ...

這樣的結果,會產生至少兩個問題:
1. 許多檔案用到同樣幾個class,於是在不同地方都需要載入一次。
2. 當類別多了起來,會顯得很亂、忘記載入時還會出現error。

那麼,不如試試一種懶惰的作法?
寫一個php,負責載入所有類別:

// load_everything.php
require 'xxx_class.php';
require 'yyy_class.php';
require 'zzz_class.php';
require 'aaa_class.php';
require 'bbb_class.php';
require 'ccc_class.php';

然後在其他檔案都載入這支檔案即可:

require 'load_everything.php'

結果新問題又來了:當類別很多的時候,隨便一個web page都會載入一堆code,吃爆記憶體,怎麼辦呢?

__autoload

為了解決這個問題,PHP 5開始提供__autoload這種俗稱「magic method」的函式。
當你要使用的類別PHP找不到時,它會將類別名稱當成字串丟進這個函式,在PHP噴error投降之前,做最後的嘗試:

// autoload.php
function __autoload($classname) {
    if ($classname === 'xxx.php'){
        $filename = "./". $classname .".php";
        include_once($filename);
    } else if ($classname === 'yyy.php'){
        $filename = "./other_library/". $classname .".php";
        include_once($filename);
    } else if ($classname === 'zzz.php'){
        $filename = "./my_library/". $classname .".php";
        include_once($filename);
    }
    // blah
}

也因為PHP這種「投降前最後一次嘗試」的行為,有時會讓沒注意到的人困惑「奇怪我的code怎麼跑得動?我根本沒有require啊..」,所以被稱為「magic method」。
如此一來,問題似乎解決了?
可惜還是有小缺點..,就是這個__autoload函式內容會變得很巨大。以上面的例子來說,一下會去根目錄找、一下會去other_library資料夾、一下會去my_library資料夾尋找。在整理檔案的時候,顯得有些混亂。

spl_autoload_register

於是PHP從5.1.2開始,多提供了一個函式。
可以多寫幾個autoload函式,然後註冊起來,效果跟直接使用__autoload相同。
現在可以針對不同用途的類別,分批autoload了。

spl_autoload_register('my_library_loader');
spl_autoload_register('other_library_loader');
spl_autoload_register('basic_loader');

function my_library_loader($classname) {
    $filename = "./my_library/". $classname .".php";
    include_once($filename);
}
function other_library_loader($classname) {
    $filename = "./other_library/". $classname .".php";
    include_once($filename);
}
function basic_loader($classname) {
    $filename = "./". $classname .".php";
    include_once($filename);
}

每個loader內容可以做很多變化。可以多寫判斷式讓它更智慧、可以進行字串處理…。
自動載入類別的問題終於解決了…。

但是光上面的code也有15行,而且在每個project一定都會寫類似的東西。有沒有辦法自動產生這15行呢?
我的願望很簡單,我告訴你,反正我有my_library資料夾跟other_library資料夾,你自己進去看到什麼類別就全部載入好不好…?
阿不對,全部載入剛又說效能不好,那你進去看到什麼就全部想辦法用spl_autoload_register記起來好不好…?
我懶得打15行了,我只想打這幾個字:

$please_autoload = array( 'my_library', 'other_library');

可不可以發明一個工具,去吃$please_autoload這個變數,然後自己想辦法載入一切啊…?

ㄟ等等,我連php程式碼都懶得打了,在web領域JSON格式更簡潔。允許我這樣打,好嗎?

{
    "autoload": [
        "my_library",
        "other_library"
    ]
}

然後誰來個工具幫我產生一大串autoload相關的php程式碼吧…,可以嗎?

可以。

Composer登場

首先,裝好composer(本文不介紹如何安裝。)
再來,建立一個composer.json檔,裏面輸入這些:

{
    "autoload": {
        "classmap": [
            "my_library",
            "other_library"
        ]
    }
}

比原本希望的多打了一些字,不過差不多。
再來,在terminal輸入

composer install

執行成功之後,你會看到一個vendor資料夾,內含一個autoload.php。
沒錯,跟你夢想的一樣。你只要載入這個檔案:

require 'vendor/autoload.php';

你需要的所有類別,都會在適當的時候、以適當的方式自動載入。
php再也不會噴error說你「類別尚未定義」了!
這vendor資料夾裏面的一切,都只是php code而已,並沒有特別神奇的地方。只要去看autoload.php的原始碼,就能知道composer到底寫了哪些php code給你。

ㄟ等等,我寫的類別都放在my_library裏面了,other_library都是網路上copy下來的現成類別。我想要用Google API的Client類別、Doctrine資料庫管理抽象層類別、還有guzzlehttp的發送request類別。
我連去下載這些檔案、然後丟進這個資料夾都懶得做了,我根本不想手動建立other_library這個資料夾。composer真那麼神…不如連下載都幫我自動下載?可以嗎?

可以。

查詢一下那幾個套件在「https://packagist.org/」的名稱、還有你需要的版本號。
把剛剛的composer.json改成這樣:

{
    "require": {
        "google/apiclient": "1.0.*@beta",
        "guzzlehttp/guzzle": "~4.0",
        "doctrine/dbal": "~2.4"
    },

    "autoload": {
        "classmap": [
            "my_library"
        ]
    }
}

然後’composer install’指令除了自動載入你的類別之外、還會自動下載你需要的類別、然後自動載入它們。
一樣require ‘vendor/autoload.php’就可以了。composer實在是太棒了。

其實composer解決的問題不只這樣。
類別多了起來之後,各種程式語言都提供namespace功能協助分類。
在有namespace的情況下,PHP社群與composer是如何解決自動載入的問題呢?
這些比較進階的內容,下回分曉。

Laravel確保資料庫正確:transaction與lock

最近在開發上碰到一個request要執行的任務比較多、後面的任務牽扯到第3方API因此有可能fail,此時前面執行的任務需要將資料回溯的問題。

另外還碰到race condition的資料庫資料同步問題:當兩個使用者同時按下某個按鈕時,資料庫的資料會出現問題。

前者需要利用資料庫的transaction功能確保任務全執行或是全不執行、後者需要用到lock/unlock將某些資料表鎖住不讓其他程序修改。

在Laravel中,該怎麼做呢?查了一下,大概整理出來。

Transaction

有兩種作法,第1種使用closure:

DB::transaction(function()
 {
      // do something
 });

第2種也許比較親切,

try {
    DB::connection()->getPdo()->beginTransaction();
    // database queries here
    DB::connection()->getPdo()->commit();
} catch (\PDOException $e) {
    // Woopsy
    DB::connection()->getPdo()->rollBack();
}

在Laravel facades的協助下,這兩種作法都滿簡潔有力的。
要注意的是,在第1種情況下,若是closure要使用到執行closure之前定義的變數,記得使用關鍵字「use」:

DB::transaction(function() use ($user_id)
{
    // do something with $user_id
});

Lock

要保證一次只有一個程序在修改某幾張資料表,以Mysql來說有LOCK跟UNLOCK可以用。Laravel並沒有直接支援此功能,不過這樣變通就可以了:

DB::connection()->getPdo()->exec( 'LOCK TABLES items WRITE, accounts WRITE, orders WRITE' );
// blah blah
DB::connection()->getPdo()->exec( 'UNLOCK TABLES' );

這邊一次用WRTIE LOCK鎖住三張資料表。當然也有READ LOCK可以使用。

在新創公司,我的軟體開發習慣。

在startup工作,經常是在經歷會員數從0到1000、軟體從無到有的過程。

我在這個過程寫code的習慣是這樣的:

  1. 聽完需求,動手隨便寫、能跑就好、有成就感就好、什麼原則都不管、不花時間討論什麼偉大的架構或是未來
  2. 開始覺得不對勁、不整理code之後會死很慘,重構一部份code、補幾個測試
  3. 覺得繼續改善code只是在浪費時間,繼續往下快樂亂寫
  4. 重複以上這個過程

一個網站的beta版,我通常可以在2-4週內讓它上線。
在這個過程中寫出的某些code,老師看到了會很生氣。

其實,不是真的不理會任何原則。我奉行的核心是這兩條:

* 過早最佳化是萬惡的根源。

(Premature optimization is the root of all evil)

* 軟體開發真正的生產力,只能用它帶來的商業價值去衡量。

(Any true measure of software development productivity must be based on delivered business value)

至於怎麼定義「premature optimization」?
如果沒有前輩指引的話,這件事當然就是憑直覺了,所以想怎麼寫就怎麼寫。

這個循環進行幾次之後,會變得更有經驗,下一次開始專案時,在(1. )的所謂「憑直覺亂寫」,實際上會直接寫出更有經驗、更成熟的架構。

就商業上來說,跟現在流行的Lean Startup精神也搭配得很好。

沒經驗就是沒經驗、還不確定的需求沒有辦法針對它去優化、沒碰到問題不會知道如何處理。
不要花太多時間去處理你根本不太確定的事情。

最後附上Jason Fried與DHH所合著Getting Real中的一段話


最棒的設計師跟軟體工程師,並不是技術最好、手指最靈巧的那些人,也不是把Photoshop跟vim用得出神入化的人。他們是能夠判斷哪些事情根本不重要的人。真正的生產力是從這裡來的。

你大部份的時間都花在根本不重要的事情上。如果你能停止這些工作、思考哪些事情根本不重要,你馬上會發揮你從來沒想過的生產力。只要別把精力用在不重要的事情上就行了。

(Photo via Sharon, CC licensed)

Laravel之父:學習出色的design patterns!

Laravel之父Taylor Otwell在2012年接受採訪時談論了自己寫程式的習慣、並表示他最想給軟體工程師的建議就是「學習出色的design patterns」。
採訪原文在:
PHP Interview With Taylor Otwell The Creator Of Laravel PHP 5.3 Framework – Learn Good Design Patterns

Taylor Otwell最讓人驚豔之處在於:他本來是 .NET 工程師、一本PHP書都沒讀過就把Laravel創造出來了!

原文總共有30個採訪問題,後19個牽扯到技術細節。
本文節錄翻譯前11個問題與各位分享,讓大家更瞭解Laravel之父是怎麼樣的人。


跟我們談談你自己

我的名字是Taylor Otwell,我是住在美國的一位26歲工程師。

你如何開始PHP的

一開始,我是為了快速測試一些產品構想才在晚上寫PHP。我幾乎一直在思考新的產品構想,PHP能讓我非常快速地實作並且測試它們。

你能給PHP初學者的最好建議

見下文。

如果有人想成為更棒的PHP工程師,你會怎麼建議?

學習出色的design patterns。這不只適用在PHP。你可以在任何程式語言使用這些pattern。尤其是S.O.L.I.D. patterns 。把這五個徹底學好。這五個patterns會把你帶到新的境界,我每次寫code幾乎都在想這五個。

你讀過最棒的PHP書籍

我沒有讀過任何一本PHP的書。

你最推崇的PHP部落格或是學習資源

我沒有在看特定的PHP部落格。但是我會每天逛Hacker News,看看現在趨勢何在。

你用什麼IDE

我現在用Sublime Text 2的 “dev” 版本。我愛它!我不能想像沒有Sublime Text要怎麼寫code。

你怎麼debug你的PHP code?

我試著徹底對我寫的所有PHP code做單元測試,特別是像Laravel這樣的函式庫。這在之後會省下很多時間,因為我不用在改變某些地方之後重新測試其他部份。沒辦法寫測試的地方,我會從寫「echo」開始。我的測試工具有PHPUnit跟Mockery。

你最欽佩的PHP工程師?為什麼?

在PHP界,我最欽佩Fabien Potencier。這傢伙是寫code機器、永遠用銳利的眼光去追求扎實的架構、同時維護許多大型PHP專案(Symfony與其元件、Swift Mailer、Twig、Silex等等)、經營Sensio實驗室。雖然Symfony跟Laravel非常不同,我還是欽佩Fabien更勝於其他PHP工程師。

你是任何PHP社團的成員嗎?有的話,能談一談嗎?

我目前沒有加入任何PHP社團。不過我正在準備搬去市中心,也許我可以開一個新社團!

你之前是 .NET工程師,為什麼你選擇用PHP而不是別的語言來建造框架

我選PHP因為它幾乎在所有 shared web hosts都能用,而且他的官網說明文件很棒。雖然跟別的語言相比,PHP有點缺陷,但是它的易用以及完整的文件讓它非常適合用來快速開發應用程式。

研讀Laravel原始碼!

用了一陣子的CodeIgniter,慢慢感覺到這個有點年紀framework的極限。
包括PHP社群現在廣泛使用的套件管理Composer、PHP 5.3以後出現的namespace、到處都是全域物件(導致要一直打$this->blah)、缺乏單元測試的整合。
搜尋了一下,現在Laravel有很精美的template engine以及ORM,決定開始學習這個框架。

以前學習新框架都是翻官方文件、同時試著實作一個小project出來,常常有「不夠深入瞭解這套框架」的感覺。
這次試著從閱讀source code開始,每讀到一個段落就做筆記、評論、反覆翻閱官方文件、試著實作小功能。

下面就是我目前的進度,向對Laravel有興趣的各位分享!
Laravel原始碼分析

(Photo via Adam Ward, CC licensed.)

Rails之父:我怎麼學會寫程式的?

DHH,本名David Heinemeier Hansson,Basecamp合夥人、Google 2005年度駭客、業餘賽車手,他最知名的身份是網路開發框架Ruby on Rails的發明者。

DHH曾在部落格發表他學寫程式的心得:

https://signalvnoise.com/posts/2582-how-do-i-learn-to-program

看過之後覺得獲益良多,特此翻譯出來和大家分享。


我怎麼學會寫程式的?

我花了二十幾年才真的學會怎麼寫程式。不是因為我嘗試的不夠,而是因為我一直用錯誤的方法。我以前都看著那些教材、範本照做,寫出一些我根本沒興趣繼續往下寫的東西。這是為了學習而學習。

我知道這方法對有些人管用,這些人就是很樂意學習新東西。我真羨慕你們。但這對我不管用,而且我知道很多人也沒辦法用這種方式學習。

為了解決鳥事而寫程式———對我來說這才管用。寫程式是因為非這麼做不可。寫程式是因為我他媽的在乎自己所寫的東西,而且我希望它越快完成越好。

這就是我學寫Ruby的方法。我把目標定為,用Ruby把Basecamp寫出來。當你因為一個目標而去學習,每件事的先後順序就變得非常清楚。我到底該做什麼才能讓這幾個訊息順利在Ruby執行?哦,我需要在這裡加一個迴圈。哦,我需要在哪裡抓些資料庫的資料出來。

決定目標的當下,你的點子就完成一半了、而且你還知道了該怎麼做。

簡單來說,就是從一些確實的東西開始做起,接著讓時鐘發出「滴」聲,然後讓它發出「答」聲。

by 阿川先生