ASP.NET Web APIにおけるパラメータバインドの概要
24231 ワード
ASP.NET Web APIにおけるactionパラメータタイプは、単純タイプと複雑タイプに分けられる.HttpResponseMessage Put(int id,Product item)idはintタイプ、単純タイプ、itemはProductタイプ、複雑タイプです.単純なタイプの実パラメータ値はどこから読み込まれますか?--一般的にURIから読み出される単純タイプとはどのようなものでしょうか.--int,bool,double,TimeSpan,DateTime,Guid,decimal,string,および文字列から変換できる複雑なタイプの実パラメータ値はどこから読み出されますか.--一般的に要求されたbodyから複雑なタイプの実パラメータ値を読み取ることはURIから取得できるのでしょうか.--はい、以下のように→このようなクラスがあります
public class Shape
{
public double Width{get;set;}
public double Length{get;set;}
}→URIから取得したい場合は[FromUri]public HttpResponseMessage Get([FromUri]Shape shape)→クライアントはクエリー文字列に入れて転送できる...api/products/?Width=88&Length=199単純タイプはリクエストのbodyから取得できますか?--いいですよ.→アクションメソッドpublic HttpResponseMessage Post([FromBody]string name){...}→フロントエンドリクエストでContent-Type:applicaiton/json「hello world」APIサービス側はContent-Typeの値に応じて適切なメディアタイプを選択します.複雑なタイプはuriの文字列から取得できますか?--api/products/?shape=188,80 uriのクエリ文字列のshapeのフィールド値,すなわちカンマで分割された文字列をShapeクラスインスタンスに変換するにはどうすればよいのでしょうか.--Type Converterクラスの使用
[TypeConverter(typeof(ShapeConverter))]
public class Shape
{
public double Width{get;set;}
public double Length{get;set;}
public static bool TryParse(string s, out Shampe result)
{
result = null;
var parts = s.Split(',');
if(parts.lenth != 2)
{
return false;
}
double width, length;
if(double.TryParse(parts[0], out width) && double.TryParse(parts[1], out length))
{
result = new Shape(){Width = width; Length = length};
return true;
}
return false;
}
}
public class ShapeConverter: TypeConverter
{
public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourcType)
{
if(sourceType == typeof(string))
{
return true;
}
return base.CanConvertFrom(context, sourceType);
}
public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo, object value)
{
if(value is string)
{
Shape shape;
if(Shape.TryParse((string)value, out shape))
{
return shape;
}
}
return base.ConvertFrom(context, culture, value);
}
}→actionで[FromUri]public HttpResponseMessage Get(Shape shape)→クライアントapi/products/?shape=188,80はModel Binderによってカスタムパラメータバインドプロセスを実現できますか?--はい、IModelBinderインタフェースがあります.BindModelメソッドを提供します.→Model Binderをカスタマイズします.
public class ShapeModelBinder : IModelBinder
{
private static ConcurrentDictionary<string, Shape> _shapes = new ConcurrentDictionary<string, Shape>(StringComparer.OrdinalIgnoreCase);
static ShapeModelBinder()
{
_shapes["shape1"] = new Shape(){Width= 10, Length = 20};
_shapes["shape2"] = new Shape(){Width=12, Length = 22 };
}
public bool BindModel(HttpActionContext actionContext, ModelBindingContect biningContext)
{
if(bindingContext.ModelType != typeof(Shape))
{
return false;
}
ValueProviderResult val = bindingContext.ValueProvider.GetValue(bidingContext.ModelName);
if(val == null)
{
return false;
}
string key = val.RawValue as string;
if(key == null){
bdingContext.ModelState.AddModelError(bindingContext.ModelName, " ");
return false;
}
Shape shape;
if(_shapes.TryGetValue(key, out shape) || Shape.TryParse(key, shape))
{
bindingContext.Model = result;
return true;
}
bindingContext.ModelState.AddModelError(bindingContext.ModelName, " Shape");
return false;
}
}●BindingContextのValueProvider属性からValueProviderResultを取得●フロントエンドクエリ文字列から渡された文字列は、ValueProviderResultのRawValue属性に置かれる●文字列をShapeインスタンスに変換し、最終的にBindingContextのModel属性に入れた→カスタムModel Binderを使用してactionで使える:public HttpResposneMessage Get([ModelBinder(typeof(ShapeModelBinder)]Shape shape);モデルに配置するには、次の手順に従います.
[ModelBinder(typeof(Shape))]
public class Shape
{
}グローバル・レジストリに含めることもできます.
public static class WebApiConfig
{
public static void Register(HttpConfiguraiton config)
{
var provider = new SimpleModelBinderProvider(typeof(Shape), new ShapeModelBinder());
config.Services.Insert(typeof(ModelBinderProvider), 0, provider);
}
}注意:グローバルに登録しても、actionでpublic HttpResponseMessage Get([ModelBinder]Shape shape);Value Providerを使用してパラメータバインドプロセスを定義できますか?--いいですよ.例えば、フロントエンドクッキーから値を取得し、Value Providerをカスタマイズする.
public class MyCookieValueProvider : IValueProvider
{
private Dictionary<string, string> _values;
public MyCookieValueProvider(HttpActionContext actionContext)
{
if(actionContext == null)
{
throw new ArgumentNullException("actionContext");
}
_values = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
foreach(var cookie in actionContext.Request.Headers.GetCookies())
{
foreach(CookieState state in cookie.Cookies)
{
_values[state.Name] = state.Value;
}
}
}
public bool COntainsPrefix(string prefix)
{
return _values.keys.Contains(prefix);
}
public ValueProviderResult GetValue(string key)
{
string value;
if(_values.TryGetValue(key, out value))
{
return new ValueProviderResult(value, value, CultureInfo.InvariantCulture);
}
return null;
}
}ValueProviderFactoryも必要です
public class MyCookieValueProviderFactory : ValueProviderFactory
{
public override IValueProvider GetValueProvider(HttpActionContext actionContext)
{
return new MyCookeValueProvider(actionContext);
}
}最後にグローバルに登録します.
public static void Register(HttpConfiguration config)
{
config.Services.Add(typeof(ValueProviderFactory), new MyCookieValueProviderFactory());
}カスタマイズしたValueProviderをactionに置くこともできます.public HttpResponseMessage Get([ValueProvider(typeof(MyCookieValueProviderFactory))] Shape shape);
HttpParameterBindingでパラメータバインドカスタムを実装できますか?--いいですよ.ModelBinderAttributeはParameterBindingAttributeに継承する.
public abstract class ParameterBindingAttribute : Attribute
{
public abstract HttpParameterBinding GetBinding(HttpParameterDescriptor parameter);
}HttpParameterBindingは、パラメータに値をバインドするために使用されます.フロントエンド要求のif-matchフィールドとif-none-matchフィールドからETag値を取得する必要があると仮定します.
public class ETag
{
public string Tag{get;set;}
}if-matchから取得するか、if-none-matchから取得するか、列挙します.
public enum ETagMatch
{
IfMatch,
IfNoneMatch
}HttpParameterBindingをカスタマイズします.
public class ETagParameterBinding : HttpParameterBinding
{
ETagMatch _match;
public ETagParameterBinding(HttpParameterDescriptor parameter, ETagMatch match) : base(parameter)
{
_match = match;
}
public override Task ExecuteBindingAsync(ModelMetadataProvider metadataProvider, HttpActionContext actionContext, CancellationToken candellationToken)
{
EntityTagHeaderValue etagHeader = null;
switch(_match)
{
case ETagMatch.IfNoneMatch:
etagHeader = actionContext.Request.Headers.IfNoneMatch.FirstOrDefault();
break;
case ETagMatch.IfMatch:
etagHeader = actionContext.Request.Headers.IfMatch.FirstOrDefault();
break;
}
ETag etag = null;
if(etagHeader != null)
{
etag = new ETag{Tag = etagHeader.Tag};
}
actionContext.ActionArguemnts[Descriptor.ParameterName] = etag;
var tsc = new TaskCompletionSource<object>();
tsc.SetResult(null);
return tsc.Task;
}
}すべてのactionパラメータがActionContextのActionArgumentsに配置されていることがわかります.カスタムHttpParameterBindingの使い方--ParameterBindingAttributeプロパティをカスタマイズします.
public abstract class ETagMatchAttribute : ParameterBindingAttribute
{
private ETagMatch _match;
public ETagMatchAttribute(ETagMatch match)
{
_match = match;
}
public override HttpParameterBinding GetBinding(HttpParameterDescriptor parameter)
{
if(parameter.ParameterType == typeof(ETag))
{
return new ETagParameterBinding(parameter, _match);
}
return parameter.BindAsError(" ");
}
}
public class IfMatchAttribute : ETageMatchAttribute
{
public IfMatchAttribute(): base(ETagMatch.IfMatch)
{}
}
public class IfNoneMatchAttribute: ETagMatchAttribute
{
public IfNoneMatchAttribute() : base(ETagMatch.IfNoneMatch)
{}
}さらに定義したHttpParameterBindingに関する特性を方法に適用する.public HttpResponseMessage Get([IfNoneMatch]ETag etag)は、グローバルに登録する必要があります.
config.ParameterBindingRules.Add(p => {
if(p.ParameterType == typeof(ETag) && p.ActionDescriptor.SupportedHttpMethods.Contains(HttpMethod.Get))
{
return new ETagParameterBinding(p, ETagMatch.IfNoneMatch);
}
else
{
return null;
}
})まとめて、本編では、簡単なタイプと複雑なタイプでフロントエンドデータを取得する方法を体験しました.パラメータバインドプロセスの制御は、ValueProvider、ModelBinder、HttpParameterBindingをカスタマイズすることによって実現されます.