Hướng dẫn php coding standards psr-4
PSR có nghĩa là PHP Standards Recommendations, nó là tiêu chuẩn được khuyến nghị áp dụng khi lập trình PHP và được các lập trình viên, tổ chức chấp nhận sử dụng. Show
PSR được soạn thảo, đánh giá và khuyến khích sử dụng bởi một nhóm chuyên gia PHP những người phát triển cho các Framework và hệ thống PHP phổ biến (thành viên PSR). PSR bao gồm 7 phần (http://www.php-fig.org/psr/) từ PSR-1, PSR-2, PSR-3, PSR-4, PSR-6, PSR-7. Các tiêu chuẩn thành phần hoàn chỉnh của PSR đó gồm:
1. PSR-1 Basic Coding Standard (Tiêu chuẩn cơ bản khi viết code PHP)PRS-1 là các nguyên tắc mỗi lập trình viên PHP nên theo để đảm bảo code dễ đọc, bảo trì, và dễ sử dụng lại cũng như chia sẻ cho đồng đội. 1. Nguyên tắc chung nhất khi code PHP
Ví dụ 1) File PHP viết không theo chuẩn, trộn lẫn lung tung hiệu ứng phụ và khai báo các đối tượng ngôn ngữ PHP.
Đoạn mã PHP sau đúng chuẩn, đã khai báo thì không gồm hiệu ứng phụ 2. Các Namespace và tên ClassNamespace và
Lớp Có nghĩa là mỗi lớp được khai báo trên mỗi file PHP riêng và namespace tối thiểu có một cấp, cấp đầu là tên vendor. Tên lớp lại Ví dụ đúng chuẩn: 3. Hằng, Thuộc tính và Phương thức của lớpHằng theo chuẩn ở trên, tất cả Ví dụ hằng đúng chuẩn: 2. PSR-2 Coding Style Guide (Tiêu chuẩn trình bày code)PSR-2 sẽ tạo cho bạn thói quen viết code đúng chuẩn, dễ đọc, đẹp. Tổng quan về trình bày code PHP
Ví dụ:
Gọi phương thức và hàm Khi gọi một hàm hay phương thức của lớp,
IF, ELSE, SWITCH, CASE
WHILE
FOR
TRY,CATCH
Trình bày Closure
3. PSR-3 Logger Interface (Giao diện logger)PSR-3 Logger Interface: trình bày về các thành phần cần phải có của một Logger (ghi lại dấu vết của ứng dụng). 1. Các đặc điểm kỹ thuật
Ví dụ:
2. PackageCác Interface và Class được mô tả chi tiết trong gói psr/log. 3. Psr\Log\LoggerInterface
4. Psr\Log\LoggerAwareInterface
5. Psr\Log\LogLevel4. PSR-4 Autoloading Standard (Tiêu chuẩn về tự động nạp)PSR-4 Autoloading Standard: trình bày về cách chỉ định ứng dụng tự động nạp (giống include, require) các file php, lớp, hàm khi nó cần dùng đến. Các lớp có thể được load tự động khi dùng đến bằng cách sử dụng cơ chế autoload của PHP (http://php.net/autoload). Để thống nhất và sử dụng dễ dàng, phù hợp với nhiều mã Autoload khác nên viết các lớp theo quy tắc sau: * “lớp” ở đây ám chỉ cho: class, interface,traits * Tên xác định đầy đủ của một lớp có dạng:
* Khi một nạp một file thì nó phải tương ứng với một tên xác định đầy đủ của lớp.
Khi viết các lớp, theo quy tắc đó thì dễ dàng phát triển một bộ tự động nạp. Autoloader để khởi tạo ứng dụng. Tham khảo mẫu Autoloader tự động đăng ký các lớp tự động tải vào khi dùng đến, với điều kiện các lớp viết theo PSR-4. https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-4-autoloader-examples.md Các Framework PHP phổ biến hầu hết theo chuẩn PSR-4, nên chúng đều có bộ Autoloader tương tự. 5. PSR-6 Caching Interface (Giao diện về Caching)PSR-6 Caching Interface là tiêu chuẩn cần có của một bộ ứng dụng caching (lưu tạm dữ liệu và database, đĩa, RAM …) Tham khảo thông tin tại đây 6. PSR-7 HTTP Message Interface (Tiêu chuẩn Giao diện thông điệp HTTP)PSR-7 HTTP Message Interface là tiêu chuẩn về giao diện (thành phần cần có) của một ứng dụng sử dụng thông điệp HTTP (HTTP Message – request và respone), nó căn cứ vào các tiêu chuẩn RFC 7230, RFC 7231, RFC 3986. Thông điệp HTTP là nền tảng của ứng dụng web. Các Web Browser và các trình khách HTTP như cURL tạo ra một thông điệp HTTP ( Cấu tạo các HTTP MESSAGE Các HTTP message thường thì không được nhìn thấy, không cần phải hiểu bởi người dùng, nhưng với người phát triển web thì rất nên hiểu về cấu trúc để sử dụng chúng thi hành các tác vụ theo yêu cầu. Mọi HTTP Request Message đều có dạng:
Dòng đầu tiên yêu cầu, theo thứ tự chứa thông tin: phương thức yêu cầu (POST,GET …), đích yêu cầu (thường là URI hoặc đường dẫn trên web), và phiên bản của giao thức HTTP. Theo sau là các dòng HTTP header nếu nó, một dòng trống, cuối cùng là nội dung message. Mọi HTTP Response Message đều có dạng:
Dòng đầu là dòng trạng thái, theo thứ tự chứa phiên bản giao thức HTTP, mã trả về, và dòng mô tả mã. Tiếp theo là các dòng header nếu có, tiếp theo một dòng trống và cuối cùng là nội dung của HTTP Response Message. Thuật ngữ gợi ý của PSR bạn lưu ý đó là: PHẢI, KHÔNG PHẢI, KHUYẾN NGHỊ … đó là các từ để căn cứ để bạn quyết định áp dụng phần nào của kỹ thuật vào ứng dụng. Tiếp theo là các mô tả và namespace, interface class, các phương thức nên theo. Các đặc điểm kỹ thuật về HTTP MESSAGE1) Thông điệp (Message)Một thông điệp HTTP có thể là yêu cầu gửi đi từ client hoặc thông điệp đáp trả từ server cho client. Như vậy cần phải có các lớp định nghĩa giao diện cho các thông điệp yêu cầu (request) Psr\Http\Message\RequestInterface và giao diện thông điệp đáp trả (response) Psr\Http\Message\ResponseInterface. Cả hai loại thông điệp này đều kế thừa từ một giao diện chung có Psr\Http\Message\MessageInterface. Psr\Http\Message\MessageInterface 2) Về các HTTP HeaderKhông phân biệt chữ hoa – thường Các header được truy cập bởi tên của header đó trong bởi phương thức (withHeader) trong MessageInterface và phương thức này không phân biệt chữ hoa và chữ thường. Ví dụ:
Bởi vì tên của header khi các server trả về có chữ hoa, chữ thường nên bạn Header nhiều giá trị Thông lệ thì các header với nhiều giá trị vẫn được dùng, header có thể nhận được từ MessageInterface như là một mảng hoặc chuỗi. Sử dụng
phương thức getHeaderLine() để nhận chuỗi có chứa giá trị phân cách bởi dấu Ví dụ:
Host trong Header Khi khởi tạo thông điệp Request 3) Streams – Các luồngHTTP message chứa dòng bắt đầu, các header và body(nội dung). Phần body của thông điệp có thể rất nhở hoặc rất lớn. Nếu cố tình nhét tất cả dữ liệu vào body với kiểu chuỗi thì có vẻ dễ nhưng nhiều trường hợp ảnh hưởng nghiêm trọng đến bộ nhớ lưu giữ body. Khi dữ liệu lớn bạn sẽ sử dụng StreamInterface để diễn tả dữ liệu được đọc/ghi của body. Nhưng trường hợp này chuỗi dữ liệu body của thông điệp được sử dụng từ php://memory hoặc php://temp. (php://memory và php://temp là luồng chuẩn PHP xem tại php://) Các Stream có thể dùng ba phương thức: isReadable(), isWritable(), isSeekable() để kiểm tra giới hạn của Stream (đọc, ghi, tìm). Cuối cùng StreamInterface định nghĩa phương thức __toString() để nhận hoặc chuyển dữ liệu. 4) Request Targets và URIsRequest target(mục tiêu – đích của HTTP mgs) có thể ở dạng sau:
URL được định nghĩa bởi UriInterface, nó cung cấp __toString() để lấy URI. Nhận request target bằng phương thức getRequestTarget(). Ví dụ:
5) Server-side Request – các request tại serverPHP cung cấp các biến toàn cục:
ServerRequestInterface mở rộng từ RequestInterface cung cấp lớp trừu tượng bao học hết các biến toàn cục trên, nó thêm một property là “attributes” dùng truy cập các thông tin. 6 Uploaded files – các file uploadServerRequestInterface có phương thức getUploadedFiles() để nhận một cây mô tả file upload, mà mỗi lá của cây là một UploadedFileInterface. Có các phương thưc để làm việc với file, moveTo($targetPath) , _uploaded_file() Chuẩn giao diện thông điệp HTTP bắt đầu được cung cấp bởi hầu hết các Framework PHP phổ biến. Trong tiêu chuẩn này gợi ý xây dựng các Interface, Method, Atribute để trừu tượng hóa HTTP Message. Gợi ý này được đóng gói và được nhiều Framework làm theo, bạn lấy Package này tại https://github.com/php-fig/http-message Các Framework xây dựng sẵn cho bạn theo PSR-7 Symfony : http://symfony.com/blog/psr-7-support-in-symfony-is-here Zend Framework : https://zendframework.github.io/zend-expressive/ Laravel : https://laravel.com/docs/5.1/requests 7. Các tiêu chuẩn khácPHPDoc Standard (PSR-5), Huggable Interface(PSR-8), Security Disclosure(PSR-9), Security Advisories(PSR-10),Container Interface(PSR-11),Extended Coding Style Guide(PSR-12),Hypermedia Links(PSR-13). Bạn có thể tham khảo tại http://www.php-fig.org/psr/ |