بهترین شیوه‌های Node.js: راهنمایی برای توسعه‌دهندگان

نود جی‌اس (Node.js) یک ابزار قدرتمند برای ساخت برنامه‌های وب مقیاس‌پذیر و سریع است. با این حال، برای استفاده حداکثری از Node.js، پیروی از بهترین شیوه‌ها مهم است. در این پست، برخی از بهترین شیوه‌های کلیدی برای توسعه نرم افزارهای Node.js را بررسی خواهیم کرد.

1. به پروژه خود Structure (ساختار) دهید

نگهداری و توسعه یک پروژه با ساختار مناسب به مراتب راحت‌تر از پروژه‌ای هست که ساختار استاندارد و مناسبی ندارد. در زیر یک Structure ساده آماده کرده‌ام که از آن میتوانید در پروژه های Node.js تان استفاده کنید:

my-node-app/
│
├── src/
│   ├── controllers/
│   ├── models/
│   ├── routes/
│   └── services/
│
├── tests/
│
├── .env
├── .gitignore
├── package.json
└── README.md

• src/

شامل کد اصلی برنامه شماست.

── controllers/

مدیریت لاجیک برنامه.

── models/

تعریف ساختار داده‌ها.

── routes/

مدیریت endpoint های API ها.

── services

شامل بیزنس لاجیک‌ها.

• tests/

پوشه مخصوص برای فایل‌های تست پروژه.

• .env

ذخیره سازی تمامی environment variable ها.

• .gitignore

مشخص کننده فایل های git که باید نادیده گرفته شوند.

• .package.json

اسکریپت‌ها و Dependency های پروژه .

• README.md

شرح و توضیحات مربوط به پروژه.

2. از Environment Variable ها استفاده کنید

با استفاده از Environment Variable ها می‌توانید تنظیمات پیکربندی‌های مربوط به پروژ را خارج از کدهایتان ذخیره کنید که این کار علاوه بر اینکه برنامه شمارا امن‌تر می‌کند، بلکه مدیریت آن‌را نیز ساده‌تر خواهد کرد.

نمونه یک فایل .env:

DB_HOST=localhost
DB_USER=root
DB_PASS=password

با استفاده از dotenv می‌توانید فایل .env را در کدتان لود و استفاده کنید:

require('dotenv').config();

const dbHost = process.env.DB_HOST;
const dbUser = process.env.DB_USER;
const dbPass = process.env.DB_PASS;

console.log(`Connecting to database at ${dbHost} with user ${dbUser}`);

3. ارورها را به درستی مدیریت کنید

مدیریت صحیح ارورها تضمین می‌کند که برنامه شما بطور ناگهانی کرش نخواهد کرد.

app.get('/user/:id', async (req, res, next) => {
  try {
    const user = await getUserById(req.params.id);
    if (!user) {
      return res.status(404).send('User not found');
    }
    res.send(user);
  } catch (error) {
    next(error);
  }
});

app.use((err, req, res, next) => {
  console.error(err.stack);
  res.status(500).send('Something went wrong!');
});

4. از کد Asynchronous استفاده کنید

نود جی‌اس ذاتاً asynchronous (ناهمگام یا نامتقارن) است. از async و await بری هندل کردن asynchronous کدتان استفاده کنید.

async function fetchData() {
  try {
    const response = await fetch('https://api.example.com/data');
    const data = await response.json();
    console.log(data);
  } catch (error) {
    console.error('Error fetching data:', error);
  }
}

fetchData();

5. پکیج‌ها و Dependency های پروژه را آپدیت نگه دارید

بطور منظم پکیج‌ها و Dependency ها را به روز کنید تا مطمئن شوید که آخرین ویژگیها و اصلاحات امنیتی را دارید.

می‌توانید با استفاده از دستور زیر پکیج‌های قدیمی پروژه را چک کنید:

npm outdated

و سپس با دستور زیر آن‌ها را آپدیت کنید:

npm update

6. تست بنویسد

نوشتن تست از رخ دادن بسیاری از باگ‌ها جلوگیری می‌کند و به شما اطمینان می‌دهند که برنامه طبق انتظارتان کار می‌کند.

• مرحله 1: نصب Jest

یکی از محبوب‌ترین فریم‌ورک‌های قدرتمند برای تست کردن کدهای جاوااسکریپت Jest است که با دستور زیر می‌توانید آن‌را نصب کنید:

npm install --save-dev jest

• مرحله 2: نوشتن تست‌ها

یک فایل تست ایجاد کنید. برای مثال (tests/example.test.js).

یک مثال تست نویسی ساده:

const sum = (a, b) => a + b;

test('adds 1 + 2 to equal 3', () => {
  expect(sum(1, 2)).toBe(3);
});

7. از یک Linter استفاده کنید

Linter ابزاری که با آنالیز کردن کد منبع شما، هرگونه خطای برنامه نویسی، اشکالات، خطاهای سبکی و
ساختارهای مشکوک را علامت گذاری کند. و در نهایت کدهای خود را تمیز و ثابت نگه دارید.

ESLint یکی از محبوب‌ترین گزینه‌ها در میان برنامه نویس‌های جاوااسکریپت است.

نصب ESLint:

npm install eslint --save-dev

راه اندازی ESLint:

npx eslint --init

اضافه کردن lint به package.json پروژه:

"scripts": {
  "lint": "eslint ."
}

اجرای linter:

npm run lint

نتجیه‌گیری

استفاده از این روش‌ها به شما کمک می‌کند تا بتوانید نرم افزارهای Node.js بهتری بنویسید که قابلیت نگهداری بیشتری نیز دارند. به خاطر داشته باشید که پروژه خود را ساختار دهید، از environmental variable ها استفاده کنید، خطاها را به درستی مدیریت کنید، کدهای asynchronous بنویسید، dependency ها را به‌روز نگه دارید، تست بنویسید و از linter استفاده کنید.

با انجام این کارا نرم افزاهای Node.js تان علاوه بر اینکه قوی‌تر و کارآمد‌تر خواهد شد، بلکه مدیریت و نگهداری آن نیز به مراتب راحت‌تر خواهد بود.

امیدوارم که این مقاله براتون مفید بوده باشه.

- منبع