英語简体中文简体中文



Salvoは非常にシンプルで強力なRust Webバックエンドフレームワークです。バックエンドサービスを開発するには、基本的な錆の知識のみが必要です。
ここでサンプルを表示するか、公式Webサイトを表示できます。
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 ) ;多くの場合、記事や記事リストを表示するようなものでは、ユーザーログインは必要ありませんが、記事の作成、編集、削除などが必要です。サルボの木のようなルーティングシステムは、この需要を満たすことができます。ユーザーログインなしでルーターを作成できます。
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 ) ) ;これらの2つのルートには同じ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 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の完璧なサポートは、プロジェクトに大きな変更を加えることなく達成できます。
# [ 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は、Web API、Webサイト、データベース(SQLite、PostgreSQL、およびMySQLを介してSQLX、SeoM、Diesel、Rbatisを含む)、および基本的なミドルウェアのテンプレートをサポートする新しいSalvoプロジェクトの作成を簡素化するコマンドラインツールです。 Salvo-Cliを使用して、新しいSalvoプロジェクトを作成できます。
cargo install salvo-clisalvo 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ライセンス(ライセンスマイットまたはhttp://opensource.org/licenses/mit)。