Tại sao Xdebug không thử làm lại

Bạn chỉ có thể gỡ lỗi mã PHP của mình bằng cách sử dụng các chức năng gỡ lỗi kết xuất, chẳng hạn như error_log, print và

[xdebug]
zend_extension="/path/to/xdebug/extension/xdebug.so"
xdebug.remote_enable=1
xdebug.remote_host=127.0.0.1
xdebug.remote_port="9000"

Nhập Xdebug, công cụ lược tả và gỡ lỗi từng bước khá tuyệt vời dành cho PHP

Trong bài đăng này, tôi sẽ đưa bạn qua hành trình Xdebug của tôi và chỉ cho bạn cách sử dụng nó để giúp cuộc sống của bạn dễ dàng hơn. Bạn có thể cảm ơn tôi sau (trong phần bình luận) 🙂

Nếu bạn là kiểu người thích tìm hiểu mọi thứ một cách trực quan, thì Jonathan, nhà giáo dục nhà phát triển của chúng tôi, đã tạo một video ngắn hướng dẫn chi tiết cách sử dụng Xdebug với PHPStorm

Xdebug đã thay đổi cuộc đời tôi như thế nào

Một vài năm trước, tôi không biết có trình gỡ lỗi tồn tại, chưa bao giờ nghe nói về Xdebug và rất hài lòng khi sử dụng một chức năng mà tôi đã ghép lại với nhau từ Stack Overflow trong tất cả các trang web WordPress của mình để gỡ lỗi

if ( ! function_exists( '_log' ) ) {
    function _log( $message ) {
        if ( WP_DEBUG === true ) {
            if ( is_array( $message ) || is_object( $message ) ) {
                error_log( print_r( $message, true ) );
            } else {
                error_log( $message );
            }
        }
    }
}

Đó là tất cả những gì tôi nghĩ mình cần cho đến khi ai đó giới thiệu tôi với Xdebug và cuộc đời tôi đã thay đổi. Xin lỗi cường điệu, nhưng nó đã xảy ra

Khi bạn kết xuất gỡ lỗi bằng các hàm như error_log hoặc

[xdebug]
zend_extension="/path/to/xdebug/extension/xdebug.so"
xdebug.remote_enable=1
xdebug.remote_host=127.0.0.1
xdebug.remote_port="9000"

Xdebug cho phép bạn ngắt trong quá trình thực thi mã và kiểm tra tất cả các biến trong phạm vi trong một yêu cầu. Điều này có nghĩa là bạn có mọi thứ cần thiết để khắc phục sự cố chỉ trong một lần lặp lại chu trình này. Bạn tiết kiệm được rất nhiều thời gian khi theo dõi các vấn đề và quy trình phát triển của bạn hiệu quả hơn

Khắc phục sự cố ++ với Xdebug

Xdebug thực sự tỏa sáng khi cố gắng khắc phục sự cố mà bạn hoàn toàn không biết nguyên nhân. Nếu bạn biết chức năng của mình bị hỏng, các dòng nhật ký bên trong nó rất tuyệt và hoạt động tốt. Nhưng hành vi lạ gây ra sự cố có thể đến từ bất kỳ đâu trong dự án, chẳng hạn như plugin hoặc chính lõi WordPress. Làm thế quái nào để bạn theo dõi nó xuống?

Bằng cách sử dụng các điểm ngắt, bạn có thể tạm dừng thực thi mã tại bất kỳ thời điểm nào, điều đó có nghĩa là điều tốt nhất nên làm là ngắt sớm và theo dõi quá trình thực thi mã với Xdebug (thêm về điều đó sau) cho đến khi bạn phát hiện ra điều gì đó không ổn. Để tiết kiệm thời gian, bạn có thể dần dần di chuyển các điểm dừng xa hơn trong quá trình thực thi cho đến khi bạn tiến gần hơn đến vấn đề tiềm ẩn, thay vì vi phạm mã đã được phân tích là không phải nguyên nhân của vấn đề. Khi tìm thấy sự cố, bạn có thể nhanh chóng thay đổi giá trị của các biến sau khi chúng được chỉ định, vì vậy bạn có thể kiểm tra các bản sửa lỗi tiềm năng trong khi gỡ lỗi, tất cả trong cùng một yêu cầu

Phát triển theo hướng gỡ lỗi

