사용자 지정 메시지 인코더: 압축 인코더

아티클
04/08/2023

압축 샘플은 WCF(Windows Communication Foundation) 플랫폼을 사용하여 사용자 지정 인코더를 구현하는 방법을 보여 줍니다.

샘플 세부 정보

이 샘플은 클라이언트 콘솔 프로그램(.exe), 자체 호스팅 서비스 콘솔 프로그램(.exe) 및 압축 메시지 인코더 라이브러리(.dll)로 구성됩니다. 이 서비스는 요청-회신 통신 패턴을 정의하는 계약을 구현합니다. 이 계약은 기본 문자열 echo 작업(ISampleServer 및 Echo)을 노출하는 BigEcho 인터페이스에 의해 정의됩니다. 클라이언트가 지정된 작업에 대한 동기적 요청을 만들면 서비스는 이 메시지를 다시 클라이언트에게 보내는 방법으로 회신합니다. 클라이언트와 서비스 동작은 콘솔 창에 표시됩니다. 이 샘플의 목적은 사용자 지정 인코더의 작성 방법과 통신 중 메시지 압축이 미치는 영향을 보여 주는 데 있습니다. 압축 메시지 인코더에 계측을 추가하여 메시지 크기, 처리 시간 또는 둘 다를 계산할 수 있습니다.

참고 항목

.NET Framework 4의 WCF 클라이언트에서는 서버에서 GZip 또는 Deflate 같은 알고리즘으로 만들어진 압축된 응답을 보낼 경우 자동 압축 해제가 사용하도록 설정되어 있습니다. 서비스가 IIS(인터넷 정보 서버)에 웹 호스팅된 경우 서비스에서 압축된 응답을 보낼 수 있도록 IIS를 구성할 수 있습니다. 이 샘플은 클라이언트와 서비스 모두에서 압축 및 압축 해제를 수행하거나 서비스가 자체 호스팅되는 경우에 사용할 수 있습니다.

샘플은 사용자 지정 메시지 인코더를 빌드하고 WCF 애플리케이션에 통합하는 방법을 보여 줍니다. 라이브러리 GZipEncoder.dll은 클라이언트와 서비스 모두와 함께 배포됩니다. 또한 이 샘플에서는 메시지 압축이 미치는 영향을 보여 줍니다. GZipEncoder.dll의 코드는 다음 작업을 보여 줍니다.

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

앞에서 설명한 대로 사용자 지정 인코더에는 몇 개의 계층이 구현됩니다. 이 각 계층 간의 관계를 더 명확하게 보여 주기 위해 서비스 시작을 위한 간단한 이벤트 순서는 다음 목록과 같습니다.

서버가 시작합니다.
구성 정보를 읽습니다.
1. 서버 구성이 사용자 지정 구성 처리기를 등록합니다.
2. 서버 호스트가 만들어지고 열립니다.
3. 사용자 지정 구성 요소가 사용자 지정 바인딩 요소를 만들어 반환합니다.
4. 사용자 지정 바인딩 요소가 메시지 인코더 팩터리를 만들어 반환합니다.
메시지가 수신됩니다.
메시지 인코더 팩터리는 메시지를 읽고 응답을 기록하기 위한 메시지 인코더를 반환합니다.
인코더 계층이 클래스 팩터리로 구현됩니다. 인코더 클래스 팩터리만 사용자 지정 인코더에 대해 공개적으로 노출되어야 합니다. ServiceHost 또는 ChannelFactory<TChannel> 개체가 만들어질 때 바인딩 요소가 팩터리 개체를 반환합니다. 메시지 인코더는 버퍼링 모드 또는 스트리밍 모드에서 작동할 수 있습니다. 이 샘플에서는 버퍼링 모드와 스트리밍 모드를 모두 보여 줍니다.

각 모드에 대해 추상 ReadMessage 클래스에 관련 WriteMessage 및 MessageEncoder 메서드가 있습니다. 인코딩 작업 중 대부분은 이 메서드에서 수행됩니다. 이 샘플은 기존 텍스트 및 이진 메시지 인코더를 래핑합니다. 따라서 샘플에서 메시지 연결 표시의 읽기 및 쓰기를 내부 인코더로 위임할 수 있고 압축 인코더가 그 결과를 압축하거나 압축을 풀 수 있습니다. 메시지 인코딩을 위한 파이프라인이 없으므로 이는 WCF에서 여러 인코더를 사용하는 경우의 유일한 모델입니다. 메시지의 압축을 풀었으면 결과 메시지는 채널 스택에서 처리하도록 스택을 따라 위로 전달됩니다. 압축 과정에서 압축된 결과 메시지는 제공된 스트림에 직접 기록됩니다.

