تنزيل salvo - تنزيل رمز المصدر salvo

الإنجليزية 简体中文繁體中文

بناء الحالة

Salvo هو إطار خلفي على شبكة الإنترنت بسيط وقوي للغاية وقوي. لا يلزم سوى معرفة الصدأ الأساسية لتطوير خدمات الواجهة الخلفية.

سمات

بنيت مع Hyper 1 و Tokio.
HTTP1 ، HTTP2 و HTTP3 ؛
الوسيطة الموحدة وواجهة المقبض ؛
يمكن تداخل جهاز التوجيه بلا حدود ، ويمكن توصيل العديد من الأدوات الوسطى بأي جهاز توجيه ؛
معالجة النماذج المتعددة المتكاملة ؛
دعم WebSocket ، WebTransport ؛
دعم Openapi ، وإنشاء بيانات OpenAPI تلقائيًا ؛
دعم ACME ، احصل على شهادة TLS تلقائيًا من Let's Encrypt ؛
دعم خدمة برج وطبقة ؛

⚡ بداية سريعة

يمكنك عرض العينات هنا ، أو عرض الموقع الرسمي.

مرحبا العالم مع ACME و HTTP3

لا يتطلب الأمر سوى بضعة أسطر من التعليمات البرمجية لتنفيذ خادم يدعم ACME للحصول على الشهادات تلقائيًا ، ويدعم بروتوكولات HTTP1 و HTTP2 و HTTP3.

 use salvo :: prelude :: * ;

# [ handler ]
async fn hello ( res : & mut Response ) {
    res . render ( Text :: Plain ( "Hello World" ) ) ;
}

# [ tokio :: main ]
async fn main ( ) {
    let mut router = Router :: new ( ) . get ( hello ) ;
    let listener = TcpListener :: new ( "0.0.0.0:443" )
        . acme ( )
        . add_domain ( "test.salvo.rs" ) // Replace this domain name with your own.
        . http01_challenge ( & mut router ) . quinn ( "0.0.0.0:443" ) ;
    let acceptor = listener . join ( TcpListener :: new ( "0.0.0.0:80" ) ) . bind ( ) . await ;
    Server :: new ( acceptor ) . serve ( router ) . await ;
}

الوسيطة

لا يوجد فرق بين المعالج والأدوات الوسيطة ، والوسيط هو مجرد معالج. يمكنك كتابة البرامج الوسيطة دون معرفة مفاهيم مثل الأنواع المرتبطة والأنواع العامة. إذا كنت تستطيع كتابة وظيفة ، فيمكنك كتابة الوسيطة !!!

 use salvo :: http :: header :: { self , HeaderValue } ;
use salvo :: prelude :: * ;

# [ handler ]
async fn add_header ( res : & mut Response ) {
    res . headers_mut ( )
        . insert ( header :: SERVER , HeaderValue :: from_static ( "Salvo" ) ) ;
}

ثم أضفه إلى جهاز التوجيه:

 Router :: new ( ) . hoop ( add_header ) . get ( hello )

هذا هو الوسيطة البسيطة للغاية ، فهو يضيف Header إلى Response ، وعرض رمز المصدر الكامل.

نظام توجيه الأشجار القابل للسلسلة

عادةً ما نكتب توجيهًا مثل هذا:

 Router :: with_path ( "articles" ) . get ( list_articles ) . post ( create_article ) ;
Router :: with_path ( "articles/<id>" )
    . get ( show_article )
    . patch ( edit_article )
    . delete ( delete_article ) ;

في كثير من الأحيان ، لا يتطلب شيء مثل عرض المقالات وقوائم المقالات تسجيل الدخول إلى المستخدم ، ولكن إنشاء المقالات وتحريرها وحذفها ، إلخ. تتطلب أذونات مصادقة تسجيل الدخول إلى المستخدم. يمكن لنظام التوجيه الذي يشبه الأشجار في سلفو تلبية هذا الطلب. يمكننا كتابة أجهزة التوجيه دون تسجيل الدخول إلى المستخدم معًا:

 Router :: with_path ( "articles" )
    . get ( list_articles )
    . push ( Router :: with_path ( "<id>" ) . get ( show_article ) ) ;

ثم اكتب أجهزة التوجيه التي تتطلب من المستخدم تسجيل الدخول معًا ، واستخدام البرامج الوسيطة المقابلة للتحقق مما إذا كان المستخدم قد تم تسجيل الدخول:

 Router :: with_path ( "articles" )
    . hoop ( auth_check )
    . push ( Router :: with_path ( "<id>" ) . patch ( edit_article ) . delete ( delete_article ) ) ;

على الرغم من أن هذين المسارين لهما نفس path("articles") ، فلا يزال من الممكن إضافته إلى نفس مسار الوالدين في نفس الوقت ، وبالتالي يبدو الطريق النهائي مثل هذا:

 Router :: new ( )
    . push (
        Router :: with_path ( "articles" )
            . get ( list_articles )
            . push ( Router :: with_path ( "<id>" ) . get ( show_article ) ) ,
    )
    . push (
        Router :: with_path ( "articles" )
            . hoop ( auth_check )
            . push ( Router :: with_path ( "<id>" ) . patch ( edit_article ) . delete ( delete_article ) ) ,
    ) ;

<id> يتطابق مع جزء في المسار ، في ظل الظروف العادية ، id المقالة هو مجرد رقم ، يمكننا استخدام التعبيرات العادية لتقييد قواعد مطابقة id ، r"<id:/d+/>" .

يمكنك أيضًا استخدام <**> أو <*+> أو <*?> لمطابقة جميع شظايا المسار المتبقية. لجعل الكود أكثر قابلية للقراءة ، يمكنك أيضًا إضافة اسم مناسب لجعل دلالات المسار أكثر وضوحًا ، على سبيل المثال: <**file_path> .

