Скачать salvo - Скачать исходный код salvo

Английский 简体中文繁體中文

Статус сборки

Salvo - это чрезвычайно простая и мощная бэкэнд -рамки Rust. Для разработки бэкэнд -услуг требуются только базовые знания ржавчины.

Функции

Построен с Hyper 1 и Tokio;
Http1, http2 и http3 ;
Унифицированное промежуточное программное обеспечение и ручка интерфейса;
Маршрутизатор может быть вложенным бесконечно, а несколько среднихворсов могут быть прикреплены к любому маршрутизатору;
Интегрированная обработка Multipart Form;
Поддержка WebSocket, WebTransport;
Поддержать 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 CLI-это инструмент командной строки, который упрощает создание новых проектов Salvo, вспомогательные шаблоны для веб-API, веб-сайтов, баз данных (включая SQLite, PostgreSQL и MySQL через SQLX, Seaorm, Diesel, Rbatis) и базовое провозглашение. Вы можете использовать Salvo-CLI для создания нового проекта Salvo:

установить

cargo install salvo-cli

Создать новый проект Salvo

salvo new project_name

Больше примеров

Вы можете найти больше примеров в папке примеров. Вы можете запустить эти примеры со следующей командой:

 cd examples
cargo run --bin example-basic-auth

Вы можете использовать любое имя примера, которое вы хотите запустить, вместо basic-auth .

Производительность

Отсюда можно найти результаты тестирования.

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

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

? Участники

☕ Пожертвовать

Salvo - это проект с открытым исходным кодом. Если вы хотите поддержать Salvo, вы можете ☕ купить мне кофе здесь .

️ Лицензия

Салво

Лицензия Apache, версия 2.0, (лицензия-apache или http://www.apache.org/licenses/license-2.0).
Лицензия MIT (лицензия MIT или http://opensource.org/licenses/mit).

Расширять