หน้าแรก>แหล่งข้อมูลการสร้างเว็บไซต์>ข้อมูลเว็บไซต์
ดาวน์โหลด

ตัวอย่างเว็บแอปพลิเคชันใน Clojure

แอพนี้เป็นตัวแปรที่ลดลงของโครงการตัวอย่าง UserManager- ตัวอย่างของ Sean Corfield (ซิงค์ตาม Commit SHA 2A9CF63)

ทำไม

ตัวอย่างโครงการ "ตัวจัดการผู้ใช้" ดั้งเดิมของฌอนและตัวแปร (รวมถึงโครงการนี้) ตั้งเป้าหมายที่จะ demystify "วิธีการสร้างเว็บแอปพลิเคชัน Clojure โดยใช้ไลบรารีเท่านั้น?" -

"องค์ประกอบเหนือมรดก", "ห้องสมุดเหนือเฟรมเวิร์ก" และ "การวางแนวข้อมูล" มีคุณสมบัติเด่นชัดในรูปแบบการเขียนโปรแกรมทางจิตของ Clojure World รวมถึงการเขียนโปรแกรมเว็บ ขาดสัญชาตญาณที่สำคัญเหล่านี้แม้กระทั่งนักพัฒนาที่มีประสบการณ์ซึ่งยังใหม่ต่อ Clojure มักจะดิ้นรนเพื่อสร้างแอพโดยใช้ห้องสมุด กลุ่ม "ผู้จัดการผู้ใช้" ของการสาธิตมีจุดมุ่งหมายเพื่อจัดการกับความท้าทายเฉพาะนี้ พวกเขา ไม่ ปรารถนาที่จะสอนแนวทางปฏิบัติที่ดีที่สุดในการพัฒนาเว็บ ด้วยเหตุนี้ตัวอย่าง "ตัวจัดการผู้ใช้" ทั้งหมดจึงมีขนาดเล็กง่ายขึ้น "แอพสไตล์ Web 1.0"

ยังไง?

โครงการนี้ขยายออกจากไพรเมอร์ "จากหลักการแรก" ที่ฉันเขียนลงใน " Clojuring The Web Application Stack: Meditation One " ฉันเลือกที่จะใช้แอพสาธิตดั้งเดิมของฌอนเป็นข้อกำหนดเพราะ:

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

ถ้าไม่มีอะไรอื่นมันจะมีรอยขีดข่วนคันของตัวเอง ... ฉันชอบคำอธิบายเปลือยเปล่าและรักที่จะลงไป "รอ แต่ทำไม?" รูกระต่ายและแทนเจนต์

คุณจะเห็นการสาธิต "ตัวจัดการผู้ใช้" อื่น ๆ ทั้งหมดแม้ว่าจะง่าย แต่ก็ถูกสร้างขึ้นด้วยห้องสมุดที่ใช้โดยผู้เชี่ยวชาญด้าน Clojure ในเว็บแอปพลิเคชันการผลิตในโลกแห่งความเป็นจริง ดังนั้นหากห้องสมุดเป็นสารตั้งต้นของเว็บสแต็ก (หรือกรอบ) (หรือกรอบ) ... อะไรคือสารตั้งต้นของห้องสมุด? ไม่มีห้องสมุด :)

การอ่านบันทึกย่อ

ให้ความสะดวกแก่ผู้จัดการผู้ใช้เดิม "และโพสต์บล็อกของฉันสำหรับการอ้างอิงแบบเคียงข้างกันในขณะที่คุณทำงานผ่าน codebase นี้

หากมีสิ่งใดที่ไม่ชัดเจนหรือผิดพลาดโปรดเปิดปัญหา (แต่โปรดอย่าเปลี่ยนโครงสร้างของรหัส)

ทำตามประวัติศาสตร์การกระทำ

ฉันได้สร้างมันขึ้นมาเพื่อช่วยให้ผู้อ่านสังเกต "การทำ" ของแอพทีละชิ้น ปรึกษา readme เกี่ยวกับการกระทำที่เป็นปัญหา สำหรับคำแนะนำการใช้งานที่เกี่ยวข้องกับจุดนั้นในการพัฒนา

ใช้สิ่งที่มีประโยชน์ทิ้งส่วนที่เหลือ

