PHP Laravel의 Builder Pattern을 사용하여 유연한 워크 플로우 자동화 시스템을 설계

Workflow 자동화는 현대 소프트웨어 효율성의 핵심에 자리 잡고 있으며, 팀들은 명확성과 제어를 통해 복잡한 비즈니스 프로세스를 관현할 수 있습니다. Laravel 생태계에서 우아하게 유연성과 유지성을 균형이 잡히는 입증된 접근법은 Builder 패턴입니다. 이 문서는 Laravel의 Builder 패턴을 사용하여 워크플로 자동화 시스템을 설계하는 데 있어, 기본 원칙부터 고급 생산 읽은 구현을 위한 포괄적인 방법을 제공합니다.

Laravel Context에 Builder 패턴 이해

Builder 패턴은 최종 표현에서 복잡한 객체의 구조를 분리하는 창조적인 디자인 패턴입니다. 대신 많은 매개 변수를 가진 단일 생성기를 강제로, Builder 패턴은 객체의 단계별 구성을 할 수 있습니다. 생성 프로세스를 읽을 수 있고 유연한.

작업 흐름 자동화의 맥락에서, "컴플렉스 객체"는 단계 (작업 흐름)의 순서입니다. Builder를 사용하여 구성 추가, 제거, 또는 주문 단계의 워크플로를 정의할 수 있습니다. 이 디코딩은 시스템 확장 및 테스트를 쉽게 만들 수 있습니다. Laravel 개발자는 이미 플런트를 즐기고, Builder와 같은 API를 프레임 워크 (예 : Query Builder, Mail Builder, Dynamics 등)의 많은 부분에서 얻고 있습니다.

주요 이점은 다음을 포함합니다:

Readability: Chaining 메서드는 DSL과 워크플로우 정의에 대해 닮았습니다.
Immutability: 내장 워크플로우 객체는 부작용 없이 실행되거나 지속될 수 있습니다.
테스트: 단계와 빌더는 격리에서 테스트할 수 있습니다.

Workflow 시스템의 핵심 구성 요소

깨끗한 디자인은 3가지의 초록색을 요구합니다: Workflow 자체, 단계 인터페이스 및 Workflow로 단계 조립하는 방법을 알고 있는 Builder.

Workflow 클래스 정의

Workflow 클래스는 주문된 단계 수집을 보유하며, 순서대로 실행하는 방법을 제공합니다. 정의된 계약을 실행하는 각 단계의 특정에 대해 걱정할 필요가 없습니다.

<?php

namespace App\Workflow;

class Workflow
{
 protected array $steps = [];

 public function addStep(Step $step): self
 {
 $this->steps[] = $step;
 return $this;
 }

 public function run(): void
 {
 foreach ($this->steps as $step) {
 $step->execute();
 }
 }

 public function getSteps(): array
 {
 return $this->steps;
 }
}

이 최소 구현은 개념을 입증하는 것이 충분합니다. 실제 라라벨 응용 프로그램에서, 당신은 또는 ]를 워크 플로우로 주사 할 수 있지만, 그없이 패턴은 고체 남아 있습니다.

단계 인터페이스 만들기

작업 흐름에 참여하는 모든 단계는 일반적인 인터페이스를 구현해야합니다. 이것은 워크 플로우가 내부 논리를 알 수없는 단계에 [FLT : 3]]를 호출 할 수 있도록합니다.

<?php

namespace App\Workflow;

interface Step
{
 public function execute(): void;
}

이 인터페이스를 한 번에 확장할 수 있습니다. 예를 들어, 또는 ]을 추가하면, 생산 작업 흐름에 유용하게 rollbacks와 같은 조건 실행 및 트랜잭션을 활성화합니다.

콘크리트 단계 구현

구체적인 단계는 실제 작업을 수행합니다. 아래는 두 가지 일반적인 단계의 예입니다. 이메일 및 처리 데이터를 전송합니다.

