來源:藏色散人 發(fā)布時間:2020-05-09 10:59:27 閱讀量:1069
引言
接觸過php框架的朋友們可能都知道,日志在項目中的重要作用了,他可以幫助我們定位錯誤的位置,讓程序更友好(處理得當(dāng)?shù)脑挷粫苯訏伋鲆淮蠖阎挥谐绦蛟巢耪嬲齽拥挠⑽模?,調(diào)試的時候也會很方便,還可以記錄一些重要的操作等等,總之一個完整的項目要是沒了日志系統(tǒng),就已經(jīng)開發(fā)的路上布滿了荊棘、坑洼,肯定會磕磕絆絆的。
簡介
要掌握PHP日志系統(tǒng),必須先對這幾點(diǎn)東西了解透徹。
一、php的幾個函數(shù)
1 2 3 |
|
這三個函數(shù)在錯誤處理控制中給開發(fā)者提供了很大的自主空間,在日志系統(tǒng)中記錄日志信息有他們的功勞。
在程序中出現(xiàn)異常(exception)問題時,php內(nèi)核會拋出異常錯誤,然后將錯誤信息打印給使用者,如果注冊了exception處理函數(shù),php拋出的異常會轉(zhuǎn)給自定義的注冊的異常捕獲函數(shù),這個函數(shù)里面包含了我們要做的處理,記錄錯誤信息(包括錯誤詳細(xì)內(nèi)容、錯誤位置),該函數(shù)處理完異常后,異常就會終止。
當(dāng)程序中出現(xiàn)error時,我們注冊的error處理函數(shù)會在函數(shù)中將錯誤信息轉(zhuǎn)化為一個錯誤異常對象傳遞給異常處理函數(shù),也就是第一步的$exception_handler函數(shù)。
當(dāng)成續(xù)重出現(xiàn)shutdown錯誤時,會執(zhí)行我們注冊的異常終止處理函數(shù),該函數(shù)通過error_get_last()獲取到最后的shutdown時的錯誤對象,接著和上一部一樣,生成一個error exception對象,將該對象傳遞給我們注冊的異常處理函數(shù)。
可以看到,其實不管是異常還是錯誤,都是將自己的信息轉(zhuǎn)化為異常處理函數(shù)認(rèn)識的異常信息,然后交給異常處理函數(shù)處理,非異常信息就像化了妝的女人一樣,異常處理程序不認(rèn)識這些非異常信息,只有將裝卸掉(非異常信息自己轉(zhuǎn)化為異常信息,準(zhǔn)確的說應(yīng)該是拋出),異常處理才認(rèn)識。
php日志系統(tǒng)中的錯誤處理流程
那么現(xiàn)在問題來了,這幾個函數(shù)一般會配合一個異常處理類庫,加上一個錯誤日志記錄類庫來進(jìn)行工作,異常處理類庫中包含要注冊的3個函數(shù),日志記錄類庫在$exception_handler中調(diào)用,用來合理的記錄和放置日志文件的位置,上面說到的幾個函數(shù)一般是在程序框架入口處進(jìn)行加載注冊的,就像下面這樣:
這里面用的是array(class,function)這種方式。
1 2 3 |
|
二、日志記錄相關(guān)類庫
第一部分介紹到的東西只是對異常、錯誤、shutdown進(jìn)行了捕獲,這只是第一步,接下來還要對捕獲到的信息進(jìn)行合理的處理,比如說記錄這些日志信息到本地文件系統(tǒng)中(這個操作是在array(“Myexception”,”exceptionHandler”)),這個地方就用到了日志記錄類庫。(下面要說的類庫是借鑒了kohana日志系統(tǒng)的設(shè)計)。
日式日志記錄也很簡單只要做的將信息添加到文件末尾就行,這個很容易實現(xiàn),相信大家都可以自己實現(xiàn),但是要設(shè)計出一個便捷的、高效的、擴(kuò)展的日志記錄類庫就不那么簡單了,要經(jīng)過長時間的實踐總結(jié)優(yōu)化才可以,kohana框架中的日志記錄類庫已經(jīng)比較成熟了,因此這里拿來借鑒。
相信使用過kohana的用戶一定對kohana框架中的日志記錄比較熟悉,不熟悉也沒關(guān)系,我下面會大概的說說,在kohana源碼中的application/bootstrap.php文件中的第109——112行可以看到下面的代碼:
1 2 3 4 |
|
這個就是添加一個日志記錄對象到日志對象中,注意橄欖色打底的倆個,他們是不同的類庫實例,在kohana中,日志記錄對象分為兩部分,第一部分就是日志對象,用來維護(hù)一個日志記錄對象的列表,這個要怎么理解呢,其實就像一個容器,里面包含了一個或多個日志記錄對象(這個就是第二部分,這些日志記錄對象才是真正來記錄日志的),還有每個對象要記錄的錯誤等級的數(shù)組,當(dāng)滿足錯誤等級的時候才會去記錄,不滿足就會略掉。下面是我自己簡化重命名后的日志記錄方式:
1 2 3 |
|
我這里面為了更好地理解,將“容器”命名為Log,記錄的實例命名為Logwriter,可以看到我在程序入口處很容易的添加了兩不同的日志種類,第一個是記錄所有錯誤號比Log::DEBUG小的錯誤(錯誤級別比他高),并按規(guī)則記錄在文件夾./data/debug下面,第二個是記錄級別等于或高于Log::NOTICE的錯誤,當(dāng)然了你還可以更詳細(xì)制定具體哪些錯誤好,傳遞數(shù)組就行了,這個就是我感覺方便、快捷的地方,我們可以根據(jù)需求來添加錯誤日志、分不同的日志目錄,下面看一幅圖也許會有助于理解:
log與logwriter的關(guān)系
通過上面的圖你就會看到Log是一個容器,包含了具體的不同的logwriter對象,每個對象可能要記錄不同的信息,當(dāng)錯誤信息要刷到文件中的時候,會運(yùn)行每一個Logwriter實例,看看自己是否要記錄errormessage中的錯誤,errormessage中的level不包含在Logwriter內(nèi)時忽略。
這本分和第一部分怎么合作的呢?
其實很簡單,當(dāng)exception捕獲的異常時會調(diào)用添加一條錯誤信息(包括錯誤位置、錯誤代號、錯誤信息等信息)到Log容器中的errormessage數(shù)組中,然后當(dāng)程序結(jié)束之后在將這些信息寫入文件,這里還要注意下,也許你在閱讀kohana代碼是發(fā)現(xiàn)沒有明顯的直接寫入到日志中去,這里面kohana優(yōu)化的比較好,因為php的一次執(zhí)行可能出現(xiàn)多個錯誤,如果來一個錯誤你就去記錄一次這樣會在程序返回之前占用多余的io和時間,所以kohana的做法是默認(rèn)將所有的錯誤、異常、日志存放在Log::$errormessage中,并在實例化的時候講Log中的writer操作注冊register_shutdown_function,這個函數(shù)的作用是在程序異常終止或者執(zhí)行完成之后執(zhí)行,前面第一部分也有使用到,這樣日志記錄就不會對本次php的執(zhí)行產(chǎn)生帶大的影響。