Trong bài viết đầu tiên của loạt bài này, chúng tôi đã định nghĩa code xấu là gì và xem xét một số ví dụ về chúng và cách chúng ta có thể tái tạo cấu trúc của chúng để chất lượng code được cải thiện. Nhắc lại
Mã xấu, trong mã thiết lập máy tính, chỉ đến bất kỳ biểu hiện nào trong mã nguồn của chương trình mà chỉ có thể đưa ra một vấn đề lớn hơn
Cuối cùng, chúng ta đang hướng tới việc áp dụng các quy tắc đánh hơi mã, cụ thể là cho WordPress, nhưng trước khi chúng ta làm điều đó, điều quan trọng là làm quen với PHP CodeSniffer
Trong bài viết này, chúng ta sẽ xem xét PHP CodeSniffer là gì, cách cài đặt nó, chạy nó như thế nào trên một tập lệnh ví dụ, và làm thế nào để tái tạo cấu trúc cho tập lệnh đó. Sau đó, chúng ta sẽ xem xét cách chúng ta sẽ chuyển đến mã cụ thể cho WordPress
Nếu bạn đã thiết lập một bộ phát triển môi trường cục bộ, thì tuyệt vời; . Tôi sẽ cung cấp một số liên kết sẽ giúp bạn thiết lập nhanh chóng
Bây giờ chúng ta hãy bắt đầu
Yêu cầu Tiên quyết
Trước khi bắt đầu, điều quan trọng là bạn có một số kiểu môi trường phát triển cục bộ, ngay cả khi điều này chỉ bao gồm một bản sao của trình thông dịch PHP
You could have been
Lưu ý rằng, nếu bạn đang chạy một biến thể của Linux hoặc OS X, thì nhiều khả năng bạn đã cài đặt PHP. Nếu như vậy, thì bạn không cần phải lắng nghe về bất cứ điều gì khác trong phần này. Để xác định xem bạn đã cài đặt PHP hay chưa, hãy chạy lệnh sau trong terminal
$ php -v
Bạn sẽ thấy một vài thứ như sau [mặc dù đầu ra của bạn có thể khác nhau tùy theo phiên bản PHP mà bạn chạy]
PHP 5.6.10 [cli] [built: Jul 6 2015 14:28:54] Copyright [c] 1997-2015 The PHP Group Zend Engine v2.6.0, Copyright [c] 1998-2015 Zend Technologies
Nếu bạn giỏi hơn và có nhiều phiên bản được cài đặt, thì bạn có thể chạy
$ which php
And you will see a number as after
/Applications/MAMP/bin/php/php5.6.10/bin/php
Tuy nhiên, đầu ra của bạn sẽ khác với nơi bạn đã cài đặt phiên bản của PHP
Nhưng nếu bạn chưa cài đặt, ổn thôi
Mặc dù loạt bài này chủ yếu hướng đến những người mới bắt đầu, nhưng có thể có một số bạn đã quen với công việc tải về một phiên bản của PHP và cài đặt nó trên hệ thống của mình. Nếu đó là bạn, thì hãy tải xuống một phiên bản của PHP từ trang chủ của dự án, cài đặt nó và quay lại hướng dẫn này
Mặt khác, nếu điều này là mới đối với bạn thì bạn có thể chọn sử dụng một trong những trình cài đặt cho hệ điều hành của bạn trên trang chủ PHP được liên kết ở trên hoặc một trong các tiện ích được cung cấp bên dưới
- WAMP cho Windows
- XAMPP cho Linux, Windows hoặc OS X
- MAMP cho Windows và OS X
Tất cả các gói này đều có trình cài đặt riêng và sẽ cài đặt PHP, MySQL và Apache. Như đã đề cập trước đây, chúng tôi chủ yếu quan tâm đến việc cài đặt một phiên bản PHP trên hệ thống của chúng tôi
Khi đã cài đặt xong, hãy thử chạy các lệnh đã được cập nhật trong phần đầu của hướng dẫn này [hoặc tương ứng với hệ thống của bạn] và bạn sẽ thấy kết quả tương tự
Nếu không, thì có thể bạn phải thêm đường dẫn đến PHP vào biến môi trường của bạn. Việc này nằm ngoài phạm vi của hướng dẫn này, vì vậy xin vui lòng tham khảo tài liệu hướng dẫn tài liệu cho phiên bản của PHP mà bạn đã cài đặt
Sau khi đã cài đặt PHP, chúng ta sẵn sàng bắt đầu tìm ra và làm sạch mã xấu của chúng ta
PHP CodeSniffer là gì?
Bạn có thể tìm thấy phần mềm PHP CodeSniffer main server trên GitHub
From document direction of project
PHP_CodeSniffer là một bộ bao gồm hai tập lệnh PHP; . PHP_CodeSniffer là một công cụ phát triển thiết yếu để đảm bảo mã của bạn sẽ sạch và quán nhất
Nếu bạn chưa bao giờ thấy bất cứ thứ gì như thế này trước đây, thì nó có vẻ thật sự gọn gàng, phải không?
Mặc dù dự án này đề cập đến các ngôn ngữ như CSS và JavaScript, nhưng chúng tôi chỉ tập trung vào PHP trong loạt bài này. Điều này không có nghĩa là không cần kiểm tra chất lượng của các tập tin ngôn ngữ mà cụ thể là trong các dự án của bạn
Mặc dù nghe có vẻ tuyệt vời, nhưng nó vẫn làm nảy sinh những câu hỏi. Làm thế nào để chúng ta cài đặt phần mềm, và làm thế nào để chúng ta bắt đầu kiểm tra mã của chúng ta?
Hãy trả lời ngay cả hai câu hỏi đó
1. Cài đặt phần mềm
Nếu bạn thực hiện tìm kiếm Google cho từ khóa cách cài đặt PHP CodeSniffer, thì có thể bạn sẽ nhận được nhiều kết quả khác nhau, nhiều trong số đó sẽ bao gồm việc sử dụng một thứ gọi là Pear
Pear đã từng là gói hệ thống phân phối không chính thức cho các thư viện PHP, và tuy nhiên nhiều gói vẫn có sẵn thông tin qua phần mềm này, nó cũng đã được rút lui khỏi các gói biến phổ biến khác [không hạn chế như
Vì lý do này, tôi khuyên bạn nên sử dụng các phương pháp cài đặt khác khi có. Điều này bao gồm việc sử dụng các công cụ như Composer, được xem là phần mềm quản lý phụ thuộc phổ biến nhất cho PHP
Nếu bạn chưa biết giờ sử dụng Composer trước đây, đừng lo lắng. Tôi sẽ cung cấp tất cả các bước mà bạn cần để thiết lập PHP CodeSniffer trên máy tính của bạn với Composer và với ít công việc nhất. Nếu bạn thích thú muốn tìm hiểu thêm, chúng tôi có khá nhiều hướng dẫn về cách sử dụng Composer, vì vậy hãy kiểm tra xem chúng ra sao nhé
Cài đặt Composer
Trước khi cài đặt PHP CodeSniffer, chúng ta cần cài đặt Composer. May mắn thay, nó rất dễ dàng để cài đặt một khi bạn đã có PHP chạy trên máy tính cục bộ của bạn
Để cài đặt Trình soạn thảo, bạn có thể tải xuống tệp này và chạy lệnh sau trên thiết bị đầu cuối từ bất kỳ vị trí nào mà bạn đã tải xuống trình cài đặt Trình soạn thảo
$ php composer-setup.php --install-dir=bin --filename=composer
Một lưu ý từ các bước cài đặt Composer
Bạn có thể cài đặt Composer vào một thư mục cụ thể bằng cách sử dụng tùy chọnPHP 5.6.10 [cli] [built: Jul 6 2015 14:28:54] Copyright [c] 1997-2015 The PHP Group Zend Engine v2.6.0, Copyright [c] 1998-2015 Zend Technologies3 và ngoài việc đặt tên [hay đổi tên] cho nó bằng cách sử dụng tùy chọnPHP 5.6.10 [cli] [built: Jul 6 2015 14:28:54] Copyright [c] 1997-2015 The PHP Group Zend Engine v2.6.0, Copyright [c] 1998-2015 Zend Technologies4
Để biết thêm thông tin, vui lòng tham khảo hướng dẫn tải xuống hoặc xem toàn bộ dự án trên GitHub
Một khi đã cài đặt xong, giờ đây bạn có thể sử dụng Composer để cài đặt các phần phụ thuộc của bên thứ ba, chẳng hạn như PHP CodeSniffer vào dự án của bạn. Tuy nhiên, hãy lưu lại vị trí bạn đã cài đặt Composer. Bạn cần phải tham chiếu đến nó khi chạy nó vì chúng ta sẽ chạy nó từ dòng lệnh
Dù thế nào đi nữa, chúng ta hãy tiếp tục và tạo một thư mục trong đó chúng ta sẽ chạy các tập lệnh PHP của chúng ta. Tuy nhiên, chúng ta không có bất cứ điều gì trong thư mục này cả, chúng ta cần phải tạo một tập tin có tên là
PHP 5.6.10 [cli] [built: Jul 6 2015 14:28:54] Copyright [c] 1997-2015 The PHP Group Zend Engine v2.6.0, Copyright [c] 1998-2015 Zend Technologies5
Tôi sẽ đặt tên thư mục của tôi là
PHP 5.6.10 [cli] [built: Jul 6 2015 14:28:54] Copyright [c] 1997-2015 The PHP Group Zend Engine v2.6.0, Copyright [c] 1998-2015 Zend Technologies6 và tôi sẽ thêm Trình soạn thảo tệp vào thư mục đó để bắt đầu
Một khi bạn đã tạo tệp đó, hãy dán mã sau đây vào tệp JSON
PHP 5.6.10 [cli] [built: Jul 6 2015 14:28:54] Copyright [c] 1997-2015 The PHP Group Zend Engine v2.6.0, Copyright [c] 1998-2015 Zend Technologies1
Nói lại, điều này bảo đảm với Composer cài đặt PHP CodeSniffer khi bạn chạy lệnh thích hợp. Lưu ý rằng chỉ thị
PHP 5.6.10 [cli] [built: Jul 6 2015 14:28:54] Copyright [c] 1997-2015 The PHP Group Zend Engine v2.6.0, Copyright [c] 1998-2015 Zend Technologies7 thực hiện các công việc sau
Liệt kê các gói được yêu cầu theo gói này. Các gói này sẽ không được cài đặt trừ khi các yêu cầu này có thể được trả lời
Bạn có thể đọc thêm về Lược sử Nhà soạn nhạc trong tài liệu hướng dẫn
Một khi Composer đã được cài đặt và một khi bạn đã có tệp
PHP 5.6.10 [cli] [built: Jul 6 2015 14:28:54] Copyright [c] 1997-2015 The PHP Group Zend Engine v2.6.0, Copyright [c] 1998-2015 Zend Technologies5 tương tự như mã ở trên, thì đây là lúc để cài đặt PHP CodeSniffer. From terminal, run command after
PHP 5.6.10 [cli] [built: Jul 6 2015 14:28:54] Copyright [c] 1997-2015 The PHP Group Zend Engine v2.6.0, Copyright [c] 1998-2015 Zend Technologies4
Hãy lưu ý, điều này giả sử rằng Nhà soạn nhạc có hiệu lực trên toàn bộ hệ thống của bạn. Nếu không, bạn có thể thực hiện nó bằng cách nhập đầy đủ đường dẫn đến tệp đã cài đặt hoặc bạn có thể thêm nó vào các biến môi trường của bạn và sau đó khởi động lại phiên bản thiết bị đầu cuối để tải lại các biến
Khi Composer hoàn tất công việc, bạn sẽ thấy một số thứ như sau
Và thư mục
PHP 5.6.10 [cli] [built: Jul 6 2015 14:28:54] Copyright [c] 1997-2015 The PHP Group Zend Engine v2.6.0, Copyright [c] 1998-2015 Zend Technologies9 của bạn bây giờ sẽ giống như thế này
Đặc biệt lưu ý rằng bạn có một nhà cung cấp thư mục. Điều này có nghĩa là Composer đã cài đặt PHP CodeSniffer đúng cách. Tại thời điểm này, chúng tôi đã sẵn sàng để đánh giá mã PHP của chúng tôi
2. Kiểm tra Script
Trước tiên, hãy lấy một tập lệnh mẫu. Cái mà chúng ta sẽ xem xét có thể được tìm thấy trong câu trả lời này trên Stack Overflow
Hãy tạo một tập tin trong thư mục
PHP 5.6.10 [cli] [built: Jul 6 2015 14:28:54] Copyright [c] 1997-2015 The PHP Group Zend Engine v2.6.0, Copyright [c] 1998-2015 Zend Technologies6 và đặt tên cho nó là
$ which php1. Sau đó, hãy đảm bảo rằng tập tin đó chứa các nội dung sau
PHP 5.6.10 [cli] [built: Jul 6 2015 14:28:54] Copyright [c] 1997-2015 The PHP Group Zend Engine v2.6.0, Copyright [c] 1998-2015 Zend Technologies8
Save back what you do. Tiếp theo, chúng ta có thể chạy PHP CodeSniffer từ dòng lệnh và sử dụng nó để đánh giá mã trong tập lệnh ở trên bằng bộ quy tắc tiêu chuẩn
From your terminal, enter command after
PHP 5.6.10 [cli] [built: Jul 6 2015 14:28:54] Copyright [c] 1997-2015 The PHP Group Zend Engine v2.6.0, Copyright [c] 1998-2015 Zend Technologies9
Lệnh này sẽ xuất ra bao gồm những thứ sau đây
$ which php0
Lưu ý rằng, nó đã tìm thấy bốn lỗi. Cột thứ nhất cho bạn biết dòng nào là lỗi, cột thứ hai nói rằng đó là lỗi [hoặc cảnh báo], và sau đó phần còn lại cho bạn biết những gì mà nó kỳ vọng được nhìn thấy so với những gì nó đã có
Vì vậy, hãy làm sạch tập tin dựa trên các lỗi đó. Nói chung, chúng ta cần làm những công việc sau
- Add file chú thích cấp độ
- Thêm dấu cách sau dấu phẩy trong lệnh gọi tới một hàm trên dòng tệp
- Thêm dấu cách sau câu lệnh
$ which php
2 trong tập lệnh
Kết quả cuối cùng sẽ tương tự như sau
PHP 5.6.10 [cli] [built: Jul 6 2015 14:28:54] Copyright [c] 1997-2015 The PHP Group Zend Engine v2.6.0, Copyright [c] 1998-2015 Zend Technologies0
Tiếp theo, hãy chạy tập lệnh một lần nữa và bạn sẽ không còn nhận được bất kỳ đầu ra nào. Nghĩa là, bạn sẽ thấy tiêu chuẩn nhắc lệnh. Đôi khi điều này có nghĩa là một cái gì đó bị sai, nhưng trong trường hợp này, nó có nghĩa là mọi thứ đang chạy như mong đợi
Không tệ, đúng không?
Bây giờ hãy tưởng tượng những gì mà công cụ này có thể làm cho lượng mã và kịch bản lớn hơn mà bạn đang làm hàng ngày
It is not all
Mặc dù đánh giá mã của chúng tôi là điều quan trọng, để tránh mã xấu và nâng cao chất lượng mã lên cao nhất có thể, nhưng các công cụ như PHP CodeSniffer không có nghĩa là tất cả. Điều đó có nghĩa là chúng ta không nên viết mã xấu chỉ vì có một công cụ khác sẽ bắt lấy nó
Bởi vì không phải lúc nào nó cũng làm như vậy
Thay vào đó, điều này có nghĩa là một công cụ trợ giúp. Nghĩa là, để lấy những thứ mà chúng ta có thể bỏ lỡ khi viết mã lần đầu tiên, lần thứ hai hoặc lần thứ chín. Điều tuyệt vời về chương trình đặc biệt này là bạn có thể tải các quy tắc khác nhau vào PHP CodeSniffer tùy thuộc vào môi trường, khung hoặc thư viện mà bạn đang làm việc
Và đó chính xác là những gì chúng ta sẽ làm với WordPress trong bài tiếp theo
tóm tắt
Từ đầu phần giới thiệu cho đến thời điểm này, chúng ta đã đề cập đến khá nhiều kiến thức trong hướng dẫn này. Đó là, chúng tôi đã xem xét việc thiết lập một môi trường phát triển cơ bản trên bộ máy tính cục bộ của chúng tôi để cài đặt PHP
Tiếp theo, chúng ta đã tìm hiểu về Composer và cách cài đặt nó trên hệ thống của mình. Chúng tôi đã viết Composer tập tin đầu tiên để cài đặt các công cụ phụ thuộc, cụ thể là PHP CodeSniffer, và ngay cả khi chúng tôi đã đánh giá và chỉnh sửa các kết quả được cung cấp bởi phần mềm
Nếu bạn là một nhà phát triển chủ yếu bằng PHP, thì tôi hy vọng hai bài viết đầu tiên trong loạt bài viết này thực sự hữu ích, nhưng nếu bạn là nhà phát triển WordPress thì chúng tôi còn có thêm một số điều để tìm kiếm
Trong bài viết cuối cùng trong loạt bài này, chúng tôi sẽ chuyển sự chú ý của chúng tôi sang WordPress. Bởi vì nó có các tiêu chuẩn viết mã riêng nên chúng ta sẽ xem xét cách tải các quy tắc này vào PHP CodeSniffer và sau đó đánh giá plugin, chủ đề, vân vân. để có được một ý tưởng về cách sử dụng phần mềm này trong công việc hàng ngày trong các dự án WordPress của chúng tôi
Trước khi chúng tôi chuyển đến bài viết tiếp theo, hãy xem lại mã ở trên và đảm bảo rằng bạn đã cài đặt PHP và PHP CodeSniffer và bạn đã nắm rõ cách hoạt động của nó, vì chúng tôi sẽ gắn kết tất cả những điều này
Cuối cùng, bạn có thể xem lại tất cả các từ khóa học và hướng dẫn của tôi trên trang tiểu sử của tôi và bạn có thể theo dõi tôi trên blog của trang và/hoặc Twitter của tôi tại @tommcfarlin, nơi tôi nói về các phương tiện
Đừng sợ hãi để quay lại bất kỳ câu hỏi hoặc nhận xét nào trong phần bình luận dưới đây và tôi sẽ cố gắng trả lời từng câu hỏi