<?php

namespace App\Workflow\Steps;

use App\Workflow\Step;
use Illuminate\Support\Facades\Mail;

class EmailStep implements Step
{
 public function __construct(
 private readonly string $recipient,
 private readonly string $subject = 'Workflow Notification',
 private readonly string $body = ''
 ) {}

 public function execute(): void
 {
 Mail::raw($this->body, function ($message) {
 $message->to($this->recipient)
 ->subject($this->subject);
 });
 }
}

class DataProcessingStep implements Step
{
 public function __construct(
 private readonly array $data
 ) {}

 public function execute(): void
 {
 // Transform, validate, or persist $this->data
 // For demo: log the data
 \Log::info('Processing data', $this->data);
 }
}

작은 단계와 집중을 유지함으로써, 다른 워크플로우를 통해 재사용 가능성을 높입니다.

Builder를 구현

Builder 클래스는 Workflow 객체를 구성하기위한 유창한 인터페이스를 제공합니다. Builder의 각 메소드는 내부 워크플로우 인스턴스에 구성된 단계를 추가하고 체인딩을 위해 스스로를 반환합니다.

<?php

namespace App\Workflow;

class WorkflowBuilder
{
 protected Workflow $workflow;

 public function __construct()
 {
 $this->workflow = new Workflow();
 }

 public function addEmailStep(string $recipient, string $subject = 'Notification', string $body = ''): self
 {
 $this->workflow->addStep(
 new Steps\EmailStep($recipient, $subject, $body)
 );
 return $this;
 }

 public function addDataProcessingStep(array $data): self
 {
 $this->workflow->addStep(
 new Steps\DataProcessingStep($data)
 );
 return $this;
 }

 public function build(): Workflow
 {
 return $this->workflow;
 }
}

Fluent 공용영역과 Chaining

플런트 인터페이스는 Laravel에서 Builder 패턴을 빛내는 것입니다. 개발자는 단일 표현식에서 워크플로를 구성할 수 있습니다.

$workflow = (new WorkflowBuilder())
 ->addEmailStep('[email protected]', 'Welcome', 'Your account is ready.')
 ->addDataProcessingStep(['user_id' => 42, 'action' => 'register'])
 ->build();

$workflow->run();

이 읽기성은인지 부하를 줄이고 비즈니스 규칙 변경시 리어 레인지 단계가 용이하게 만듭니다. 더 복잡한 시나리오의 경우, Director] class는 여러 사전 정의 빌더, 예를 들어, 를 캡슐화하여 새로운 사용자 등록을 위한 완전 내장 워크플로를 반환합니다.

고급 Workflow 기능

생산 워크플로우 시스템은 선형 실행보다 더 많은 필요. 조건부 단계, 오류 처리 및 지속력을 지원하는 아키텍처를 강화하자.

Predicates를 사용하여 조건 단계

모든 단계가 매번 실행되어야 합니다. ] 메소드를 사용하여 단계 인터페이스를 확장하면, 실행 데이터에 근거한 결정이 발생할 수 있습니다.

interface Step
{
 public function shouldExecute(Context $context): bool;
 public function execute(): void;
}

class ConditionalEmailStep implements Step
{
 public function shouldExecute(Context $context): bool
 {
 return $context->get('send_email') === true;
 }

 public function execute(): void
 {
 // send email...
 }
}

Workflow의 메소드는 각 단계의 상태를 실행하기 전에 확인합니다.

오류 처리 및 롤백

단계가 실패하면 이전에 완료된 단계 (사가 패턴)를 원할 수 있습니다. 단계 인터페이스에 ] 메소드를 추가하십시오.

interface Step
{
 public function execute(): void;
 public function rollback(): void;
}

Workflow는 트랜잭션 관리자가 됩니다.