ฉันคิดว่าเราเรียนรู้ได้ดีขึ้นโดยการไปจากแบบจำลองทางจิตหยาบโดยประมาณไปจนถึงรูปแบบความเที่ยงตรงสูง ดังนั้นการทำให้เข้าใจง่ายโดยเจตนาบางอย่างอาจรบกวนผู้เชี่ยวชาญด้านเว็บ (เช่นใช้ Get to Delete) คนหนึ่งไว้วางใจผู้เรียนที่จะรับวิธีการ "ถูกต้อง" ในการทำสิ่งต่าง ๆ จากผลรวมของการศึกษาการทดลองเพื่อนร่วมงานและที่ปรึกษา

เมื่อเรียนรู้บางครั้งก็ดีที่จะกระสับกระส่าย;)

วิธีสำรวจรหัส

สิ่งที่คาดหวังถ้าคุณทำงานไปข้างหน้าจากการกระทำครั้งแรก:

  • จากการเดินทางคุณควรจะสามารถออกคำขอ curl ไปยังแอพได้ 
     curl localhost:3000
curl -XPOST localhost:3000/some/path?q=somethingsomething
curl -XDELETE localhost:3000/foo/bar/baz
    • บิตแอพทีละน้อยจะได้รับการคัดเลือกและ/หรือเรียกร้องเกี่ยวกับการตอบกลับมากขึ้น
    • ลองเล่นกับชุดค่าผสม
    • อ่านรหัสเพื่อตัดสินใจว่าจะร้องขออะไรในการประดิษฐ์ขณะที่ตัวจัดการและ APIs วิวัฒนาการ
  • ใช้ REPL และเริ่มเล่นกับรหัสจากการกระทำครั้งแรก
    • ใช้ "บล็อกความคิดเห็นที่หลากหลาย" ที่ด้านล่างของแต่ละเนมสเปซ
    • เนมสเปซ usermanager.main ควรมีวิธีการเริ่มต้น/หยุดกระบวนการเซิร์ฟเวอร์ (และ/หรือสถานะปัจจุบันของแอป)
    • ระวังการพึ่งพาห้องสมุดใหม่ที่แนะนำใน deps.edn หากคุณเห็นเนมสเปซใหม่ในรหัสนั่นไม่ใช่ usermanager.* เนมสเปซนั่นเป็นเบาะแส
    • คุณจะต้องรีสตาร์ท REPL เพื่อรับการพึ่งพาใหม่ตามที่ปรากฏในแหล่งที่มา ยูทิลิตี้เริ่มต้น/หยุดใน usermanager.main ควรง่ายขึ้นในการกู้คืนเซิร์ฟเวอร์ของคุณหลังจากรีสตาร์ท Repl
  • การทดสอบควรผ่านการกระทำแต่ละครั้ง ให้คำแนะนำความเข้าใจของคุณด้วย
    • สำหรับการกระทำไม่กี่ครั้งแรกแอปจะสะท้อนข้อมูลบางอย่างที่พบในคำขอ
    • ณ จุดหนึ่งคำขอจะส่งผลกระทบต่อฐานข้อมูล ตอนนี้แอพควรสร้างฐานข้อมูล SQLite ที่ไหนสักแห่ง ตรวจสอบรูทของโครงการหรือภายใต้ไดเรกทอรี dev/ ไดเรกทอรีของโครงการ (คุณอาจต้องสร้างด้วยตนเอง)
    • การตั้งค่าแอพควรเติมสองตาราง ( department และ addressbook )
    • ในช่วงสองสามปีที่ผ่านมาเว็บ UI ควรเริ่มมีชีวิตอยู่
  • อย่าลังเลที่จะสอบถาม/แก้ไข/ตรวจสอบฐานข้อมูล dev ...
    • ผ่าน API ของแอป UI และโดยตรง
    • คุณสามารถกู้คืนสถานะเริ่มต้นได้อย่างง่ายดาย เพียงลบไฟล์บนดิสก์ จากนั้นสร้างใหม่โดยใช้ระบบสาธารณูปโภคที่มีประโยชน์ของเรา
  • ในที่สุดในตอนท้ายคุณจะมีเว็บแอปพลิเคชันผู้ใช้ที่ "เสร็จสิ้น" เป็นธรรม
    • สิ่งนี้จะแสดงให้เห็นถึงการตั้งค่าการสร้างแบบดั้งเดิมโดยใช้เครื่องมือ Clojure CLI
    • ในสถานะสิ้นสุดนี้ลองใช้วิธีการสร้างเครื่องมือในการเรียกใช้แอพและสร้างมันสำหรับการใช้งานแบบสแตนด์อโลนในท้องถิ่นรวมถึงการปรับใช้เซิร์ฟเวอร์

