salvo下载 - salvo源代码下载

英语简体中文简体中文

建立状态

Salvo是一个非常简单和强大的Rust Web后端框架。开发后端服务只需要基本的生锈知识。

特征

用Hyper 1和Tokio建造；
http1，http2和http3 ;
统一中间件和处理接口；
路由器可以无限地嵌套，并且可以将多个中间件连接到任何路由器上。
集成的多部分形式处理；
支持WebSocket，WebTransport；
支持OpenAPI，生成OpenAPI数据自动；
支持ACME，自动从Let's Encrypt获得TLS证书；
支持塔服务和层；

⚡️快速开始

您可以在此处查看样本，或查看官方网站。

Hello World与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 )

这是一个非常简单的中间件，它在Response中添加了Header ，查看完整的源代码。

可链树路由系统

通常，我们以这样的方式编写路由：

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

通常，查看文章和文章列表之类的内容不需要用户登录，而是创建，编辑，删除文章等。需要用户登录身份验证权限。 Salvo中的树状路由系统可以满足这一需求。我们可以在没有用户登录的情况下编写路由器：

 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 )

查看完整的源代码

文件上传

我们可以在Request中通过函数file获取文件async：

 # [ 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项目的创建，支持Web API，网站，数据库的模板（包括SQLite，PostgreSQL和MySQL，通过SQLX，Seaorm，Seaorm，Diesel，diesel，rbatis）和基本中间件和基本中间件和基本中间件。您可以使用Salvo-CLI创建一个新的Salvo项目：