Separate Query from Modifier

จุดประสงค์

เมื่อ function หนึ่งตอบคำถาม และ เปลี่ยนแปลงโลกในฐานะผลข้างเคียงไปด้วย caller ก็สูญเสียอิสระที่จะแค่ถามเฉย ๆ ให้แยกงานสองอย่างนี้ออกจากกัน: query ที่คืนค่าและไม่แตะต้องอะไรเลย และ command ที่ทำงานเปลี่ยนแปลงและไม่คืนค่าอะไร ตอนนี้ caller ที่ต้องการแค่คำตอบก็สามารถเรียก query ได้โดยไม่ไปกระตุ้นผลข้างเคียง

Code Smell

คุณอยากเรียก function เพื่ออ่านผลลัพธ์เฉย ๆ อาจจะใน test ใน log หรือใน assertion แต่ทำไม่ได้ เพราะเรียกทีไรก็พ่วงการส่งอีเมล การเปลี่ยนค่า field หรือการเลื่อน cursor ไปด้วยทุกที signature จึงโกหกเรื่องต้นทุน คือหน้าตาเหมือนคำถาม แต่แอบเป็นการกระทำ function ไหนที่คืนค่าพร้อมกับสร้าง side effect ที่สังเกตเห็นได้ ตัวนั้นคือเป้าหมายของท่านี้

ก่อน → หลัง

function ตัวนี้สแกนคะแนน คืนค่าสูงสุด และแอบยิงการแจ้งเตือนเมื่อคะแนนสูงสุดข้ามเกณฑ์ เราแยกออกเป็น query บริสุทธิ์ชื่อ highScore กับ command ชื่อ alertOnHighScore

// Before
function findHighScore(scores: number[]): number {
  let highest = 0;
  for (const s of scores) {
    if (s > highest) highest = s;
  }
  if (highest > 9000) {
    sendAlert(`New record: ${highest}`);
  }
  return highest;
}

// After
function highScore(scores: number[]): number {
  return scores.reduce((highest, s) => (s > highest ? s : highest), 0);
}

function alertOnHighScore(scores: number[]): void {
  if (highScore(scores) > 9000) {
    sendAlert(`New record: ${highScore(scores)}`);
  }
}

# Before
def find_high_score(scores):
    highest = 0
    for s in scores:
        if s > highest:
            highest = s
    if highest > 9000:
        send_alert(f"New record: {highest}")
    return highest

# After
def high_score(scores):
    return max(scores, default=0)

def alert_on_high_score(scores):
    if high_score(scores) > 9000:
        send_alert(f"New record: {high_score(scores)}")

// Before
func FindHighScore(scores []int) int {
    highest := 0
    for _, s := range scores {
        if s > highest {
            highest = s
        }
    }
    if highest > 9000 {
        sendAlert(fmt.Sprintf("New record: %d", highest))
    }
    return highest
}

// After
func HighScore(scores []int) int {
    highest := 0
    for _, s := range scores {
        if s > highest {
            highest = s
        }
    }
    return highest
}

func AlertOnHighScore(scores []int) {
    if h := HighScore(scores); h > 9000 {
        sendAlert(fmt.Sprintf("New record: %d", h))
    }
}

// Before
fn find_high_score(scores: &[i32]) -> i32 {
    let mut highest = 0;
    for &s in scores {
        if s > highest {
            highest = s;
        }
    }
    if highest > 9000 {
        send_alert(&format!("New record: {highest}"));
    }
    highest
}

// After
fn high_score(scores: &[i32]) -> i32 {
    scores.iter().copied().max().unwrap_or(0)
}

fn alert_on_high_score(scores: &[i32]) {
    let h = high_score(scores);
    if h > 9000 {
        send_alert(&format!("New record: {h}"));
    }
}

flowchart LR
  subgraph Before["Before"]
    A["findHighScore()<br/>returns the max<br/>AND logs an alert"]
  end
  subgraph After["After"]
    B["highScore()<br/>pure query"]
    C["alertOnHighScore()<br/>command"]
  end
  Before -.->|"Separate Query from Modifier"| After

function ผสมหนึ่งตัวกลายเป็น query ที่บริสุทธิ์บวกกับ command

กลไกการทำงาน

คัดลอก function แล้วตั้งชื่อสำเนาให้เป็น query ที่บริสุทธิ์ — ตามธรรมเนียมจะเป็นคำนามหรือชื่อสไตล์ get/is ที่สัญญาว่าให้แค่คำตอบ
ตัด side effect ทั้งหมดออกจากสำเนาฝั่ง query ให้เหลือแค่การคำนวณค่า แล้วคืนค่านั้นออกไป
หา caller แต่ละจุดของ function เดิม จุดที่ caller ใช้ค่าที่คืนกลับมา ให้สลับไปใช้ query
ปล่อยให้ function เดิมเหลือแค่ side effect และให้เรียก query ตัวใหม่แทนการคำนวณซ้ำเอง
รัน test หลังจากย้าย caller แต่ละจุดข้ามไปแล้ว
ถ้าตอนนี้ function เดิมคืนค่าที่ไม่มีใครใช้แล้ว ให้เปลี่ยนเป็นไม่คืนค่าเลย signature ของ command จะได้ซื่อสัตย์

ใช้เมื่อไหร่ / ข้อแลกเปลี่ยน

ใช้ท่านี้เมื่อใดก็ตามที่ function ที่มีค่าคืนกลับยังเปลี่ยนสถานะ ทำ I/O หรือยิงอีเวนต์ด้วย — และโดยเฉพาะก่อนคุณจะเขียน test เพราะ query ที่บริสุทธิ์ตรวจ assert ได้ง่ายมาก การแยกที่สะอาดยังทำให้ query ปลอดภัยที่จะเรียกซ้ำ ๆ หรือ cache ได้

ต้นทุนคือ caller ที่ต้องการทั้งสอง behavior จริง ๆ ต้องเรียกสองครั้ง และค่าอาจถูกคำนวณสองรอบ ปกติการคำนวณซ้ำนั้นราคาถูก ถ้าไม่ถูกก็คำนวณครั้งเดียวแล้วส่งผลลัพธ์ต่อไป บาง operation เป็น atomic โดยธรรมชาติ เช่น pop ที่คืนค่าและลบในขั้นเดียว การฝืนแยกจะเปิดช่องให้เกิด race condition กรณีแบบนั้นให้จงใจเก็บไว้ด้วยกัน

เนื้อหาที่เกี่ยวข้อง

🧹 Command-Query Separation

การรีแฟกเตอร์นี้คือรูปแบบเชิงปฏิบัติของหลักการ Command-Query Separation ของ Bertrand Meyer (Object-Oriented Software Construction, 1988): method หนึ่งควรเปลี่ยนสถานะหรือคืนผลลัพธ์อย่างใดอย่างหนึ่ง แต่ไม่ใช่ทั้งสองอย่าง เมื่อคุณเชื่อใจได้ว่า query ปราศจากผลข้างเคียง คุณก็อ่าน code ได้โดยไม่ต้องกลัวว่าการเหลือบมองจะไปกระตุ้นการเปลี่ยนแปลง