TypeScript Academy · Pelajaran

Menentukan Penghala dan Prosedur

Bina pertanyaan dan mutasi dengan pengesahan input.

Pelajaran 2 daripada 413 langkah

Menentukan Penghala dan Prosedur ialah pelajaran TypeScript Academy percuma di CoddyKit. Ini ialah pelajaran 2 daripada 4. Anda boleh membaca keseluruhan pelajaran di bawah secara percuma — kemudian berlatih secara praktikal dalam pelayar menggunakan penyunting kod terbina dalam dan tutor kecerdasan buatan 24/7. Pelajaran ini merupakan sebahagian daripada laluan pembelajaran TypeScript Academy, dan kemajuan anda disegerakkan merentas web serta aplikasi CoddyKit. Kursus TypeScript Academy merangkumi sejumlah 4 pelajaran.

Memulakan tRPC

Setiap bahagian belakang tRPC bermula dengan mencipta satu instans menggunakan initTRPC. Ia mengembalikan pembina untuk penghala dan prosedur. Anda biasanya menciptanya sekali sahaja dan mengeksport bahagian yang diperlukan.

import { initTRPC } from '@trpc/server';

const t = initTRPC.create();
export const router = t.router;
export const publicProcedure = t.procedure;

Prosedur Pertama

Prosedur ialah satu titik akhir API. Prosedur paling mudah ialah query yang mengembalikan suatu nilai. publicProcedure.query mentakrifkan titik akhir bacaan tanpa masukan.

import { router, publicProcedure } from './trpc';

const appRouter = router({
  health: publicProcedure.query(() => 'ok'),
});

Mengesahkan Masukan

Prosedur mengisytiharkan masukannya dengan pengesah, biasanya skema zod. .input(schema) melakukan pengesahan semasa masa jalan dan membuat inferens jenis masukan untuk penyelesai serta client.

import { z } from 'zod';

const greet = publicProcedure
  .input(z.object({ name: z.string() }))
  .query(({ input }) => 'Hello, ' + input.name);

Membaca Masukan

Dalam penyelesai, masukan yang telah disahkan tersedia sebagai input dan mempunyai jenis penuh berdasarkan skema. Tiada penukaran jenis manual diperlukan; zod dan tRPC membuat inferens bentuk itu bersama-sama.

const byId = publicProcedure
  .input(z.object({ id: z.number() }))
  .query(({ input }) => {
    // input.id is number
    return { id: input.id, name: 'Alice' };
  });

mutation

Gunakan .mutation untuk operasi yang mengubah data. Bentuknya sama seperti query tetapi menandakan penulisan, yang mempengaruhi pencachean client dan kaedah HTTP.

const createUser = publicProcedure
  .input(z.object({ name: z.string() }))
  .mutation(({ input }) => {
    return { id: 1, name: input.name };
  });

Membina App Router

Kumpulkan prosedur ke dalam penghala dengan menghantar objek kepada router(...). Setiap kunci menjadi nama prosedur yang boleh dipanggil. appRouter ini ialah keseluruhan API anda.

const appRouter = router({
  greet,
  byId,
  createUser,
});

Penghala Bersarang

Penghala boleh bersarang untuk menyusun API yang besar. Satu nilai dalam objek penghala boleh menjadi penghala itu sendiri, lalu menghasilkan panggilan berruang nama seperti user.byId.

const userRouter = router({ byId, createUser });

const appRouter = router({
  user: userRouter,
  greet,
});
// call paths: user.byId, user.createUser, greet

Mengeksport Jenis Penghala

Eksport yang paling penting ialah jenis penghala. client akan mengimportnya untuk mendapatkan keselamatan jenis penuh. Eksport nilainya untuk penyesuai pelayan dan jenisnya untuk client.

export const appRouter = router({ user: userRouter });
export type AppRouter = typeof appRouter;

Melampirkan Penyesuai

Untuk menyediakan penghala melalui HTTP, lampirkan penyesuai. tRPC menyediakan penyesuai untuk Node kendiri, Express, Next.js, Fetch dan banyak lagi. Penyesuai menukar permintaan masuk menjadi panggilan prosedur.

import { createHTTPServer } from '@trpc/server/adapters/standalone';