ตัวเลือกการออกแบบห้องสมุด API และซอฟต์แวร์

ห้องสมุด

อย่างที่ฉันพูดถึงฉันได้ลบล้างห้องสมุดให้มากที่สุดเท่าที่จะทำได้โดยไม่ลดทอนความซื่อสัตย์ต่อการออกแบบของโครงการดั้งเดิม ข้อยกเว้นคือรูปแบบใด ๆ ของโฮสต์ระหว่างแอปพลิเคชันของเราและโลกภายนอก ฉันคิดว่าโซลูชั่นที่มีอยู่แล้ว (ห้องสมุด) สำหรับความต้องการเหล่านั้น (ฉันต้องวาดขอบเขตที่ไหนสักแห่ง!) นอกจากนี้ยังมียูทิลิตี้ความสะดวกสบายของสิ่งมีชีวิตที่ไม่ได้เป็นศูนย์กลางของธีมของคำอธิบายหลักการแรกนี้

Hark กลับไปที่บล็อกโพสต์เพื่อให้ได้ภาพที่ดีขึ้นเกี่ยวกับสถานที่และทำไมฉันถึงวาดขอบเขตนี้

โดยเฉพาะฉันใช้:

  • สิ่งจำเป็นเปลือยเปล่าเช่นอะแดปเตอร์สำหรับท่าเทียบเรือ, SQLite และ HTML แสดงผล
  • มิดเดิลแวร์วงแหวนบางตัวที่จัดการกับข้อมูลรูปแบบ HTML
  • ทุกอย่างอื่นรีดด้วยมือโดยใช้เฉพาะไลบรารีมาตรฐาน Clojure

ข้อมูลจำเพาะ API / โดเมน

เพื่อให้ได้ความเป็นจริงตามข้อกำหนดของฌอนสำหรับ API ของ UserManager โมเดลโดเมนและ "หลักการทางธุรกิจ" หลักฉันมีส่วนที่คัดลอกมาจากแหล่งที่มาของ userManager-Example ของเขา:

  • โครงการ URI
  • ฟังก์ชั่นตัวจัดการทั้งหมด (คอนโทรลเลอร์) ที่พบ
  • ทุกรุ่นฟังก์ชั่นที่พบ

ความตั้งใจในการออกแบบซอฟต์แวร์

เพื่อเสริมความคิดในการเขียนชิ้นส่วนที่เคลื่อนไหวโดยใช้ข้อมูล clojure ธรรมดาฉันได้สร้างรหัสของฉันเพื่อใช้ตัวเลือกการออกแบบที่ทำโดยฌอน (เช่นการฉีดชื่อของมุมมองในบริบทคำขอสำหรับการใช้งานในภายหลังโดยตรรกะการเรนเดอร์ HTML) ในทำนองเดียวกันเพื่อให้เป็นจริงกับข้อกำหนดของแหวนยูทิลิตี้แหวนที่เขียนด้วยตนเองทั้งหมดและมิดเดิลแวร์ตามข้อมูลจำเพาะวงแหวน การแทนที่พวกเขาด้วยต้นฉบับที่ให้แหวนควรตรงไปตรงมา

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

ตอนนี้มันควรจะชัดเจน แต่ฉันจะระบุมันต่อไป ... แอพพลิเคชั่นที่ถูกถอดออกไม่ได้มีความต้องการในความต้องการในโลกแห่งความเป็นจริงเพราะมันละเว้นห้องสมุดเกือบทั้งหมดที่ใช้โดยตัวอย่าง "ผู้จัดการผู้ใช้" อื่น ๆ แม้แต่แอพเหล่านั้นจะต้องทำงานให้เสร็จ (บทวิจารณ์การออกแบบการทดสอบการรวมการตรวจสอบความปลอดภัย ฯลฯ ) หากพวกเขามีคุณสมบัติในการปรับใช้ในโลกแห่งความเป็นจริง

ความต้องการ

