Topcoat: Rustのためのフルフルスタックフレームワーク
Topcoat: The full full-stack framework for Rust (github.com)
要約
Topcoatは、Rustでフルスタックアプリケーションを構築するためのモジュラーで機能豊富なフレームワークです。シンプルさと生産性を重視しており、サーバーサイドレンダリングとクライアントサイドのリアクティビティを組み合わせることで、APIレイヤーのボイラープレートを削減します。WebAssembly(Wasm)バンドルやクライアントビルドステップなしで、サーバーとブラウザ間でシームレスなインタラクションを実現します。
全文翻訳
[画像: Topcoat]
[画像: Crates.io] [画像: Docs.rs] [画像: MIT licensed] [画像: Build Status] [画像: Discord chat]
Topcoatは、フルスタックアプリケーションを構築するための、モジュール式で機能満載のRustフレームワークです。シンプルさと生産性を重視しています。Learn Topcoatで始め方を確認するか、Roadmapで今後の予定をご覧ください。
初期段階であり実験的です。破壊的変更が発生する可能性があります。
use topcoat::{
Result,
router::{module_router},
view::{View, component, view},
};
#[tokio::main]
async fn main() {
topcoat::start(module_router!().build()).await.unwrap();
}
#[page]
async fn home() -> Result<impl View> {
Ok(view! {
<!DOCTYPE html>
<html>
<body>
hello(name: "World")
</body>
</html>
})
}
#[component]
async fn hello(name: &str) -> Result<impl View> {
Ok(view! { <h1>"Hello, " (name) "!"</h1> })
}
Topcoatは何が違うのか
ボイラープレートなしのクライアントリアクティビティ
Topcoatはすべてのマークアップをサーバーでレンダリングします。コンポーネントは非同期で、データベースに直接クエリを実行できるため、独立したAPIレイヤーに必要な従来のボイラープレートがすべて不要になります。インタラクティビティは、ラウンドトリップを必要としません。$(...)式は通常の型チェックされたRustであり、Topcoatは初期レンダリングのためにサーバーで評価し、JavaScriptにも変換するため、ブラウザで即座に再実行されます。WASMバンドルもクライアントのビルドステップも不要です。
#[component]
async fn faq(cx: &Cx) -> Result<impl View> {
let open = signal(cx, || false);
Ok(view! {
// ブラウザ全体で実行されます。サーバーとのラウンドトリップはありません。
<button @click=$(|_e| open.set(!open.get()))>"What is Topcoat?"</button>
<p :hidden=$(!open.get())>"A full-stack Rust framework."</p>
})
}
更新がサーバーを必要とする場合(例: 新しい検索結果)、コンポーネントを#[shard]としてマークします。Topcoatは、$(...)引数のいずれかが変更されるたびにサーバーで再レンダリングし、新しいHTMLを置き換えます。
#[component]
async fn search(cx: &Cx) -> Result<impl View> {
let query = signal(cx, String::new);
Ok(view! {
<input @input=$(|e: Event| query.set(e.target.value))>
// ユーザーが入力するにつれて更新されます。
search_results(query: $(query.get()))
})
}
#[shard]
async fn search_results(cx: &Cx, query: String) -> Result<impl View> {
Ok(view! {
<ul>
// データベースクエリのような、独自のサーバーサイドコード:
for product in search_products(cx, &query).await? {
<li>(product.name)</li>
}
</ul>
})
}
強力で直感的なHTMLテンプレート
view!マクロは、HTMLとRustに忠実です。使い慣れたRustの制御フローをテンプレートの一部として使用できます。
view! {
<nav>
for item in nav_items {
<a
href=(item.url)
if item.url == current_path {
aria-current="page"
class="active"
}
>
(item.label)
</a>
}
</nav>
}
topcoat fmt CLIコマンドを使用して、コードベース全体のview!スニペット(およびその他のマクロ)を自動フォーマットします。
モジュールベースのルーティング
Topcoatは、オプションで、アプリケーションのモジュール構造からルートツリーを推測できます(ビルドステップなし)。
src/
|-- app.rs -> / (およびルート<html>レイアウト)
`-- app/
|-- about.rs -> /about
|-- _marketing.rs (レイアウト、URLセグメントなし)
|-- _marketing/
| `-- pricing.rs -> /pricing
|-- posts.rs -> /posts
|-- posts/
| `-- id.rs -> /posts/{post_id}
`-- api/
`-- health.rs -> GET /api/health
事前作成済みの編集可能なコンポーネント
Topcoat UIは、shadcn/uiにインスパイアされたTailwindに基づいたコンポーネントライブラリです。コンポーネントはtopcoat ui CLIコマンドを通じてプロジェクトにコピーされるため、ユースケースに合わせてデザインや機能を自由に変更できます。
#[component]
async fn delete_card() -> Result<impl View> {
Ok(view! {
card(
card_header(
card_title("Delete workspace")
card_description(
"This permanently removes the workspace and all of its data."
)
)
card_footer(
attrs: attributes! { class="justify-end" },
button(variant: ButtonVariant::Ghost, "Cancel")
button(variant: ButtonVariant::Destructive, "Delete workspace")
)
)
})
}
アセットバンドリング
バンドラーは、コンパイルされたバイナリをスキャンしてasset!呼び出しを見つけ、すべてのファイルをローカルアセットディレクトリにコピー(またはダウンロード)し、Topcoatが効率的に提供できるようにします。ブラウザキャッシュも積極的に行われます。
const FERRIS: Asset = asset!("./ferris.png");
view! { <img src=(FERRIS)> }
Topcoatは、Webフォントとアイコンのユーティリティ、およびFontsource(Google Fonts)とIconifyとの簡単な統合も提供します。
Tailwindの組み込みサポート
プロジェクトにTailwindを統合するには、tailwindフィーチャーを有効にします。
view! { <link rel="stylesheet" href=(topcoat::tailwind::stylesheet!())>
}
Topcoatを学ぶ
ここから始める
- Getting started:
topcoat newでアプリを作成し、開発サーバーを実行します。 - Manual setup: 依存関係を追加し、最小限のアプリを自分で配線します。
- Source code formatting: マクロ本体用の
topcoat fmt。
レンダリング
view!は、HTML、Rust式、制御フロー、コンポーネント呼び出しを組み合わせます。#[component]は、名前付き引数と子コンテンツを持つマークアップから非同期関数を呼び出せるようにします。attributes!は、コンポーネントに渡したり要素に展開したりする属性を収集します。class!は、ベース、オプション、条件付きCSSクラスを結合します。suspenseは、コンテンツのロード中にフォールバックを表示します。error_boundaryは、レンダリングに失敗した場合にフォールバックを表示します。live!とemit!は、非同期処理が新しいHTMLを生成するにつれて、ページの特定の部分を置き換えます。
ルーティング
- Router: ページ、レイアウト、APIルート。手動および自動検出。
- Module-based routing: モジュールツリーからルートテーブルを派生させます。
- Linking to handlers: ナビゲーションリンク、フォームアクション、リダイレクトには
href!を使用します。
リクエストの処理
- Request context (
Cx): ページ、レイアウト、コンポーネントが読み取る値。 - App context: 型でキー付けされた、リクエスト間で長寿命の値を共有します。
- Memoization: リクエストごとのキャッシュとファンアウトの重複排除のための
#[memoize]。 - Functions, not middlewares: 認証やその他のリクエストスコープの懸念をモデル化する推奨される方法。
- Cookies: リクエストCookieジャーを読み書きします。署名付き、暗号化、プレフィックス付きCookieも利用可能です。
- Sessions: 独自のストレージを持つセッション認証。ログイン/ログアウトライフサイクル、スライディング有効期限、トークンローテーション。
アセットシステム
- Assets: Rustでアセットを宣言し、コンテンツハッシュ付きURLで提供します。
- Fonts: Webフォントをバンドルして提供します。
- Icons: Iconifyアイコンセットをダウンロードするか、独自のものを宣言します。
クライアントリアクティビティ
- The runtime: シグナル、
$(...)式、@イベントハンドラ、:バインド属性。 - Expressions: Rust/JavaScriptの二重式言語とその語彙。
- Procedures: ブラウザから呼び出し可能な非同期サーバー関数。
- Shards: 引数が変更されるとサーバーで再レンダリングされるコンポーネント。
- Client-side navigation: ドキュメント全体のリロードなしでのリンク、プリフェッチ、ナビゲーション。
その他
- Topcoat UI: 事前に作成されたコンポーネントがプロジェクトにバンドルされ、編集可能です。
- Mail:
mail!マクロでメールを宣言し、SMTP、ファイル、またはインメモリトランスポートで配信します。
サードパーティ統合
- Tailwind: NodeなしのTailwind CSS。アセットパイプラインに組み込まれています。
- htmx: リクエスト/レスポンスヘッダーヘルパーを使用して、サーバーから部分的なHTMLスワップを駆動します。
- Alpine AJAX: Alpine AJAXのリクエストヘッダー規約を使用して、サーバーから部分的なHTMLスワップを駆動します。
- Datastar: サーバー送信イベントを介して、ページに要素とシグナルをパッチします。
ロードマップ
Topcoatに導入したい計画中の機能。アイデアがありますか?Issueを開く。
- 静的エクスポート
- (より多くの)リアクティビティ (
topcoat-runtime) - より多くのTopcoat UIコンポーネント、完全な「ブロック」(例: ログインフォーム)
- Toastyとのより良い統合(すべてのフィールドをリストアップせずに、フォームから安全にレコードを作成/更新)
- バリデーション
- ローカライゼーションサポート
OpenAPIエンドポイント- Topcoatのデプロイ方法に関するドキュメント
- 静的ページの前レンダリング
WebTransport- 画像最適化/リサイズ
- Markdownサポート
- より使いやすいミドルウェア(レート制限など)
- 認証
- バックグラウンドジョブ
- アイランド