v(i)b(e)c(o)d(e)4u.com
Назад на форум vbcd4u.com
🔥 Нейросети2026-11-17T09:08:00.000Z▲ 0 upvotes

Zod on API Routes Next.js: қатаң, жолақ және шын мәнінде қосымша өрістерден қорғайтын нәрсе

@murdasoftРедакция vbcd4u · MurdaSoft
Открыть все обсуждения →

Біз қандай мәселені шешіп жатырмыз?

Әдетте қатаң тексерумен бірге талқыланатын екі шабуыл:

  • Жаппай тағайындау. Клиент профильді жаңартудың соңғы нүктесіне {"name":"Ivan","role":"admin"} жібереді, ал сервер db.user.update({ data: body }) жасайды. role өрісі дерекқорға кіреді.
  • Прототиптің ластануы. Денеде __proto__ немесе constructor.prototype кілті бар және код Object прототипін өзгерте отырып, өздігінен жазылған deepMerge арқылы оны объектіге рекурсивті түрде біріктіреді.

Екі осалдық .strict() жоқтығынан емес, сервердің өңделмеген сұрау денесін пайдалануынан туындайды. Zod арқылы тексеріп, содан кейін тек parse нәтижесімен жұмыс істесеңіз, қосымша кілттер strict болмаса да ол жерге жетпейді: әдепкі бойынша z.object оларды тастайды (жолақ режимі).

Үш нысан режимі

import { z } from "zod";

const Base = { name: z.string().min(1).max(100) };

z.object(Base).parse({ name: "a", role: "admin" });
// { name: "a" } — role молча удалён

z.object(Base).strict().parse({ name: "a", role: "admin" });
// ZodError: unrecognized key "role"

z.object(Base).passthrough().parse({ name: "a", role: "admin" });
// { name: "a", role: "admin" } — опасно для входных данных

4-зонада бірдей режимдер жеке конструкторлар z.strictObject({...}) және z.looseObject({...}) ретінде қол жетімді; .strict() және .passthrough() әдістері үйлесімділік үшін сақталады. Әр жобаға бір стиль таңдаңыз.

Неліктен strict? Бұл дыбыссыз жоюды анық қатеге айналдырады. Өріс атауын қате жазған клиент (email орнына emial) электрондық поштасыз «сәтті» сақтаудың орнына кілтпен 400 алады. Ішкі API және пішіндер үшін бұл жөндеу сағаттарын үнемдейді.

Өңдеуші үлгісі

// app/api/profile/route.ts
import { z } from "zod";
import { NextResponse } from "next/server";
import { getSession } from "@/lib/auth";
import { db } from "@/lib/db";

const Address = z.strictObject({
  city: z.string().max(80),
  street: z.string().max(120),
});

const UpdateProfile = z.strictObject({
  name: z.string().trim().min(1).max(100).optional(),
  email: z.email().optional(),          // в Zod 3: z.string().email()
  address: Address.optional(),
});

export async function PATCH(req: Request) {
  const session = await getSession();
  if (!session) return NextResponse.json({ error: "unauthorized" }, { status: 401 });

  let json: unknown;
  try {
    json = await req.json();
  } catch {
    return NextResponse.json({ error: "invalid JSON" }, { status: 400 });
  }

  const parsed = UpdateProfile.safeParse(json);
  if (!parsed.success) {
    return NextResponse.json(
      { error: "validation", issues: parsed.error.issues.map(i => ({ path: i.path, message: i.message })) },
      { status: 400 }
    );
  }

  // только parsed.data, никогда json
  const user = await db.user.update({ where: { id: session.userId }, data: parsed.data });
  return NextResponse.json({ id: user.id, name: user.name, email: user.email });
}

Жиі жіберілмейтін мәліметтер:

  • `strict` рекурсивті емес. Қатаң нысан ішіндегі кірістірілген z.object жолақ режимінде қалады. Сондықтан Address қатаң деп бөлек жарияланады.
  • `req.json()` жарамсыз JSON файлында ерекше жағдайды шығарады. try/catch болмаса, клиент 400 орнына 500 алады.
  • `safeParse` `parse` орнына - қалыпты пайдаланушы қателері үшін ерекше жағдайларды болдырмау үшін.
  • Жауап та сүзіледі. Құпия сөз хэшімен бүкіл пайдаланушы нысанын емес, анық өрістер жинағын қайтарыңыз.

Сұрау параметрлері мен пішіндері

searchParams және FormData ішінен келетіндердің барлығы жолдар. Кастингті пайдаланыңыз:

const ListQuery = z.strictObject({
  page: z.coerce.number().int().min(1).default(1),
  limit: z.coerce.number().int().min(1).max(100).default(20),
  q: z.string().max(200).optional(),
});

const query = ListQuery.safeParse(Object.fromEntries(new URL(req.url).searchParams));

Object.fromEntries қайталанатын параметрлерді жоғалтады (?tag=a&tag=b). Олар қажет болса, searchParams.getAll("tag") арқылы алапты бөлек жинаңыз.

Диагнозды қалай қоюға болады

  • Клиент мобильді қосымша шыққаннан кейін 400-ге жуық шағымданады: жаңа нұсқа қосымша өріс жібереді, бірақ схема қатаң. Жауапта issues қараңыз - кілтке апаратын жол сонда болады.
  • Өріс «сақталмады», қателер жоқ: схема қатаң емес, кілт сіз күткеннен басқаша шақырылады. strict уақытша қосыңыз және сұрауды қайталаңыз.
  • Кілттердегі __proto__ журналдарында - сканер прототиптің ластануын іздейді. parsed.data қолдансаңыз, бұл шу; Біріктіру кодында өңделмеген нысандардың бар-жоғын тексеріңіз.

Қатаң жолға түскенде

Сыртқы қызметтердің веб-хуктары (төлем жүйелері, мессенджерлер) үнемі жаңа өрістерді қосып отырады. Олардағы қатаң схема зиянсыз провайдер жаңартуын өңдеу ақаулығына айналдырады. Мұндай енгізулер үшін жолақ режимін пайдаланыңыз және тек қажетті өрістерді сипаттаңыз. Кері үйлесімділігі бар жалпыға ортақ API интерфейстері үшін де солай: соңғы нүктелердің ескі нұсқаларындағы қатаң схема жаңа нұсқалардан өрістерді жіберетін клиенттерді бұзуы мүмкін.

Обсуждение (0)

Ещё на vbcd4u.com