Làm cách nào để tạo trình tạo mã trong PHP?

Tạo các hàm tạo

PhpStorm có thể tạo một hàm khởi tạo khởi tạo các thuộc tính lớp cụ thể bằng cách sử dụng các giá trị của các đối số tương ứng

Đoạn mã sau hiển thị kết quả của việc tạo một hàm tạo cho một lớp

lớp MyClass { trường $ công khai; . * @param $field */ public function __construct[$field] { $this->field = $field;

Tạo getters và setters

PhpStorm có thể tạo các phương thức truy cập và biến đổi [ getters và setters] for the fields in your classes. Generated methods have only one argument.

Trong ngữ cảnh PHP , getters và setters được tạo bằng cách sử dụng PHP Getter/Setter/Fluent . Theo mặc định, như được chỉ định trong các mẫu này, setters được tạo với tiền tố set và getters với tiền tố is hoặc get tùy theo loại thuộc tính được suy luận – boolean hoặc non-boolean. Tiền tố là giá trị của biến ${GET_OR_IS} trong mẫu getter mặc định. Các mẫu được định cấu hình trong tab file templates. By default, as specified in these templates, setters are generated with the set prefix, and getters with the is or get prefix according to the inferred property type – boolean or non-boolean. The prefix is the value of the ${GET_OR_IS} variable in the default getter template. The templates are configured in the Mã trên Tệp và mẫu mã.

Đoạn mã sau đây cho thấy kết quả của việc tạo các phương thức getter và setter cho một lớp có một trường var

lớp MyClass { /** * @return hỗn hợp */ public function getVar[] { return $this->var; . khoảng trống { $this->var = $var;

Bạn đã bao giờ nghĩ đến việc viết mã chịu trách nhiệm tạo các lớp, phương thức, thuộc tính PHP nhất định một cách tự động chưa?

Khái niệm

Ý tưởng cơ bản khá đơn giản. Bạn viết mã sẽ tạo ra các phần khác của mã, hàm, biến, lớp, khối tài liệu, v.v. Khi bạn làm điều đó bằng một ngôn ngữ lập trình [trong trường hợp của chúng tôi là PHP], bạn có thể chỉ định các tham số, câu lệnh if-else, vòng lặp, v.v.

Tất nhiên, việc có thể tạo mã PHP tự động không có nghĩa là chúng tôi, những nhà phát triển, sẽ bị thay thế. Nhưng nó có thể được sử dụng để tạo thành một cấu trúc cơ bản mà sau này sẽ được con người phát triển thêm. Ví dụ, thay vì sao chép-dán để chuẩn bị một nhóm lớp ban đầu trong ứng dụng của bạn, bạn có thể sử dụng trình tạo

Tạo mã đã được sử dụng trong các khuôn khổ khác nhau. Xem các lệnh bảng điều khiển Symfony2 GeneratorBundle, CakePHP hoặc Laravel Artisan để biết ví dụ

Tạo các lớp PHP với Memio

Nếu bạn muốn viết tập lệnh của riêng mình để tự động tạo mã PHP, một trong các tùy chọn là sử dụng thư viện Memio. Điểm hay của Memio là nó được viết tốt, sử dụng mã hướng đối tượng. Bạn không cần phải viết mã mục tiêu trong chuỗi, thực hiện nối các biến chuỗi, v.v. Mọi thứ đang được thực hiện bằng cách tạo các thể hiện của lớp và gọi các phương thức của chúng. Bản thân các mẫu cho mã đầu ra được lưu trữ dưới dạng các mẫu Twig

Để bắt đầu sử dụng Memio trong dự án của bạn, chỉ cần thêm nó vào tệp composer.json, như được viết trong tài liệu. Lớp cốt lõi, chịu trách nhiệm tạo mã – PrettyPrinter – yêu cầu một thể hiện Twig_Environment làm đối số hàm tạo. Nó nên được khởi tạo theo cách sau

$twigLoaderFilesystem = new Twig_Loader_Filesystem['vendor/memio/memio/templates'];
$twigEnvironment = new Twig_Environment[$twigLoaderFilesystem, []];

$memioPrettyPrinter = new \Memio\Memio\PrettyPrinter[$twigEnvironment];

Để tạo một số mã PHP với Memio, bạn phải tạo các đối tượng đại diện cho các phần mã cụ thể, sau đó chỉ cần chuyển chúng vào phiên bản PrettyPrinter và kết quả là bạn sẽ nhận được mã đầu ra. Mỗi đối tượng đại diện cho mã được tạo tự động là một thể hiện của một trong các lớp Memio

$class = \Memio\Memio\Model\Object::make['User'];

$nameProperty = \Memio\Memio\Model\Property::make['name'];
$class->addProperty[$nameProperty];

$getNameMethod = \Memio\Memio\Model\Method::make['getName']->setBody['return $this->name'];
$class->addMethod[$getNameMethod];

echo $memioPrettyPrinter->generateCode[$class];

$class = \Memio\Memio\Model\Object::make['User'];

$nameProperty = \Memio\Memio\Model\Property::make['name'];
$class->addProperty[$nameProperty];

$getNameMethod = \Memio\Memio\Model\Method::make['getName']->setBody['return $this->name'];
$class->addMethod[$getNameMethod];

echo $memioPrettyPrinter->generateCode[$class];

Điều này sẽ tạo ra đầu ra sau

class User
{
    private $name;

    public function getName[]
    {
        return $this->name;
    }
}

Ví dụ thế giới thực. Bản đồ quan hệ giữa các đối tượng

Mã PHP tự động tạo thường được sử dụng khi ánh xạ cấu trúc cơ sở dữ liệu tới các lớp PHP. Mỗi bảng trong cơ sở dữ liệu có thể được đại diện bởi một lớp riêng biệt trong ứng dụng PHP. Sau đó, mỗi cột của bảng sẽ được đại diện bởi một thuộc tính lớp. Hãy thử viết một kịch bản đơn giản sẽ tạo các lớp như vậy, dựa trên cấu trúc cơ sở dữ liệu MySQL

Để bắt đầu với tập lệnh của chúng tôi, chúng tôi cần tìm nạp danh sách các bảng trong cơ sở dữ liệu đã chọn. Chúng tôi cũng sẽ cần danh sách các cột trong mỗi bảng này. Để có được tất cả dữ liệu này, chúng ta phải sử dụng hai lệnh MySQL.

$class = \Memio\Memio\Model\Object::make['User'];

$nameProperty = \Memio\Memio\Model\Property::make['name'];
$class->addProperty[$nameProperty];

$getNameMethod = \Memio\Memio\Model\Method::make['getName']->setBody['return $this->name'];
$class->addMethod[$getNameMethod];

echo $memioPrettyPrinter->generateCode[$class];

$class = \Memio\Memio\Model\Object::make['User'];

$nameProperty = \Memio\Memio\Model\Property::make['name'];
$class->addProperty[$nameProperty];

$getNameMethod = \Memio\Memio\Model\Method::make['getName']->setBody['return $this->name'];
$class->addMethod[$getNameMethod];

echo $memioPrettyPrinter->generateCode[$class];

Bước tiếp theo là tạo một lớp PHP riêng cho từng bảng. Tên của lớp sẽ giống như tên bảng, chỉ bắt đầu bằng một chữ in hoa

foreach[$tableNames as $table] {
    $class = new \Memio\Memio\Model\Object[ucfirst[$table]];

    //...
}

Để làm cho các lớp của chúng tôi hữu ích hơn, chúng tôi sẽ thêm các thuộc tính lớp đại diện cho từng cột trong bảng. Giả sử rằng chúng ta đã lưu trữ các tên cột trong một mảng phẳng, đoạn mã sẽ như sau

foreach[$columnNames as $column] {
    $property = \Memio\Memio\Model\Property::make[$column];
    $class->addProperty[$property];
}

Và đó là tất cả. Để lấy mã đầu ra cho lớp, chỉ cần chuyển biến

$class = \Memio\Memio\Model\Object::make['User'];

$nameProperty = \Memio\Memio\Model\Property::make['name'];
$class->addProperty[$nameProperty];

$getNameMethod = \Memio\Memio\Model\Method::make['getName']->setBody['return $this->name'];
$class->addMethod[$getNameMethod];

echo $memioPrettyPrinter->generateCode[$class];

$class = \Memio\Memio\Model\Object::make['User'];

$nameProperty = \Memio\Memio\Model\Property::make['name'];
$class->addProperty[$nameProperty];

$getNameMethod = \Memio\Memio\Model\Method::make['getName']->setBody['return $this->name'];
$class->addMethod[$getNameMethod];

echo $memioPrettyPrinter->generateCode[$class];

$code = $memioPrettyPrinter->generateCode[$class];

Điều này cho phép chúng tôi tự động tạo các lớp cho tất cả các bảng trong cơ sở dữ liệu của chúng tôi

Mở rộng Model Generator

Ví dụ trên chỉ là phần giới thiệu đơn giản để làm việc với Memoo. Để làm cho các lớp của chúng tôi dễ sử dụng hơn, chúng tôi có thể mở rộng chúng theo nhiều cách. Đầu tiên, hãy tạo getters và setters cho từng thuộc tính. Vòng lặp của chúng tôi thông qua các tên cột trong một bảng bây giờ sẽ như sau

foreach[$columnNames as $column] {
    $property = \Memio\Memio\Model\Property::make[$column];
    $class->addProperty[$property];

    $getter = Method::make['get' . ucfirst[$column]]->setBody['return $this->' . $column . ';'];
    $class->addMethod[$getter];

    $setterArgument = Argument::make['string', $column];
    $setter = Method::make['set' . ucfirst[$column]]->addArgument[$setterArgument]->setBody['$this->' . $column . ' = $' . $column . ';'];
    $class->addMethod[$setter];
}

Như bạn có thể thấy, chúng tôi đã tạo hai biến khởi tạo lớp Memio

$class = \Memio\Memio\Model\Object::make['User'];

$nameProperty = \Memio\Memio\Model\Property::make['name'];
$class->addProperty[$nameProperty];

$getNameMethod = \Memio\Memio\Model\Method::make['getName']->setBody['return $this->name'];
$class->addMethod[$getNameMethod];

echo $memioPrettyPrinter->generateCode[$class];

$class = \Memio\Memio\Model\Object::make['User'];

$nameProperty = \Memio\Memio\Model\Property::make['name'];
$class->addProperty[$nameProperty];

$getNameMethod = \Memio\Memio\Model\Method::make['getName']->setBody['return $this->name'];
$class->addMethod[$getNameMethod];

echo $memioPrettyPrinter->generateCode[$class];

$class = \Memio\Memio\Model\Object::make['User'];

$nameProperty = \Memio\Memio\Model\Property::make['name'];
$class->addProperty[$nameProperty];

$getNameMethod = \Memio\Memio\Model\Method::make['getName']->setBody['return $this->name'];
$class->addMethod[$getNameMethod];

echo $memioPrettyPrinter->generateCode[$class];

$class = \Memio\Memio\Model\Object::make['User'];

$nameProperty = \Memio\Memio\Model\Property::make['name'];
$class->addProperty[$nameProperty];

$getNameMethod = \Memio\Memio\Model\Method::make['getName']->setBody['return $this->name'];
$class->addMethod[$getNameMethod];

echo $memioPrettyPrinter->generateCode[$class];

class User
{
    private $name;

    public function getName[]
    {
        return $this->name;
    }
}

class User
{
    private $name;

    public function getName[]
    {
        return $this->name;
    }
}

class User
{
    private $name;

    public function getName[]
    {
        return $this->name;
    }
}

$class = \Memio\Memio\Model\Object::make['User'];

$nameProperty = \Memio\Memio\Model\Property::make['name'];
$class->addProperty[$nameProperty];

$getNameMethod = \Memio\Memio\Model\Method::make['getName']->setBody['return $this->name'];
$class->addMethod[$getNameMethod];

echo $memioPrettyPrinter->generateCode[$class];

class User
{
    private $name;

    public function getName[]
    {
        return $this->name;
    }
}

class User
{
    private $name;

    public function getName[]
    {
        return $this->name;
    }
}

$class = \Memio\Memio\Model\Object::make['User'];

$nameProperty = \Memio\Memio\Model\Property::make['name'];
$class->addProperty[$nameProperty];

$getNameMethod = \Memio\Memio\Model\Method::make['getName']->setBody['return $this->name'];
$class->addMethod[$getNameMethod];

echo $memioPrettyPrinter->generateCode[$class];

Ví dụ trên cho thấy một khía cạnh quan trọng khi làm việc với Memoo. Xin lưu ý rằng chúng tôi luôn chuyển các đối tượng đại diện cho các phần nhỏ của mã lên cấp cao hơn. Đầu tiên là đối số phương thức [lớp

class User
{
    private $name;

    public function getName[]
    {
        return $this->name;
    }
}

$class = \Memio\Memio\Model\Object::make['User'];

$nameProperty = \Memio\Memio\Model\Property::make['name'];
$class->addProperty[$nameProperty];

$getNameMethod = \Memio\Memio\Model\Method::make['getName']->setBody['return $this->name'];
$class->addMethod[$getNameMethod];

echo $memioPrettyPrinter->generateCode[$class];

class User
{
    private $name;

    public function getName[]
    {
        return $this->name;
    }
}

foreach[$tableNames as $table] {
    $class = new \Memio\Memio\Model\Object[ucfirst[$table]];

    //...
}

Để thể hiện toàn bộ cấu trúc mã trong Memio, bạn có thể đặt thêm lớp đầu ra [lớp

foreach[$tableNames as $table] {
    $class = new \Memio\Memio\Model\Object[ucfirst[$table]];

    //...
}

foreach[$tableNames as $table] {
    $class = new \Memio\Memio\Model\Object[ucfirst[$table]];

    //...
}

Bước tiếp theo

Trong ví dụ của chúng tôi, chúng tôi chỉ tạo một trình tạo lớp đơn giản để ánh xạ các bảng cơ sở dữ liệu thành các đối tượng. Mã mẫu có thể được mở rộng thành một tập lệnh nâng cao hơn nhiều. Ví dụ: bạn có thể sử dụng thông tin về các loại cột từ MySQL và xác thực các biến đang được chuyển cho các phương thức setter. Bước tiếp theo, bạn có thể tạo mã duy trì đối tượng trong cơ sở dữ liệu, bằng cách chuyển một thể hiện đối tượng vào câu lệnh MySQL

foreach[$tableNames as $table] {
    $class = new \Memio\Memio\Model\Object[ucfirst[$table]];

    //...
}

foreach[$tableNames as $table] {
    $class = new \Memio\Memio\Model\Object[ucfirst[$table]];

    //...
}

Cũng nên nhớ rằng đầu ra của tập lệnh dựa trên Memio có thể được sửa đổi bằng cách thay đổi các mẫu mặc định. Ví dụ: nếu bạn muốn tạo mã tuân thủ các tiêu chuẩn mã hóa được sử dụng trong dự án của mình, tất cả những gì bạn cần làm là thực hiện thay đổi trong mẫu. Sau đó, tất cả mã được tạo tự động sẽ được tạo dựa trên quy ước và phong cách mã hóa của riêng bạn. Tài liệu mẫu chứa tất cả các chi tiết về cách thay thế các mẫu mặc định bằng các tệp của riêng bạn

Tôi khuyến khích bạn tự viết một số tập lệnh tự động tạo để kiểm tra tất cả các tính năng của thư viện Memio. Chia sẻ kết quả và suy nghĩ của bạn trong phần bình luận bên dưới. Chúc vui vẻ

Chia sẻ bài viết này