تعریف Interface حرفه‌ای برای آبجکت‌ها در TypeScript

چرا Interface حرفه‌ای مهم است؟

Interface حرفه‌ای، نه تنها Type Safety را تضمین می‌کند، بلکه به خوانایی، مستندسازی، تکمیل خودکار و Refactoring کمک می‌کند. در پروژه‌های بزرگ، Interfaceها به‌عنوان قرارداد بین بخش‌های مختلف کد عمل می‌کنند.

سه معیار Interface حرفه‌ای

• خوانایی: هر توسعه‌دهنده جدید باید بتواند ساختار را سریع درک کند.
• انعطاف‌پذیری: Interface باید با نیازهای در حال تغییر سازگار باشد.
• Type Safety: خطاها در زمان Compile شناسایی شوند.

«Interface حرفه‌ای، قراردادی است که خود را مستند می‌کند؛ نه یک بلوک کد اضافی.»

برای درک مبانی، مقاله اینترفیس در TypeScript چیست و چگونه از خطا جلوگیری می‌کند؟ را مطالعه کنید.

اصول پایه تعریف Interface

interface User {
id: number;
name: string;
email: string;
}

این تعریف پایه، سه پراپرتی اجباری را برای شیء User تعریف می‌کند.

پراپرتی‌های اختیاری

پراپرتی‌های اختیاری با علامت سؤال مشخص می‌شوند و امکان نبود مقدار را فراهم می‌کنند:

interface User {
id: number;
name: string;
email: string;
phone?: string; // اختیاری
avatar?: string; // اختیاری
}

نکات مهم

• پراپرتی اختیاری، مقدار undefined دارد.
• پیش از استفاده، باید وجود آن بررسی شود.
• استفاده از Optional Chaining: user.phone?.length
• استفاده از Nullish Coalescing: user.phone ?? 'بدون شماره'

Readonly و Immutability

پراپرتی‌های Readonly، پس از تعریف، قابل تغییر نیستند:

interface Config {
readonly apiKey: string;
readonly baseUrl: string;
timeout: number; // قابل تغییر
}

مزایای Readonly

• جلوگیری از تغییر ناخواسته.
• مستندسازی داده‌های ثابت.
• بهبود Thread Safety در سناریوهای همزمانی.
• تضمین یکپارچگی داده.

ReadonlyArray

interface UserList {
readonly items: ReadonlyArray<User>;
}

تعریف متدها

Interface می‌تواند متدها را نیز تعریف کند:

interface Calculator {
add(a: number, b: number): number;
subtract(a: number, b: number): number;
multiply(a: number, b: number): number;
}

متدهای اختیاری

interface Logger {
info(message: string): void;
error?(message: string): void; // اختیاری
}

اشیاء تودرتو

برای ساختارهای تودرتو، از Interfaceهای تودرتو یا ارجاع به Interfaceهای دیگر استفاده کنید:

interface Address {
street: string;
city: string;
country: string;
}

interface User {
id: number;
name: string;
address: Address;
contacts: {
email: string;
phone: string;
};
}

Index Signature

برای دیکشنری‌ها و اشیاء با کلیدهای پویا:

interface StringMap {
[key: string]: string;
}

مثال پیشرفته

interface Config {
name: string;
[key: string]: string | number | boolean;
}

نکات مهم

• Index Signature با سایر پراپرتی‌ها ترکیب می‌شود.
• نوع Index باید تمام انواع پراپرتی‌ها را پوشش دهد.
• برای محدودسازی کلیدها، از Generic استفاده کنید.

Generic در Interface

Generic امکان تعریف Interfaceهای انعطاف‌پذیر را فراهم می‌کند:

interface ApiResponse<T> {
data: T;
status: number;
message: string;
}

استفاده عملی

type UserResponse = ApiResponse<User>;
type UserListResponse = ApiResponse<User[]>;
type ErrorResponse = ApiResponse<null>;

محدودسازی Generic

interface Repository<T extends { id: number }> {
getById(id: number): T;
save(item: T): void;
}

Extends و Intersection

Interface می‌تواند از Interface دیگر ارث‌بری کند:

interface Animal {
name: string;
age: number;
}

interface Dog extends Animal {
breed: string;
bark(): void;
}

Extends چندگانه

interface Employee extends Person, Contact {
employeeId: string;
department: string;
}

Intersection Types

type Admin = User & { permissions: string[] };

Union Type در Interface

Interface می‌تواند از Union Types استفاده کند:

interface User {
id: number;
status: 'active' | 'inactive' | 'pending';
}

Discriminated Union

Discriminated Union یکی از قدرتمندترین الگوها برای مدل‌سازی حالت‌های مختلف یک موجودیت است:

interface SuccessResponse {
status: 'success';
data: User;
}

interface ErrorResponse {
status: 'error';
message: string;
}

type Response = SuccessResponse | ErrorResponse;

مزیت اصلی

در این الگو، TypeScript می‌تواند بر پایه مقدار status، نوع را تشخیص دهد و Type Safety کامل را تضمین کند.

Interface برای توابع

Interface می‌تواند نوع تابع را تعریف کند:

interface Formatter {
(input: string): string;
}

const toUpperCase: Formatter = (input) => input.toUpperCase();

Interface با متدهای اضافی

interface Middleware {
(req: Request, res: Response): void;
cache?: boolean;
}

مثال‌های واقعی

Interface برای API Response

interface ApiResponse<T> {
readonly success: boolean;
readonly data: T;
readonly meta: {
page: number;
total: number;
perPage: number;
};
error?: {
code: string;
message: string;
};
}

Interface برای Props کامپوننت React

