Custom Message Encoder: Custom Text Encoder

아티클
04/08/2023

Text 샘플에서는 WCF(Windows Communication Foundation)를 사용하여 사용자 지정 문자 메시지 인코더를 구현하는 방법을 보여 줍니다.

WCF의 TextMessageEncodingBindingElement는 UTF-8, UTF-16, Big Endian 유니코드 인코딩만 지원합니다. 이 샘플의 사용자 지정 텍스트 메시지 인코더는 상호 운용성에 필요할 수 있는 모든 플랫폼에서 지원하는 문자 인코딩을 지원합니다. 이 샘플은 클라이언트 콘솔 프로그램(.exe), IIS(인터넷 정보 서비스)에서 호스팅하는 서비스 라이브러리(.dll), 텍스트 메시지 인코더 라이브러리(.dll)로 구성됩니다. 이 서비스는 요청-회신 통신 패턴을 정의하는 계약을 구현합니다. 계약은 수학 연산(Add, Subtract, Multiply 및 Divide)을 노출시키는 ICalculator 인터페이스에 의해 정의됩니다. 클라이언트에서 지정된 수학 작업을 동기적으로 요청하면 서비스에서 결과로 회신합니다. 클라이언트와 서비스는 모두 기본 CustomTextMessageEncoder 대신 TextMessageEncodingBindingElement를 사용합니다.

사용자 지정 인코더 구현은 메시지 인코더 팩터리, 메시지 인코더, 메시지 인코딩 바인딩 요소 및 구성 처리기로 구성되며 다음 방법을 보여 줍니다.

사용자 지정 인코더 및 인코더 팩터리 빌드
사용자 지정 인코더의 바인딩 요소 만들기
사용자 지정 바인딩 요소 통합에 사용자 지정 바인딩 구성 사용
사용자 지정 바인딩 요소의 파일 구성을 허용하는 사용자 지정 구성 처리기 개발

샘플을 설치, 빌드 및 실행하려면

다음 명령을 사용하여 ASP.NET 4.0을 설치합니다.

%windir%\Microsoft.NET\Framework\v4.0.XXXXX\aspnet_regiis.exe /i /enable

Windows Communication Foundation 샘플의 일회 설치 절차를 수행했는지 확인합니다.
솔루션을 빌드하려면 Windows Communication Foundation 샘플 빌드의 지침을 따릅니다.
단일 컴퓨터 또는 다중 컴퓨터 구성에서 샘플을 실행하려면 Windows Communication Foundation 샘플 실행의 지침을 따릅니다.

메시지 인코더 팩터리 및 메시지 인코더

ServiceHost 또는 클라이언트 채널이 열려 있으면 디자인 타임 구성 요소 CustomTextMessageBindingElement는 CustomTextMessageEncoderFactory를 만듭니다. 이 팩터리는 CustomTextMessageEncoder를 만듭니다. 메시지 인코더는 스트리밍 모드와 버퍼링 모드에서 모두 작동하며 XmlReader 및 XmlWriter를 사용하여 각각 메시지를 읽고 씁니다. UTF-8, UTF-16, Big-Endian 유니코드만 지원하도록 최적화된 WCF의 XML 판독기 및 작성기와 달리 이러한 판독기와 작성기는 모든 플랫폼에서 지원하는 인코딩을 지원합니다.

다음 코드 예제는 CustomTextMessageEncoder를 보여 줍니다.

public class CustomTextMessageEncoder : MessageEncoder
{
    private CustomTextMessageEncoderFactory factory;
    private XmlWriterSettings writerSettings;
    private string contentType;

    public CustomTextMessageEncoder(CustomTextMessageEncoderFactory factory)
    {
        this.factory = factory;

        this.writerSettings = new XmlWriterSettings();
        this.writerSettings.Encoding = Encoding.GetEncoding(factory.CharSet);
        this.contentType = $"{this.factory.MediaType}; charset={this.writerSettings.Encoding.HeaderName}";
    }

    public override string ContentType
    {
        get
        {
            return this.contentType;
        }
    }