Một công dụng tuyệt vời khác của Xdebug là sử dụng nó một cách chủ động trong quá trình phát triển thay vì phản ứng với các sự cố mã hiện có. Hãy nghĩ về điều này giống như Phát triển dựa trên thử nghiệm (TDD) nhưng trước tiên hãy sử dụng trình gỡ lỗi thay vì viết thử nghiệm. Tôi thậm chí không chắc liệu Debug Driven Development (DDD) có phải là một thuật ngữ được sử dụng rộng rãi hay không, nhưng đối với tôi, tôi đã sử dụng Xdebug để giúp tôi viết mã mới theo một số cách

1. Kiểm tra các mảng, đối tượng và thể hiện của lớp hiện có để tìm dữ liệu có sẵn cho tôi trong mã, vì vậy tôi có thể sử dụng dữ liệu đó trong mã mới mà tôi viết
2. Ngay lập tức gỡ lỗi một đoạn mã mới viết để kiểm tra xem nó có hoạt động như mong đợi không

Đây không phải là điều tôi làm mọi lúc, nhưng Xdebug cung cấp cho tôi cái nhìn sâu sắc này khi tôi cần

Cài đặt Xdebug

Hy vọng rằng những lợi ích tôi đã trình bày chi tiết khiến bạn muốn sử dụng Xdebug và bạn đã sẵn sàng cho một số bước cài đặt. Tôi đã tập hợp một danh sách các môi trường cục bộ phổ biến nhất với một số liên kết hữu ích để cài đặt Xdebug trên chúng

• MAMP
• MAMP Pro
• XAMPP
• VVV
• trang trại
• người phục vụ
• Máy chủ để bàn
• địa phươngWP
• DevKinsta
• docker
• hộp quỷ

Matt Stauffer gần đây cũng đã biên soạn một danh sách các cấu hình phổ biến có sẵn, vì vậy nếu tôi bỏ lỡ nó, bạn nên tìm thứ gì đó cho môi trường cục bộ của mình ở đó

Bạn có làm việc với một môi trường địa phương khác và cần một số hướng dẫn không?

Phiên bản Xdebug 3

Vào tháng 11 năm 2020, Xdebug 3 được phát hành. Bên cạnh những cải tiến lớn về hiệu suất và hỗ trợ PHP 8, thay đổi quan trọng nhất là cách bạn bật chức năng Xdebug thông qua cài đặt

[xdebug]
zend_extension="/path/to/xdebug/extension/xdebug.so"
xdebug.remote_enable=1
xdebug.remote_host=127.0.0.1
xdebug.remote_port="9000"

[xdebug]
zend_extension="/path/to/xdebug/extension/xdebug.so"
xdebug.remote_enable=1
xdebug.remote_host=127.0.0.1
xdebug.remote_port="9000"

Hướng dẫn trực tuyến mà bạn đang theo dõi để cài đặt và định cấu hình Xdebug cho môi trường phát triển cục bộ của mình sẽ xác định cài đặt nào bạn cần định cấu hình. May mắn thay, có tài liệu trợ giúp Xdebug về nâng cấp từ phiên bản 2 lên phiên bản 3 để hướng dẫn bạn

Ví dụ nhanh, nếu bạn đã cài đặt phiên bản 2, bạn có thể được hướng dẫn định cấu hình cài đặt

[xdebug]
zend_extension="/path/to/xdebug/extension/xdebug.so"
xdebug.remote_enable=1
xdebug.remote_host=127.0.0.1
xdebug.remote_port="9000"

[xdebug]
zend_extension="/path/to/xdebug/extension/xdebug.so"
xdebug.remote_enable=1
xdebug.remote_host=127.0.0.1
xdebug.remote_port="9000"

Trong khi nếu bạn đã cài đặt phiên bản 3, bạn sẽ cần cấu hình nó như thế này

[xdebug]
zend_extension="/path/to/xdebug/extension/xdebug.so"
xdebug.mode=debug
xdebug.client_host=127.0.0.1
xdebug.client_port="9003"

Trong phiên bản 3, bạn cũng có thể kích hoạt các chế độ Xdebug khác nhau bằng cách chỉ định chúng trong danh sách được phân tách bằng dấu phẩy

Đối với bài viết này, tôi đang sử dụng Xdebug 3, với

[xdebug]
zend_extension="/path/to/xdebug/extension/xdebug.so"
xdebug.remote_enable=1
xdebug.remote_host=127.0.0.1
xdebug.remote_port="9000"

[xdebug]
zend_extension="/path/to/xdebug/extension/xdebug.so"
xdebug.remote_enable=1
xdebug.remote_host=127.0.0.1
xdebug.remote_port="9000"

Tích hợp PhpStorm

tin tức chớp nhoáng. Tôi yêu PhpStorm. Và đoán xem?

