WebApi属性路由——为get绑定路由参数到一个对象

本文关键字：路由 参数 一个对象 绑定 属性 WebApi get | 更新日期: 2023-09-27 18:04:46

目前，对于每个GET，我都必须从路由参数中手动创建一个查询对象。

是否可以直接绑定到查询对象?

所以，而不是:

[Route("{id:int}")]
public Book Get(int id) {
    var query = new GetBookByIdQuery {
        Id = id
    };
    // execute query and return result
}

我可以这样做:

[Route("{id:int}")]
public Book Get(GetBookByIdQuery query) {
    // execute query and return result
}

其中GetBookByIdQuery看起来像:

public class GetBookByIdQuery {
    public int Id { get; set;}
}

WebApi属性路由——为get绑定路由参数到一个对象

从URI中读取复杂类型，可以使用[FromUri] 

    [Route("{id:int}")]
    public Book Get([FromUri] GetBookByIdQuery query) {
        // execute query and return result
    }

如果您请求api/values/2，则查询对象的id属性将为2;

答案是定义你自己的HttpParameterBinding。

这是我做的例子。

首先创建CustomParameterBinding 

public class CustomParameterBinding : HttpParameterBinding
{
    public CustomParameterBinding( HttpParameterDescriptor p ) : base( p ) { }
    public override System.Threading.Tasks.Task ExecuteBindingAsync( System.Web.Http.Metadata.ModelMetadataProvider metadataProvider, HttpActionContext actionContext, System.Threading.CancellationToken cancellationToken )
    {
        // Do your custom logic here
        var id = int.Parse( actionContext.Request.RequestUri.Segments.Last() );
        // Set transformed value
        SetValue( actionContext, string.Format( "This is formatted ID value:{0}", id ) );
        var tsc = new TaskCompletionSource<object>();
        tsc.SetResult(null );
        return tsc.Task;
    }
}

下一步是创建自定义属性来装饰参数:

public class CustomParameterBindingAttribute : ParameterBindingAttribute
{
    public override HttpParameterBinding GetBinding( HttpParameterDescriptor parameter )
    {
        return new CustomParameterBinding( parameter );
    }
}

最后控制器是这样的

public class ValuesController : ApiController
{
    // GET api/values/5
    [Route( "api/values/{id}" )]
    public string Get([CustomParameterBinding] string id )
    {
        return id;
    }       
}

现在当我调用http://localhost:xxxx/api/values/5

我得到:"This is格式化ID value:5"

你可以使用类作为参数，但由于id不再是方法定义中的参数，所以它不能包含在Route中。

public class LibraryController : ApiController
{
    [HttpGet]  
    public Book Get(GetBookByIdQuery query)
    {
        // Process query... & return
    }
}

你可以用链接来调用它:

http://localhost:54556/api/Library?id=12
相关文章：