    public override string MediaType
    {
        get
        {
            return factory.MediaType;
        }
    }

    public override MessageVersion MessageVersion
    {
        get
        {
            return this.factory.MessageVersion;
        }
    }

    public override Message ReadMessage(ArraySegment<byte> buffer, BufferManager bufferManager, string contentType)
    {
        byte[] msgContents = new byte[buffer.Count];
        Array.Copy(buffer.Array, buffer.Offset, msgContents, 0, msgContents.Length);
        bufferManager.ReturnBuffer(buffer.Array);

        MemoryStream stream = new MemoryStream(msgContents);
        return ReadMessage(stream, int.MaxValue);
    }

    public override Message ReadMessage(Stream stream, int maxSizeOfHeaders, string contentType)
    {
        XmlReader reader = XmlReader.Create(stream);
        return Message.CreateMessage(reader, maxSizeOfHeaders, this.MessageVersion);
    }

    public override ArraySegment<byte> WriteMessage(Message message, int maxMessageSize, BufferManager bufferManager, int messageOffset)
    {
        MemoryStream stream = new MemoryStream();
        XmlWriter writer = XmlWriter.Create(stream, this.writerSettings);
        message.WriteMessage(writer);
        writer.Close();

        byte[] messageBytes = stream.GetBuffer();
        int messageLength = (int)stream.Position;
        stream.Close();

        int totalLength = messageLength + messageOffset;
        byte[] totalBytes = bufferManager.TakeBuffer(totalLength);
        Array.Copy(messageBytes, 0, totalBytes, messageOffset, messageLength);

        ArraySegment<byte> byteArray = new ArraySegment<byte>(totalBytes, messageOffset, messageLength);
        return byteArray;
    }

    public override void WriteMessage(Message message, Stream stream)
    {
        XmlWriter writer = XmlWriter.Create(stream, this.writerSettings);
        message.WriteMessage(writer);
        writer.Close();
    }
}

다음 코드 예제는 메시지 인코더 팩터리를 빌드하는 방법을 보여 줍니다.

public class CustomTextMessageEncoderFactory : MessageEncoderFactory
{
    private MessageEncoder encoder;
    private MessageVersion version;
    private string mediaType;
    private string charSet;

    internal CustomTextMessageEncoderFactory(string mediaType, string charSet,
        MessageVersion version)
    {
        this.version = version;
        this.mediaType = mediaType;
        this.charSet = charSet;
        this.encoder = new CustomTextMessageEncoder(this);
    }

    public override MessageEncoder Encoder
    {
        get
        {
            return this.encoder;
        }
    }

    public override MessageVersion MessageVersion
    {
        get
        {
            return this.version;
        }
    }

    internal string MediaType
    {
        get
        {
            return this.mediaType;
        }
    }

    internal string CharSet
    {
        get
        {
            return this.charSet;
        }
    }
}

메시지 인코딩 바인딩 요소

바인딩 요소를 사용하면 WCF 런타임 스택을 구성할 수 있습니다. WCF 애플리케이션에서 사용자 지정 메시지 인코더를 사용하려면 런타임 스택의 적절한 수준에서 적절한 설정으로 메시지 인코더 팩터리를 만드는 바인딩 요소가 필요합니다.

CustomTextMessageBindingElement는 BindingElement 기본 클래스에서 파생되며 MessageEncodingBindingElement 클래스에서 상속됩니다. 따라서 다른 WCF 구성 요소가 이 바인딩 요소를 메시지 인코딩 바인딩 요소로 인식할 수 있습니다. CreateMessageEncoderFactory의 구현은 일치하는 메시지 인코더 팩터리의 인스턴스를 알맞은 설정과 함께 반환합니다.

CustomTextMessageBindingElement는 속성을 통해 MessageVersion, ContentType 및 Encoding에 대한 설정을 노출합니다. 인코더는 Soap11Addressing 및 Soap12Addressing1 버전을 모두 지원하며 기본값은 Soap11Addressing1입니다. ContentType의 기본값은 "text/xml"입니다. Encoding 속성을 사용하면 원하는 문자 인코딩의 값을 설정할 수 있습니다. 이 샘플의 클라이언트 및 서비스는 WCF의 TextMessageEncodingBindingElement에서는 지원되지 않는 ISO-8859-1(Latin1) 문자 인코딩을 사용합니다.

