🧼 نوک کد تمیز: کد های وضعیت HTTP را سخت نگیرید – به جای آن از ثابت استفاده کنید – Community Dev

نوشتن کد رمزنگاری را متوقف کنید – بگذارید کد شما به وضوح صحبت کند

اگر تا به حال نوشته اید res.status(200) در یک مسیر و فکر صریح ، “امیدوارم کسی بفهمد این به چه معنی است” – شما تنها نیستید.

کدهای وضعیت HTTP سخت در همه جا وجود دارد. آنها کار می کنند ، اما آنها بیانگر نیستند. آنها توسعه دهندگان را وادار می کنند تا آنچه را که اعداد را دوست دارند به خاطر بسپارند 201با 403، یا 422 در واقع معنی دارد. این برای ماشین ها خوب است – اما انسان ها سزاوار بهتر هستند.

کد تمیز همه چیز در مورد وضوح و ارتباط است. کد شما باید بدون نیاز به اظهار نظر یا برگه های تقلب ، خودش را توضیح دهد.

این جایی است که http-response-status-code وارد می شود-یک بسته ساده که جایگزین اعداد گیج کننده با نام های معنی دار مانند است HTTP_CODE_404 وت NOT_FOUNDبشر

بیایید بررسی کنیم که چگونه این تغییر کوچک می تواند تفاوت زیادی در خوانایی و کیفیت پایگاه کد شما ایجاد کند.

چرا از کدهای وضعیت سخت کد شده جلوگیری می کنیم؟

در اینجا یک مقایسه سریع وجود دارد:
قبل از (هارد کد):

res.status(404).json({ error: "Not found" });

بعد از (تمیز و بیان):

import { NOT_FOUND } from 'http-response-status-code';

res.status(NOT_FOUND).json({ error: "Not found" });

🔹 خواندن کدام یک در یک نگاه راحت تر است؟
🔹 کدام یک عمدی تر به نظر می رسد؟

معرفی http-response-status-code

این بسته مفید به شما می دهد ثابت نامگذاری شده است برای کلیه کدهای وضعیت HTTP استاندارد – هر دو بر اساس شماره (HTTP_CODE_200) و با برچسب (OKبا NOT_FOUND، و غیره).

npm install http-response-status-code

از مورد استفاده کنید: مثال را بیان کنید

import express from 'express';
import {
  HTTP_CODE_200,
  BAD_REQUEST,
  INTERNAL_SERVER_ERROR,
} from 'http-response-status-code';

const app = express();

app.get('/ping', (req, res) => {
  res.status(HTTP_CODE_200).json({ message: 'pong' });
});

app.use((err, req, res, next) => {
  const status = err.isClientError ? BAD_REQUEST : INTERNAL_SERVER_ERROR;
  res.status(status).json({ error: err.message });
});

این بسیار خواندنی تر از تلاش برای یادآوری کدام شماره است.

از نامهای ثابت معنی دار استفاده کنید

این ایده در همه جا اعمال می شود.

به جای:

const TIMEOUT = 5000;

ترجیح می دهد:

const REQUEST_TIMEOUT_MS = 5000;

نامگذاری پاک باعث صرفه جویی در وقت می شود ، از اشکالات جلوگیری می کند و به سریعتر به توسعه دهندگان جدید کمک می کند.

پاداش: صادرات دوگانه

در http-response-status-code بسته بندی هر دو ثابت مبتنی بر شماره و موارد مبتنی بر برچسب را صادر می کند.

بنابراین می توانید استفاده کنید:

import { HTTP_CODE_404, NOT_FOUND } from 'http-response-status-code';

console.log(HTTP_CODE_404); // 404
console.log(NOT_FOUND);     // 404

هر دو معتبر هستند – این مربوط به راهنمای سبک یا اولویت تیم شماست.

افکار نهایی

کد تمیز در مورد آشکار کردن قصد شما است.
نام های ثابت مانند HTTP_CODE_400 وت INTERNAL_SERVER_ERROR خوانایی را بهبود بخشید ، سربار شناختی را کاهش دهید و کد خود را آسان تر کنید.

بنابراین دفعه بعد که قصد نوشتن دارید res.status(500)به جای یک شماره به یک نام برسید.

👉 http-response-status-code را امتحان کنید و کد خود را برای خودشان صحبت کنید.