آموزش کامپایلر دایرکتیور (Compiler Directives) ها در گولنگ

کامپایلر دایرکیتو (Compiler Directives) چیه؟

دستورالعمل‌های کامپایلر، دستورات ویژه‌ای هستند که در کامنت‌های کد قرار می‌گیرند و معمولاً با //go: شروع می‌شوند. این دستورات به کامپایلر یا ابزارهای مرتبط با Go نحوه پردازش کد را مشخص می‌کنند. از رایج‌ترین این دستورالعمل‌ها می‌توان به موارد زیر اشاره کرد:

• //go:generate برای مشخص کردن کدهای تولیدشده

• //go:build برای تعیین شرایط ساخت کد

• //go:nolint برای جلوگیری از بررسی کد توسط ابزار lint

دستورالعمل‌های گولنگ نوآوری جدیدی در این زبان نیستند، بلکه در زبان‌های دیگر نیز وجود دارند، مانند #[inline(always)] در Rust. در زبان Go، به‌صورت پیش‌فرض inline فعال است، اما برای غیرفعال کردن آن می‌توان از //go:noinline استفاده کرد.

go:build

دستور //go:build در نسخه Go 1.17 معرفی شد تا جایگزین //+build شود. این دستور امکان کامپایل کد را بر اساس شرایط مختلفی مانند سیستم‌عامل، معماری پردازنده، نسخه Go و غیره فراهم می‌کند.

نحوه استفاده از //go:build

فرمت کلی این دستور به‌صورت زیر است:

//go:build <عبارت شرطی>

در اینجا، عبارت شرطی تعیین می‌کند که کد تحت چه شرایطی کامپایل شود. برخی از نمونه‌ها:

• linux && amd64 → کامپایل فقط روی سیستم‌عامل لینوکس با معماری amd64

• !windows → کامپایل روی همه سیستم‌ها به‌جز ویندوز

• darwin || linux → کامپایل روی مک (darwin) یا لینوکس

سیستم‌عامل‌ها و معماری‌های متداول

• سیستم‌عامل‌ها: linux, windows, darwin, freebsd, netbsd, openbsd

• معماری‌های پردازنده: amd64, arm, arm64, 386, mips

ترکیب //go:build با نام فایل

همچنین می‌توان این دستور را همراه با نام فایل استفاده کرد. مثلاً، فایل main_linux.go که همراه با //go:build linux مشخص شده است، فقط روی لینوکس کامپایل خواهد شد.

کاربرد در Kubernetes

در کد منبع Kubernetes، از //go:build به‌طور گسترده‌ای استفاده می‌شود، زیرا Kubernetes یک سیستم چندسکویی (cross-platform) است و این دستور برای کامپایل روی سیستم‌ها و معماری‌های مختلف ضروری است:

go:generate

دستور //go:generate معمولاً برای تولید کد در مرحله ساخت (build) یا توسعه (development) استفاده می‌شود. این دستور به‌صورت کامنت ویژه‌ای در کد قرار می‌گیرد و برای اجرای ابزارها و دستورات خارجی جهت تولید فایل‌های کد موردنیاز به کار می‌رود.

کاربردهای //go:generate

از این دستور معمولاً برای تولید انواع فایل‌های کد مانند موارد زیر استفاده می‌شود:

• فایل‌های Mock برای تست

• فایل‌های Protobuf برای ارتباطات gRPC

• متدهای Deep Copy برای کپی عمیق داده‌ها

//go:generate mockgen -source=service.go -destination=mock_service.go -package=mocks

این دستور، ابزار mockgen را اجرا می‌کند تا فایل‌های موک (mock) از service.go ایجاد کند.

💡 نکته: دستورات //go:generate فقط در هنگام اجرای دستور go generate اجرا می‌شوند و در فرآیند معمول کامپایل تأثیری ندارند.

//go:generate mockgen -source=example.go -destination=mock_example.go -package=main
type Example interface {
    DoSomething() error
}

// generated mock_example.go
// MockExample is a mock of Example interface.
type MockExample struct {
    ctrl     *gomock.Controller
    recorder *MockExampleMockRecorder
}

// MockExampleMockRecorder is the mock recorder for MockExample.
type MockExampleMockRecorder struct {
    mock *MockExample
}

// NewMockExample creates a new mock instance.
func NewMockExample(ctrl *gomock.Controller) *MockExample {
    mock := &MockExample{ctrl: ctrl}
    mock.recorder = &MockExampleMockRecorder{mock}
    return mock
}

// ... more code skipped

//go:nolint
func unusedFunction() {
    // این تابع بدون هشدار از lint باقی می‌ماند
}

//go:nolint:unused,deadcode
func unusedFunction() {
    // فقط خطاهای مربوط به unused و deadcode نادیده گرفته می‌شوند
}