miniframe-router: Penghala untuk Aplikasi Express.JS

miniframe-router — penghala minimalis untuk aplikasi Express.JS, diilhamkan oleh Ruby on Rails. Begini cara saya membuatnya.

---

Contoh cara penghalaan mungkin kelihatan dalam aplikasi mudah.

// Root routes
root("index#home");

// Basic CRUD routes
get("/users", "users#index");
get("/users/:id", "users#show");
post("/users", "users#create");
post("/users/:id", "users#update");
post("/users/:id/destroy", "users#destroy");

// Posts routes with scope
scope("blog", () => {
  get("/posts", "posts#index");
  get("/posts/:id", "posts#show");
  post("/posts", "posts#create");
  post("/posts/:id", "posts#update");
  post("/posts/:id/destroy", "posts#destroy");
});

Konteks

Saya tidak menulis aplikasi NodeJS selama kira-kira 10 tahun. Ingin tahu tentang Aplikasi Mini Telegram, saya memutuskan untuk membina beberapa projek mudah untuk meneroka bidang baharu ini.

Untuk ini, saya memerlukan penghalaan untuk bahagian belakang aplikasi saya. Penyelesaian sedia ada tidak begitu menarik perhatian saya, jadi saya memutuskan untuk mencipta penghala saya sendiri — mudah, berkesan dan diilhamkan oleh Ruby on Rails. Ia juga merupakan peluang yang baik untuk menyegarkan pengetahuan saya tentang mencipta pakej NPM, sesuatu yang tidak pernah saya lakukan selama 9 tahun.

---

Reka bentuk

Jangkaan untuk Penghala:

1. Penghalaan ditakrifkan dalam fail berasingan

Ini memudahkan struktur aplikasi dan mengelakkan kekacauan fail aplikasi utama.

import {
  root,
  get,
  post,
  routeScope as scope,
  getRouter,
} from "miniframe-router";

// Root routes
root("index#home");

// Basic CRUD routes
get("/users", "users#index");
get("/users/:id", "users#show");
post("/users", "users#create");
post("/users/:id", "users#update");
post("/users/:id/destroy", "users#destroy");

// Posts routes with scope
scope("blog", () => {
  get("/posts", "posts#index");
  get("/posts/:id", "posts#show");
  post("/posts", "posts#create");
  post("/posts/:id", "posts#update");
  post("/posts/:id/destroy", "posts#destroy");
});

export default getRouter;

1. Penghala disepadukan ke dalam fail ExpressJS utama

Titik masuk yang mudah dan berkesan untuk aplikasi: src/index.js atau src/main.js.

import express from "express";
import getRouter from "./routes"; // <<< DEFINE ROUTES

const app = express();
app.use(express.json());
app.use(getRouter()); // <<< USER ROUTES

app.listen(3000, () => {
  console.log("Demo app is running on http://localhost:3000");
});

1. Mengikuti konvensyen untuk menyambungkan pengawal

Pengawal terletak dalam direktori src/pengawal.

MyApp
└── src
    ├── controllers
    │   ├── blog
    │   │   └── postsController.ts
    │   ├── indexController.ts
    │   └── usersController.ts
    ├── index.ts
    └── routes
        └── index.ts

Struktur Fail

• Laluan ditakrifkan dalam src/routes/index.js.
• Pengawal mengandungi logik untuk mengendalikan permintaan:

Contoh: src/controllers/usersController.ts (atau .js).

// Root routes
root("index#home");

// Basic CRUD routes
get("/users", "users#index");
get("/users/:id", "users#show");
post("/users", "users#create");
post("/users/:id", "users#update");
post("/users/:id/destroy", "users#destroy");

// Posts routes with scope
scope("blog", () => {
  get("/posts", "posts#index");
  get("/posts/:id", "posts#show");
  post("/posts", "posts#create");
  post("/posts/:id", "posts#update");
  post("/posts/:id/destroy", "posts#destroy");
});

---

Perlaksanaan

Langkah-langkah:

1. Buat bekas pembangunan menggunakan Docker.
2. Sediakan ESBuild untuk menyusun TypeScript kepada JavaScript.
3. Pasang Jest untuk ujian.
4. Tulis ujian untuk mengesahkan versi pertama penghala.
5. Laksanakan penghala sehingga semua ujian lulus.
6. Pulihkan kelayakan NPM saya yang sudah lama tidak digunakan (selepas 9 tahun).
7. Terbitkan pakej NPM sebagai versi 1.0.0.
8. Betulkan pepijat pemasangan kritikal dan alih keluar versi 1.0.0 dan 1.1.0. ?
9. Gunakan penghala pada projek pengeluaran dengan sedozen laluan.

---

Soal Jawab

Mengapa melakukan ini? Terdapat begitu banyak penyelesaian sedia ada!

• Memang menarik, berguna dan menyumbang kepada kepelbagaian dalam penyelesaian.

Mengapa begitu mudah? Bukankah ia sepatutnya lebih kompleks?

• Mengikut prinsip KISS. Kerumitan boleh ditambah kemudian mengikut keperluan.

Mengapa pengawal? Bukankah mereka tidak perlu?

• Pengawal adalah mudah untuk projek kecil. Abstraksi yang lebih tinggi seperti penyelesaian seperti Tindakan/Operasi adalah lebih sesuai untuk sistem yang lebih besar.

Adakah penyelesaian ini berfungsi?

• Sudah tentu! Penghala telah digunakan dalam apl pengeluaran kecil dan berprestasi sempurna dengan berpuluh-puluh laluan.

Apakah saiz projek yang boleh dikendalikannya?

• miniframe-router sesuai untuk aplikasi dengan berpuluh-puluh laluan. Tiada had saiz yang ketat.

---

Kesimpulan

Kod dan dokumentasi projek: GitHub - miniframe-router

Pakej NPM: miniframe-router

Suka, kongsi dan langgan! Maklum balas yang membina sentiasa dialu-alukan.

Halaman pengarang: GitHub - the-teacher

Atas ialah kandungan terperinci miniframe-router: Penghala untuk Aplikasi Express.JS. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!