處理錯誤
HTTP應用可以返回兩類主要的錯誤類型——客戶端錯誤和服務端錯誤。客戶端錯誤是指連接的客戶端觸發(fā)了什么錯誤,服務端錯誤是指有什么錯誤發(fā)生在服務端。
在許多情況下Play會自動的發(fā)現(xiàn)客戶端錯誤——這些錯誤包括如錯誤的報頭值,不支持的內容類型,請求找不到的資源。在多數(shù)情況下,Play也會自動的處理服務端錯誤——如果你的Action代碼拋出異常。Play將會捕捉這個并生成一個服務端錯誤網頁發(fā)送給客戶端。
Play處理這些錯誤的接口是 HttpErrorHandler。它定義了兩個方法,onClientError, 和 onServerError.
增加自定義的錯誤處理
自定義的錯誤處理可以通過在根包下創(chuàng)建一個叫做ErrorHandler的類實現(xiàn),這個類實現(xiàn)了 HttpErrorHandler,例如:
import play.api.http.HttpErrorHandler
import play.api.mvc._
import play.api.mvc.Results._
import scala.concurrent._
import javax.inject.Singleton;
@Singleton
class ErrorHandler extends HttpErrorHandler {
def onClientError(request: RequestHeader, statusCode: Int, message: String) = {
Future.successful(
Status(statusCode)("A client error occurred: " + message)
)
}
def onServerError(request: RequestHeader, exception: Throwable) = {
Future.successful(
InternalServerError("A server error occurred: " + exception.getMessage)
)
}
}
如果你不想把你的錯誤處理放到根包,或者如果你想可以為不同的環(huán)境配置不同的錯誤處理,那么你可以通過配置在配置資源文件application.conf中的 play.http.errorHandler:
play.http.errorHandler = "com.example.ErrorHandler"
擴展默認的錯誤處理
Play的默認錯誤處理提供了許多有用的方法,做到了開箱即用。例如在開發(fā)模式下,當服務端錯誤發(fā)生時,Play將會嘗試在你的應用中定位并提交一段引起異常的代碼,因此,你可以快速的看到并識別問題。你也許想在產品中提供自定義的服務端錯誤,同時仍然保持開發(fā)中的功能。為了方便的做到這點,Play提供了一個 DefaultHttpErrorHandler 類,這個類有一些你可以覆蓋的便利的方法,因此你可以在Play已有的行為中混入自己的邏輯。
例如,為了只在產品中提供自定義的服務端錯誤信息,去掉開發(fā)的錯誤信息不用,并且你還想提供一個指定的禁用錯誤的頁面:
import javax.inject._
import play.api.http.DefaultHttpErrorHandler
import play.api._
import play.api.mvc._
import play.api.mvc.Results._
import play.api.routing.Router
import scala.concurrent._
@Singleton
class ErrorHandler @Inject() (
env: Environment,
config: Configuration,
sourceMapper: OptionalSourceMapper,
router: Provider[Router]
) extends DefaultHttpErrorHandler(env, config, sourceMapper, router) {
override def onProdServerError(request: RequestHeader, exception: UsefulException) = {
Future.successful(
InternalServerError("A server error occurred: " + exception.getMessage)
)
}
override def onForbidden(request: RequestHeader, message: String) = {
Future.successful(
Forbidden("You're not allowed to access this resource.")
)
}
}
檢查DefaultHttpErrorHandler 的完成API文檔,看看那個方法可以被覆蓋,還有如何很好的利用它們。