คำศัพท์ (หรือ“ รูปแบบ”) สำหรับ“ ทำอะไรบางอย่างถ้ายังไม่ได้ทำ” [ปิด]

ฟังดูพื้นฐานดีฉันรู้ แต่เมื่อเร็ว ๆ นี้มีเพื่อนร่วมงานคนหนึ่งบอกฉันว่าวิธีการที่เรียกว่าstartHttpServerซับซ้อนเกินไปที่จะเข้าใจเพราะมันเริ่มเซิร์ฟเวอร์เท่านั้นหากยังไม่ได้ทำงาน ฉันพบว่าฉันมีปัญหาเมื่อฉันตอบว่า "จริงจังฉันทำสิ่งนี้มานานหลายสิบปีแล้ว - มันเป็นรูปแบบทั่วไปในการเขียนโปรแกรม" บ่อยครั้งกว่าที่ฉันจะยอมรับว่าเขากลับมาพร้อมกับเอกสารหลักฐานบางอย่างที่แสดงว่าชุมชนการเขียนโปรแกรมทั้งหมดอยู่เบื้องหลังมุมมองของเขาและฉันก็รู้สึกอาย

คำถาม : มีรูปแบบการออกแบบที่จัดทำเป็นเอกสารไว้เบื้องหลังแนวคิดของวิธีการที่ไม่ใช้งานหรือไม่หากการกระทำที่ต้องการมีผลบังคับใช้แล้วหรือไม่? หรือถ้าไม่ใช่รูปแบบจะมีชื่อด้วยหรือไม่? และถ้าไม่มีมีเหตุผลใดที่คิดว่ามันซับซ้อนเกินกว่าที่จะพิจารณาการเขียนวิธีในลักษณะนี้?

ดังที่ NickWilliams ได้กล่าวไปแล้ว : แนวคิดของ OP อธิบายเรียกว่าidempotent (นามIdempotency ) เป็นการปฏิบัติทั่วไปโดยเฉพาะอย่างยิ่งใน API ระดับสูง

แต่: เปลี่ยนชื่อฟังก์ชั่น

แทนที่จะstartHttpServerเรียกมันหรือmakeSureHttpServerIsRunningensureHttpServerIsRunning

เมื่อเรียกใช้ฟังก์ชันstartHttpServerผู้อ่านคาดว่าจะเริ่มต้นเซิร์ฟเวอร์ HTTP เมื่อเรียกสิบครั้งติดต่อกันฉันจะมีเซิร์ฟเวอร์สิบเครื่องที่ทำงานอยู่ ฟังก์ชั่นของคุณไม่ได้ใช้เวลาส่วนใหญ่ นอกจากนี้ชื่อที่มี "start" แนะนำว่าถ้าฉันต้องการเซิร์ฟเวอร์เดียวที่ทำงานอยู่ฉันจะต้องติดตามว่ามีการเรียกใช้ฟังก์ชั่นนี้หรือไม่

เมื่อเรียกใช้งานฟังก์ชั่นmakeSureHttpServerIsRunningฉันคิดว่ามันจะทำสิ่งที่จำเป็นเพื่อให้แน่ใจว่าเซิร์ฟเวอร์ HTTP กำลังทำงานอยู่โดยส่วนใหญ่จะตรวจสอบว่ามันทำงานอยู่หรือไม่และเริ่มต้นใหม่ ฉันยังสันนิษฐานว่าฟังก์ชั่นทำให้แน่ใจว่าเซิร์ฟเวอร์กำลังทำงานจริง (การเริ่มต้นเซิร์ฟเวอร์อาจเกี่ยวข้องกับเวลาที่ยังไม่ได้ทำงาน)

EnsureServerRunningเปลี่ยนชื่อเป็น

ชัดเจนอย่างสมบูรณ์และชัดเจนว่ามันทำให้แน่ใจว่ามันกำลังทำงาน (ถ้ามันไม่ได้) โดยไม่ต้องเริ่มต้นใหม่ถ้ามันเป็น

(ทางเลือก: StartServerIfNotRunning?)

