Axum 0.7定义带JSON体与Token头的POST接口编译失败求助

问题描述 #

使用Axum 0.7编写POST接口处理函数，结合Json提取器和自定义SecurityToken提取器时出现编译错误，但GET接口结合Path和SecurityToken可正常运行。

POST接口处理函数代码：

async fn add_key(
    Json(customer): Json<AddKeyRequest>,
    security_token: SecurityToken,
) -> impl IntoResponse {  
   ...
}

SecurityToken的FromRequest实现：

#[derive(Serialize, Deserialize, Clone, Debug)]
pub struct SecurityToken(pub String);

#[async_trait]
impl<S> FromRequest<S> for SecurityToken
where
    S: Send + Sync,
{
    type Rejection = (StatusCode, String);
    async fn from_request(req: Request, _state: &S) -> Result<Self, Self::Rejection> {
        let headers = req.headers();
        headers
            .get("token")
            .and_then(|value| value.to_str().ok())
            .map(|value| SecurityToken(value.to_string()))
            .ok_or((
                StatusCode::UNAUTHORIZED,
                "Missing or invalid token header".into(),
            ))
    }
}

编译错误信息：

error[E0277]: the trait bound `fn(Json<AddKeyRequest>, SecurityToken) -> impl Future<Output = impl IntoResponse> {add_key}: Handler<_, _>` is not satisfied
   --> key-manager\src/main.rs:162:40
    |
162 |         .route("/key", post(add_key));
    |                                   ---- ^^^^^^^^ the trait `Handler<_, _>` is not implemented for fn item `fn(AddKeyRequest>, SecurityToken) -> impl Future<Output = impl IntoResponse> {add_key}`
    |                                   |
    |                                   required by a bound introduced by this call

错误原因 #

Axum 0.7要求Handler的所有提取器参数的Rejection类型必须能统一兼容：

• POST接口中，Json提取器的Rejection是JsonRejection，而自定义SecurityToken的Rejection是(StatusCode, String)，两个类型无法自动合并，导致Handler trait无法实现。
• GET接口中，Path提取器的Rejection是PathRejection，但你的WebType<CustomerKeyReply>返回类型可能统一了错误处理逻辑，刚好满足编译条件。

解决方案 #

方案1：统一Rejection类型为自定义错误枚举 #

定义全局API错误类型，实现IntoResponse，并让所有提取器的Rejection都转换成该类型：

1. 定义自定义错误枚举：

use axum::{http::StatusCode, response::IntoResponse};
use serde_json::json;

#[derive(Debug)]
enum ApiError {
    Unauthorized(String),
    BadRequest(String),
}

impl IntoResponse for ApiError {
    fn into_response(self) -> axum::response::Response {
        let (status, message) = match self {
            ApiError::Unauthorized(msg) => (StatusCode::UNAUTHORIZED, msg),
            ApiError::BadRequest(msg) => (StatusCode::BAD_REQUEST, msg),
        };
        (status, json!({"error": message})).into_response()
    }
}

2. 修改SecurityToken的FromRequest实现，使用自定义错误：

#[async_trait]
impl<S> FromRequest<S> for SecurityToken
where
    S: Send + Sync,
{
    type Rejection = ApiError;
    async fn from_request(req: axum::extract::Request, _state: &S) -> Result<Self, Self::Rejection> {
        let headers = req.headers();
        headers
            .get("token")
            .and_then(|value| value.to_str().ok())
            .map(|value| SecurityToken(value.to_string()))
            .ok_or(ApiError::Unauthorized("Missing or invalid token header".into()))
    }
}

3. 实现JsonRejection到ApiError的转换：

impl From<axum::extract::rejection::JsonRejection> for ApiError {
    fn from(e: axum::extract::rejection::JsonRejection) -> Self {
        ApiError::BadRequest(format!("Invalid request body: {}", e))
    }
}

4. 修改处理函数返回Result：

async fn add_key(
    Json(customer): Json<AddKeyRequest>,
    security_token: SecurityToken,
) -> Result<impl IntoResponse, ApiError> {
    // 业务逻辑实现
    Ok(Json(/* 你的响应结构体 */))
}

方案2：手动处理Json提取器的错误 #

将Json提取器改为Result类型，手动转换错误为SecurityToken的Rejection类型：

async fn add_key(
    json_result: Result<Json<AddKeyRequest>, axum::extract::rejection::JsonRejection>,
    security_token: SecurityToken,
) -> impl IntoResponse {
    // 处理Json解析错误
    let Json(customer) = match json_result {
        Ok(data) => data,
        Err(e) => return (StatusCode::BAD_REQUEST, format!("Invalid JSON: {}", e)).into_response(),
    };

    // 业务逻辑实现
    // ...

    // 返回响应
    (StatusCode::OK, "Key added successfully").into_response()
}

方案3：转换Json提取器的Rejection类型 #

使用HandlerExt的map_rejection方法，将JsonRejection转换为与SecurityToken一致的Rejection类型：

use axum::handler::HandlerExt;

// 路由注册时转换错误
.route("/key", post(add_key.map_rejection(|e: axum::extract::rejection::JsonRejection| {
    (StatusCode::BAD_REQUEST, format!("Invalid JSON: {}", e))
})))

验证 #

修改后重新编译，POST接口应能正常通过编译并运行，错误处理逻辑也会统一规范。

内容的提问来源于stack exchange，提问作者the duck