interface ButtonProps {
readonly children: React.ReactNode;
readonly variant?: 'primary' | 'secondary' | 'danger';
readonly size?: 'small' | 'medium' | 'large';
onClick?: (event: React.MouseEvent) => void;
disabled?: boolean;
}

Interface برای Config

interface AppConfig {
readonly environment: 'development' | 'staging' | 'production';
readonly api: {
readonly baseUrl: string;
readonly timeout: number;
readonly retries: number;
};
readonly features: Record<string, boolean>;
}

نام‌گذاری حرفه‌ای

سازمان‌دهی Interfaceها

الگوهای رایج

• Co-location: Interface در همان فایل کامپوننت.
• Types Folder: پوشه اختصاصی برای انواع مشترک.
• Feature-based: هر feature شامل types خود.
• Domain-based: تفکیک بر پایه دامنه کسب‌وکار.

ساختار پیشنهادی

src/
├── types/
│ ├── user.ts
│ ├── order.ts
│ └── api.ts
├── features/
│ └── auth/
│ └── types.ts

رویکردهای توصیه‌شده

• استفاده از Readonly برای داده‌های ثابت.
• استفاده از پراپرتی‌های اختیاری برای فیلدهای غیرضروری.
• تقسیم Interfaceهای بزرگ به کوچک‌تر.
• استفاده از Generic برای انعطاف‌پذیری.
• استفاده از Discriminated Union برای حالت‌های مختلف.
• مستندسازی Interfaceهای عمومی با JSDoc.
• پرهیز از any.
• استفاده از Type برای Union و Type Alias.
• سازمان‌دهی منطقی Interfaceها.
• پایش کیفیت Interfaceها به‌طور دوره‌ای.

«Interface حرفه‌ای، سه ویژگی دارد: خوانا، منعطف و دقیق.»

اشتباهات رایج

پرسش‌های پرتکرار

Interface حرفه‌ای چه تفاوتی با Interface ساده دارد؟

Interface حرفه‌ای از الگوهای پیشرفته‌ای مانند Generic، Discriminated Union، Readonly و Optional استفاده می‌کند و خوانایی، انعطاف‌پذیری و Type Safety را هم‌زمان رعایت می‌کند.

چه زمانی از Generic در Interface استفاده کنم؟

وقتی Interface باید برای انواع مختلف داده کار کند و انعطاف‌پذیری مورد نیاز است. مثال کلاسیک: ApiResponse<T>.

Discriminated Union چیست و چه کاربردی دارد؟

الگویی که در آن یک پراپرتی مشترک (مانند status) تعیین‌کننده نوع است و TypeScript می‌تواند بر پایه آن، نوع را دقیق تشخیص دهد.

آیا از I در ابتدای Interface استفاده کنم؟

سبک رایج مدرن، استفاده از PascalCase بدون prefix است. مثال: User به‌جای IUser.

چه زمانی از Interface و چه زمانی از Type Alias استفاده کنم؟

Interface برای اشیاء و Classها مناسب است و از Declare Merge پشتیبانی می‌کند. Type Alias برای Union، Tuple و انواع پیچیده‌تر.

چگونه Interface را برای Props کامپوننت React تعریف کنم؟

با استفاده از Interface و تعریف پراپرتی‌های اجباری و اختیاری. مثال: interface ButtonProps { children: React.ReactNode; onClick?: () => void; }

آیا Interface بر عملکرد اثر دارد؟

خیر. Interface در زمان Compile حذف می‌شود و در Runtime اثری ندارد.

چگونه Interface را سازمان‌دهی کنم؟

با Co-location یا ساختار Domain-based. برای پروژه‌های بزرگ، پوشه types یا تفکیک بر پایه feature رویکرد توصیه‌شده است.

آیا از Readonly برای همه پراپرتی‌ها استفاده کنم؟

خیر. Readonly تنها برای پراپرتی‌هایی که نباید تغییر کنند. استفاده نابجا از Readonly، انعطاف‌پذیری کد را کاهش می‌دهد.

آیا Interface می‌تواند ترکیب Union و Optional باشد؟

بله. مثال: interface Response { status: 'success' | 'error'; data?: unknown; }

پایان‌بندی

تعریف Interface حرفه‌ای در TypeScript، یکی از مهارت‌های بنیادین توسعه‌دهندگان مدرن است که مستقیماً بر کیفیت، خوانایی و پایداری پروژه اثر می‌گذارد. Interface حرفه‌ای، از الگوهای پیشرفته‌ای مانند Generic، Discriminated Union، Readonly و Optional استفاده می‌کند تا Type Safety، انعطاف‌پذیری و مستندسازی را هم‌زمان فراهم کند.

از منظر مهندسی سطح ارشد، سه اصل در تعریف Interface حرفه‌ای تعیین‌کننده است. نخست، تقسیم Interfaceهای بزرگ به Interfaceهای کوچک و متمرکز که هر یک مسئولیت مشخصی دارد. دوم، استفاده هوشمندانه از Generic برای انعطاف‌پذیری بدون تکرار کد. سوم، به‌کارگیری Discriminated Union برای مدل‌سازی حالت‌های مختلف موجودیت‌ها به‌شکلی امن و خوانا.

برای درک عمیق‌تر، مقاله اینترفیس در TypeScript چیست و چگونه از خطا جلوگیری می‌کند؟ و مقاله تایپ اسکریپت از صفر را مطالعه کنید.

اگر در پروژه‌های خود تجربه‌ای از تعریف Interface حرفه‌ای داشته‌اید، برایتان جالب است بدانید کدام الگو بیشترین اثر را در کیفیت کد داشت. تجربه‌تان را در دیدگاه‌ها بنویسید. 💻