Miles' Blog

調整程式碼風格（Coding Style）

發表於 2018-01-02 分類於 IT鐵人賽， 2018 Disqus：

雖然程式碼風格跟設計沒有關係，但是程式碼風格不一致，對理解程式是一個很大的阻礙。調整程式碼風格，是不會影響功能的，因此很適合拿來當重構的暖身。

閱讀全文 »

Monolog（3）－－Formatter 與 Handler 之間的關係

發表於 2018-01-01 分類於 IT鐵人賽， 2018 Disqus：

打開 Monolog 的資料夾，會發現除了昨天提到的 Logger 與 Handler 之外，還有幾個沒提到的角色，如 Formatter 或是 Processor。

今天我們就來看看 Formatter 裡面做了什麼事。

從使用它到了解它

首先當然先看看它如何使用！我們可以從先從 Handler\HandlerInterface 找到相關的實作：

interface HandlerInterface
{
    public function setFormatter(FormatterInterface $formatter);
}

這裡可以注意到，它的設計是「抽象依賴抽象」，這符合依賴反轉原則；並且它的行為設計上，是做成抽象與抽象之間的一對一關係（因為它用 set，而不是 push），所以它實際上是實作了 Bridge Pattern。關係圖如下：

@startuml
Interface Handler\HandlerInterface {
  + setFormatter(f: FormatterInterface)
}
Interface Formatter\FormatterInterface
Class Handler\ConcreteHandler
Class Formatter\ConcreteFormatter
Handler\HandlerInterface -> Formatter\FormatterInterface
Handler\HandlerInterface <|-- Handler\ConcreteHandler
Formatter\FormatterInterface <|-- Formatter\ConcreteFormatter
@enduml

它們的實作之間並沒有直接耦合，而是透過抽象介面耦合；換句話說，只要物件有實作抽象介面的話，它就能正常的介接使用。

我們先來看昨天使用的 Handler\StreamHandler 裡面是使用了哪種 Formatter。追一下程式碼，會發現在 Handler\AbstractHandler 裡面：

abstract class AbstractHandler implements HandlerInterface
{
    public function getFormatter()
    {
        if (!$this->formatter) {
            $this->formatter = $this->getDefaultFormatter();
        }

        return $this->formatter;
    }

    protected function getDefaultFormatter()
    {
        return new LineFormatter();
    }
}

因此預設會是 LineFormatter，當然不是發 Log 到 Line，而是指單行的 log。

再來我們來寫一個測試程式如下：

$logger = new \Monolog\Logger('name');

$handler = new \Monolog\Handler\StreamHandler('php://stdout', \Monolog\Logger::DEBUG);

$logger->pushHandler($handler);

$logger->warning('test');

這樣輸出的結果應該會如下：

[2018-01-15 18:10:12] name.WARNING: test [] []

剛有提到，我們應該能自由地抽換 Formatter 才對，我們來換成 JsonFormatter 試看看：

$handler->setFormatter(new \Monolog\Formatter\JsonFormatter());

輸出就會變成 JSON 了：

{"message":"test","context":[],"level":300,"level_name":"WARNING","channel":"name","datetime":{"date":"2018-01-15 18:16:28.438148","timezone_type":3,"timezone":"UTC"},"extra":[]}

自由組合 1+1 = $50

相信大家都去過黃色拱門，Formatter 與 Handler 之間的關係事實上就跟銅板輕鬆點很像，可以依需求任意搭配兩區的餐點，而店員都可以接受並結帳。

我們也可以使用 Slack 配 Json 或是 Mail 配 Html 等等，完全自由配。

參考資料

SOLID 之依賴反轉原則（Dependency inversion principle） - 看到 code 寫成這樣我也是醉了，不如試試重構？

Delivery

發表於 2018-01-01 分類於 IT鐵人賽， 2018 Disqus：

截至目前為止，應用程式該有基本功能都已經完備了，再來就是最後一哩路了－－交付。

閱讀全文 »

準備工作的簡短回顧（一）

發表於 2018-01-01 分類於 IT鐵人賽， 2018 Disqus：

在拿到程式碼的時候，我們並不是立刻把程式碼砍掉重練，而是先做一連串的準備工作：

閱讀全文 »

Monolog（2）－－從使用它到了解它

發表於 2017-12-31 分類於 IT鐵人賽， 2018 Disqus：

在開始拆解前，首先我們先了解該如何使用它，官方提供的 Basic Usage 如下：

use Monolog\Logger;
use Monolog\Handler\StreamHandler;

// create a log channel
$log = new Logger('name');
$log->pushHandler(new StreamHandler('path/to/your.log', Logger::WARNING));

// add records to the log
$log->addWarning('Foo');
$log->addError('Bar');

以下為方便說明，皆把 Monolog namespace 省略

通常好的函式庫，從範例就能快速了解函式庫的基本架構。這段程式碼可以發現主要的核心物件是 Logger，而另外一個依附在 Logger 上的物件 Handler\StreamHandler。Handler\StreamHandler 實作了 Handler\HandlerInterface，這也是 pushHandler 方法所限制的物件型別。

而後面兩行新增 log 的方法，翻一下原始碼，會發現是由 Logger 轉接到 Handler\StreamHandler 和其他被加入的 Handler 上。

通常兩個物件如果是抽象層依賴的話，有可能會是 Bridge Pattern 或是 Observer Pattern；而 Bridge Pattern 又通常會是建構時期決定依賴的物件為何，因此 Logger 與 Handler\HandlerInterface 的關係基本上比較像是 Observer Pattern。關係圖如下：

@startuml
Class Logger {
  + pushHandler(h: Handler\HandlerInterface)
  + popHandler(): Handler\HandlerInterface
}
Class Handler\StreamHandler
Class Handler\HandlerInterface
Logger -> Handler\HandlerInterface
Handler\HandlerInterface <|-- Handler\StreamHandler
@enduml

Logger 有些行為也正好是 Observer Pattern 的特色：

沒有 Handler 一樣能 work
可以動態追加或移除 Handler，Monolog 是使用 Array Stack 實作

使用 Observer Pattern 的好處很明確，實作儲存 log 的方法有千百種，加上寫 log 行為並不會太複雜（info、error 等），自從 PHP 有 PSR-3 後，行為又更加明確了。這樣的情境下使用 Observer Pattern 更能看出套用 Pattern 的好處。