چگونه از Workflow در لاراول استفاده کنیم؟ | همراه با مثال

وقتی به توسعه نرم‌افزارها می‌پردازیم، زمانی رسیده‌ایم که باید با فرآیندها و جریان‌های کاری مختلف که در اجرای یک برنامه نیاز است مواجه شویم. Workflow یکی از اصطلاحات مهم در این حوزه است که به ما کمک می‌کند که فرآیندها را بهبود بخشیم، بهینه‌سازی کنیم و به راحتی با آن‌ها کار کنیم. در این مقاله، ما با مفهوم Workflow در لاراول آشنا خواهیم شد و نحوه استفاده از آن را با یک مثال عملی نیز بررسی خواهیم کرد.

Workflow چیست؟

Workflow به معنای جریان کاری یا فرآیند کاری است و به توصیف نحوه انجام فعالیت‌ها، مراحل یا وظایف در یک فرآیند می‌پردازد. این فرآیندها معمولاً یک الگوی مشخص دارند که مشخص می‌کند چگونه اطلاعات، داده‌ها و فعالیت‌ها از یک مرحله به مرحله دیگر منتقل می‌شوند. Workflow ها بهبود و بهینه‌سازی کارها، کاهش خطاها و افزایش کارآیی را در فرآیندهای کاری ایجاد می‌کنند.

آشنایی با مفهوم Workflow در لاراول

در لاراول، ما می‌توانیم از افزونه‌ها و پکیج‌هایی استفاده کنیم که امکان پیاده‌سازی Workflow را برای ما فراهم می‌کنند. این پکیج‌ها تعدادی از توابع و کلاس‌های کمکی را ارائه می‌دهند که می‌توانیم با استفاده از آن‌ها Workflow های خود را تعریف کنیم.

پکیج Laravel Workflow 

لاراول از چندین پکیج مختلف برای پیاده‌سازی Workflow پشتیبانی می‌کند. برخی از این پکیج‌ها شامل "spatie/laravel-permission" و "dyrynda/laravel-conditions" می‌شوند. هر کدام از این پکیج‌ها قابلیت‌ها و ویژگی‌های مختلفی را برای تعریف و مدیریت Workflow در لاراول فراهم می‌آورند.

مفاهیم State Machines and Transitions

در تعریف Workflow، مفهومی به نام "State Machine" بسیار مهم است. این مفهوم نشان‌دهنده وضعیت‌ها و حالت‌های مختلفی است که یک فرآیند می‌تواند داشته باشد. هر وضعیت می‌تواند به یک یا چند حالت دیگر تبدیل شود که این تبدیل‌ها با نام "Transitions" شناخته می‌شوند.

مزایای استفاده از Workflow در لاراول 

استفاده از Workflow در لاراول بسیار مزایایی را به همراه دارد که به ما کمک می‌کند فرآیند توسعه برنامه‌ها را بهبود بخشیم و با همکارانمان بهتر هماهنگ شویم. بیایید نگاهی به برخی از این مزایا بیاندازیم:

فرآیند توسعه ساده

استفاده از Workflow باعث می‌شود که فرآیند توسعه نرم‌افزار بهبود یابد و به صورت شفاف‌تری انجام شود. همه اعضای تیم می‌توانند به راحتی وضعیت فعلی فرآیند را مشاهده کنند و بدانند کدام قسمت‌ها نیاز به بررسی یا بهبود دارند.

بهبود Collaboration
استفاده از Workflow باعث می‌شود که همکاران در توسعه نرم‌افزار با هم هماهنگ‌تر عمل کنند. هر فرد می‌تواند مراحل کاری خود را به طور دقیق ترتیب دهد و بداند کدام وظیفه باید بعدی باشد.

مدیریت خطای پیشرفته

Workflow ها به ما امکان می‌دهند که به راحتی خطاها و مشکلاتی که در فرآیند کاری ممکن است رخ دهند را مدیریت کنیم. اگر یک ترانزیشن موفقیت‌آمیز نباشد، می‌توانیم برنامه را به وضعیت قبلی بازگردانی کنیم.

پیاده سازی Workflow در لاراول

برای پیاده‌سازی Workflow در لاراول، مراحل زیر را دنبال می‌کنیم:

مرحله 1: نصب پکیج Workflow

ابتدا، باید پکیج مورد نظر برای Workflow را نصب کنیم. برای مثال، اگر از پکیج "laravel-workflow/laravel-workflow" استفاده می‌کنیم، ابتدا آن را نصب می‌کنیم.

composer require laravel-workflow/laravel-workflow

مرحله 2: ساخت جدول سفارشات

حالا که پکیج نصب شد، باید Workflow خود را تعریف کنیم. به عنوان مثال، فرض کنید می‌خواهیم Workflow برای مدیریت سفارشات در یک فروشگاه آنلاین ایجاد کنیم.

ابتدا، مدل مربوط به سفارشات را ایجاد می‌کنیم:

php artisan make:model Order -m

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

public function up()
{
    Schema::create('orders', function (Blueprint $table) {
        $table->id();
        $table->string('order_number')->unique();
        $table->decimal('total_amount', 8, 2);
        $table->string('status');
        $table->timestamps();
    });
}

مرحله 3:  تعریف وضعیت‌ها و ترانزیشن‌ها