Nếu bạn không sử dụng PHPStorm, hầu hết các Môi trường Phát triển Tích hợp (IDE) khác như Visual Studio Code và các trình chỉnh sửa như Sublime Text đều có thể được định cấu hình để sử dụng Xdebug

bắt đầu gỡ lỗi

Khi bạn đã cài đặt Xdebug và cấu hình PhpStorm, bạn có thể bắt đầu gỡ lỗi mã của mình một cách tương tác. Điều này được thực hiện bằng cách đặt các điểm dừng tại một số dòng mã nhất định của bạn và yêu cầu PhpStorm lắng nghe các kết nối đến. Khi PHP thực thi một dòng có điểm dừng trên đó, Xdebug sẽ can thiệp và tạm dừng thực thi, cho phép bạn có được thông tin chi tiết có giá trị về tất cả những gì đang diễn ra trong quá trình thực thi

Thanh bên của bảng gỡ lỗi có nhiều nút khác nhau để kiểm soát việc thực thi mã. Đây là từ trên xuống khi chúng xuất hiện trong ảnh chụp màn hình

• Tiếp tục chương trình – tiếp tục với việc thực thi PHP
• Tạm dừng chương trình – không khả dụng trong quá trình gỡ lỗi
• Dừng - tạm dừng thực hiện
• View Breakpoints – hiển thị cửa sổ tất cả các điểm ngắt được đặt trong tất cả các tệp của dự án
• Mute Breakpoints – hủy kích hoạt các điểm ngắt trong khi thực thi (tốt cho việc hoàn thành yêu cầu mà không vi phạm thêm)
• Cài đặt – điều chỉnh màn hình trình gỡ lỗi
• Tab Pin – luôn hiển thị bảng Gỡ lỗi

Bên cạnh các tab

[xdebug]
zend_extension="/path/to/xdebug/extension/xdebug.so"
xdebug.remote_enable=1
xdebug.remote_host=127.0.0.1
xdebug.remote_port="9000"

[xdebug]
zend_extension="/path/to/xdebug/extension/xdebug.so"
xdebug.remote_enable=1
xdebug.remote_host=127.0.0.1
xdebug.remote_port="9000"

[xdebug]
zend_extension="/path/to/xdebug/extension/xdebug.so"
xdebug.mode=debug
xdebug.client_host=127.0.0.1
xdebug.client_port="9003"

• Hiển thị điểm thực thi – nhảy trở lại nơi chương trình bị hỏng
• Step Over – thực thi và chuyển sang dòng tiếp theo của tệp
• Bước vào – nếu dòng tiếp theo có một hoặc nhiều chức năng, hãy chuyển trình gỡ lỗi vào các chức năng đó để bước qua
• Force Step Into – bước vào một chức năng được đánh dấu là đã bỏ qua
• Step Out – di chuyển trình gỡ lỗi ra khỏi chức năng hiện tại trở lại chức năng đã gọi nó
• Run to Cursor – thực thi đến dòng có con trỏ
• Đánh giá biểu thức – thực thi PHP trong khi trình gỡ lỗi đang chạy (nghĩ về điều này giống như bảng điều khiển JS của Chrome)
• Hiển thị các hằng số do người dùng xác định – chuyển đổi hiển thị cho bất kỳ hằng số PHP nào mà mã của bạn đã xác định
• Hiển thị địa chỉ giá trị – chuyển đổi hiển thị địa chỉ bộ nhớ của các đối tượng
• Show Empty Superglobals Variables – chuyển chế độ hiển thị của bất kỳ siêu toàn cầu rỗng nào
• Add Method to Skip List – đánh dấu phương thức sẽ bỏ qua lần sau

Hầu hết các nút này cũng có phím tắt, nhưng thường được sử dụng nhất là

• F9 – Tiếp tục chương trình
• F8 – Bước qua
• F7 – Bước Vào

Điểm ngắt được thêm bằng cách nhấp vào rãnh bên trái của mã, dọc theo dòng bạn muốn tại đó bạn muốn ngắt. PhpStorm cũng cho phép bạn đặt các điểm dừng có điều kiện, nơi bạn thêm logic PHP để kiểm soát khi một điểm ngắt thực sự kích hoạt

Khi khắc phục sự cố, việc kiểm tra và xem giá trị của một biến trong suốt quá trình thực hiện yêu cầu để xem khi nào thay đổi sẽ rất hữu ích. PhpStorm cho phép bạn thêm các biến vào danh sách mà nó theo dõi và hiển thị trong bảng “Đồng hồ” riêng biệt, tách biệt với tất cả dữ liệu trong bảng “Biến” chính. Bạn có thể xem một biến bằng cách nhấp chuột phải vào biến trong tệp trong khi gỡ lỗi và chọn Thêm vào Đồng hồ hoặc thực hiện tương tự từ biến trong bảng "Biến"