이 샘플에서는 CompressBuffer 클래스를 사용하기 위해 도우미 메서드(DecompressBuffer 및 GZipStream)를 사용하여 버퍼에서 스트림으로의 변환을 수행합니다.

버퍼링된 ReadMessage 및 WriteMessage 클래스는 BufferManager 클래스를 사용합니다. 인코더는 인코더 팩터리를 통해서만 액세스할 수 있습니다. 추상 MessageEncoderFactory 클래스는 현재 인코더에 액세스하기 위해 Encoder라는 이름의 속성을, 세션을 지원하는 인코더를 만들기 위해 CreateSessionEncoder라는 이름의 메서드를 제공합니다. 이러한 인코더는 채널이 세션을 지원하는 시나리오에서 사용 가능하며 순서가 지정되었고 신뢰할 수 있습니다. 이 시나리오에서는 연결 중에 기록된 데이터의 세션별로 최적화를 허용합니다. 이를 원치 않을 경우 기본 메서드를 오버로드해서는 안 됩니다. Encoder 속성은 세션 없는 인코더에 액세스하기 위한 메커니즘을 제공하며 CreateSessionEncoder 메서드의 기본 구현은 속성의 값을 반환합니다. 이 샘플에서는 압축을 제공하기 위해 기존 인코더를 래핑하므로 MessageEncoderFactory 구현은 내부 인코더 팩터리를 나타내는 MessageEncoderFactory를 허용합니다.

인코더 및 인코더 팩터리가 정의되었으므로 WCF 클라이언트 및 서비스와 함께 사용할 수 있습니다. 그러나 이 인코더가 채널 스택에 추가되어야 합니다. ServiceHost 및 ChannelFactory<TChannel> 클래스로부터 클래스를 파생하고 OnInitialize 메서드를 재정의하여 이 인코더 팩터리를 수동으로 추가할 수 있습니다. 또한 사용자 지정 바인딩 요소를 통해 인코더 팩터리를 노출할 수도 있습니다.

새 사용자 지정 바인딩 요소를 만들려면 BindingElement 클래스로부터 클래스를 파생합니다. 그러나 바인딩 요소에는 몇 가지 형식이 있습니다. 사용자 지정 바인딩 요소가 메시지 인코딩 바인딩 요소로 인식되기 위해서는 MessageEncodingBindingElement도 구현해야 합니다. MessageEncodingBindingElement는 새 메시지 인코더를 만들기 위한 메서드 팩터리(CreateMessageEncoderFactory)를 노출하며 이는 일치하는 메시지 인코더 팩터리의 인스턴스를 반환하기 위해 구현됩니다. 또한 MessageEncodingBindingElement는 주소 지정 버전을 나타내는 속성을 갖습니다. 이 샘플에서 기존 인코더를 래핑하기 때문에 샘플 구현 시 기존 인코더 바인딩 요소도 래핑하며 내부 인코더 바인딩 요소를 생성자의 매개 변수로 받아 어떤 속성을 통해 노출합니다. 다음 샘플 코드에서는 GZipMessageEncodingBindingElement 클래스의 구현을 보여 줍니다.