다음 코드는 사용자 지정 텍스트 메시지 인코더를 사용하여 프로그래밍 방식으로 바인딩을 만드는 방법을 보여 줍니다.

ICollection<BindingElement> bindingElements = new List<BindingElement>();
HttpTransportBindingElement httpBindingElement = new HttpTransportBindingElement();
CustomTextMessageBindingElement textBindingElement = new CustomTextMessageBindingElement();
bindingElements.Add(textBindingElement);
bindingElements.Add(httpBindingElement);
CustomBinding binding = new CustomBinding(bindingElements);

메시지 인코딩 바인딩 요소에 메타데이터 지원 추가

MessageEncodingBindingElement에서 파생되는 모든 형식은 서비스에 대해 생성된 WSDL 문서에서 SOAP 바인딩의 버전을 업데이트해야 합니다. 이 작업은 ExportEndpoint 인터페이스에서 IWsdlExportExtension 메서드를 구현한 다음 생성된 WSDL을 수정하여 수행됩니다. 이 샘플에서 CustomTextMessageBindingElement는 TextMessageEncodingBindingElement의 WSDL 내보내기 논리를 사용합니다.

이 샘플에서 클라이언트 구성은 수동 구성입니다. CustomTextMessageBindingElement는 그 동작을 설명하기 위해 정책 어설션을 내보내지 않으므로 Svcutil.exe를 사용하여 클라이언트 구성을 생성할 수 없습니다. 일반적으로 사용자 지정 바인딩 요소에서 IPolicyExportExtension 인터페이스를 구현하여 바인딩 요소에서 구현한 동작 또는 기능을 설명하는 사용자 지정 정책 어설션을 내보내야 합니다. 사용자 지정 바인딩 요소의 정책 어설션을 내보내는 방법의 예를 보려면 Transport: UDP 샘플을 참조하세요.

메시지 인코딩 바인딩 구성 처리기

이전 단원에서는 프로그래밍 방식으로 사용자 지정 텍스트 메시지 인코더를 사용하는 방법을 보여 줍니다. CustomTextMessageEncodingBindingSection은 구성 파일 내에서 사용자 지정 텍스트 메시지 인코더를 사용하도록 지정할 수 있는 구성 처리기를 구현합니다. CustomTextMessageEncodingBindingSection 클래스는 BindingElementExtensionElement 클래스에서 파생됩니다. BindingElementType 속성은 이 섹션에서 만들 바인딩 요소의 형식을 구성 시스템에 알립니다.

CustomTextMessageBindingElement에 정의된 모든 설정은 CustomTextMessageEncodingBindingSection에 속성으로 노출됩니다. ConfigurationPropertyAttribute는 구성 요소 특성을 속성에 매핑하고 특성이 설정되지 않은 경우 기본값을 설정하도록 합니다. 구성의 값이 로드되어 형식의 속성에 적용된 후에는 속성을 바인딩 요소의 구체적인 인스턴스로 변환하는 CreateBindingElement 메서드가 호출됩니다.

이 구성 처리기는 서비스나 클라이언트의 App.config 또는 Web.config에 있는 다음 표현에 매핑됩니다.

<customTextMessageEncoding encoding="utf-8" contentType="text/xml" messageVersion="Soap11Addressing1" />

이 샘플은 ISO-8859-1 인코딩을 사용합니다.

이 구성 처리기를 사용하려면 다음 구성 요소를 사용하여 등록해야 합니다.

<extensions>
    <bindingElementExtensions>
        <add name="customTextMessageEncoding" type="
Microsoft.ServiceModel.Samples.CustomTextMessageEncodingBindingSection,
                  CustomTextMessageEncoder" />
    </bindingElementExtensions>
</extensions>

다음을 통해 공유