createHTTPServer({ router: appRouter }).listen(3000);

Menyusun Fail

Susun atur biasa: satu trpc.ts dengan initTRPC serta router/publicProcedure yang dieksport, penghala ciri dalam fail masing-masing, dan appRouter akar yang menggabungkannya. Menyimpan initTRPC di satu tempat mengelakkan berbilang instans.

// trpc.ts: initTRPC.create(), export router + publicProcedure
// routers/user.ts: userRouter
// router.ts: appRouter = router({ user: userRouter })

Imbas Kembali Inferens Masukan

Oleh sebab .input(schema) melakukan pengesahan dan inferens, anda menulis skema sekali sahaja lalu memperoleh pengawal masa jalan serta jenis statik. client akan melihat tepat masukan yang dijangka oleh setiap prosedur, yang diperoleh daripada skema ini.

const search = publicProcedure
  .input(z.object({ q: z.string(), page: z.number().optional() }))
  .query(({ input }) => ({ q: input.q, page: input.page ?? 1 }));

Semakan Pantas

Uji pemahaman anda tentang penghala dan prosedur.

Imbas Kembali

Anda telah membina bahagian belakang tRPC.

  • initTRPC.create() menghasilkan pembina router dan procedure.
  • .input(schema) mengesahkan dan membuat inferens masukan.
  • .query membaca; .mutation menulis.
  • Gabungkan prosedur ke dalam appRouter dan eksport type AppRouter = typeof appRouter.

Seterusnya: menggunakan API itu dengan client yang berjenis penuh.

Percuma untuk bermula

Pelajari TypeScript dengan tutor kecerdasan buatan — percuma

Tulis dan jalankan kod sebenar dalam pelayar anda, dapatkan bantuan segera daripada tutor kecerdasan buatan yang tersedia 24/7, dan sambung semula dari tempat anda berhenti di web atau dalam aplikasi.

Kursus
101
Pelajaran
352

Soalan Lazim

Adakah pelajaran “Menentukan Penghala dan Prosedur” percuma?

Ya — teks penuh “Menentukan Penghala dan Prosedur” boleh dibaca secara percuma di web ini. Untuk berlatih secara interaktif menggunakan penyunting kod terbina dalam dan tutor kecerdasan buatan 24/7, serta membuka kunci baki kursus TypeScript Academy, tingkat taraf kepada CoddyKit PRO. Kursus TypeScript Academy merangkumi sejumlah 4 pelajaran.

Apakah yang akan saya pelajari dalam “Menentukan Penghala dan Prosedur”?

Bina pertanyaan dan mutasi dengan pengesahan input. Anda berlatih TypeScript Academy menggunakan kod praktikal yang dijalankan terus dalam pelayar, manakala tutor kecerdasan buatan 24/7 menjawab soalan anda semasa anda mengikuti pelajaran.

Adakah saya memerlukan pengalaman untuk memulakan TypeScript Academy?

Tiada pengalaman terdahulu diperlukan. Pembelajaran TypeScript Academy di CoddyKit disusun untuk pelajar daripada peringkat pemula hingga lanjutan, jadi anda boleh bermula di sini atau dari awal dan belajar mengikut kadar anda sendiri. Ini ialah pelajaran 2 daripada 4.

Berapa lamakah pelajaran “Menentukan Penghala dan Prosedur” diambil?

Kebanyakan pelajaran CoddyKit mengambil masa kira-kira 5–10 minit. Setiap pelajaran ringkas dan interaktif, jadi anda boleh membuat kemajuan secara berterusan dan menyambung tepat dari tempat anda berhenti di web atau aplikasi.

Bolehkah saya menulis dan menjalankan kod dalam pelajaran TypeScript Academy ini?

Ya. Setiap pelajaran TypeScript Academy menyertakan penyunting kod terbina dalam, jadi anda boleh menulis dan menjalankan kod sebenar terus dalam pelayar serta menerima maklum balas kecerdasan buatan serta-merta — tanpa memerlukan persediaan setempat.

Semua pelajaran dalam kursus ini

  1. Seni Bina tRPC
  2. Menentukan Penghala dan Prosedur
  3. Inferens Jenis Klien-Pelayan
  4. Perisian Tengah dan Konteks
← Kembali ke TypeScript Academy