يجب استخدام بعض التعبيرات المنتظمة لمسارات المطابقة بشكل متكرر ، ويمكن تسجيلها مسبقًا ، مثل GUID:

 PathFilter :: register_wisp_regex (
    "guid" ,
    Regex :: new ( "[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}" ) . unwrap ( ) ,
) ;

هذا يجعلها أكثر إيجازًا عند الحاجة إلى مطابقة المسار:

 Router :: with_path ( "<id:guid>" ) . get ( index )

عرض رمز المصدر بالكامل

تحميل الملف

يمكننا الحصول على ملف ASYNC حسب file الوظيفة عند Request :

 # [ handler ]
async fn upload ( req : & mut Request , res : & mut Response ) {
    let file = req . file ( "file" ) . await ;
    if let Some ( file ) = file {
        let dest = format ! ( "temp/{}" , file . name ( ) . unwrap_or_else ( || "file" . into ( ) ) ) ;
        if let Err ( e ) = tokio :: fs :: copy ( & file . path , Path :: new ( & dest ) ) . await {
            res . status_code ( StatusCode :: INTERNAL_SERVER_ERROR ) ;
        } else {
            res . render ( "Ok" ) ;
        }
    } else {
        res . status_code ( StatusCode :: BAD_REQUEST ) ;
    }
}

استخراج البيانات من الطلب

يمكنك بسهولة الحصول على بيانات من مصادر بيانات مختلفة متعددة وتجميعها في النوع الذي تريده. يمكنك تحديد نوع مخصص أولاً ، على سبيل المثال:

 # [ derive ( Serialize , Deserialize , Extractible , Debug ) ]
/// Get the data field value from the body by default.
# [ salvo ( extract ( default_source ( from = "body" ) ) ) ]
struct GoodMan < ' a > {
    /// The id number is obtained from the request path parameter, and the data is automatically parsed as i64 type.
    # [ salvo ( extract ( source ( from = "param" ) ) ) ]
    id : i64 ,
    /// Reference types can be used to avoid memory copying.
    username : & ' a str ,
    first_name : String ,
    last_name : String ,
}

ثم في Handler ، يمكنك الحصول على البيانات مثل هذا:

 # [ handler ]
async fn edit ( req : & mut Request ) {
    let good_man : GoodMan < ' _ > = req . extract ( ) . await . unwrap ( ) ;
}

يمكنك حتى تمرير النوع مباشرة إلى الوظيفة كمعلمة ، مثل هذا:

 # [ handler ]
async fn edit < ' a > ( good_man : GoodMan < ' a > ) {
    res . render ( Json ( good_man ) ) ;
}

عرض رمز المصدر بالكامل

مدعوم Openapi

يمكن تحقيق دعم مثالي لـ OpenAPI دون إجراء تغييرات كبيرة على المشروع.

 # [ derive ( Serialize , Deserialize , ToSchema , Debug ) ]
struct MyObject < T : ToSchema + std :: fmt :: Debug > {
    value : T ,
}

# [ endpoint ]
async fn use_string ( body : JsonBody < MyObject < String > > ) -> String {
    format ! ( "{:?}" , body )
}
# [ endpoint ]
async fn use_i32 ( body : JsonBody < MyObject < i32 > > ) -> String {
    format ! ( "{:?}" , body )
}
# [ endpoint ]
async fn use_u64 ( body : JsonBody < MyObject < u64 > > ) -> String {
    format ! ( "{:?}" , body )
}

# [ tokio :: main ]
async fn main ( ) {
    tracing_subscriber :: fmt ( ) . init ( ) ;

    let router = Router :: new ( )
        . push ( Router :: with_path ( "i32" ) . post ( use_i32 ) )
        . push ( Router :: with_path ( "u64" ) . post ( use_u64 ) )
        . push ( Router :: with_path ( "string" ) . post ( use_string ) ) ;

    let doc = OpenApi :: new ( "test api" , "0.0.1" ) . merge_router ( & router ) ;

    let router = router
        . push ( doc . into_router ( "/api-doc/openapi.json" ) )
        . push ( SwaggerUi :: new ( "/api-doc/openapi.json" ) . into_router ( "swagger-ui" ) ) ;

    let acceptor = TcpListener :: new ( "127.0.0.1:5800" ) . bind ( ) . await ;
    Server :: new ( acceptor ) . serve ( router ) . await ;
}

سلفو كلي

Salvo CLI هي أداة سطر الأوامر التي تبسط إنشاء مشاريع Salvo الجديدة ، ودعم القوالب لواجهة برمجة تطبيقات الويب ، ومواقع الويب ، وقواعد البيانات (بما في ذلك SQLite ، و PostgreSQL ، و MySQL عبر SQLX ، و Seaorm ، و Diesel ، و RBATIS) ، والوسيط الأساسي. يمكنك استخدام Salvo-Cli لإنشاء مشروع Salvo جديد:

ثَبَّتَ

cargo install salvo-cli

إنشاء مشروع سلفو جديد

salvo new project_name

أداء

يمكن العثور على نتيجة الاختبار القياسية من هنا:

https://web-frameworks-benchmark.netlify.app/result؟l=rust

https://www.techempower.com/benchmarks/#section=data-r22

؟ المساهمين

☕ التبرع

Salvo هو مشروع مفتوح المصدر. إذا كنت ترغب في دعم Salvo ، فيمكنك شراء قهوة هنا .

️ رخصة

Salvo مرخصة تحت أي من

Apache License ، الإصدار 2.0 ، (ترخيص-apache أو http://www.apache.org/licenses/license-2.0).
ترخيص MIT (ترخيص-mit أو http://opensource.org/licenses/mit).

يوسع