🌴

TanStack、正直よく分からなかったのでStartから触ってみた

に公開

前からちょいちょい見かける TanStack に入門してみたので、まずは触って分かったことをまとめます。

この記事のゴールはシンプルです。TanStack Start でプロジェクトを作って /demo/prisma が動くところまで進めます。

公式サイト

https://tanstack.com/

公式サイトの左側のバーを見ると Router や Query などが並んでいて、最初はどれから見ればいいのか迷いました。

少しスクロールすると一覧っぽいセクションが出てきます。ここを見て「TanStack は役割ごとに分かれた部品集なんだな〜」と整理できました。

TanStackは何の集まりか

TanStack は「ひとつの巨大ライブラリ」ではなく、アプリ開発の役割ごとに分かれたライブラリ群です。よく見る名前を一言でまとめるとこうなります。

名前 ざっくり役割
Start フルスタックの土台(RouterやServer側の仕組みも含む)
Router ルーティング(型安全を強めに意識)
Query API取得・キャッシュ・再取得などサーバーデータ管理
Table テーブルのロジック(見た目は自分で実装する)
Form フォーム管理
Store アプリ内の状態管理(軽量)
DB クライアント側DB寄り(実験的)
AI AI連携用SDK(実験的)
Hotkeys ショートカット管理

今回やること

TanStack Start のスターターを作って、Prisma のデモ画面が動くところまでやります。

作業の流れは次の通りです。

TanStack Start を作ってみた

Start の overview を眺めつつ、まずはプロジェクト作成から入ります。
https://tanstack.com/start/latest/docs/framework/react/overview

自分は pnpm を使いました。

pnpm create @tanstack/start@latest

実行すると deprecated の警告が出ます。今後は次のコマンドが推奨らしいです。

tanstack create
# または
npx @tanstack/cli create

今回は pnpm create @tanstack/start@latest でもプロジェクトは生成できたので、そのまま進めました。

実行ログ

➜ dev ❯ pnpm create @tanstack/start@latest
Warning: @tanstack/create-start is deprecated. Use "tanstack create" or "npx @tanstack/cli create" instead.
         See: https://tanstack.com/start/latest/docs/framework/react/quick-start

┌  Let's configure your TanStack Start application
│
◇  What would you like to name your project?
│  tan-test
│
◇  Select toolchain
│  ESLint
│
◇  Select deployment adapter
│  Netlify
│
◇  What add-ons would you like for your project?
│  Prisma
│
◇  Would you like an example?
│  None
│
◇  Prisma: Database Provider
│  SQLite
│
◇  Initialized git repository
│
◇  Installed dependencies
│
└  Your TanStack Start app is ready in 'tan-test'.

Use the following commands to start your app:
% cd tan-test
% pnpm dev

セットアップ時の選択肢メモ

対話形式でいろいろ聞かれますが、今回はこんな意図で選びました。

  • Project Name(tan-test)
    -> 作成されるフォルダ名です。

  • Toolchain(ESLint)
    -> コードのチェック用です。まずはこれで十分かと。

  • Deployment adapter(Netlify)
    -> デプロイ先の想定です。Netlify に乗せる前提の設定が入りやすくなります。ホスティング先が未定なら Nitro(汎用)を選ぶのもアリっぽい。

  • Add-ons(Prisma)
    -> Start の雰囲気を掴むのに、DB まで一気に触れるデモがあると助かるので Prisma を追加しました。

  • Prisma: Database Provider(SQLite)
    -> ローカルで軽く試したいので SQLite を選びました。動かすだけなら一番ラクです。

今回の選択はこうなります。

項目 選択
Toolchain ESLint
Adapter Netlify
Add-on Prisma
DB SQLite
Example None

初期プロジェクト構成(ざっくり)

生成直後の雰囲気はこんな感じでした。

主要なファイルだけ抜き出すと以下です。

