آموزش مدیریت خطا در PHP به همراه مثال های کاربردی

سیستم مدیریت خطای پیش فرض(default error handling) در PHP بسیار ساده است. یک پیام خطا با نام فایل، شماره خط و یک توصیفی از پیام خطا، به مرورگر ارسال می شود.

مدیریت خطا (Error Handling) در php

هنگام ایجاد اسکریپت ها و برنامه های کاربردی وب، مدیریت خطا(Error Handling )، بخش مهمی از کد را تشکیل می دهد. اگر کد شما فاقد کدهای چک کردن خطا باشد، برنامه شما بسیار غیر حرفه ای به نظر می رسد و ممکن است با خطرات امنیتی زیادی روبه رو شود.

این آموزش شامل برخی از رایج ترین متدهای بررسی خطا در PHP می باشد.

دراین بخش از آموزش php، ما روش های مختلفِ مدیریتِ خطا را نشان می دهیم. این متدها عبارتند از :

• دستورات ساده با تابع "die()"
• error های گوناگون و بررسی فعال کننده خطا (error triggers)
• گزارش کردن خطاها یا (error reporting)

روش پایه مدیریت خطا با استفاده از تابع die () در php

مثال، یک اسکریپت ساده را نشان می دهد که یک فایل متنی(text file) را باز می کند:

<?php
$file=fopen("notebook.txt","r");
?>

اگر فایل وجود نداشته باشد شما ممکن است چنین خطایی را دریافت کنید:

Warning: fopen(notebook.txt) [function.fopen]: failed to open stream:

No such file or directory in C:\myfolder\test.php on line 2

برای جلوگیری از دریافت پیام خطایی مانند پیام خطای بالا، باید قبل از باز کردن فایل، بررسی کنیم آیا چنین فایلی وجود دارد یا خیر و اگر چنین فایلی وجود داشت اقدام به باز نمودن آن کنیم.

<?php
if(!file_exists("notebook.txt")) {
  die("File not found");
} else {
  $file=fopen("notebook.txt","r");
}
?>

حال اگر فایل وجود نداشته باشد شما یک خطا مانند خطای زیر را دریافت خواهید کرد:

File not found

کد بالایی، کارایی بیشتری نسبت به کد قبلی دارد، چرا که از یک مکانیزم ساده خطا استفاده می کند تا مانع از اجرای اسکریپت، پس از خطا شود.

با این حال، متوقف کردن اسکریپت، همیشه راه مناسبی برای مدیریت خطا نیست. بیایید نگاهی به توابع جایگزین php برای مدیریت خطاها داشته باشیم.

ساخت یک مدیریت کننده خطای سفارشی (Custom Error Handling)

ایجاد یک مدیریت کننده سفارشی خطا (Custom Error Handling) بسیار ساده است. ما به سادگی یک تابع خاص ایجاد می کنیم که وقتی یک خطا اتفاق می افتد، می تواند فراخوانی شود. این تابع باید بتواند حداقل دو پارامتر درجه خطا(error level) و پیام خطا(error message) را مدیریت کند، اما می تواند تا پنج پارامتر (پارامترهای اختیاری مانند : نام فایل، شماره خطی که خطا در آن رخ داده است و محتویات خطا) را نیز دریافت کند.

Syntax

error_function(error_level,error_message,
error_file,error_line,error_context)

درجه گزارش خطا (Error Report levels) در php

هر خطایی که در php رخ می دهد یک درجه یا سطح یا level ی دارد. این درجه گزارش خطاها، انواع مختلفی از خطاها هستند، که در لیست زیر نشان داده شده است:

اکنون اجازه می دهید تا یک تابع برای مدیریت خطاها ایجاد کنیم، کد تابع به صورت زیر است :

function customError($errno, $errstr) {
  echo "<b>Error:</b> [$errno] $errstr<br>";
  echo "Ending Script";
  die();
}

کد بالا یک تابع ساده مدیریت خطا (error handling) است. هنگامی که آن را فعال می کنیم، درجه خطا و یک پیام خطا دریافت می کند. سپس درجه خطا و پیام را نشان می دهد و اسکریپت را خاتمه می دهد.

حالا ما یک تابع مدیریت خطا ایجاد کرده ایم باید تصمیم بگیریم که چه زمانی باید آن را، فراخوانی و اجرا(triggere) کنیم.

تنظیم تابع مدیریت خطا در PHP :

به طور پیش فرض در php یک تابع مدیریت خطا ساخته شده است. اما ما قصد داریم، تا خودمان تابع مدیریت خطا بسازیم و آن را به عنوان تابعِ مدیریتِ پیش فرضِ خطا، در برنامه قرار دهیم.

ممکن است ما به گونه ای تابع مدیریت خطا را تغییر دهیم تا برای برخی از خطاها اعمال شود، در این صورت می توان error های مختلف را با روش های مختلف اداره کرد. با این حال، در این مثال ما قصد داریم تابع خود را برای مدیریت همه خطاهای برنامه تنظیم کنیم :

set_error_handler("customError");

از آنجا که ما می خواهیم تابع سفارشی ما تمام اشتباهات را مدیریت کند، set_error_handler()  تنها نیاز به یک پارامتر دارد، پارامتر دوم برای تعیین درجه خطا می تواند اضافه شود.