public sealed class GZipMessageEncodingBindingElement
                        : MessageEncodingBindingElement //BindingElement
                        , IPolicyExportExtension
{

    //We use an inner binding element to store information
    //required for the inner encoder.
    MessageEncodingBindingElement innerBindingElement;

        //By default, use the default text encoder as the inner encoder.
        public GZipMessageEncodingBindingElement()
            : this(new TextMessageEncodingBindingElement()) { }

    public GZipMessageEncodingBindingElement(MessageEncodingBindingElement messageEncoderBindingElement)
    {
        this.innerBindingElement = messageEncoderBindingElement;
    }

    public MessageEncodingBindingElement InnerMessageEncodingBindingElement
    {
        get { return innerBindingElement; }
        set { innerBindingElement = value; }
    }

    //Main entry point into the encoder binding element.
    // Called by WCF to get the factory that creates the
    //message encoder.
    public override MessageEncoderFactory CreateMessageEncoderFactory()
    {
        return new
GZipMessageEncoderFactory(innerBindingElement.CreateMessageEncoderFactory());
    }

    public override MessageVersion MessageVersion
    {
        get { return innerBindingElement.MessageVersion; }
        set { innerBindingElement.MessageVersion = value; }
    }

    public override BindingElement Clone()
    {
        return new
        GZipMessageEncodingBindingElement(this.innerBindingElement);
    }

    public override T GetProperty<T>(BindingContext context)
    {
        if (typeof(T) == typeof(XmlDictionaryReaderQuotas))
        {
            return innerBindingElement.GetProperty<T>(context);
        }
        else
        {
            return base.GetProperty<T>(context);
        }
    }

    public override IChannelFactory<TChannel> BuildChannelFactory<TChannel>(BindingContext context)
    {
        if (context == null)
            throw new ArgumentNullException("context");

        context.BindingParameters.Add(this);
        return context.BuildInnerChannelFactory<TChannel>();
    }

    public override IChannelListener<TChannel> BuildChannelListener<TChannel>(BindingContext context)
    {
        if (context == null)
            throw new ArgumentNullException("context");

        context.BindingParameters.Add(this);
        return context.BuildInnerChannelListener<TChannel>();
    }

    public override bool CanBuildChannelListener<TChannel>(BindingContext context)
    {
        if (context == null)
            throw new ArgumentNullException("context");

        context.BindingParameters.Add(this);
        return context.CanBuildInnerChannelListener<TChannel>();
    }

    void IPolicyExportExtension.ExportPolicy(MetadataExporter exporter, PolicyConversionContext policyContext)
    {
        if (policyContext == null)
        {
            throw new ArgumentNullException("policyContext");
        }
       XmlDocument document = new XmlDocument();
       policyContext.GetBindingAssertions().Add(document.CreateElement(
            GZipMessageEncodingPolicyConstants.GZipEncodingPrefix,
            GZipMessageEncodingPolicyConstants.GZipEncodingName,
            GZipMessageEncodingPolicyConstants.GZipEncodingNamespace));
    }
}

GZipMessageEncodingBindingElement 클래스가 IPolicyExportExtension 인터페이스를 구현하므로 다음 예제에서와 같이 이 바인딩 요소는 메타데이터에 정책으로 내보낼 수 있습니다.

<wsp:Policy wsu:Id="BufferedHttpSampleServer_ISampleServer_policy">
    <wsp:ExactlyOne>
      <wsp:All>
        <gzip:text xmlns:gzip=
        "http://schemas.microsoft.com/ws/06/2004/mspolicy/netgzip1" />
       <wsaw:UsingAddressing />
     </wsp:All>
   </wsp:ExactlyOne>
</wsp:Policy>

GZipMessageEncodingBindingElementImporter 클래스는 IPolicyImportExtension 인터페이스를 구현하고 이 클래스는 GZipMessageEncodingBindingElement를 위한 정책을 가져옵니다. Svcutil.exe 도구는 정책을 구성 파일로 가져올 때 사용할 수 있습니다. GZipMessageEncodingBindingElement를 처리하려면 Svcutil.exe.config에 다음을 추가해야 합니다.

<configuration>
  <system.serviceModel>
    <extensions>
      <bindingElementExtensions>
        <add name="gzipMessageEncoding"
          type=
            "Microsoft.ServiceModel.Samples.GZipMessageEncodingElement, GZipEncoder, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" />
      </bindingElementExtensions>
    </extensions>
    <client>
      <metadata>
        <policyImporters>
          <remove type=
"System.ServiceModel.Channels.MessageEncodingBindingElementImporter, System.ServiceModel, Version=3.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" />
          <extension type=
"Microsoft.ServiceModel.Samples.GZipMessageEncodingBindingElementImporter, GZipEncoder, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" />
        </policyImporters>
      </metadata>
    </client>
  </system.serviceModel>
</configuration>

이제 압축 인코더에 일치하는 바인딩 요소가 있으므로 프로그래밍 방식으로 이를 서비스 또는 클라이언트에 후크할 수 있습니다. 다음 샘플 코드에서와 같이 새 사용자 지정 바인딩 개체를 생성하고 사용자 지정 바인딩 요소를 개체에 추가하면 됩니다.

ICollection<BindingElement> bindingElements = new List<BindingElement>();
HttpTransportBindingElement httpBindingElement = new HttpTransportBindingElement();
GZipMessageEncodingBindingElement compBindingElement = new GZipMessageEncodingBindingElement ();
bindingElements.Add(compBindingElement);
bindingElements.Add(httpBindingElement);
CustomBinding binding = new CustomBinding(bindingElements);
binding.Name = "SampleBinding";
binding.Namespace = "http://tempuri.org/bindings";

대부분의 사용자 시나리오에서는 이 정도로 충분할 수 있지만 서비스가 웹 호스팅되는 경우 파일 구성 지원이 중요합니다. 웹 호스팅되는 시나리오를 지원하려면 파일에서 사용자 지정 바인딩 요소를 구성할 수 있도록 사용자 지정 구성 처리기를 개발해야 합니다.