حالا که مدل سفارشات و فیلدهای وضعیت‌ها را تعریف کردیم، باید وضعیت‌ها و ترانزیشن‌ها را در Workflow تعریف کنیم.

در فایل OrderWorkflow.php که در پوشه app/Workflows ایجاد می‌شود، این تعریف‌ها را انجام می‌دهیم:

namespace App\Workflows;

use Symfony\Component\Workflow\DefinitionBuilder;
use Symfony\Component\Workflow\Transition;
use Symfony\Component\Workflow\TransitionBlockerList;
use Symfony\Component\Workflow\Workflow;
use Symfony\Component\Workflow\MarkingStore\MethodMarkingStore;

class OrderWorkflow
{
    public static function getWorkflow(): Workflow
    {
        $definitionBuilder = new DefinitionBuilder();

        $definition = $definitionBuilder->addPlaces(['new', 'paid', 'shipped'])
            ->addTransition(new Transition('payment_received', 'new', 'paid'))
            ->addTransition(new Transition('order_shipped', 'paid', 'shipped'))
            ->build();

        $marking = new MethodMarkingStore(true, 'status');

        return new Workflow($definition, $marking);
    }
}

در این تعریف، وضعیت‌ها "جدید"، "پرداخت شده" و "ارسال شده" و ترانزیشن‌ها "payment_received" (واریز پرداخت) و "order_shipped" (ارسال سفارش) تعریف شده‌اند.

مرحله 4: استفاده از Workflow در کنترلر

حالا که Workflow تعریف شده است، باید آن را در کنترلرها یا مکانیسم‌های دیگر برنامه لاراولمان به کار ببریم.

use App\Models\Order;
use App\Workflows\OrderWorkflow;

class OrderController extends Controller
{
    public function updateStatus(Request $request, Order $order)
    {
        $workflow = OrderWorkflow::getWorkflow();

        $transition = $request->input('transition');
        if (!$workflow->can($order, $transition)) {
            return response()->json(['error' => 'Invalid transition'], 422);
        }

        $workflow->apply($order, $transition);
        $order->save();

        return response()->json(['message' => 'Status updated successfully']);
    }
}

در این کنترلر، متد updateStatus برای به‌روزرسانی وضعیت سفارشات استفاده می‌شود. ابتدا اعتبارسنجی می‌شود که ترانزیشن مورد نظر معتبر است و سپس اعمال می‌شود.

مانیتورینگ Workflow در لاراول

laravel-workflow/waterline یک ابزار بسیار شیک برای مانیتورینگ Workflow های لاراول است.

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

composer require laravel-workflow/waterline

سپس با اجرای دستور زیر، مراحل نصب انجام می‌شود:

php artisan waterline:install

مجوز دسترسی
Waterline یک داشبورد رابط کاربری را در مسیر waterline/ ایجاد می‌کند. به طور پیش‌فرض، شما تنها در محیط محلی به این داشبورد دسترسی دارید. اما در فایل app/Providers/WaterlineServiceProvider.php، تعریفی برای مجوز دسترسی وجود دارد. این مجوز دسترسی کنترل می‌کند که در محیط‌های غیر محلی به Waterline دسترسی داشته باشید یا خیر.

مثال:

public function boot()
{
    $this->registerPolicies();

    Gate::define('viewWaterline', function ($user) {
        // اینجا می‌توانید شرط‌های مورد نیاز برای دسترسی به Waterline را تعریف کنید.
        // مثلاً شرطی برای اعتبارسنجی نقش کاربران یا دسترسی‌های خاص آن‌ها.
        return in_array($user->email, [
            'admin@example.com',
        ]);
    });
}

این مثال نشان می‌دهد که تنها کاربر با ایمیل admin@example.com مجوز دسترسی به Waterline را دارد.

با تنظیم شرایط مناسب برای دسترسی به Waterline می‌توانید از این ابزار برای مانیتورینگ و پیگیری Workflow های لاراول استفاده کنید.

نکات استفاده از Workflow

در این بخش، به برخی از نکات و مراحل بهتری برای استفاده از Workflow در لاراول پرداخته می‌شود:

Workflows ساده نگه دارید
تلاش کنید Workflow های خود را ساده و قابل فهم نگه دارید. این کمک می‌کند تا توسعه‌دهندگان دیگر به راحتی آن‌ها را درک کنند و به تعداد خطاها کاهش بدهید.

از نام های واضح برای State بکار ببرید 

وضعیت‌هایی که برای Workflow تعریف می‌کنید باید نام‌هایی شفاف و معنی‌دار داشته باشند. این امر به دیگران کمک می‌کند تا بدون اشتباه در فرآیند کاری شما شرکت کنند.

تست کنید

قبل از استفاده از Workflow در برنامه‌های حساس و زنده، حتماً آن را به طور جامع تست کنید. اطمینان حاصل کنید که همه حالت‌ها و ترانزیشن‌ها به درستی کار می‌کنند.

نتیجه

در این مقاله، با مفهوم Workflow در لاراول آشنا شدیم و نحوه استفاده از آن را با یک مثال عملی مورد بررسی قرار دادیم. استفاده از Workflow در لاراول باعث بهبود فرآیند توسعه نرم‌افزار، افزایش هماهنگی تیم و بهبود کیفیت کد می‌شود.