public function run(): void
{
 $completed = [];
 try {
 foreach ($this->steps as $step) {
 $step->execute();
 $completed[] = $step;
 }
 } catch (\Throwable $e) {
 // Rollback in reverse order
 foreach (array_reverse($completed) as $completedStep) {
 $completedStep->rollback();
 }
 throw $e;
 }
}

이 패턴은 금융 거래 또는 재고 조정과 같은 데이터 일관성을 유지해야 하는 다단계 작업에 특히 유용합니다.

Persisting Workflow 상태

긴 실행 워크플로우(예: 사용자 승인 체인)은 요청 사이에 해당 상태를 지속해야 합니다. Laravel의 Eloquent ORM은 이 직선적 작업을 합니다.

]를 생성하면 단계 목록(동일)과 현재 실행 인덱스를 저장합니다. 전용 테이블을 사용하십시오.

Schema::create('workflows', function (Blueprint $table) {
 $table->id();
 $table->text('steps'); // serialized array of Step objects
 $table->unsignedSmallInteger('current_step')->default(0);
 $table->string('status'); // pending, running, completed, failed
 $table->timestamps();
});

재작동할 때, Workflow 객체는 저장된 직렬화 단계(또는 빌드를 사용하여 재발동할 수 있는 단계 정의)에서 재건됩니다. 단계는 Laravel job class로, 비동기 실행 기본을 만들 수 있습니다.

Laravel의 Ecosystem과 통합

Asynchronous Steps에 대한 작업 사용

배경에서 실행해야 하는 단계 (예: 큰 보고서를 보내), 각 단계를 라벨 작업으로 변환. 워크 플로우는 순서에 작업을 파견할 수 있습니다, 또는 빌더는 작업 클래스 내부를 포장 할 수 있습니다.

class DispatchJobStep implements Step
{
 public function __construct(
 private readonly object $job
 ) {}

 public function execute(): void
 {
 dispatch($this->job);
 }
}

// Usage in builder
public function addReportGenerationJobStep(int $userId): self
{
 $this->workflow->addStep(
 new DispatchJobStep(new GenerateReportJob($userId))
 );
 return $this;
}

방송 작업 흐름 진행

Real‐time UI 업데이트는 Laravel의 이벤트 방송을 활용할 수 있습니다. 각 단계는 실행 전과 후 이벤트를 불릴 수 있습니다.

public function execute(): void
{
 StepStarted::dispatch($this);
 // perform work
 StepCompleted::dispatch($this);
}

Listeners는 WebSockets (Laravel Echo)를 통해 프론트엔드 대시보드에 방송할 수 있습니다.

Real-World 사용 사례

User Onboarding Workflow: 계정을 생성 → 이메일 보내기 → 기본 권한 설정 → 트리거 온보딩 분석.
주문 처리 워크플로: 재고목록 → 충전 결제 → 주문 확인 → 업데이트 배송 큐를 보내주세요.
Content 승인 워크플로: 초안 → 알림 → approve/reject → 출판 또는 개정을 위해 다시 보내주세요.

각 경우 Builder 패턴은 다른 부서가 내부 실행 엔진을 만지지 않고 자체 워크플로 구성을 정의 할 수 있습니다.

시험 Workflows

패턴의 가장 큰 승리 중 하나는 테스트 가능입니다. 각 단계는 독립적으로 테스트 할 수 있습니다. 빌더는 단계의 정확한 순서가 조립된다는 것을 확인하기 위해 조폐 된 단계로 테스트 할 수 있습니다. 통합 테스트는 외부 서비스의 가짜 구현을 사용하여 전체 워크플로를 실행할 수 있습니다 (예 : ]).

public function test_email_step_is_added_to_workflow()
{
 $builder = new WorkflowBuilder();
 $workflow = $builder
 ->addEmailStep('[email protected]')
 ->build();

 $steps = $workflow->getSteps();
 $this->assertCount(1, $steps);
 $this->assertInstanceOf(EmailStep::class, $steps[0]);
}