Tuy nhiên, đồng hồ không giới hạn ở các biến. Bạn thậm chí có thể thêm các biểu thức hoặc chức năng vào danh sách theo dõi của mình. Điều này cực kỳ hữu ích khi bạn đang làm việc với một CMS như WordPress, sử dụng nhiều chức năng của trình trợ giúp như

[xdebug]
zend_extension="/path/to/xdebug/extension/xdebug.so"
xdebug.mode=debug
xdebug.client_host=127.0.0.1
xdebug.client_port="9003"

[xdebug]
zend_extension="/path/to/xdebug/extension/xdebug.so"
xdebug.mode=debug
xdebug.client_host=127.0.0.1
xdebug.client_port="9003"

dấu vết ngăn xếp

Trong Xdebug phiên bản 2, việc bật Xdebug sẽ cho phép theo dõi ngăn xếp mở rộng đối với bất kỳ lỗi, thông báo hoặc cảnh báo nào được ghi vào nhật ký PHP. Với việc phát hành phiên bản 3, điều này đã được thay đổi để nó cần được kích hoạt rõ ràng bằng cách đặt Xdebug

[xdebug]
zend_extension="/path/to/xdebug/extension/xdebug.so"
xdebug.remote_enable=1
xdebug.remote_host=127.0.0.1
xdebug.remote_port="9000"

[xdebug]
zend_extension="/path/to/xdebug/extension/xdebug.so"
xdebug.mode=debug
xdebug.client_host=127.0.0.1
xdebug.client_port="9003"

Bởi vì tôi dựa vào

[xdebug]
zend_extension="/path/to/xdebug/extension/xdebug.so"
xdebug.mode=debug
xdebug.client_host=127.0.0.1
xdebug.client_port="9003"

[xdebug]
zend_extension="/path/to/xdebug/extension/xdebug.so"
xdebug.mode=debug
xdebug.client_host=127.0.0.1
xdebug.client_port="9003"

if ( function_exists( 'xdebug_disable' ) ) {
    xdebug_disable();
}

Sử dụng nâng cao

Nắm vững những điều cơ bản?

lập hồ sơ

Khi bạn thực sự cần điều tra các vấn đề về hiệu suất với mã hoặc trang web của mình, một trong những công cụ tốt nhất mà chúng tôi tìm thấy là Blackfire, công cụ mà chúng tôi đã viết về. Nhưng Xdebug cũng tạo hồ sơ cho bạn và PhpStorm có thể giải thích kết quả, điều này thật tuyệt vì điều đó có nghĩa là bạn không bao giờ phải rời khỏi PhpStorm. 😂 , hãy chỉnh sửa tệp

[xdebug]
zend_extension="/path/to/xdebug/extension/xdebug.so"
xdebug.remote_enable=1
xdebug.remote_host=127.0.0.1
xdebug.remote_port="9000"

Phiên bản 3

xdebug.mode = profile
xdebug.output_dir = "/path/to/desired/profiler/output/directory"

Phiên bản 2

xdebug.profiler_enable=1
xdebug.profiler_output_dir="/path/to/desired/profiler/output/directory"

Sau đó, Xdebug sẽ tạo một tệp nhật ký hồ sơ trong

[xdebug]
zend_extension="/path/to/xdebug/extension/xdebug.so"
xdebug.mode=debug
xdebug.client_host=127.0.0.1
xdebug.client_port="9003"

xdebug.mode=develop,trace

xdebug.mode=develop,trace

Gỡ lỗi từ xa qua SSH

Bạn chỉ có thể khắc phục lỗi nếu bạn có thể tạo lại chúng trên môi trường phát triển của mình. Tất nhiên, khi nói đến việc chạy một trang web, chúng tôi khuyên bạn nên có môi trường phát triển gần với sản xuất nhất có thể và bạn gỡ lỗi trên một bản sao gần như có thể của cơ sở dữ liệu sản xuất. Tuy nhiên, đôi khi lỗi và điều kỳ lạ sẽ chỉ xảy ra khi sản xuất. Không ai muốn bắt đầu loay hoay trên một trang web trực tiếp, chỉnh sửa tệp để thêm dòng nhật ký. Đừng lo, PhpStorm và Xdebug sẽ hỗ trợ bạn. Bạn có thể cài đặt Xdebug trên máy chủ từ xa và gỡ lỗi thực thi mã cục bộ bằng Xdebug và PhpStorm. Tính năng này là cứu cánh và không yêu cầu nhiều để thiết lập. Đảm bảo tắt Xdebug khi bạn hoàn tất, để hiệu suất trang web của bạn không bị ảnh hưởng bởi Xdebug một cách không cần thiết

