การใช้ TypeScript กับ Node.js: คู่มือฉบับสมบูรณ์

Apr 19 2023

หากคุณกำลังทำงานกับ Node.js คุณอาจคุ้นเคยกับความท้าทายในการจัดการและปรับขนาดโค้ดเบสขนาดใหญ่

หากคุณกำลังทำงานกับ Node.js คุณอาจคุ้นเคยกับความท้าทายในการจัดการและปรับขนาดโค้ดเบสขนาดใหญ่ วิธีหนึ่งที่จะเอาชนะสิ่งนี้คือการใช้ TypeScript ซึ่งเป็น superset แบบคงที่ของ JavaScript ที่เพิ่มคำอธิบายประกอบประเภทตัวเลือกและคุณสมบัติขั้นสูงให้กับภาษา ในบทความนี้ เราจะสำรวจวิธีใช้ TypeScript กับ Node.js และให้ตัวอย่างเพื่อช่วยคุณเริ่มต้น

สารบัญ

รู้เบื้องต้นเกี่ยวกับ TypeScript
การตั้งค่าโครงการ TypeScript
ใช้ TypeScript กับ Node.js
การใช้คุณสมบัติ TypeScript ใน Node.js
การดีบักโค้ด TypeScript
การใช้ TypeScript กับไลบรารี Node.js ยอดนิยม
แนวทางปฏิบัติที่ดีที่สุดสำหรับการใช้ TypeScript กับ Node.js
บทสรุป
คำถามที่พบบ่อย

TypeScript เป็นภาษาที่ให้การตรวจสอบประเภทคงที่สำหรับ JavaScript ได้รับการพัฒนาโดย Microsoft และเป็นโครงการโอเพ่นซอร์สที่ชุมชนนักพัฒนานำไปใช้อย่างกว้างขวาง ด้วย TypeScript คุณสามารถตรวจพบข้อผิดพลาดก่อนรันไทม์ ปรับปรุงความสามารถในการอ่านและการบำรุงรักษาโค้ด และใช้คุณสมบัติขั้นสูง เช่น คลาส อินเทอร์เฟซ และ enums TypeScript ยังเข้ากันได้กับเฟรมเวิร์กและไลบรารี JavaScript ยอดนิยม เช่น React, Angular และ Node.js

การตั้งค่าโครงการ TypeScript

ในการเริ่มต้นใช้งาน TypeScript คุณต้องตั้งค่าโปรเจ็กต์ด้วยการพึ่งพาและการกำหนดค่าที่จำเป็น ก่อนอื่น คุณต้องติดตั้ง Node.js และ npm บนเครื่องของคุณ จากนั้น คุณสามารถสร้างไดเรกทอรีโครงการใหม่และเรียกใช้คำสั่งต่อไปนี้เพื่อเริ่มต้นโครงการ Node.js ใหม่:

$ npm init -y

$ npm install --save-dev typescript

{
  "compilerOptions": {
    "target": "es6",
    "module": "commonjs",
    "outDir": "dist",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true
  },
  "include": [
    "src/**/*.ts"
  ]
}jj

ใช้ TypeScript กับ Node.js

หลังจากตั้งค่าโปรเจ็กต์ TypeScript แล้ว คุณสามารถใช้คอมไพเลอร์ TypeScript ( tsc) เพื่อคอมไพล์โค้ด TypeScript เป็นโค้ด JavaScript ที่ Node.js เรียกใช้ได้ คุณสามารถเรียกใช้คอมไพเลอร์โดยใช้คำสั่งต่อไปนี้:

$ npx tsc

ในการรันไฟล์ JavaScript ที่คอมไพล์แล้ว คุณสามารถใช้nodeคำสั่งตามด้วยพาธไปยังไฟล์รายการ ตัวอย่างเช่น หากไฟล์รายการของคุณคือdist/index.jsคุณสามารถรันได้โดยใช้คำสั่งต่อไปนี้:

$ node dist/index.js

TypeScript มีคุณสมบัติขั้นสูง เช่น คลาส อินเทอร์เฟซ และ enums ที่สามารถใช้ในแอปพลิเคชัน Node.js นี่คือตัวอย่างบางส่วน:

ชั้นเรียน

class Person {
  constructor(public name: string, public age: number) {}

  greet() {
    console.log(`Hello, my name is ${this.name} and I am ${this.age} years old.`);
  }
}
const john = new Person('John', 30);
john.greet();

interface Animal {
  name: string;
  age: number;
  speak(): void;
}
class Dog implements Animal {
  constructor(public name: string, public age: number) {}
  speak() {
    console.log('Woof!');
  }
}
const rex: Animal = new Dog('Rex', 5);
rex.speak();

//typescript code
enum Color {
  Red = 'RED',
  Green = 'GREEN',
  Blue = 'BLUE'
}

function printColor(color: Color) {
  console.log(`The color is ${color}`);
}
printColor(Color.Red);

เมื่อทำงานกับ TypeScript คุณอาจพบข้อผิดพลาดที่คอมไพเลอร์ TypeScript ตรวจไม่พบ ในการดีบักโค้ด TypeScript คุณสามารถใช้--inspectแฟล็กพร้อมกับnodeคำสั่งเพื่อเริ่มเซสชันการดีบัก จากนั้นคุณสามารถใช้ดีบักเกอร์ เช่น VS Code เพื่อตั้งค่าเบรกพอยต์และทำตามขั้นตอนในโค้ดของคุณ

$ node --inspect dist/index.js

TypeScript เข้ากันได้กับไลบรารีและเฟรมเวิร์ก Node.js ยอดนิยมมากมาย นี่คือตัวอย่างบางส่วน:

ด่วน

//typescript code

import express from 'express';

const app = express();
app.get('/', (req, res) => {
  res.send('Hello World!');
});
app.listen(3000, () => {
  console.log('Server started on port 3000');
});

typescript code
//typescript code

import { Entity, Column, PrimaryGeneratedColumn } from 'typeorm';
yt
@Entity()
class User {
  @PrimaryGeneratedColumn()
  id: number;
  @Column()
  name: string;
  @Column()
  age: number;
}

แนวทางปฏิบัติที่ดีที่สุดสำหรับการใช้ TypeScript กับ Node.js มีดังนี้

ใช้โหมดเข้มงวดเพื่อตรวจหาข้อผิดพลาดมากขึ้นในขณะคอมไพล์
ใช้อินเทอร์เฟซและประเภทเพื่อกำหนดรูปร่างของข้อมูลและปรับปรุงการอ่านรหัส
ใช้tsconfig.jsonเพื่อระบุตัวเลือกการกำหนดค่า TypeScript สำหรับโครงการของคุณ
ใช้เครื่องมือเช่น ESLint และ Prettier เพื่อบังคับใช้คุณภาพและความสอดคล้องของโค้ด

เมื่อเปิดใช้งานโหมดเข้มงวดใน TypeScript คุณจะตรวจจับข้อผิดพลาดและปัญหาที่อาจเกิดขึ้นได้ในขณะคอมไพล์แทนที่จะเป็นรันไทม์ สิ่งนี้สามารถช่วยคุณประหยัดเวลาและความพยายามในระยะยาวโดยหลีกเลี่ยงข้อผิดพลาดที่ยากต่อการแก้ไขที่อาจเกิดขึ้นในการผลิต

หากต้องการเปิดใช้งานโหมดเข้มงวด ให้เพิ่ม"strict": trueไฟล์ tsconfig.json การดำเนินการนี้จะช่วยให้มีการตรวจสอบอย่างเข้มงวดหลายอย่าง เช่น:

ไม่อนุญาตให้มีประเภทใด ๆ โดยนัย
บังคับใช้การตรวจสอบค่าว่าง
ไม่อนุญาตให้นำเข้าและตัวแปรที่ไม่ได้ใช้

การใช้อินเทอร์เฟซและประเภทสามารถช่วยให้รหัสของคุณสามารถอ่านและบำรุงรักษาได้มากขึ้นโดยการให้คำจำกัดความที่ชัดเจนเกี่ยวกับรูปร่างของข้อมูลของคุณ นอกจากนี้ยังช่วยให้ตรวจจับข้อผิดพลาดเกี่ยวกับประเภทได้ง่ายขึ้นในขณะคอมไพล์

ตัวอย่างเช่น พิจารณารหัสต่อไปนี้:

function printUser(user: { name: string, age: number }) {
  console.log(`Name: ${user.name}, Age: ${user.age}`);
}

interface User {
  name: string;
  age: number;
}
function printUser(user: User) {
  console.log(`Name: ${user.name}, Age: ${user.age}`);
}

ไฟล์ tsconfig.json ใช้เพื่อระบุตัวเลือกการกำหนดค่า TypeScript สำหรับโครงการของคุณ ซึ่งอาจรวมถึงสิ่งต่างๆ เช่น:

เวอร์ชันของ TypeScript ที่จะใช้
ไดเรกทอรีรากของโครงการของคุณ
ไดเร็กทอรีเอาต์พุตสำหรับไฟล์ JavaScript ที่คอมไพล์แล้ว

ใช้เครื่องมือเช่น ESLint และ Prettier เพื่อบังคับใช้คุณภาพและความสอดคล้องของโค้ด

ESLint และ Prettier เป็นทั้งเครื่องมือที่สามารถช่วยบังคับใช้คุณภาพรหัสและความสอดคล้องในฐานรหัส TypeScript ของคุณ สามารถใช้ ESLint เพื่อตรวจจับข้อผิดพลาดทั่วไปและบังคับใช้มาตรฐานการเข้ารหัส ในขณะที่สามารถใช้ Prettier เพื่อจัดรูปแบบโค้ดของคุณโดยอัตโนมัติให้เป็นรูปแบบที่สอดคล้องกัน

ด้วยการใช้เครื่องมือเหล่านี้ คุณสามารถช่วยให้แน่ใจว่ารหัสของคุณสามารถบำรุงรักษาได้และสอดคล้องกันในโครงการของคุณ

โดยรวมแล้ว แนวปฏิบัติที่ดีที่สุดเหล่านี้สามารถช่วยปรับปรุงคุณภาพและความสามารถในการบำรุงรักษาของ TypeScript codebase ของคุณเมื่อใช้ Node.js

บทสรุป

ในบทความนี้ เราได้สำรวจวิธีใช้ TypeScript กับ Node.js และให้ตัวอย่างเพื่อช่วยคุณเริ่มต้น TypeScript สามารถช่วยคุณตรวจจับข้อผิดพลาดก่อนรันไทม์ ปรับปรุงความสามารถในการอ่านและการบำรุงรักษาโค้ด และใช้คุณสมบัติขั้นสูง เช่น คลาส อินเทอร์เฟซ และ enums เมื่อปฏิบัติตามแนวทางปฏิบัติที่ดีที่สุดและใช้ไลบรารีและเฟรมเวิร์กยอดนิยม คุณจะสามารถสร้างแอปพลิเคชัน Node.js ที่ปรับขนาดได้และบำรุงรักษาได้ด้วย TypeScript