Leon's Blogging

Coding blogging for hackers.

Lib vs Service Object

| Comments

大家都知道,fat models, skinny controllers
但要將 code 放在哪邊,才會比較好維護?這就有很多方式了

/lib:

  • It is not coupled to my app’s domain models.
  • It can be reused on other projects.
  • It can potentially become its own gem. Thus, putting it in lib/ is the first step in that direction.

簡單的來說,/lib 放的比較像是,很多 project 都可以重複使用,並沒有專屬某個 project,並且可以包成一個 gem 給大家使用。

舉例: FacebookAuth GithubAuth

/app/services:

  • They tend to know a decent amount about the inner workings of domain models.
  • Perform work that is specific to business domain in my app.
  • Tend to be coupled to specific models.

/app/services 比較像是,專屬於某個 project,並且與 business logic 息息相關,就像是某個服務一樣。

舉例: UserAuthenticator 開立發票 寄密碼提醒信

Service Object使用時機

  • The action is complex (e.g. closing the books at the end of an accounting period)
  • The action reaches across multiple models (e.g. an e-commerce purchase using Order, CreditCard and Customer objects)
  • The action interacts with an external service (e.g. posting to social networks)
  • The action is not a core concern of the underlying model (e.g. sweeping up outdated data after a certain time period).
  • There are multiple ways of performing the action (e.g. authenticating with an access token or password). This is the Gang of Four Strategy pattern.

大致上就是

  1. 邏輯複雜
  2. 牽扯到很多 model 關係 (ex: 兩個 model 的資料運算)
  3. 與外部服務相關 (ex: slack 通知)
  4. 與核心無關 (ex: 定時清理過期數據)
  5. 會經常重複使用

約定

  • 一個Service Object 只做一件事。
  • 每個Service Object 一個文件,統一放在app/services 目錄下。
  • 命名採用動作,比如SignEstimate ,而不是EstimateSigner 。
  • instance級別實現兩個接口,initialize負責傳入所有依賴,call負責調用。
  • class級別實現一個接口call,用於簡單的實例化Service Object然後調用call 。
  • call的返回值默認為true/false,也可以有更複雜的形式,比如StatusObject 。

以上約定主要都是看個人習慣,也有人會放在 app/controller 底下
A Way to Organize POROs in Rails

concern vs service object

  • concern
  • 簡單說就是,有許多 model 有共用的邏輯片段,可以拆出來
  • service object
  • 與 concern 不同的地方是,存放的是比較完成的 code,簡單多你丟什麼給它,他就會丟相對應的資料給你。

  • 兩個搭配使用

  • 將許多 service object 搬到 concern

參考文件:
什麼時候使用Concerns,什麼時候使用Services?
Service Object 整理和小結
Gourmet Service Objects
7 Patterns to Refactor Fat ActiveRecord Models
Rails code 整理系列- Service Object 初探
Rails service objects vs lib classes
Lib Folder vs. Services in Rails
Service Objects 整理架構
Using Services to Keep Your Rails Controllers Clean and DRY
Slimming Down Your Models and Controllers with Concerns, Service Objects, and Tableless Models

Comments