文档
一个 项目

handle_errors

设置错误处理程序。

当正常的 HTTP 请求处理程序返回错误时,正常的处理会停止,并且会调用错误处理程序。错误处理程序形成一个路由,就像正常的路由一样,它们可以执行正常的路由可以执行的任何操作。这在处理 HTTP 请求期间处理错误时提供了极大的控制和灵活性。例如,您可以提供静态错误页面、模板化的错误页面,或者反向代理到另一个后端来处理错误。

请求的上下文被带入错误路由,因此在请求上下文中设置的任何值,例如 站点根目录变量,也会在错误处理程序中保留。此外,在处理错误时可以使用 新的占位符

请注意,某些指令,例如 reverse_proxy,它可能会使用被归类为错误的 HTTP 状态码写入响应,不会触发错误路由。

您可以使用 error 指令根据您自己的路由决策显式触发错误。

语法

handle_errors {
	<directives...>
}
  • <directives...> 是 HTTP 处理程序 指令匹配器 的列表,每行一个。

占位符

在处理错误时可以使用以下占位符。它们是 Caddyfile 简写,用于可以在 HTTP 服务器错误路由的 JSON 文档 中找到的完整占位符。

占位符 描述
{err.status_code} 推荐的 HTTP 状态码
{err.status_text} 与推荐的状态码关联的状态文本
{err.message} 错误消息
{err.trace} 错误的来源
{err.id} 此错误发生的标识符

示例

基于状态码的自定义错误页面(例如,对于 404 错误,名为 404.html 的页面)。请注意,file_serverhandle_errors 中运行时会保留错误的 HTTP 状态码(假设您之前在站点中设置了 站点根目录

handle_errors {
	rewrite * /{err.status_code}.html
	file_server
}

使用 templates 写入自定义错误消息的单个错误页面

handle_errors {
	rewrite * /error.html
	templates
	file_server
}

如果您只想为某些错误代码提供自定义错误页面,可以使用 file 匹配器事先检查自定义错误文件是否存在

handle_errors {
	@custom_err file /err-{err.status_code}.html /err.html
	handle @custom_err {
		rewrite * {file_match.relative}
		file_server
	}
	respond "{err.status_code} {err.status_text}"
}

反向代理到一个专业服务器,该服务器非常适合处理 HTTP 错误并改善您的工作日 😸

handle_errors {
	rewrite * /{err.status_code}
	reverse_proxy https://http.cat {
		header_up Host {upstream_hostport}
		replace_status {err.status_code}
	}
}

只需使用 respond 返回错误代码和名称

handle_errors {
	respond "{err.status_code} {err.status_text}"
}

要以不同的方式处理特定的错误代码,请使用 expression 匹配器,使用 handle 来实现互斥

handle_errors {
	@404-410 `{err.status_code} in [404, 410]`
	handle @404-410 {
		respond "It's a 404 or 410 error!"
	}

	@5xx `{err.status_code} >= 500 && {err.status_code} < 600`
	handle @5xx {
		respond "It's a 5xx error."
	}

	handle {
		respond "It's another error"
	}
}