Play框架学习之错误处理

2016-01-10

在Play中，分为2种错误：客户端错误和服务端错误。客户端错误包括不规范的请求头数据，不支持的content type，找不到静态页面等等，服务端错误时会返回一个错误的页面。

自定义错误处理

可以在app目录下创建一个名为ErrorHandler的类，实现HttpErrorHandler，注意，必须没有包名，并且类名必须为ErrorHandler，如

class ErrorHandler extends HttpErrorHandler {
  override def onClientError(request: RequestHeader, statusCode: Int, message: String) = {
    Future.successful {
      Status(statusCode)("A client error occurred: " + message)
    }
  }

  override def onServerError(request: RequestHeader, exception: Throwable) = {
    Future.successful {
      InternalServerError("A server error occurred: " + exception.getMessage)
    }
  }
}

// 在Action实现中直接抛出异常
def custom() = Action { implicit request =>
    throw new RuntimeException("RuntimeException")
}

访问http://localhost:9000/custom 时，会返回“A server error occurred: RuntimeException”文本信息。

也可以在其他包中定义其他类名，并且在application.conf中指定，如

1	play.http.errorHandler = "error.CustomErrorHandler"

继承默认错误处理

在Play的开发环境中，如果发生服务端错误，会定位出发生错误的代码块，并且提示出来，如果想要使用这种默认的处理机制，又想添加一些自定义的错误处理，则可以继承默认的处理类。

默认的处理类为DefaultHttpErrorHandler, 可以重写这个类的某些方法，处理一些自定义的方法，如

import javax.inject.Inject

import com.google.inject.Provider
import play.api._
import play.api.http.DefaultHttpErrorHandler
import play.api.mvc.{RequestHeader, Results}
import play.api.routing.Router

import scala.concurrent.Future

class ErrorHandler @Inject()(
                              environment: Environment, configuration: Configuration,
                              sourceMapper: OptionalSourceMapper,
                              router: Provider[Router]
                            ) extends DefaultHttpErrorHandler(environment, configuration, sourceMapper, router) {

  override protected def onDevServerError(request: RequestHeader, exception: UsefulException) = {
    Logger.info("server error happens")
    super.onDevServerError(request, exception)
  }

  override protected def onProdServerError(request: RequestHeader, exception: UsefulException) = {
    Future.successful {
      Results.InternalServerError("A server error occurred: " + exception.getMessage)
    }
  }

  override protected def onForbidden(request: RequestHeader, message: String) = {
    Future.successful {
      Results.Forbidden("your'are not allowed to access this resource.")
    }
  }
}