مثال:

در این مثال قصد داریم تا با تابع مدیریت خطا، متغیری که وجود ندارد را چاپ کنیم:

<?php
//error handler function
function customError($errno, $errstr) {
  echo "<b>Error:</b> [$errno] $errstr";
}

//set error handler
set_error_handler("customError");

//trigger error
echo($test);
?>

خروجی کد مثال فوق به صورت زیر خواهد بود :

Error: [8] Undefined variable: test

راه اندازی یک خطا(Trigger an Error)

در یک اسکریپتی که کاربران می توانند داده هایی را داخل inputها وارد کنند، زمانی که یک ورودی غیر قانونی داشته باشیم، فعال کردن errorها میتواند کار بسیار مفیدی باشد. در PHP این کار به وسیله تابع trigger_error() انجام می شود.

مثال

در این مثال اگر متغیر "test" بزرگتر از "1" باشد خطایی رخ می دهد:

<?php
$test=2;
if ($test>1) {
  trigger_error("Value must be 1 or below");
}
?>

خروجی کد بالا باید چیزی شبیه به این می باشد:

Notice: Value must be 1 or below

in C:\myfolder\test.php on line 6

یک خطا(error) را می توانید در هر نقطه ای در یک اسکریپت فعال و فراخوانی(trigger) کنید. و با اضافه کردن یک پارامتر دوم، می توانید درجه خطا (error level) را تعیین کنید.

انواع خطاهای احتمالی  عبارت اند از:

E_USER_ERROR : خطایی(Fatal Error) که زمان اجرا، توسط کد کاربر ایجاد شده است. خطاهایی که قابل برگشت نیستند (نمی توان برنامه را به نقطه بروز خطا باز گرداند) و اجرای اسکریپت متوقف می شود.

E_USER_WARNING : هشدارهایی(Non-fatal) که زمان اجرا توسط کد کاربر ایجاد شده است. ولی باعث توقف اجرای اسکریپت نمی شوند.

E_USER_NOTICE : پیش فرض کلیه Error ها می باشد. یک اعلان است که در هنگام بروز خطا در کدِ در حال اجرا صادر می شود.

مثال

در این مثال، اگر متغیر "test" بزرگتر از "1" باشد، E_USER_WARNING رخ می دهد. اگر یک E_USER_WARNING اتفاق بیفتد ما از تابع مدیریت خطای مورد نظر خود استفاده خواهیم کرد و این اسکریپت را پایان خواهیم داد:

<?php
//error handler function
function customError($errno, $errstr) {
  echo "<b>Error:</b> [$errno] $errstr<br>";
  echo "Ending Script";
  die();
}

//set error handler
set_error_handler("customError",E_USER_WARNING);

//trigger error
$test=2;
if ($test>1) {
  trigger_error("Value must be 1 or below",E_USER_WARNING);
}
?>

خروجی کد بالا باید چیزی شبیه به این می باشد:

Error: [512] Value must be 1 or below
Ending Script

حالا که آموختیم خودمان، خطاها را ایجاد و طراحی کنیم و چگونه آنها را به کار ببریم، اجازه دهید که نحوه ثبت کردن خطا یا (error logging) را نیز آموزش دهیم.

ثبت خطا یا error logging

به طور پیش فرض PHP یک کد ثبت خطا (error-log) را به سیستم خطاها (server's logging system) یا به یک فایل خاصی ارسال می کند. و این بستگی به نحوه تنظیم پیکربندی  error_log در فایل php.ini دارد.

با استفاده از تابع error_log () شما می توانید Error log ها را به یک فایل مشخص شده یا یک مقصد از راه دور ارسال کنید.همچنین ارسال پیام های خطا به خودتان از طریق ایمیل، می تواند یک راه بسیار مطمئن جهت اطلاع از بروز خطا در سیستم باشد.

ارسال یک پیام خطا (Error Message) توسط ایمیل

در مثال زیر اگر یک خطای خاص رخ دهد ما یک ایمیل با پیغام خطا برای کاربر ارسال می کنیم و اسکریپت را پایان خواهیم داد:

<?php
//error handler function
function customError($errno, $errstr) {
  echo "<b>Error:</b> [$errno] $errstr<br>";
  echo "Webmaster has been notified";
  error_log("Error: [$errno] $errstr",1,
  "someone@example.com","From:clicksite.ir@gmail.com");
}

//set error handler
set_error_handler("customError",E_USER_WARNING);

//trigger error
$test=2;
if ($test>1) {
  trigger_error("Value must be 1 or below",E_USER_WARNING);
}
?>

خروجی کد بالا باید چیزی شبیه به این می باشد:

Error: [512] Value must be 1 or below
Webmaster has been notified

و ایمیل دریافت شده توسط کاربر (از کد بالا) به شرح زیر است:

Error: [512] Value must be 1 or below

این روش( ارسال خطا به وسیله ایمیل ) نباید برای تمام خطاها استفاده شودو برای موارد حیاتی باید مورد استفاده قرار بگیرد. مابقی error ها را بایستی توسط سیستم ثبت کننده خطاهای PHP در فایل log ذخیره نمود.