Konsol Symfony yang memperkenalkan semula - CLI PHP untuk yang tidak dikenali!

mata teras

Konsol Symfony adalah pakej mandiri yang menyediakan rangka kerja mudah untuk membuat alat baris arahan, yang berguna untuk tugas berulang seperti penghijrahan data, mengimport, atau membuat pekerjaan cron.
Untuk membuat arahan baru, fail perlu dilaksanakan. Ini boleh dilakukan dengan membuat fail konsol dalam direktori root projek, memastikan fail boleh dilaksanakan, dan menentukan aplikasi konsol.
Anda boleh menggunakan kelas CommandTester Symfony untuk menguji arahan, yang menyediakan kelas input dan output khas untuk menguji arahan tanpa baris arahan.
Konsol Symfony dipasang menggunakan komposer (alat pengurusan ketergantungan dalam PHP). Ia menyediakan API mudah untuk membuat arahan baris arahan dan menyokong paparan warna, bar kemajuan, jadual dan ciri-ciri interaktif lain dari output.

Artikel ini dikemas kini pada 24 Mei 2017 dan memberikan pengenalan yang lebih komprehensif kepada alat moden yang penting ini.

---

"Komponen konsol memudahkan proses membuat antara muka baris perintah yang indah dan boleh diuji." Ini adalah mesej selamat datang yang kita lihat ketika kami melawat halaman Alat Komponen Konsol Symfony.

Sebagai pemaju perisian, kita sering perlu menggunakan alat baris arahan. Alat ini berguna apabila kita perlu melaksanakan beberapa jenis tugas berulang (seperti data yang berhijrah, melaksanakan import, atau membuat pekerjaan cron).

Alat Komponen Konsol Symfony menyediakan kami dengan rangka kerja mudah untuk membuat alat baris arahan kami sendiri.

Tidak seperti banyak komponen dalam Symfony, ini adalah pakej mandiri yang digunakan oleh Artisan Laravel dan banyak pakej PHP yang terkenal.

Untuk mengetahui tentang alternatif kepada Konsol Symfony, lihat artikel perbandingan kami: Battle of PHP Console!

Pemasangan

Maklumat penting mengenai komposer disertakan di sini.

composer require symfony/console

Buat perintah baru

Untuk membuat arahan baru, kita perlu memastikan fail kami boleh dilaksanakan. Untuk melakukan ini, mari buat fail konsol dalam direktori root projek. Fail ini akan berfungsi sebagai pengurus arahan kami.

Sekarang, mari pastikan fail itu boleh dilaksanakan.

touch console

Kemudian, mari pastikan ada shebang pada permulaan fail kami. Shebang adalah urutan watak (tanda ibu jari diikuti dengan tanda seru) yang muncul pada permulaan skrip. Apabila Shebang wujud, Exec () akan berubah ke fail yang boleh dilaksanakan yang ditentukan selepas Shebang dijalankan. Dalam contoh kami, ia akan dijalankan sebagai skrip PHP.

Selepas

, mari kita tentukan permohonan konsol kami. Penyebaran pertama pengurus perintah kami akan kelihatan seperti ini:

chmod 755 console

mari kita lihat lebih dekat. Pertama, kami secara automatik memuat semua kebergantungan dan kemudian mengimport pakej aplikasi dari komponen konsol. Selepas itu, kami membuat contoh aplikasi baru dan menjalankannya.

Jika kita menggunakan ./console untuk melaksanakan skrip, kita harus mendapatkan mesej bantuan berikut:

Ini kerana kami belum mendaftarkan sebarang arahan, kami hanya membina kerangka asas mereka.

Mari buat skrip kami dan daftarkannya dalam pengurus arahan kami yang baru dibuat.

Untuk contoh khusus ini, kami akan melaksanakan dua perintah mudah: satu untuk rentetan hashing dan yang lain untuk mengesahkan bahawa hash milik rentetan yang diberikan.

kami akan meletakkan folder

kelas hash.php kami, dengan kandungan berikut: /src

composer require symfony/console

Sudah tiba masanya untuk membuat arahan kami. Mari buat fail PHP baru yang dipanggil HashCommand.php.

Kelas ini akan memperluaskan kelas arahan Symfony dan melaksanakan Konfigurasi dan Laksanakan Kaedah. Kaedah ini sangat penting untuk arahan kami kerana mereka memberitahu perintah bagaimana mereka melihat dan berkelakuan.

Perintah yang disiapkan oleh

adalah seperti berikut:

touch console

Di bahagian konfigurasi, kaedah setName adalah cara kami memanggil perintah, setDescription adalah perihalan perintah, dan AddArgument adalah pernyataan yang kami katakan bahawa perintah itu akan menerima parameter yang dinamakan kata laluan, dan diperlukan.

Di bahagian Execute, kami mengakses parameter melalui fungsi getArgument dan kemudian hash mereka menggunakan kelas hash kami. Akhirnya, kami menggunakan kaedah WriteEln OutputInterface untuk mencetak hasilnya ke skrin.

Jika kita menjalankan perintah kita seperti ini, kita tidak akan melihat apa -apa yang berlaku. Ini kerana kita masih kehilangan langkah yang sangat penting. Kami masih perlu mendaftarkan arahan kami di konsol.

chmod 755 console

Selepas mendaftarkan arahan di konsol, mari kita jalankan.

Jika kita menjalankan perintah

sekali lagi, kita dapat melihat bahawa kita telah mendaftarkan arahan baru. ./console

mari kita jalankan:

kita melihat hasil akhir:

#!/usr/bin/env php

<?php require_once __DIR__ . '/vendor/autoload.php';

use Symfony\Component\Console\Application;

$app = new Application();
$app->run();

hash adalah hasil daripada menggunakan kaedah php hash () ke rentetan sitepoint.

Untuk fungsi pengesahan hash kami akan menggunakan kaedah yang sama, tetapi kami akan mempunyai dua parameter dan bukannya satu. Satu akan menjadi rentetan yang perlu disahkan, dan yang lain akan menjadi nilai hash yang kami ingin sahkan.

Kami akan membuat fail arahan baru, betul -betul di sebelah fail hashCommand. Mari kita panggil ia mengesahkan Komando.

Kemudian, daftar arahan dalam konsol.

<?php
namespace Hash;

class Hash {

    /**
     * 接收一个字符串密码并对其进行哈希处理。
     *
     * @param string $password
     * @return string $hash
     */
    public static function hash($password) {
        return password_hash($password, PASSWORD_DEFAULT);
    }

    /**
     * 验证哈希是否与给定的密码相对应
     *
     * @param string $password
     * @param string $hash
     * @return boolean 如果哈希是从密码生成的
     */
    public static function checkHash($string, $hash) {
        if (password_verify($string, $hash)) {
            return true;
        }
        return false;
    }

}

ujian

<?php
namespace Hash;

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Formatter\OutputFormatterStyle;

use Hash\Hash;

class HashCommand extends Command {

    protected function configure() {
        $this->setName("Hash:Hash")
                ->setDescription("使用Bcrypt对给定字符串进行哈希处理。")
                ->addArgument('Password', InputArgument::REQUIRED, '你想要哈希什么？');
    }

    protected function execute(InputInterface $input, OutputInterface $output) {

        $hash = new Hash();
        $input = $input->getArgument('Password');

        $result = $hash->hash($input);

        $output->writeln('你的密码哈希值：' . $result);

    }

}

Dari segi ujian, Symfony memberikan kita beberapa alat yang mudah. Yang paling berguna ialah kelas CommandTester, kerana ia menyediakan kelas input dan output khas untuk menguji arahan kami tanpa baris arahan.

mari kita gunakan kelas CommandTester untuk melaksanakan ujian untuk hash kami: perintah hash kami.

Pertama, mari buat folder /src pada tahap yang sama seperti kita. /tests

Kemudian, mari buat kelas ujian kami di dalamnya dan namakannya hashcommandtest.php:

composer require symfony/console

Kami mula -mula memuat arahan kami menggunakan kelas aplikasi. Kemudian, kami memberi instantiasi commandtester baru. Menggunakan CommandTester, kita boleh mengkonfigurasi bagaimana kita mahu memanggil arahan kita. Langkah terakhir adalah menggunakan kaedah getDisplay () untuk membandingkan hasil pelaksanaan dengan hasil yang kami harapkan.

Kaedah

getDisplay () menjimatkan hasil pelaksanaan perintah kami, seperti yang kita lihat pada baris arahan.

Kesimpulan

Kami hanya mencipta dua arahan yang berbeza menggunakan komponen Konsol Symfony. Kami juga melihat cara yang baik untuk menguji arahan ini. Saya cadangkan anda melihat pelbagai pilihan dan ciri -ciri komponen dan memberi kami maklum balas mengenai eksperimen anda di bahagian komen di bawah.

Adakah anda ingin melihat tutorial yang lebih maju di Konsol Symfony di Sitepoint? Tolong beritahu kami!

Semua kod yang kami tulis dalam artikel ini boleh didapati di GitHub.

Soalan Lazim Konsol Symfony

Bagaimana untuk memasang Konsol Symfony?

Konsol Symfony adalah komponen rangka kerja Symfony yang boleh dipasang menggunakan komposer (alat pengurusan ketergantungan dalam PHP). Untuk memasang Konsol Symfony, anda perlu menjalankan perintah berikut di terminal:

. Perintah ini akan memuat turun dan memasang komponen Konsol Symfony ke dalam projek anda. composer require symfony/console

Apakah fungsi utama Konsol Symfony?

Konsol Symfony menyediakan API mudah untuk membuat arahan baris arahan. Perintah ini boleh digunakan untuk pekerjaan kron, migrasi, import, atau mana -mana jenis tugas lain yang boleh dijalankan melalui baris arahan. Ia juga menyokong paparan warna, bar kemajuan, jadual dan ciri -ciri interaktif lain dari output.

Bagaimana untuk membuat arahan baru dalam Konsol Symfony?

Untuk membuat arahan baru, anda perlu membuat kelas baru yang memanjangkan kelas SymfonyComponentConsoleCommand. Dalam kelas ini, anda menentukan nama, penerangan, parameter, dan pilihan arahan dalam kaedah konfigurasi. Kaedah pelaksanaan mengandungi logik arahan.

Bagaimana untuk menjalankan arahan dalam Konsol Symfony?

Untuk menjalankan arahan, anda perlu menggunakan skrip

diikuti dengan nama perintah. Sebagai contoh, jika anda mempunyai arahan yang dipanggil bin/console, anda boleh menjalankannya dengan arahan berikut: app:my-command. bin/console app:my-command

Bagaimana menggunakan Konsol Symfony untuk Migrasi Pangkalan Data?

Konsol Symfony boleh digunakan bersempena dengan doktrin (lapisan abstraksi pangkalan data dalam Symfony) untuk menguruskan migrasi pangkalan data. Anda boleh membuat arahan baru yang melaksanakan pertanyaan SQL yang diperlukan untuk memindahkan pangkalan data anda.

Bagaimana untuk mengendalikan parameter dan pilihan arahan dalam Konsol Symfony?

Parameter perintah dan pilihan boleh ditakrifkan dalam kaedah konfigurasi kelas arahan. Anda boleh menggunakan kaedah GetArgument dan GetOption untuk mengambil nilai parameter dan pilihan ini dalam kaedah Execute.

Bagaimana untuk memaparkan output dalam Konsol Symfony?

Konsol Symfony menyediakan beberapa cara untuk memaparkan output. Anda boleh menggunakan kaedah WriteEln untuk memaparkan garis teks, gunakan kaedah tulis untuk memaparkan teks (tiada garis pecah pada akhir), dan gunakan kaedah jadual untuk memaparkan jadual.

Bagaimana menangani kesilapan dalam Konsol Symfony?

ralat boleh dikendalikan dengan membuang pengecualian. Konsol Symfony akan menangkap pengecualian ini dan memaparkan mesej ralat. Anda juga boleh menggunakan kaedah keluar untuk menghentikan pelaksanaan arahan dan mengembalikan kod keluar.

Bagaimana untuk menguji arahan dalam Konsol Symfony?

Konsol Symfony menyediakan kelas CommandTester yang boleh digunakan untuk menguji arahan. Anda boleh menggunakan kelas ini untuk melaksanakan arahan dengan parameter dan pilihan tertentu dan menegaskan kod output dan keluar.

Bagaimana menggunakan Konsol Symfony dalam Projek Symfony?

Dalam projek Symfony, anda boleh menggunakan skrip bin/console untuk menjalankan arahan. Anda juga boleh membuat arahan anda sendiri dengan membuat kelas baru yang memperluaskan kelas SymfonyComponentConsoleCommand dalam direktori src/Command.

Atas ialah kandungan terperinci Konsol Symfony yang memperkenalkan semula - CLI PHP untuk yang tidak dikenali!. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!