mORMotBP

mormotbp

เซิร์ฟเวอร์ HTTP Boilerplate สำหรับ Synopse Mormot Framework

โครงการนี้กำลังฝังสินทรัพย์และการตั้งค่า HTML5 Boilerplate และการตั้งค่าลงใน Synopse Mormot Framework :

• html5boilerplate.com
  HTML5 Boilerplate เป็นเทมเพลตส่วนหน้าระดับมืออาชีพสำหรับการสร้างแอพหรือเว็บไซต์หรือเว็บไซต์ที่ปรับตัวได้อย่างรวดเร็ว เป็นผลิตภัณฑ์ของการพัฒนาซ้ำกว่า 10 ปีและความรู้ชุมชน มันไม่ได้กำหนดปรัชญาการพัฒนาหรือกรอบการพัฒนาที่เฉพาะเจาะจงดังนั้นคุณมีอิสระที่จะสถาปนิกรหัสของคุณในแบบที่คุณต้องการ เริ่มต้นโครงการของคุณด้วยความรู้ร่วมกันและความพยายามของนักพัฒนา 100 คนทั้งหมดในแพ็คเกจเล็ก ๆ น้อย ๆ
• synopse.info
  Synopse Mormot เป็นเฟรมเวิร์กโอเพนซอร์สเซิร์ฟเวอร์ ORM SOA MVC สำหรับ Delphi และ FPC โดยกำหนดเป้าหมาย Windows/Linux สำหรับเซิร์ฟเวอร์และแพลตฟอร์มใด ๆ สำหรับลูกค้า (รวมถึงมือถือหรือ AJAX)

เริ่มต้นอย่างรวดเร็ว

1. ดาวน์โหลดรุ่น Mormotbp ล่าสุดจากที่เก็บ GitHub
2. เพิ่มไดเร็กทอรี mORMotBP ไปยังเส้นทางไลบรารี IDE ของคุณ
3. เพิ่มเหตุการณ์ ก่อนการสร้าง สองรายการถัดไปเพื่อสร้าง Assets.res ด้วยทรัพยากร H5BP ทั้งหมดที่ฝังอยู่:

• "..Toolsassetslz" "$(PROJECTDIR)Assets" "$(PROJECTDIR)Assets.tmp"
• "..Toolsresedit" -D "$(PROJECTDIR)Assets.res" rcdata ASSETS "$(PROJECTDIR)Assets.tmp"

แทนที่ "..Tools" เป็น mormorbp สัมพัทธ์หรือตำแหน่งไดเรกทอรีเต็ม

4. แทนที่การสร้างอินสแตนซ์ TSQLHttpServer ด้วย TBoilerplateHTTPServer
5. โหลดสินทรัพย์ไปยังอินสแตนซ์เซิร์ฟเวอร์โดยเรียก YourHTTPServerInstance.LoadFromResource('Assets');

คุณสมบัติ

