😸 💯 🔪 Getter / Setter und Kapselungsprobleme in Symfony-Projekten 👩🏼‍🤝‍👩🏻 🌚 ⏫

In jüngerer Zeit habe ich mit Symfony gearbeitet (etwas mehr als ein Jahr) und in allen Projekten, an denen ich arbeiten durfte - Entitäten wurden immer so erstellt, dass sie nur private Felder und bloße Setter / Getter für sie enthielten.

In den Artikeln wird es Argumente und Beispiele geben, warum dieser Ansatz gefährlich ist, nämlich: Er verstößt gegen unsere gute alte Kapselung, provoziert das Schreiben von Code mit Fehlern und erhöht die Komplexität des Systems.
In dem Artikel werden das Thema Setter in verschiedenen Buildern und das Thema der Abhängigkeitsinjektion durch Setter weggelassen (ich werde nur sagen, dass wir dies nicht genehmigen). Es wird nichts über komplexe Themen wie DDD, Rich Model, über Kopplung / Kohäsion und andere kluge Wörter geben - sprechen Sie einfach über Kapselung. Willkommen bei Katze.

Gehe zum Code. Lassen Sie für eine Sekunde den Typehint und die Typrückgabeanzeige weg und überlegen Sie, wie sich der folgende Code bei der Arbeit mit einem Objekt aus utilitaristischer Sicht unterscheidet:

$userName = $user->name;
$user->name = $newUserName;

$userName = $user->getName();
$user->setName($newUserName);

, , .

C . — , .

? , , . , , , .

«» , :

class Order
{
     private const STATUS_OPEN = 'open';
     private const STATUS_DELIVERED = 'delivered';

     private ProductCollection $products;
     private string $deliveryStatus;
     private ?DateTime $deliveryDate = null;

     public function deliver()
     {
          if ($this->isDelivered()) {
               throw new OrderDomainException('Order already delivered.');
          }

          $this->deliveryDate = new DateTime();
          $this->deliveryStatus = self::STATUS_DELIVERED;
     }

     private function isDelivered(): bool
     {
         return $this->deliveryStatus === self::STATUS_DELIVERED;
     }

     //  
}

« » - ? ? — ? . — , , . (cohesion).

:

class Order
{
    private const STATUS_OPEN = 'open';
    private const STATUS_DELIVERED = 'delivered';

    private ProductCollection $products;
    private string $deliveryStatus;
    private ?DateTime $deliveryDate = null;

    public function getDeliveryStatus(): string
    {
        return $this->deliveryStatus;
    }

    public function setDeliveryStatus(string $deliveryStatus): void
    {
        $this->deliveryStatus = $deliveryStatus;
    }

    public function getDeliveryDate(): ?DateTime
    {
        return $this->deliveryDate;
    }

    public function setDeliveryDate(?DateTime $deliveryDate): void
    {
        $this->deliveryDate = $deliveryDate;
    }

    public function getProducts(): ProductCollection
    {
        return $this->products;
    }

    public function setProducts(ProductCollection $products): void
    {
        $this->products = $products;
    }
}

? ( ). — , , , , ? , ? . — , — . . . , — ?

, . — , .

— , , , , , .

. :

/**
 * @ORM\Entity
 */
class Project
{
    /**
     * @var Id
     * @ORM\GeneratedValue()
     * @ORM\Id
     */
    private $id;
    /**
     * @var string
     * @ORM\Column(type="string")
     */
    private $name;
    /**
     * @var string
     * @ORM\Column(type="string", nullable=false)
     */
    private $status;
    /**
     * @var int
     * @ORM\Column(type="integer", nullable=true)
     */
    private $sort;
    /**
     * @var User
     * @ORM\Column(type="user_type", nullable=false)
     */
    private $user;
    /**
     * @var Department
     * @ORM\OneToMany(targetEntity="Department")
     */
    private $department;
    /**
     * @var string
     * @ORM\Column(type="string", nullable=true)
     */
    private $membership;
    
    public function getId(): Id
    {
        return $this->id;
    }
    
    public function getName(): string
    {
        return $this->name;
    }
    
    public function setName(string $name): Project
    {
        $this->name = $name;
        return $this;
    }
    
    public function getStatus(): string
    {
        return $this->status;
    }
    
    public function setStatus(string $status): Project
    {
        $this->status = $status;
        return $this;
    }
    
    public function getSort(): int
    {
        return $this->sort;
    }
    
    public function setSort(int $sort): Project
    {
        $this->sort = $sort;
        return $this;
    }
    
    public function getUser(): User
    {
        return $this->user;
    }
    
    public function setUser(User $user): Project
    {
        $this->user = $user;
        return $this;
    }
    
    public function getDepartment(): Department
    {
        return $this->department;
    }
    
    public function setDepartment(Department $department): Project
    {
        $this->department = $department;
        return $this;
    }
    
    public function getMembership(): string
    {
        return $this->membership;
    }
    
    public function setMembership(string $membership): Project
    {
        $this->membership = $membership;
        return $this;
    }
}

not nullable — ( false). , — not nullable , ? :)
, — ( ). .

, Doctrine ( ) , Reflection API. Marco Pivetta , : ocramius.imtqy.com/blog/doctrine-orm-optimization-hydration

. .
, , ( DTO, ..).

, , - «» . , , .

-. ID, — :

$order = $this->orderRepository->find($orderId);
if ($order === null) {
     throw new OrderException('Order not found.');
}

if ($order->getStatus() === Order::STATUS_ACTIVE 
    && $order->getDeliveryDate() <= $date
) {
    $this->orderDeliveryService->handle($order);
}

— , :

$order = $this->orderRepository->find($orderId);
$cityFreeLimit = $this->cityOrderService->getCityFreeLimit($cityName);

if ($order->getCity() === $cityName 
    && $order->getTotalPrice() > $cityFreeLimit
) {
     $delivery = 0;
     $this->orderDeliveryService->deliveryOrder($order, $delivery);
     
     return;
}

//

, - .

, - . , , , . , , , . «» «».

/ , , , , « » , — , , .

— Symfony (DAO), /. — - ( , ).

, — :)

. — .

Getter / Setter und Kapselungsprobleme in Symfony-Projekten

More articles: