WCF 웹 HTTP 프로그래밍 모델을 사용하면 서비스 작업에서 응답을 반환하는 데 가장 적합한 형식을 동적으로 결정할 수 있습니다. 적절한 형식을 결정하는 두 가지 메서드인 자동 및 명시적 메서드가 지원됩니다.
자동 서식 지정
사용하도록 설정하면 자동 서식이 응답을 반환할 최상의 형식을 선택합니다. 순서대로 다음을 확인하여 최상의 형식을 결정합니다.
요청 메시지의 Accept 헤더에 미디어 유형이 있습니다.
요청 메시지의 콘텐츠 형식입니다.
작업의 기본 형식 설정입니다.
WebHttpBehavior의 기본 형식 설정입니다.
요청 메시지에 Accept 헤더가 포함된 경우 WCF(Windows Communication Foundation) 인프라는 지원하는 형식을 검색합니다.
Accept
헤더가 미디어 형식에 대한 우선 순위를 지정하면 해당 우선 순위가 존중됩니다. 헤더에 Accept
적합한 형식이 없으면 요청 메시지의 콘텐츠 형식이 사용됩니다. 적절한 content-type을 지정하지 않으면 작업에 대한 기본 형식 설정이 사용됩니다. 기본 형식은 ResponseFormat
매개 변수와 WebGetAttribute, WebInvokeAttribute 특성을 사용하여 설정됩니다. 작업에 기본 형식이 지정되지 않은 경우 속성 값 DefaultOutgoingResponseFormat 이 사용됩니다. 자동 서식은 속성에 AutomaticFormatSelectionEnabled 의존합니다. 이 속성을 설정 true
하면 WCF 인프라에서 사용할 최상의 형식을 결정합니다. 자동 서식 선택은 기본적으로 이전 버전과의 호환성을 위해 사용하지 않도록 설정됩니다. 자동 서식 선택은 프로그래밍 방식으로 또는 구성을 통해 사용하도록 설정할 수 있습니다. 다음 예제에서는 코드에서 자동 서식 선택을 사용하도록 설정하는 방법을 보여 줍니다.
// This code assumes the service name is MyService and the service contract is IMyContract
Uri baseAddress = new Uri("http://localhost:8000");
WebServiceHost host = new WebServiceHost(typeof(MyService), baseAddress)
try
{
ServiceEndpoint sep = host.AddServiceEndpoint(typeof(IMyContract), new WebHttpBinding(), "");
// Check it see if the WebHttpBehavior already exists
WebHttpBehavior whb = sep.Behaviors.Find<WebHttpBehavior>();
if (whb != null)
{
whb.AutomaticFormatSelectionEnabled = true;
}
else
{
WebHttpBehavior webBehavior = new WebHttpBehavior();
webBehavior.AutomaticFormatSelectionEnabled = true;
sep.Behaviors.Add(webBehavior);
}
// Open host to start listening for messages
host.Open();
// ...
}
catch(CommunicationException ex)
{
Console.WriteLine("An exception occurred: " + ex.Message());
}
구성을 통해 자동 서식을 사용하도록 설정할 수도 있습니다. AutomaticFormatSelectionEnabled 속성을 WebHttpBehavior에 직접 설정하거나 WebHttpEndpoint를 사용하여 설정할 수 있습니다. 다음 예제에서는 WebHttpBehavior에서 자동 서식 선택 기능을 활성화하는 방법을 보여줍니다.
<system.serviceModel>
<behaviors>
<endpointBehaviors>
<behavior>
<webHttp automaticFormatSelectionEnabled="true" />
</behavior>
</endpointBehaviors>
</behaviors>
<standardEndpoints>
<webHttpEndpoint>
<!-- the "" standard endpoint is used by WebServiceHost for auto creating a web endpoint. -->
<standardEndpoint name="" helpEnabled="true" />
</webHttpEndpoint>
</standardEndpoints>
</system.serviceModel>
다음 예제에서는 을 사용하여 WebHttpEndpoint자동 서식 선택을 사용하도록 설정하는 방법을 보여 줍니다.
<system.serviceModel>
<standardEndpoints>
<webHttpEndpoint>
<!-- the "" standard endpoint is used by WebServiceHost for auto creating a web endpoint. -->
<standardEndpoint name="" helpEnabled="true" automaticFormatSelectionEnabled="true" />
</webHttpEndpoint>
</standardEndpoints>
</system.serviceModel>
명시적 서식 지정
이름에서 알 수 있듯이 명시적 서식 지정에서 개발자는 작업 코드 내에서 사용할 최상의 형식을 결정합니다. 가장 적합한 형식이 XML 또는 JSON인 경우 개발자는 다음 중 하나 Format 또는 Xml.로 설정합니다Json. 속성이 Format 명시적으로 설정되지 않은 경우 작업의 기본 형식이 사용됩니다.
다음 예제에서는 사용할 형식에 대한 형식 쿼리 문자열 매개 변수를 확인합니다. 지정된 경우에 Format를 사용하여 작업의 형식을 설정합니다.
public class Service : IService
{
[WebGet]
public string EchoWithGet(string s)
{
// if a format query string parameter has been specified, set the response format to that. If no such
// query string parameter exists the Accept header will be used
string formatQueryStringValue = WebOperationContext.Current.IncomingRequest.UriTemplateMatch.QueryParameters["format"];
if (!string.IsNullOrEmpty(formatQueryStringValue))
{
if (formatQueryStringValue.Equals("xml", System.StringComparison.OrdinalIgnoreCase))
{
WebOperationContext.Current.OutgoingResponse.Format = WebMessageFormat.Xml;
}
else if (formatQueryStringValue.Equals("json", System.StringComparison.OrdinalIgnoreCase))
{
WebOperationContext.Current.OutgoingResponse.Format = WebMessageFormat.Json;
}
else
{
throw new WebFaultException<string>($"Unsupported format '{formatQueryStringValue}'", HttpStatusCode.BadRequest);
}
}
return "You said " + s;
}
XML 또는 JSON 이외의 형식을 지원해야 하는 경우 반환 형식 Message이 되도록 작업을 정의합니다. 작업 코드 내에서 사용할 적절한 형식을 확인한 다음, 다음 방법 중 하나를 사용하여 개체를 만듭니 Message 다.
WebOperationContext.CreateAtom10Response
WebOperationContext.CreateJsonResponse
WebOperationContext.CreateStreamResponse
WebOperationContext.CreateTextResponse
WebOperationContext.CreateXmlResponse
이러한 각 메서드는 콘텐츠를 사용하고 적절한 형식의 메시지를 만듭니다. 클라이언트가 선호하는 형식 목록을 선호도 높은 순서대로 WebOperationContext.Current.IncomingRequest.GetAcceptHeaderElements
메서드를 사용하여 가져올 수 있습니다. 다음 예제에서는 사용할 형식을 결정하는 데 사용한 WebOperationContext.Current.IncomingRequest.GetAcceptHeaderElements
다음 적절한 응답 만들기 메서드를 사용하여 응답 메시지를 만드는 방법을 보여줍니다.
public class Service : IService
{
public Message EchoListWithGet(string list)
{
List<string> returnList = new List<string>(list.Split(new char[] { ',' }, StringSplitOptions.RemoveEmptyEntries));
IList<ContentType> acceptHeaderElements = WebOperationContext.Current.IncomingRequest.GetAcceptHeaderElements();
for (int x = 0; x < acceptHeaderElements.Count; x++)
{
string normalizedMediaType = acceptHeaderElements[x].MediaType.ToLowerInvariant();
switch (normalizedMediaType)
{
case "image/jpeg": return CreateJpegResponse(returnList);
case "application/xhtml+xml": return CreateXhtmlResponse(returnList);
case "application/atom+xml": return CreateAtom10Response(returnList);
case "application/xml": return CreateXmlResponse(returnList);
case "application/json": return CreateJsonResponse(returnList);
}
}
// Default response format is XML
return CreateXmlResponse(returnList);
}
}