Aplikasi dan promosi spesifikasi PSR2 dan PSR4 dalam kerangka mikro Lumen

Aplikasi dan promosi spesifikasi PSR2 dan PSR4 dalam kerangka mikro Lumen

Pengenalan:
Dengan aplikasi dan pembangunan bahasa PHP yang meluas, spesifikasi kod telah menjadi aspek penting untuk mengekalkan kualiti dan kebolehbacaan kod. PHP FIG (PHP FIG, PHP Framework Interop Group) telah mencipta satu siri spesifikasi amalan terbaik (PSR, Pengesyoran Piawaian PHP) untuk pembangunan PHP, yang mana PSR2 dan PSR4 adalah dua daripada spesifikasi yang lebih penting. Artikel ini akan menumpukan pada cara menggunakan dan mempromosikan spesifikasi PSR2 dan PSR4 dalam rangka kerja mikro Lumen dan menyediakan contoh kod khusus.

1. Aplikasi dan promosi spesifikasi PSR2 dalam Lumen:

1. Gaya kod:
   Spesifikasi PSR2 mempunyai keperluan terperinci untuk gaya kod, termasuk lekukan, pemisah baris, penamaan, dsb. Dalam projek Lumen, kami boleh menggunakan dan mempromosikan spesifikasi PSR2 melalui aspek berikut:

(1) Lekukan dan pemisah baris: Gunakan empat ruang untuk lekukan secara seragam, dan panjang setiap baris tidak boleh melebihi 80 aksara.

Contoh kod khusus:

<?php

namespace AppHttpControllers;

use IlluminateHttpRequest;

class UserController extends Controller
{
    public function index(Request $request)
    {
        // your code here
    }
}

(2) Konvensyen penamaan: Gunakan penamaan huruf unta untuk nama kelas, dan gunakan huruf kecil dan garis bawah untuk nama fungsi dan nama berubah. Gunakan {} kurungan antara kelas dan ruang nama.

Contoh kod khusus:

<?php

namespace AppServices;

use AppRepositoriesUserRepository;

class UserService
{
    protected $userRepository;

    public function __construct(UserRepository $userRepository)
    {
        $this->userRepository = $userRepository;
    }

    public function getUserById($id)
    {
        // your code here
    }
}

2. Komen:
   Spesifikasi PSR2 menetapkan format dan kandungan ulasan. Dalam projek Lumen, kita harus membangunkan tabiat ulasan yang baik dan menggunakan format ulasan piawai.

(1) Komen fail: Setiap fail hendaklah mengandungi ulasan fail, yang menunjukkan pengarang fail, tarikh penciptaan, rekod pengubahsuaian, dsb.

Contoh kod khusus:

<?php

/**
 * UserController.php
 *
 * This file is part of the Lumen project.
 *
 * @author John Doe <john.doe@example.com>
 * @created 2022-09-01
 * @updated 2022-09-10
 */

namespace AppHttpControllers;

// ...

(2) Komen fungsi: Setiap fungsi hendaklah termasuk ulasan fungsi, menunjukkan parameter fungsi, nilai pulangan, perihalan fungsi, dsb.

Contoh kod khusus:

/**
 * Get user by ID.
 *
 * @param int $id User ID
 * @return array
 */
public function getUserById($id)
{
    // your code here
}

2. Aplikasi dan promosi spesifikasi PSR4 dalam Lumen:

1. Struktur direktori:
   Spesifikasi PSR4 mengemukakan keperluan terperinci untuk pemuatan automatik. Dalam projek Lumen, kami boleh menyusun struktur direktori kod mengikut spesifikasi PSR4 untuk meningkatkan kebolehselenggaraan dan kebolehskalaan kod.

Contoh kod khusus:

│   app/
│   ├── Http/
│   │   ├── Controllers/
│   │   └── Middleware/
│   ├── Models/
│   ├── Repositories/
│   └── Services/

2. Pemuatan automatik ruang nama dan kelas:
   Mengikut keperluan spesifikasi PSR4, kami perlu mengkonfigurasi hubungan pemetaan antara ruang nama dan kelas dalam fail komposer use.json, dan memuatkan kelas Muatkan secara automatik.

Contoh kod khusus (composer.json):

{
    "autoload": {
        "psr-4": {
            "App\": "app/"
        }
    }
}

Jalankan arahan berikut dalam terminal untuk mengemas kini pemuatan automatik kelas:

composer dump-autoload

Selepas menggunakan konfigurasi di atas, kita boleh menggunakan ruang nama lengkap untuk merujuk kelas tanpa memperkenalkan dokumen itu secara manual.

Contoh kod khusus:

<?php

namespace AppHttpControllers;

use AppServicesUserService;
use IlluminateHttpRequest;

class UserController extends Controller
{
    protected $userService;

    public function __construct(UserService $userService)
    {
        $this->userService = $userService;
    }

    public function index(Request $request)
    {
        // your code here
    }
}

Kesimpulan:
Dalam rangka kerja mikro Lumen, mengaplikasi dan mempromosikan spesifikasi PSR2 dan PSR4 boleh meningkatkan kualiti kod, kebolehbacaan dan kebolehselenggaraan projek. Dengan menggunakan gaya pengekodan piawai dan spesifikasi anotasi, pembangun boleh memahami dan mengekalkan kod dengan lebih mudah. Pada masa yang sama, dengan mengatur struktur direktori kod dan pemuatan automatik kelas konfigurasi mengikut spesifikasi PSR4, kebolehskalaan dan kebolehgunaan semula kod boleh dipertingkatkan. Dalam projek sebenar, kita harus membangunkan tabiat pengekodan yang baik dan memilih spesifikasi yang sesuai untuk digunakan dan dipromosikan berdasarkan situasi sebenar.

Atas ialah kandungan terperinci Aplikasi dan promosi spesifikasi PSR2 dan PSR4 dalam kerangka mikro Lumen. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!