구성 시스템 위에 바인딩 요소에 대한 구성 처리기를 빌드할 수 있습니다. 바인딩 요소의 구성 처리기는 BindingElementExtensionElement 클래스에서 파생되어야 합니다. BindingElementExtensionElement.BindingElementType은 이 섹션에 대해 만들 바인딩 요소 형식을 구성 시스템에 알립니다. 설정 가능한 모든 BindingElement의 요소는 BindingElementExtensionElement 파생 클래스에서 속성으로 노출되어야 합니다. ConfigurationPropertyAttribute는 구성 요소 특성을 속성에 매핑하고 특성이 누락된 경우 기본값을 설정하는 데 도움이 됩니다. 구성으로부터 값이 로드되어 속성에 적용된 후 BindingElementExtensionElement.CreateBindingElement 메서드가 호출되며 이 메서드는 속성을 바인딩 요소의 구체적인 인스턴스로 변환합니다. BindingElementExtensionElement 파생 클래스의 속성을 새로 만들어진 바인딩 요소에서 설정될 값으로 변환하기 위해 BindingElementExtensionElement.ApplyConfiguration 메서드가 사용됩니다.

다음 샘플 코드에서는 GZipMessageEncodingElement의 구현을 보여 줍니다.

public class GZipMessageEncodingElement : BindingElementExtensionElement
{
    public GZipMessageEncodingElement()
    {
    }

//Called by the WCF to discover the type of binding element this
//config section enables
    public override Type BindingElementType
    {
        get { return typeof(GZipMessageEncodingBindingElement); }
    }

    //The only property we need to configure for our binding element is
    //the type of inner encoder to use. Here, we support text and
    //binary.
    [ConfigurationProperty("innerMessageEncoding",
                         DefaultValue = "textMessageEncoding")]
    public string InnerMessageEncoding
    {
        get { return (string)base["innerMessageEncoding"]; }
        set { base["innerMessageEncoding"] = value; }
    }

    //Called by the WCF to apply the configuration settings (the
    //property above) to the binding element
    public override void ApplyConfiguration(BindingElement bindingElement)
    {
        GZipMessageEncodingBindingElement binding =
                (GZipMessageEncodingBindingElement)bindingElement;
        PropertyInformationCollection propertyInfo =
                    this.ElementInformation.Properties;
        if (propertyInfo["innerMessageEncoding"].ValueOrigin !=
                                     PropertyValueOrigin.Default)
        {
            switch (this.InnerMessageEncoding)
            {
                case "textMessageEncoding":
                    binding.InnerMessageEncodingBindingElement =
                      new TextMessageEncodingBindingElement();
                    break;
                case "binaryMessageEncoding":
                    binding.InnerMessageEncodingBindingElement =
                         new BinaryMessageEncodingBindingElement();
                    break;
            }
        }
    }

    //Called by the WCF to create the binding element
    protected override BindingElement CreateBindingElement()
    {
        GZipMessageEncodingBindingElement bindingElement =
                new GZipMessageEncodingBindingElement();
        this.ApplyConfiguration(bindingElement);
        return bindingElement;
    }
}

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

<gzipMessageEncoding innerMessageEncoding="textMessageEncoding" />

이 구성 처리기를 사용하려면 다음 샘플 구성과 같이 <system.serviceModel> 요소 내에 등록해야 합니다.

<extensions>
    <bindingElementExtensions>
       <add
           name="gzipMessageEncoding"
           type=
           "Microsoft.ServiceModel.Samples.GZipMessageEncodingElement,
           GZipEncoder, Version=1.0.0.0, Culture=neutral,
           PublicKeyToken=null" />
      </bindingElementExtensions>
</extensions>

서버를 실행하면 작업 요청 및 응답이 콘솔 창에 표시됩니다. 서버를 종료하려면 창에서 Enter 키를 누릅니다.

Press Enter key to Exit.

        Server Echo(string input) called:
        Client message: Simple hello

        Server BigEcho(string[] input) called:
        64 client messages

클라이언트를 실행하면 작업 요청 및 응답이 콘솔 창에 표시됩니다. 클라이언트를 종료하려면 클라이언트 창에서 Enter 키를 누릅니다.

Calling Echo(string):
Server responds: Simple hello Simple hello

Calling BigEcho(string[]):
Server responds: Hello 0

Press <ENTER> to terminate client.

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

다음 명령을 사용하여 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 샘플 실행의 지침을 따릅니다.

다음을 통해 공유

사용자 지정 메시지 인코더: 압축 인코더

샘플 세부 정보

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

추가 리소스