ไม่จริงรูปแบบการออกแบบ แต่ฉันจะเรียกวิธีการของคุณidempotent มักจะมีคำที่ใช้ในการอ้างถึงการโทรทางไกล แต่คำอธิบายดูเหมือนจะตรงกับสิ่งที่คุณกำลังทำ

วิธีการ Idempotent วิธีการยังสามารถมีคุณสมบัติของ "idempotence" ในนั้น (นอกเหนือจากข้อผิดพลาดหรือปัญหาการหมดอายุ) ผลข้างเคียงของ N> 0 คำขอที่เหมือนกันจะเหมือนกันสำหรับคำขอเดียว ( จาก W3.org )

ผลข้างเคียงของเซิร์ฟเวอร์ที่นี่คือเซิร์ฟเวอร์ HTTP นั้นเริ่มต้นขึ้นเมื่อมีการเรียกใช้เมธอด ฉันเห็นว่าไม่มีอะไรผิดปกติกับวิธีการทำเช่นนี้

หากคุณต้องการรูปแบบการออกแบบฉันคิดว่าคุณสามารถเปิดเผย httpServer ของคุณเป็นซิงเกิลตันซึ่งเริ่มต้นเมื่อเริ่มต้น

ในฐานะที่เป็นผู้หนึ่งที่ใช้นี้เครื่องมือ , startHttpServerคุณควรจะพยายามที่จะทำให้มันง่ายที่สุดเนียนไร้รอยต่อที่จะใช้ ...

ตรรกะของฟังก์ชัน

ในทางเทคนิคโดยแยกstartHttpServer's ตรรกะเป็น 2 ฟังก์ชั่นและเรียกพวกเขาแยกทุกสิ่งที่คุณทำคือการย้าย startHttpServer ' s Idempotencyเป็นรหัสเรียกฟังก์ชั่นทั้งสองแทน ... นอกจากนี้ถ้าคุณห่อทั้งตรรกะในฟังก์ชั่นที่สาม (ซึ่งเป็นสิ่งที่ไม่startHttpServerในสถานที่แรก) นี้บังคับให้คุณเขียนโค้ด unDRYed startHttpServerซ้ำมันชี้แจงทุกที่ที่คุณต้องการมีการโทร ในระยะสั้นstartHttpServer ต้องเรียกตัวเองisHttpServerRunningฟังก์ชั่น

ดังนั้นประเด็นของฉันคือ:

• ใช้งานisHttpServerRunningฟังก์ชั่นเพราะอาจจำเป็นต้องใช้อย่างอิสระต่อไป ...
• นำไปใช้startHttpServerทำให้สามารถใช้isHttpServerRunningเพื่อกำหนดการกระทำถัดไปของมัน ...

ถึงกระนั้นคุณสามารถstartHttpServerคืนค่าใด ๆ ที่ผู้ใช้ฟังก์ชันนี้อาจต้องการเช่น:

• 0 => เซิร์ฟเวอร์เริ่มล้มเหลว
• 1 => เซิร์ฟเวอร์เริ่มต้นสำเร็จ
• 2 => เซิร์ฟเวอร์เริ่มต้นแล้ว

การตั้งชื่อฟังก์ชั่น

ก่อนอื่นเป้าหมายหลักของผู้ใช้คืออะไร หากต้องการเริ่มต้นเซิร์ฟเวอร์ HTTPใช่ไหม

1*1=1พื้นฐานไม่มีปัญหาโดยตั้งใจที่จะเริ่มต้นสิ่งที่ได้รับการเริ่มต้นแล้วที่อาคา อย่างน้อยสำหรับฉันการเรียกว่า " ensureHttpServerIsRunning" ดูเหมือนไม่จำเป็นอย่างยิ่งในช่วงวิกฤตฉันจะสนใจมากขึ้นว่าชื่อฟังก์ชั่นนั้นยาวเป็นธรรมชาติและน่าจดจำ

ตอนนี้ถ้าคุณต้องการทราบวิธีการทำงานอย่างละเอียดของฟังก์ชั่นภายใต้ประทุนมีเอกสารหรือซอร์สโค้ดสำหรับสิ่งนั้นฉันหมายความว่าสำหรับฟังก์ชั่นอื่น ๆ จาก library / framework / API / etc ...

