DokuFullstack-Frameworks
Von Next.js zu Nexy
In Nexy behält ein Next.js App Router-Projekt seine Dateirouten, Layouts und React Komponenten, während Servercode, Routenhandler und Serveraktionen in Python Dateien daneben verschoben werden.
Jeder Abschnitt unten zeigt eine Next.js-Gewohnheit, dann dasselbe in Nexy.
Wählen Sie zuerst den Modus aus
Eine Next.js-App mischt Server- und Clientkomponenten in einem Baum. Ein Nexy-Projekt wählt eine von zwei Formen in nexyconfig.py:
| Ihre Next.js-App ist | Nexy-Modus | Seiten sind |
|---|---|---|
| überwiegend interaktiv, Client-Navigation | Client-Modus, useCSR = True |
.tsx Dateien, wie in app/ |
| größtenteils Inhalt, ein paar interaktive Teile | Servermodus, die Standardeinstellung | .nexy Seiten mit React Inseln |
from nexy.core.models import NexyConfigModelfrom nexy.frontend import react class NexyConfig(NexyConfigModel): useFF = react() useCSR = TrueIn den folgenden Abschnitten wird der Client-Modus verwendet, sofern nicht anders angegeben. Siehe Servermodus und Clientmodus.
page.tsx
export default function About() { return <h1>About</h1>;}Eine Seite ist die Datei selbst, kein page.tsx in einem Ordner:
export default function About() { return <h1>About</h1>;}app/page.tsx ist src/routes/index.tsx und app/blog/page.tsx ist src/routes/blog/index.tsx.
Dateien weiterleiten, App Router und Pages Router
Beide Router von Next.js werden auf src/routes/ abgebildet. Eine Datei des Pages Routers behält ihren Pfad; Ein page.tsx des App Routers wird zu index.tsx, oder eine nach ihrem Ordner benannte Datei:
| Next.js | Nexy |
|---|---|
pages/about.tsx |
src/routes/about.tsx |
pages/blog/[slug].tsx |
src/routes/blog/[slug].tsx |
app/about/page.tsx |
src/routes/about/index.tsx oder src/routes/about.tsx |
app/blog/[slug]/page.tsx |
src/routes/blog/[slug]/index.tsx oder src/routes/blog/[slug].tsx |
app/docs/[...slug]/page.tsx |
src/routes/docs/[...slug].tsx |
app/(marketing)/pricing/page.tsx |
src/routes/(marketing)/pricing.tsx |
pages/api/items/[id].ts |
src/routes/api/items/[id].py |
app/api/items/[id]/route.ts |
src/routes/api/items/[id].py oder src/routes/api/items/[id]/index.py |
Eine .tsx-Datei ist eine Seite und eine .py-Datei ist ein Handler: Die Erweiterung sagt welche, also verliert ein Routenhandler seinen /route-Ordner.
Dynamische Segmente und params
export default async function Post({ params }: { params: Promise<{ slug: string }> }) { const { slug } = await params; return <h1>{slug}</h1>;}import { useParams } from "@nexy/client"; export default function Post() { const { slug } = useParams<{ slug: string }>(); return <h1>{slug}</h1>;}[...slug] und Routengruppen wie (marketing) funktionieren wie in Next.js.
generateStaticParams
export async function generateStaticParams() { return [{ slug: "hello" }, { slug: "world" }];}Der gleiche Export unter diesem Namen oder getStaticParams liefert ein vorgerendertes Dokument pro Wert. Nexy ruft es ohne await auf, also gibt es das Array selbst zurück:
import { useParams } from "@nexy/client"; export function getStaticParams() { return [{ slug: "hello" }, { slug: "world" }];} export default function Post() { const { slug } = useParams<{ slug: string }>(); return <h1>{slug}</h1>;}layout.tsx
export default function RootLayout({ children }: { children: React.ReactNode }) { return ( <html lang="en"> <body>{children}</body> </html> );}Dieselbe Datei, einen Ordner höher: Das Stammlayout besitzt <html>, und ein layout.tsx in einem Unterordner ist darin verschachtelt.
import type { ReactNode } from "react"; export default function RootLayout({ children }: { children: ReactNode }) { return ( <html lang="en"> <head> <title>My app</title> </head> <body>{children}</body> </html> );}metadata
export const metadata = { title: "Blog", description: "Posts about Nexy" };Eine .tsx-Seite hat keinen metadata-Export: Schreiben Sie die Tags in das Root-Layout. Im Servermodus legt eine .nexy-Seite sie pro Seite fest:
metadata = {"title": "Blog", "description": "Posts about Nexy"}<h1>Blog</h1>Die Wurzel layout.nexy schreibt die Tags, wo Next.js würde, im <head>:
from nexy import useMetadata children: prop[NexyElement]<!DOCTYPE html><html> <head>{{ useMetadata().html() }}</head> <body>{{ children | safe }}</body></html>next/link und next/navigation
"use client";import Link from "next/link";import { usePathname, useRouter } from "next/navigation";Die gleichen Namen, aus @nexy/client:
import { Link, usePathname, useRouter } from "@nexy/client"; export function Nav() { const pathname = usePathname(); const router = useRouter(); return ( <nav> <Link href="/">Home</Link> <Link href="/about" activeClassName="active">About</Link> <span>{pathname}</span> <button onClick={() => router.push("/dashboard")}>Dashboard</button> </nav> );}Routenhandler
export async function GET(request: Request, { params }: { params: Promise<{ id: string }> }) { const { id } = await params; return Response.json({ id: Number(id) });}Derselbe GET-Export, in Python, ohne /route:
async def GET(id: int): return {"id": id}Ein Körper ist ein Pydantic-Modell und /docs listet jeden Handler auf:
from pydantic import BaseModel from nexy.http import JSONResponse class NewItem(BaseModel): name: str async def POST(item: NewItem): return JSONResponse({"created": item.name}, status_code=201)Serveraktionen und revalidatePath
"use server";import { revalidatePath } from "next/cache"; export async function addTodo(title: string) { await db.todo.create({ data: { title } }); revalidatePath("/todos");}Eine Aktion ist eine Python Funktion. Nexy generiert seinen typisierten Client in @nexy/actions:
from pydantic import BaseModel from nexy.decorators import Action, revalidate class Todo(BaseModel): title: str done: bool = False @Actionasync def add_todo(title: str) -> Todo: revalidate("/todos") return Todo(title=title)import { useAction } from "@nexy/client";import { add_todo } from "@nexy/actions"; export default function Todos() { const { run, pending, error, data } = useAction(add_todo); return ( <button disabled={pending} onClick={() => run({ title: "Write the docs" })}> {error ? error.message : data ? `Added ${data.title}` : "Add"} </button> );}useActionState und useFormStatus werden den pending, error und data von useAction zugeordnet.
Serverkomponenten sind .nexy Seiten
export default async function Users() { const users = await db.user.findMany(); return <ul>{users.map((user) => <li key={user.id}>{user.name}</li>)}</ul>;}Eine Next.js Serverkomponente läuft auf dem Server, liest Daten und sendet HTML. Eine .nexy-Seite ist im Servermodus dasselbe: Ihr Frontmatter ist der Hauptteil der asynchronen Komponente in Python, und die Vorlage ist das, was sie zurückgibt.
users = [{"id": 1, "name": "Ada"}, {"id": 2, "name": "Alan"}]<ul> {% for user in users %} <li>{{ user.name }}</li> {% endfor %}</ul>| Next.js Serverkomponente | .nexy Seite |
|---|---|
app/users/page.tsx, nein "use client" |
src/routes/users.nexy |
await db.user.findMany() in der Komponente |
eine Abfrage im Vordergrund |
{params} und {searchParams} |
slug: prop[str] und useSearchParams() |
cookies() und headers() von next/headers |
useCookies() und useHeaders() |
export const revalidate = 60 |
revalidate = 60 |
eine "use client"-Komponente darin |
eine Insel: <Counter directive="client:load" /> |
Im Client-Modus wird eine .tsx-Seite im Browser ausgeführt, sodass diese die Daten von einem Handler liest:
async def GET(): return [{"id": 1, "name": "Ada"}, {"id": 2, "name": "Alan"}]import { useEffect, useState } from "react"; type User = { id: number; name: string }; export default function Users() { const [users, setUsers] = useState<User[]>([]); useEffect(() => { fetch("/api/users").then((response) => response.json()).then(setUsers); }, []); return <ul>{users.map((user) => <li key={user.id}>{user.name}</li>)}</ul>;}"use client" Komponenten innerhalb von Serverseiten
import Counter from "./counter"; // "use client" export default function Home() { return ( <> <h1>Static heading</h1> <Counter /> </> );}Im Servermodus ist die Client-Komponente eine Insel und ihre Anweisung besagt, wann sie hydratisiert wird:
from "@/components/Counter.tsx" import Counter<h1>Static heading</h1><Counter start=3 directive="client:visible" />import { useState } from "react"; export default function Counter({ start = 0 }: { start?: number }) { const [count, setCount] = useState(start); return <button onClick={() => setCount(count + 1)}>{count}</button>;}Siehe Inseln für client:load, client:idle, client:visible und client:media.
ISR mit revalidate
export const revalidate = 60;Dieselbe Zeile im Titelblatt einer Servermodus-Seite:
revalidate = 60<h1>News</h1>middleware.ts
import { NextResponse, type NextRequest } from "next/server"; export function middleware(request: NextRequest) { if (!request.cookies.get("session")) return NextResponse.redirect(new URL("/login", request.url));} export const config = { matcher: "/dashboard/:path*" };Der matcher ist der Ordner: ein middleware.py in dashboard/ umschließt jede Route darunter.
from nexy.http import RedirectResponse, Request async def middleware(request: Request, call_next): if "session" not in request.cookies: return RedirectResponse("/login", status_code=307) return await call_next(request)async def GET(): return {"visits": 12}notFound() und not-found.tsx
import { notFound } from "next/navigation"; if (!post) notFound();Erhöhen Sie in einem Handler; Rufen Sie auf einer Seite im Servermodus notFound() auf:
from nexy.http import HTTPException POSTS = {"hello": "Hello, world"} async def GET(slug: str): if slug not in POSTS: raise HTTPException(status_code=404, detail="No such post") return {"title": POSTS[slug]}app/not-found.tsx ist im Client-Modus src/routes/notfound.tsx und im Server-Modus notfound.nexy.
next/image
import Image from "next/image"; <Image src="/logo.png" alt="Logo" width={128} height={32} />
Auf einer .nexy-Seite ist die Image-Komponente von nexy:
from nexy import Image<Image src="/logo.png" alt="Logo" width=128 height=32 />Laufen
| Next.js | Nexy |
|---|---|
npx create-next-app |
nx new, Vorlage web-fbr-react |
next dev |
nx dev |
next build && next start |
nx build, dann nx start |
public/ |
public/, zugestellt in / |
| Knoten zur Laufzeit | Python zur Laufzeit; Der Knoten erstellt nur die Client-Bundles |