.
├─ src/
│  ├─ routes/
│  │  ├─ __root.tsx
│  │  ├─ index.tsx
│  │  └─ demo/prisma.tsx
│  ├─ components/
│  │  └─ Header.tsx
│  ├─ db.ts
│  ├─ router.tsx
│  ├─ routeTree.gen.ts
│  └─ styles.css
├─ prisma/
│  ├─ schema.prisma
│  └─ seed.ts
├─ vite.config.ts
├─ prisma.config.ts
├─ netlify.toml
└─ .env.local

読む順番を決めると迷いにくいです。自分はこの順で見ました。

  1. src/routes/demo/prisma.tsx(まず動いている例を見る)
  2. src/db.ts(DB接続の初期化を見る)
  3. prisma/schema.prisma(Todoモデルを見る)
  4. src/routes/__root.tsx(共通レイアウトを見る)
  5. vite.config.ts(プラグイン構成を軽く眺める)

とりあえず動かして触ってみる

Prisma を付けた場合は、まず DB の準備が必要です。db:push は SQLite のDBファイルを作る役割もあります。

pnpm db:generate
pnpm db:push

次に起動します。

pnpm dev

サイドバーからも辿れますが、手っ取り早くデモに行くならここです。

http://localhost:3000/demo/prisma

アクセスすると、おしゃれな Todo アプリが出ました。

この画面は、ざっくりこういう流れで動いていました。

補足画像)

createServerFnのところ


db.tsのところ

初回表示は loader で Todo を取得して表示します。追加ボタンを押すと server function が呼ばれて DB に保存されます。保存後に invalidate して再取得するので、画面が更新されます。

ちょっと脱線、loaderについて補足

TanStack Router(Start)でよく出てくる loader。
これが何をしているのかを整理します。

結論から言うと

loader は「ページを表示する前にデータを取得する仕組み」です。

従来の React との違い

まず、よくあるパターンです。

const [todos, setTodos] = useState([])

useEffect(() => {
  fetchTodos().then(setTodos)
}, [])

この流れはこうなります。

  1. 画面が表示される
  2. useEffect が走る
  3. データを取得する
  4. 再レンダリングされる

つまり、一度「空の画面」が出ます。

loader を使うとどうなる?

今回のコードはこちらです。

export const Route = createFileRoute('/demo/prisma')({
  component: DemoPrisma,
  loader: async () => await getTodos(),
})

この loader がやっていることはシンプルです。

  1. /demo/prisma にアクセス
  2. 画面を表示する前に loader 実行
  3. getTodos() でデータ取得
  4. データが揃った状態で画面を描画

図にするとこうなります。

では、取得したデータはどこに入るでしょうか?
-> loader の戻り値は、コンポーネント内でこうやって受け取れます。

const todos = Route.useLoaderData()

つまり

  • loader がデータを返す
  • useLoaderData() で受け取る
  • そのまま描画する

という流れです。

では、なぜ useEffect が不要になるのでしょうか?

-> ポイントはここです。

データ取得が「画面表示後」ではなく「表示前」に行われる

そのため、ページ単位の初期データ取得では useEffect を書く必要がなくなります。

loader の立ち位置は

  • component -> 画面を描画する
  • loader -> 画面表示前のデータ準備

役割がきれいに分離されています。

ただし注意点

loader があれば何でも解決、というわけではありません。

例えば

  • ボタン押下後の再取得
  • ポーリング
  • クライアント限定の副作用処理

こういったケースでは、通常どおり useEffect や他の仕組みを使います。

loader は

ページ単位の初期データ取得を、宣言的に書ける仕組み

React でありがちな「useEffect で初回 fetch」のパターンを、より自然な形に置き換えてくれる存在です。

ここまでの感想

Start は「ルーティング、サーバー関数、DB、UI」を一気に触れるのが良いですね。最初の一歩としては、デモが動くところまでやるだけでも雰囲気が掴めました。

次は src/routes/demo/prisma.tsx をしっかり読んで、loader と createServerFn の中身をもう少し丁寧に追ってみます。

Discussion