คุณเรียนรู้ฟังก์ชั่นหนึ่งครั้งในขณะที่เขียนหลาย ๆ ครั้ง ...

ดังนั้นต่อไปผมจะติดกับที่สั้นง่ายและชัดเจนกว่าstartHttpServerensureHttpServerIsRunning

ฉันคิดว่าเพื่อนร่วมงานของคุณหมายความว่าstartHttpServerทำมากเกินไป:

• ตรวจสอบว่าเซิร์ฟเวอร์ทำงานอยู่หรือไม่
• เริ่มต้นเซิร์ฟเวอร์หากจำเป็น

นี่คือส่วนที่ไม่เกี่ยวข้องสองส่วนของรหัส ตัวอย่างเช่นมีสถานการณ์ที่คล้ายกันเกิดขึ้นเมื่อแอปพลิเคชันเดสก์ท็อปควรตรวจสอบให้แน่ใจว่าไม่ได้ทำงานอยู่เมื่อเปิดตัว จะมีส่วนหนึ่งของรหัสที่จัดการอินสแตนซ์ของแอป (ตัวอย่างเช่นการใช้ mutex) และรหัสที่จะเริ่มลูปข้อความแอปพลิเคชัน

ซึ่งหมายความว่าคุณจะต้องไม่มีหนึ่งวิธี แต่อย่างน้อยสองวิธี :

• isHttpServerRunning: boolean
• startHttpServer

falseจุดเข้าโปรแกรมจะเรียกวิธีแรกและจากนั้นคนที่สองถ้าค่าตอบแทนเป็น ตอนนี้ทุกวิธีกำลังทำสิ่งหนึ่งและสิ่งหนึ่งและง่ายต่อการเข้าใจ

^{¹หากลอจิกที่จำเป็นต้องรู้หากเซิร์ฟเวอร์ที่ทำงานอยู่นั้นซับซ้อนเกินไปก็อาจต้องแยกออกเป็นหลายวิธี}

เนื่องจากคุณไม่ได้ระบุภาษาใน JavaScript มีหลายไลบรารีที่มีฟังก์ชัน "หนึ่งครั้ง" เช่นขีดล่าง ดังนั้นถ้าเป็นที่คุ้นเคยกับคุณเรียกว่ารูปแบบ "ครั้งเดียว" และอาจเปลี่ยนชื่อวิธีการของคุณ

ตัวเองมามากขึ้นจาก Java คำว่า "แคช" หรือ "การประเมินผลที่ขี้เกียจ" เป็นสิ่งสำคัญ "Idempotent" ถูกต้องทางเทคนิคและเป็นทางเลือกที่ดี esp หากคุณมีพื้นหลังทำงานได้มากขึ้น

startHttpServerIfNotIsRunningฉันไม่ต้องการ

วิธีนี้เงื่อนไขจะถูกกล่าวถึงอย่างชัดเจนแล้วในชื่อวิธีการ EnsureหรือmakeSureดูเหมือนคลุมเครือเล็กน้อยสำหรับฉันเพราะไม่ใช่การแสดงออกทางเทคนิค ดูเหมือนว่าเราไม่รู้ว่าจะเกิดอะไรขึ้น

สิ่งที่เพื่อนร่วมงานของคุณควรบอกคุณคือคุณไม่มีวิธีการเขียนเชิงธุรกิจ มันถูกเขียนมาแล้วหลายครั้งและเขียนได้ดีกว่าที่คุณจะเขียน ตัวอย่างเช่น: http://docs.ansible.com/ansible/latest/systemd_module.html https://docs.saltstack.com/th/latest/ref/states/all/salt.states.service.html

จากมุมมองทางสถาปัตยกรรมการมีโค้ดบางส่วนที่จัดการกับเว็บเซิร์ฟเวอร์เป็นเรื่องของฝันร้าย ยกเว้นว่าการจัดการบริการจะเป็นสิ่งที่รหัสของคุณทำ แต่ฉันเดาว่าคุณไม่ได้เขียน monit (หรือ kubernetes หรือ ... )