miniframe-router: Express.JS 애플리케이션용 라우터

miniframe-router — Ruby on Rails에서 영감을 받은 Express.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");
});

문맥

저는 약 10년 동안 NodeJS 애플리케이션을 작성하지 않았습니다. Telegram Mini Apps에 대해 궁금해서 저는 이 새로운 분야를 탐구하기 위해 몇 가지 간단한 프로젝트를 만들기로 결정했습니다.

이를 위해서는 애플리케이션 백엔드에 대한 라우팅이 필요했습니다. 기존 솔루션은 그다지 인상적이지 않았기 때문에 Ruby on Rails에서 영감을 받아 간단하고 효과적이며 나만의 라우터를 만들기로 결정했습니다. 또한 9년 동안 해보지 못한 NPM 패키지 제작 지식을 다시 한 번 확인할 수 있는 좋은 기회였습니다.

---

설계

라우터에 대한 기대 사항:

1. 라우팅은 별도의 파일에 정의됩니다

이렇게 하면 애플리케이션 구조가 단순화되고 기본 애플리케이션 파일이 복잡해지는 것을 방지할 수 있습니다.

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. 라우터는 기본 ExpressJS 파일에 통합됩니다

간단하고 효과적인 애플리케이션 진입점: src/index.js 또는 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. 컨트롤러 연결 규칙

컨트롤러는 src/controllers 디렉터리에 있습니다.

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

파일 구조

• 경로는 src/routes/index.js에 정의되어 있습니다.
• 컨트롤러에는 요청 처리를 위한 로직이 포함되어 있습니다.

예: src/controllers/usersController.ts(또는 .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");
});

---

구현

단계:

1. Docker를 사용하여 개발 컨테이너를 만듭니다.
2. TypeScript를 JavaScript로 컴파일하기 위해 ESBuild를 설정합니다.
3. 테스트를 위해 Jest를 설치하세요.
4. 라우터의 첫 번째 버전을 검증하는 테스트를 작성하세요.
5. 모든 테스트가 통과할 때까지 라우터를 구현하세요.
6. 오래 사용하지 않은 NPM 자격 증명을 복구합니다(9년 후).
7. NPM 패키지를 버전 1.0.0으로 게시하세요.
8. 중요한 설치 버그를 수정하고 버전 1.0.0 및 1.1.0을 제거합니다. ?
9. 12개의 경로가 있는 프로덕션 프로젝트에 라우터를 적용합니다.

---

Q&A

왜 이런 짓을 하는 걸까요? 기존 솔루션이 너무 많습니다!

• 흥미롭고, 유용하며 솔루션의 다양성에 기여합니다.

왜 그렇게 간단합니까? 더 복잡해져야 하지 않나요?

• KISS 원칙을 따릅니다. 필요에 따라 나중에 복잡성을 추가할 수 있습니다.

왜 컨트롤러인가? 불필요하지 않나요?

• 컨트롤러는 소규모 프로젝트에 편리합니다. 액션/작동형 솔루션과 같은 더 높은 추상화는 대규모 시스템에 더 적합합니다.

이 솔루션이 기능적인가요?

• 물론이죠! 라우터는 소규모 프로덕션 앱에서 사용되었으며 수십 개의 경로에서 완벽하게 작동했습니다.

어떤 규모의 프로젝트를 처리할 수 있나요?

• miniframe-router는 수십 개의 경로가 있는 애플리케이션에 적합합니다. 엄격한 크기 제한은 없습니다.

---

결론

프로젝트 코드 및 문서: GitHub - miniframe-router

NPM 패키지: miniframe-router

좋아요, 공유, 구독! 건설적인 피드백은 언제나 환영합니다.

저자 페이지: GitHub - the-teacher

위 내용은 miniframe-router: Express.JS 애플리케이션용 라우터의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!