• จัดตำแหน่งอย่างเต็มที่กับ HTML5 Boilerplate HTTP configs ด้วยตัวเลือกและคุณสมบัติมากกว่า 50+ ตัวเลือก
• ออกแบบมาสำหรับ Delphi 6 ถึง Delphi 10.4.1 Sydney , Kylix 3 (Over Crosskylix) และ FPC กำหนดเป้าหมาย Windows หรือ Linux , สถาปัตยกรรม 32 บิต หรือ 64 บิต
• ฝังสินทรัพย์คงที่ทั้งหมดลงในไฟล์แอปพลิเคชันเป็นคลังเก็บ ของ Synlz ที่บีบอัดสูง (ดู assetslz และเครื่องมือ resedit ) สิ่งนี้ช่วยให้สามารถสร้างการกระจายไฟล์เดียว
• บันทึกการดำเนินงานบน ดิสก์ IO บนคลาวด์ของคุณโดยส่งคืนสินทรัพย์คงที่ทั้งหมดจากที่เก็บ mem-cached
• อย่าใช้ CPU รอบ การบีบอัดสินทรัพย์สินทรัพย์ทั้งหมดของคุณจะถูกบีบอัดล่วงหน้าโดยเครื่องมือ assetslz
• รองรับ GZIP ระดับ 9 การบีบอัดสูงสุด
• รองรับการบีบอัด ZOPFLI (ประหยัดได้มากถึง 5-15% ของการรับส่งข้อมูลและเวลาการส่งมอบเมื่อเทียบกับการบีบอัดสูงสุด GZIP)
• รองรับการบีบอัด Brotli ตาม RFC 7932 (บันทึกอีก 15% -25% ของการรับส่งข้อมูลและเวลาการส่งมอบเมื่อเทียบกับการบีบอัด ZOPFLI)
• รองรับ การบีบอัด Brotli แบบไดนามิก (บันทึกการใช้งาน CPU ประมาณ 25% ในระบบ 64 บิตและเวลาส่งมอบน้อยลง ~ 10% และการใช้การจราจร)
• ความสามารถในการมอบหมายไฟล์ที่ถูกบีบอัดการถ่ายโอนไปยังไลบรารี HTTP.sys ระดับต่ำ (ดูคุณสมบัติ .StaticRoot ) และฟรีเธรดเซิร์ฟเวอร์ของคุณสำหรับงานที่น่าสนใจยิ่งขึ้น
• สนับสนุน ETag/Last-Modified หรือใช้กลยุทธ์แคช Last-Modified/If-Modified-Since มากขึ้น
• ฝั่งเซิร์ฟเวอร์ Expires หรือ Cache-Control: max-age
• แคชที่แตกต่างกันกลยุทธ์การจับตัว (ดู bpoEnableCacheBusting และ bpoEnableCacheBustingBeforeExt )
• แก้ไขค่า การเข้ารหัสการยอมรับ ที่รู้จักกันดีในส่วนหัว HTTP
• บล็อกการเข้าถึงไฟล์ที่สามารถเปิดเผยข้อมูลที่ละเอียดอ่อน (ดูตัวเลือก bpoDelegateHidden และ bpoDelegateBlocked )
• ใช้การแก้ไขส่วนหัว HTTP จำนวนมากหลังจากการตั้งค่า HTML5 Boilerplate
• สนับสนุน นโยบายความปลอดภัยของเนื้อหา ระดับ 2 / ระดับ 3 (ดูรายละเอียด CSP.pas หน่วย)
• สนับสนุนการขยายไฟล์ ประเภท MIME 1490 MIME รวมจาก Iana, Apache และ Mozilla
• รองรับสินทรัพย์ภายนอกที่คำนวณได้และคำขอ URL ด้วยการถ่ายโอนเนื้อหา/ไฟล์และเปลี่ยนเส้นทาง (ดูเหตุการณ์ .OnGetAsset )
• คุณสามารถเปลี่ยนได้อย่างปลอดภัยทุกที่ tsqlhttpserver ด้วย

TBoilerplateHTTPServer = class (TSQLHttpServer)

Lazarus Free Pascal Support

ในการสร้างหรืออัปเดตไฟล์ Assets.res ภายใต้ Lazarus IDE ให้ใช้เมนูถัดไป (เมื่อเปิดไฟล์โครงการ):

Run / Build File

คำสั่งเมนูนี้เรียกใช้ pre-build.sh หรือ pre-build.bat สคริปต์ซึ่งใช้ assetslz32 / assetslz64 และ resedit32 / resedit64 เครื่องมือในการบีบอัดและฝังสินทรัพย์ภายใต้สภาพแวดล้อม Linux / Windows

เพิ่มคำสั่ง FPC Lazarus IDE ต่อไปในไฟล์โครงการใด ๆ เพื่อความสามารถในการสร้างไฟล์ทรัพยากรใหม่:

 { $IFDEF LINUX }
  { %BuildCommand pre-build.sh $ProjPath() }
{ $ENDIF }
{ $IFDEF MSWINDOWS }
  { %BuildCommand pre-build.bat "$ProjPath()" }
{ $ENDIF } 

การสนับสนุน Delphi 6/7/2005/2006

ต้องขอบคุณ Kiran Kurapaty ด้วยแพ็คเกจ Buildoptions ของเขาสำหรับ Delphi 5 และ Delphi 7 ตามรหัสของเขาแพ็คเกจ IDE ที่แก้ไขแล้วสำหรับ Delphi 5/6/7/2005/2006 ถูกสร้างขึ้นเพื่อเปิดใช้งานการสนับสนุนการสร้างกิจกรรมในทุกรุ่น Delphi IDE ก่อนที่ Delphi 2007

ใช้ ส่วนประกอบ / ติดตั้งแพ็คเกจ / เพิ่ม เมนู ide เพื่อติดตั้ง การสร้างกิจกรรม ส่วนขยาย IDE:

• ToolsBuildEventsBuildEventsD5.bpl สำหรับ Delphi 5
• ToolsBuildEventsBuildEventsD6.bpl สำหรับ Delphi 6
• ToolsBuildEventsBuildEventsD7.bpl สำหรับ Delphi 7
• ToolsBuildEventsBuildEventsD2005.bpl สำหรับ Delphi 2005
• ToolsBuildEventsBuildEventsD2006.bpl สำหรับ Delphi 2006

ด้วยเหตุการณ์การสร้างนี้และไฟล์ .bat พิเศษคุณสามารถเลียนแบบ DEBUG และการกำหนดค่าการกำหนด RELEASE โปรดดูรายละเอียดของ Build Events Readme

การกำหนดค่า DEBUG ที่แนะนำ