Xdebug có phải là cách duy nhất để gỡ lỗi PHP cho WordPress không?

Câu trả lời ngắn gọn là 'không', câu trả lời dài là 'còn tùy'. Mặc dù Xdebug là cách được đề xuất để kích hoạt tính năng gỡ lỗi theo bước cho PHP, nhưng bạn có thể muốn xem xét các tùy chọn khác. Một người mà tôi gặp gần đây là Ray, từ những người ở Spatie. Ray là một ứng dụng trả phí chạy trên Mac, Windows hoặc Linux và kết nối với dự án PHP của bạn. Điều này được thực hiện thông qua gói soạn thảo hoặc plugin WordPress nếu bạn đang gỡ lỗi cho WordPress

Khi bạn đã thiết lập xong mọi thứ, bạn có thể sử dụng lệnh gọi hàm

xdebug.mode=develop,trace

ray('Hello world');

ray('My variable', $variable);

ray('array', $array, 'object', $object);

Ray gửi dữ liệu này đến ứng dụng Ray bằng quy trình tương tự như bạn có thể thực hiện khi thực hiện yêu cầu cURL tới API HTTP JSON

Có một số lợi thế khi sử dụng Ray trên Xdebug. Bởi vì Ray sẽ chỉ truyền dữ liệu từ mã của bạn đến ứng dụng Ray khi ứng dụng đang chạy, nó sẽ không ảnh hưởng nhiều đến hiệu suất hệ thống của bạn như Xdebug có thể. Xdebug 3 cải thiện khá nhiều về hiệu suất so với Xdebug 2 và bạn có thể tắt gỡ lỗi thông qua tiện ích mở rộng của trình duyệt khi cần. Tuy nhiên, nó vẫn được cài đặt và hoạt động trên môi trường PHP cục bộ của bạn, vì vậy bạn chỉ có thể thực sự tắt nó hoàn toàn bằng cách vô hiệu hóa nó trong

[xdebug]
zend_extension="/path/to/xdebug/extension/xdebug.so"
xdebug.remote_enable=1
xdebug.remote_host=127.0.0.1
xdebug.remote_port="9000"

Ray cũng cho phép bạn thực hiện những việc nâng cao hơn như khả năng tạm dừng thực thi mã, gỡ lỗi từ xa qua SSH và khả năng nắm bắt mọi truy vấn đang được thực thi trong một yêu cầu PHP. Xdebug làm được nhiều hơn một chút và miễn phí, nhưng Ray là thứ cần xem xét như một tùy chọn để gỡ lỗi, đặc biệt nếu bạn vẫn dựa vào gỡ lỗi kết xuất trong quá trình phát triển

Hỗ trợ Xdebug

Người đứng sau Xdebug là Derick Rethans. Anh ấy là nhà phát triển duy nhất của Xdebug và dựa vào các nhà tài trợ để tài trợ cho công việc liên tục của anh ấy là bảo trì và cập nhật Xdebug. Tại Delicious Brains, chúng tôi đã là người ủng hộ Patreon của anh ấy kể từ tháng 2 năm 2019. Nếu bạn hoặc công ty của bạn thấy Xdebug hữu ích, tại sao không tài trợ cho anh ấy thông qua Patreon của anh ấy hoặc qua GitHub?

Phần kết luận

Tôi hy vọng đây là phần giới thiệu tốt về mức độ mạnh mẽ và giá trị của việc sử dụng trình gỡ lỗi như Xdebug đối với quy trình phát triển của bạn, cũng như một giải pháp thay thế khả thi nếu bạn thấy nó quá phức tạp. Xdebug là một trình tiết kiệm thời gian rất lớn và tôi không thể tưởng tượng được việc phát triển mà không có nó trong hộp công cụ của mình. Bạn có sử dụng Xdebug, Ray hoặc trình gỡ lỗi khác không?

Mục nhập này đã được đăng trong WP Offload Media, Mã và được gắn thẻ Hiệu suất, Phát triển, Mẹo phát triển WordPress, Gỡ lỗi, PhpStorm, Xdebug

Thông tin về các Tác giả

Iain Poulson

Iain là giám đốc sản phẩm có trụ sở tại miền nam nước Anh. Anh ấy cũng điều hành nhiều sản phẩm WordPress. Anh ấy giúp mọi người mua và bán doanh nghiệp WordPress và viết bản tin hàng tháng về xu hướng WordPress

@polevaultweb. com