เช่นเดียวกับโครงการ userManager- ตัวอย่างของฌอน

  • ตัวอย่างนี้สันนิษฐานว่าคุณมีการติดตั้ง CLOJURE CLI เวอร์ชันล่าสุด (อย่างน้อย 1.10.3.933) และให้ไฟล์ deps.edn
  • จำเป็นต้องมี Clojure 1.10 (หรือใหม่กว่า) แอป "รุ่น" ของตัวอย่างนี้ใช้ปุ่มที่ผ่านการรับรองเนมสเปซในแผนที่แฮช มันใช้ next.jdbc-"ไลบรารี JDBC รุ่นต่อไป" สำหรับ Clojure-ซึ่งสร้างแผนที่แฮชที่ผ่านการรับรองเนมสเปซจากชุดผลลัพธ์
  • tools.build Library เพื่อใช้คำสั่งจากไฟล์ build.clj มันรวมผ่าน :build นามแฝงของไฟล์ deps.edn โครงการการใช้งานของ Clojure-cli-cli-cli ใช้ไฟล์ build.clj ตามการประชุมเพื่อจัดทำฟังก์ชั่นการสร้างโครงการมาตรฐานและกำหนดเอง เครื่องมือการตั้งค่าโครงกระดูกโครงการมักจะสร้างไฟล์นี้โดยอัตโนมัติ ฉันคัดลอกมาจากโครงการของฌอน
  • หมายเหตุ: ฉันยังไม่ได้ทดสอบสิ่งนี้บนเครื่อง Windows หรือ MacOS เนื่องจากแอพนี้เป็นวานิลลาเท่าที่พวกเขามาฉันเชื่อว่ามันควรจะ "ทำงาน" บน Linux, MacOS และ WSL ภายใต้ Windows ตราบใดที่ความต้องการมีความต้องการ

การใช้งาน

โคลน repo, cd ลงไปแล้วทำตามวิธีการใด ๆ ด้านล่างเพื่อลองใช้แอพและ/หรือปรับใช้ โปรดทราบว่า แอพที่ได้นั้นไม่เหมาะสำหรับการปรับใช้การผลิต อย่าลังเลที่จะปรับใช้แน่นอน แต่เปิดเผยไปยังอินเทอร์เน็ตสาธารณะเฉพาะในอินสแตนซ์เซิร์ฟเวอร์ที่ทิ้ง

เรียกใช้การทดสอบ

เรียกใช้การทดสอบด้วยวิธีนี้จากรากของโครงการ 

 clojure -T:build test

สิ่งนี้ใช้ :build นามแฝงเพื่อโหลดไฟล์ build.clj ตาม tools.build และเรียกใช้งาน test

หวังว่าการทดสอบจะผ่านไป! คุณควรเห็นอะไรแบบนี้: 

 Running tests in #{"test"}

[ Many lines of test runner log messages. ]

Ran 11 tests containing 37 assertions.
0 failures, 0 errors.

หมายเหตุเกี่ยวกับข้อความบันทึก:

  • คุณจะเห็นข้อความการดีบักจำนวนมาก ปกติฉันจะแยกส่วนใหญ่ออกจากผลลัพธ์การทดสอบประจำวันของฉัน ที่นี่การบันทึกพิเศษมีไว้เพื่อการสอน
  • ในช่วงเริ่มต้นของการทดสอบคุณอาจเห็นข้อความบางส่วน (น่ารำคาญ) เกี่ยวกับการใช้งาน logger "SLF4J" คุณอาจเพิกเฉยต่อสิ่งเหล่านี้ได้อย่างปลอดภัย

เรียกใช้แอปพลิเคชัน

คุณสามารถเรียกใช้แอพได้ทุกจุดในประวัติศาสตร์การกระทำของโครงการนี้ อย่างไรก็ตาม ฟังก์ชั่นที่มีอยู่จะตรงกับสิ่งที่ถูกสร้างขึ้นกับการกระทำนั้นเท่านั้น

เริ่มแอพและชี้เบราว์เซอร์ของคุณไปที่ http: // localhost: 3000 

 clojure -M -m usermanager.main

หากมีการใช้พอร์ตนั้นให้เริ่มต้นบนพอร์ตอื่น ตัวอย่างเช่นพอร์ต 3100: 

 clojure -M -m usermanager.main 3100

รันแอปพลิเคชันใน REPL หรือ VIA EDITOR

เริ่ม REPL 

 clj -M:dev:test