เนื่องจากลักษณะการบีบอัดช้าลง 80 เท่าของอัลกอริทึม Zopfli จึงไม่สมเหตุสมผลที่จะใช้ในระหว่างการพัฒนาและการดีบัก ดังนั้นสำหรับการกำหนดค่าการดีบักทั้งหมดคุณสามารถใช้การบีบอัดระดับที่รวดเร็วและแสง 1 ด้วยตัวเลือก -GZ1 -B1 ตัวเลือกของเครื่องมือ AssetSlz :

• "..Toolsassetslz" -GZ1 -B1 "$(PROJECTDIR)Assets" "$(PROJECTDIR)Assets.tmp"
• "..Toolsresedit" -D "$(PROJECTDIR)Assets.res" rcdata ASSETS "$(PROJECTDIR)Assets.tmp"

การกำหนดค่า RELEASE ที่แนะนำ

สำหรับการกำหนดค่าการเปิดตัวขอแนะนำให้เปิด bpoForceHTTPS และตั้งค่าคุณสมบัติ .StrictSSL เป็น strictSSLOn หรือแม้กระทั่ง strictSSLIncludeSubDomains การตั้งค่าคุณสมบัติ .ContentSecurityPolicy การรักษาความปลอดภัยและตรวจสอบความถูกต้องด้วยบริการส่วนหัวความปลอดภัย (ดูรายละเอียดหน่วย CSP.pas สำหรับรายละเอียด)

ปิดการใช้งานส่วนหัว Server HTTP ในการผลิต

ด้วยเหตุผลด้านความปลอดภัยคุณสามารถปิดการใช้ Server และส่วนหัว HTTP X-Powered-By ได้อย่างสมบูรณ์ในการผลิต ในการทำเช่นนี้เพิ่ม NOXPOWEREDNAME กำหนดให้ โครงการ / ตัวเลือก / การกำหนดเงื่อนไข และสร้างใหม่ทั้งหมด

หากคุณใช้ HTTP.sys API บน Windows Server เพิ่มหรือแก้ไขคีย์รีจิสตรีถัดไปเพื่อปิดใช้งานการฝังส่วนหัว Server HTTP (ต้องการสิทธิ์ผู้ดูแลระบบ):

ส่วน: SYSTEMCurrentControlSetServicesHTTPParameters

คีย์: DisableServerHeader: DWORD = 2

เปิดใช้งานการบีบอัด Brotli แบบไดนามิก

โชคไม่ดีเริ่มต้น Mormot HTTP Server มักจะใช้การบีบอัดที่ลงทะเบียนครั้งแรกในกรณีที่มีตัวเลือกการบีบอัดหลายตัว เพื่อเปิดใช้งานการสนับสนุน Brotli สำหรับเนื้อหาที่สร้างขึ้น (HTML, JSON, XML ฯลฯ ) ทำต่อไป:

ปิดการบีบอัด deflate เริ่มต้นใน mORMotHttpServer.pas unit (บรรทัด 76):

ก่อน

 { $define COMPRESSDEFLATE }

หลังจาก

 {.$define COMPRESSDEFLATE}

จากนั้นลงทะเบียนการบีบอัดเซิร์ฟเวอร์ HTTP ใน Brotli, GZip :

 uses
  SynZip,
  Brotli;
...

    HttpServer.RegisterCompress(CompressBrotli);
    HttpServer.RegisterCompress(CompressGZip);

การใช้สินทรัพย์ภายนอกแบบไดนามิกและการเปลี่ยนเส้นทางที่กำหนดเอง

คุณสามารถจัดหาสินทรัพย์และการเปลี่ยนเส้นทางของคุณเอง สิ่งนี้มีประโยชน์สำหรับ:

• คำนวณเนื้อหาแบบไดนามิก
• ส่งคืนการเปลี่ยนเส้นทางที่กำหนดเองสำหรับคำขอใด ๆ ซึ่งเปิดความสามารถในการอพยพของโครงการการทดสอบ A/B ลิงก์สังเคราะห์/เลิกใช้แล้วสนับสนุน ฯลฯ ฯลฯ
• Precache เนื้อหาแบบไดนามิกที่ได้รับการอัพเดทหายากและบีบอัดด้วย GZIP, Zopfli หรือ Brotli
• การถ่ายโอนไฟล์ที่เก็บไว้ใด ๆ ไปยังไคลเอนต์
• บริการเนื้อหา Dynamic /404.html ที่กำหนดเอง

