ngx_http_service_module

โมดูลการประมวลผลบริการ nginx

ข้อกำหนดเบื้องต้น

• แพลตฟอร์ม Linux
• เวอร์ชัน nginx ไม่ต่ำกว่า 1.9.11
• เครื่องมือที่ติดตั้งสำหรับการรวบรวม nginx

คุณสมบัติของโมดูล

• ข้อความคำขอ/การตอบกลับบริการทั้งหมดอยู่ในรูปแบบ json ไลบรารี cJSON ถูกรวบรวมโดยค่าเริ่มต้น นักพัฒนาธุรกิจสามารถใช้มันเพื่อแยกวิเคราะห์/แพ็คเกจแพ็คเกจและแน่นอนว่าพวกเขายังสามารถใช้ไลบรารีการแยกวิเคราะห์ json อื่น ๆ (ดู example/third_test )
• โดยการใช้อินเทอร์เฟซเฉพาะให้รวบรวมบริการลงในไลบรารีแบบไดนามิกและโหลดลงใน nginx

ข้อได้เปรียบ

• ประสิทธิภาพสูง โดยใช้รูปแบบหลายกระบวนการของ NGINX ในการประมวลผลธุรกิจและนักพัฒนาธุรกิจยังสามารถใช้การทำมัลติเธรดในอินเทอร์เฟซที่ใช้งานตามสถานการณ์ที่เฉพาะเจาะจงเพื่อปรับปรุงประสิทธิภาพเพิ่มเติมและยังสามารถปรับขนาดในแนวนอนผ่านการปรับสมดุลโหลด
• แข็งแกร่ง เมื่อบริการล่ม NGINX จะเริ่มกระบวนการทำงานอีกครั้งเพื่อให้แน่ใจว่าธุรกิจจะไม่หยุดการประมวลผล
• บริการ Smooth Restart/Upgrade ด้วยความช่วยเหลือของฟังก์ชั่นการรีสตาร์ท/อัพเกรดที่ราบรื่นของ Nginx การรีสตาร์ทบริการ/การอัพเกรดสามารถรีสตาร์ท/อัพเกรดอย่างหรูหรา

สร้าง

1. ดาวน์โหลดซอร์สโค้ด nginx

 # 这里以 nginx-1.24.0 为例, 也可以根据自己情况下载其他版本的 nginx 源码
wget http://nginx.org/download/nginx-1.24.0.tar.gz

2. การบีบอัดและป้อนไดเรกทอรีซอร์สโค้ด Nginx

tar -zxvf nginx-1.24.0.tar.gz
cd nginx-1.24.0

3. ดึงรหัสของโครงการนี้

 # 这里拉取到 nginx 源码的目录下, 也可以根据情况拉取到其他目录
git clone https://github.com/xukeawsl/ngx_http_service_module.git

4. เพิ่มโมดูลลงใน Nginx และติดตั้ง

 # 如果你将项目代码放在其他路径, 则需要修改这里的模块路径
./configure --add-module=ngx_http_service_module
make
make install

คำสั่งการกำหนดค่า

1. module_path (สามารถกำหนดค่าได้ในบล็อก HTTP เท่านั้น)

• คำสั่งนี้กำหนดค่าเส้นทางที่ไลบรารีแบบไดนามิก หากไม่ได้กำหนดค่าให้ติดตั้งเส้นทางค้นหาเริ่มต้น
• พารามิเตอร์แรกคือพา ธ ตามด้วยชื่อไฟล์ไลบรารีไดนามิก (ชื่อเต็ม)

 module_path {
    / path/to /dir1    module1.so;
    / path/to /dir2    module2.so  module3.so;
}

2. module_dependency (สามารถกำหนดค่าได้ในบล็อก HTTP เท่านั้น)

• การกำหนดค่านี้ตั้งค่าการพึ่งพาระหว่างไลบรารีแบบไดนามิก
• พารามิเตอร์แรกคือไลบรารีแบบไดนามิกที่ขึ้นอยู่กับตามด้วยไลบรารีแบบไดนามิกที่ขึ้นอยู่กับ

 module_dependency {
    module1. so     module2.so;
    module3. so     module2.so  libjsoncpp.so;
}

3. บริการ (สามารถกำหนดค่าได้ในบล็อก HTTP เท่านั้น)

• บริการที่จัดทำโดยโมดูลการตั้งค่าการกำหนดค่านี้
• พารามิเตอร์แรกคือชื่อไฟล์ไลบรารีแบบไดนามิกตามด้วยชื่อบริการที่มีให้สำหรับไลบรารีแบบไดนามิก (Case Sensitive)
• ชื่อบริการจะต้องมีความเป็นเอกลักษณ์ทั่วโลก

 service {
    module1. so    srv_echo  srv_datetime;
    module2. so    srv_sayHello;
    module3. so    srv_getSum;
}

4. service_mode (http, เซิร์ฟเวอร์, บล็อกตำแหน่งทั้งหมดสามารถกำหนดค่าได้)

• ใช้เพื่อเปิดใช้งานฟังก์ชั่นโมดูลชิ้นส่วนที่ไม่ได้เปิดใช้งานจะไม่ถูกประมวลผลสำหรับบริการ
• ไม่ได้เปิดใช้งานโดยค่าเริ่มต้นตัวอย่างต่อไปนี้จะเปิดใช้งานทั่วโลกบนเซิร์ฟเวอร์ที่ระบุ แต่คำขอการกำหนดเส้นทางสำหรับ /test ไม่ได้ประมวลผล

 http {

    server {
        sevice_mode on;

        location /test {
            service_mode off;
        }
    }
}

การพัฒนาส่วนต่อประสานบริการ

• ผู้ใช้จำเป็นต้องรวมไฟล์อินเตอร์เฟส ngx_http_service_interface.h ในโครงการ

 // 接口形如下面的函数

#include "ngx_http_service_interface.h"
#include "cJSON.h"

void srv_sayHello ( const ngx_request_t * rqst , ngx_request_t * resp )
{
    // do something...
}

• โครงสร้างคำขอ/การตอบกลับ

 // 请求结构只包含一个 const char * 指针指向 json 请求字符串
struct ngx_json_request_s {
    const char * data ;
};

// 响应结构包含一个 char * 指针指向 json 响应字符串和一个回调函数用于释放响应字符串的内存
// 因为对于 c++ 实现的服务可能使用 new 来分配内存, 那就需要指定正确的内存释放方式
struct ngx_json_response_s {
    char * data ;
    void ( * release )( void * );
};

กฎการโทรบริการ

• วิธีการร้องขอต้องมี POST
• ระบุบริการที่จะเรียกโดยค่าของ Service-Name ส่วนหัว HTTP
• Content-Type จะต้องเป็นประเภท json
• ดังต่อไปนี้โทรหาบริการ srv_sayHello

curl -X POST " http://localhost/service_test " 
-H ' Content-Type: application/json ' 
-H ' Service-Name: srv_sayHello ' 
-d ' {"data": "xxxx"} '