เมื่อทำการเปลี่ยนแล้วให้เริ่มเซิร์ฟเวอร์บนพอร์ตเริ่มต้น (พอร์ต 3000): 

user=> ( require 'usermanager.main)  ; load the code
user=> ( in-ns 'usermanager.main)    ; move to the namespace
usermanager.main=> ( -main )          ; or some other port (-main 8080)

ชี้เบราว์เซอร์ของคุณไปยัง URL ที่เหมาะสม http: // localhost: portnumber

ใช้โปรไฟล์ dev และ test เมื่อคุณเรียกใช้ REPL ไม่ว่าจะเป็นแบบสแตนด์อโลนหรือผ่านตัวแก้ไขที่คุณชื่นชอบ

จากนั้นประเมิน/สมัคร!

สร้าง Uberjar สำหรับการปรับใช้เซิร์ฟเวอร์

สำหรับการปรับใช้เซิร์ฟเวอร์โดยทั่วไปคุณต้องการสร้าง "uberjar" -ไฟล์ .jar ที่มี clojure และรหัสทั้งหมดจากแอปพลิเคชันของคุณและการพึ่งพาของมันเพื่อให้คุณสามารถเรียกใช้กับคำสั่ง java -jar (แต่อย่างที่ฉันได้กล่าวไว้ก่อนหน้านี้โครงการนี้ไม่ใช่ซอฟต์แวร์การผลิตดังนั้นปรับใช้เพื่อสภาพแวดล้อมเซิร์ฟเวอร์ที่ทิ้งได้เท่านั้น)

ไฟล์ build.clj - ที่กล่าวถึงข้างต้น - มีงาน ci ที่:

  • เรียกใช้การทดสอบทั้งหมด
  • ทำความสะอาดโฟลเดอร์ target
  • รวบรวมแอปพลิเคชัน (บางครั้งเรียกว่า "AOT Compilation")
  • ผลิตไฟล์ .jar แบบสแตนด์อโลน 
 clojure -T:build ci

ที่ควรสร้างผลลัพธ์เดียวกันกับ test ด้านบนตามด้วยสิ่งที่ชอบ: 

 Copying source...

Compiling usermanager.main...

Building JAR...

โฟลเดอร์ target จะถูกสร้างขึ้นหากไม่มีอยู่และจะมีโฟลเดอร์ classes ที่มีซอร์สโค้ด clojure ที่รวบรวมทั้งหมดจากแอปพลิเคชัน usermanager และการพึ่งพาทั้งหมด รวมถึง Clojure เอง: 

 ls target/classes/
hiccup  hiccup2  public  ring  usermanager

นอกจากนี้ยังจะรวมไฟล์ .jar แบบสแตนด์อโลนซึ่งคุณสามารถเรียกใช้เช่นนี้: 

 java -jar target/usermanager/example-standalone.jar

สิ่งนี้ควรทำตัวเหมือนกับการ เรียกใช้แอปพลิเคชัน ตัวอย่างด้านบน

ไฟล์ JAR นี้สามารถปรับใช้กับเซิร์ฟเวอร์ใด ๆ ที่ติดตั้ง Java และเรียกใช้โดยไม่มีการอ้างอิงภายนอกหรือไฟล์อื่น ๆ

สิ่งที่ฉันต้องทำ

ฉันอาจสาธิตวิธีการแทนที่ชิ้นส่วนที่รีดด้วยมือแต่ละชิ้นโดยใช้ไลบรารีการผลิต

แต่บางทีคุณสามารถทำได้ด้วยคำพูดของคุณเองเช่นเดียวกับการบ้านที่ออกแบบมาเอง! -

เปรียบเทียบและเปรียบเทียบกับโครงการ userManager- ตัวอย่างอื่น ๆ สำหรับเบาะแส

ขอให้แหล่งข่าวอยู่กับคุณ!

ใบอนุญาตและลิขสิทธิ์

ลิขสิทธิ์ (c) 2015-2024 ฌอนคอร์ฟิลด์ ลิขสิทธิ์ (c) 2024 Aditya Athalye

แจกจ่ายภายใต้ใบอนุญาต Apache Source 2.0

ขยาย
ข้อมูลเพิ่มเติม
แอปที่เกี่ยวข้อง
แนะนำสำหรับคุณ
ข้อมูลที่เกี่ยวข้อง ทั้งหมด