ใช้ตัวจัดการเหตุการณ์ BoilerplateHTTPServer.OnGetAsset และตรวจสอบให้แน่ใจว่าทรัพยากรที่ปรับเปลี่ยนได้นั้นได้รับการจัดการด้วยการสนับสนุนแบบมัลติเธรด สินทรัพย์ภายนอกทั้งหมดสนับสนุน ETag กลยุทธ์แคช Last-Modified ตามคุณสมบัติ Timestamp ที่ให้ไว้และสามารถอัปโหลดไปยังพื้นที่เก็บข้อมูลได้อย่างคงที่ (ตัวอย่างเช่นการมอบหมายเนื้อหาการถ่ายโอนเนื้อหาไปยัง HTTP API ระดับต่ำ) วิธีเดียวกันสามารถใช้เพื่อส่งคืนเส้นทางการเปลี่ยนเส้นทางที่กำหนดเองสำหรับเส้นทาง URL ที่เฉพาะเจาะจง

การใช้ TAssets ขั้นสูง

คุณสามารถฝังไดเรกทอรีหรือไฟล์ใด ๆ ลงในไฟล์ปฏิบัติการโครงการ เดียว ของคุณ สิ่งนี้จะช่วยให้คุณสามารถแจกจ่ายปรับขนาดและเรียกใช้เพียงไฟล์เดียวในสภาพแวดล้อมการผลิตของคุณ โหลดจากทรัพยากรและปรับใช้สินทรัพย์ใด ๆ ในการผลิตของคุณเมื่อเริ่มต้น TAssets ยังตรวจสอบไฟล์สำหรับการปรับเปลี่ยนเวลาและการเปลี่ยนแปลงขนาดก่อนที่จะบันทึกเพื่อเพิ่มประสิทธิภาพการทำงานของดิสก์ IO

ตัวอย่างเช่นคุณสามารถบีบอัดและแพ็คสินทรัพย์คงที่ทั้งหมดของคุณลงใน Assets.res และเพิ่มเติมแพ็คเทมเพลตมุมมองหนวดใน Views.res แยกต่างหากเช่นนี้:

• "..Toolsassetslz" "$(PROJECTDIR)Assets" "$(PROJECTDIR)Assets.tmp"
• "..Toolsresedit" -D "$(PROJECTDIR)Assets.res" rcdata ASSETS "$(PROJECTDIR)Assets.tmp"
• "..Toolsassetslz" -E "$(PROJECTDIR)Views" "$(PROJECTDIR)Views.tmp"
• "..Toolsresedit" -D "$(PROJECTDIR)Views.res" rcdata VIEWS "$(PROJECTDIR)Views.tmp"

ตัวเลือก -E สำหรับมุมมองหมายถึงการข้ามการบีบอัดใด ๆ เพราะเราไม่จำเป็นต้องบีบอัดมุมมองหนวด ตอนนี้คุณสามารถฝังไฟล์ทรัพยากรทั้งสองไว้ในการเรียกใช้งานได้ เพิ่มบรรทัดถัดไปให้คุณไฟล์โครงการใกล้ {$R *.res} หรือเพิ่มทั้งสองไฟล์ลงในโครงการ:

 { $R Assets.res }
{ $R Views.res }

จากนั้นในการผลิตคุณสามารถแยกมุมมองจากการดำเนินการเช่นนี้:

 procedure SaveViews ;
var
  Assets: TAssets;
begin
  Assets.Init;
  Assets.LoadFromResource( ' Views ' );
  Assets.SaveAllIdentities( ' Views ' );
end ;

ตัวเลือกที่กำหนดเอง

ด้วยเมธอด RegisterCustomOptions คุณสามารถปรับแต่งตัวเลือกที่แตกต่างกันสำหรับเส้นทาง URL HTTP ที่แตกต่างกัน ตัวอย่างเช่นคุณสามารถปิดการใช้งานการใช้แคชสำหรับคุณ API JSON หรือหน้าพิเศษเช่นนี้:

  HTTPServer.RegisterCustomOptions(
    [ ' /api/json ' , ' /login ' , ' /settings* ' ],
    HTTPServer.Options - [bpoSetCachePublic] + [bpoSetCachePrivate,
      bpoSetCacheNoCache, bpoSetCacheNoStore, bpoSetCacheMustRevalidate]);

ชุดทดสอบ

TBoilerplateHTTPServer ได้รับการทดสอบอย่างเต็มที่ครอบคลุมด้วยกรอบ การทดสอบ Mormot แทนที่จะใช้วิธีการ TDD แบบคลาสสิกสถานการณ์ การพัฒนาพฤติกรรม (BDD) จะใช้ โปรดดู TestsBoilerplateTests.pas สำหรับรายละเอียด

เปลี่ยนบันทึก

โครงการนี้ปฏิบัติตามเวอร์ชันความหมาย ทุกรุ่นพร้อมกับคำแนะนำการโยกย้ายจะถูกบันทึกไว้ในหน้า GitHub Reasees

ใบอนุญาต

รหัสมีอยู่ภายใต้ใบอนุญาต MIT

ผู้ติดต่อ

อย่าลังเลที่จะติดต่อฉันที่ @gmail.com : Eugene.ilyin