Nodejs 是一個用於建立快速且可擴展的 Web 應用程式的強大工具。然而,為了充分利用 Nodejs,遵循最佳實踐非常重要。在這篇文章中,我們將探討 Nodejs 開發的一些關鍵最佳實務。

1. 建構你的專案

結構良好的專案易於維護和擴展。這是一個您可以遵循的簡單結構:

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

解釋:

  • src/包含您的主要應用程式程式碼。

  • controllers/處理您的應用程式的邏輯。

  • models/定義您的資料結構。

  • routes/管理 API 的不同端點。

  • services/包含業務邏輯。

  • tests/包含所有測試檔案。

  • .env儲存您的環境變數

  • .gitignore指定 GIT 中要忽略的檔案。

  • .package.json追蹤依賴項和腳本。

  • README.md描述了您的專案。

2.使用環境變數

環境變數有助於將配置設定保留在程式碼之外。這使您的應用程式更安全且更易於管理。

例子:

建立一個.env檔:

DB_HOST=localhost
DB_USER=root
DB_PASS=password

使用dotenv包在程式碼中載入這些變數:

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. 使用非同步程式碼

Nodejs 本質上是異步的。使用asyncawait更乾淨地處理非同步程式碼。

例子:

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. 保持依賴關係更新

定期更新您的依賴項,以確保您擁有最新的功能和安全性修復。

使用npm outdated檢查是否有過時的軟體包。

npm outdated

更新套件:

npm update

6. 編寫測試

測試您的程式碼有助於及早發現錯誤並確保您的應用程式正常執行

正如預期的那樣。

例子:

第 1 步:安裝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

Linters 可協助您編寫乾淨且一致的程式碼。 ESLint 是一個受歡迎的選擇。

例子:

安裝 ESLint:

npm install eslint --save-dev

初始化 ESLint:

npx eslint --init

將 lint 腳本加入package.json

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

執行短絨檢查:

npm run lint

結論

遵循這些最佳實踐將幫助您編寫更好、更易於維護的 Nodejs 應用程式。請記住建立您的專案、使用環境變數、正確處理錯誤、編寫非同步程式碼、保持依賴項更新、編寫測試並使用 linter。透過這樣做,您將建立健壯且高效的 Nodejs 應用程式,並且更易於管理和維護。

快樂編碼!


原文出處:https://dev.to/mehedihasan2810/nodejs-best-practices-a-guide-for-developers-4d65


共有 0 則留言