Dreamine.Communication.Core.Protocols.RawJsonProtocolAdapter 클래스 참조

더 자세히 ...

Dreamine.Communication.Core.Protocols.RawJsonProtocolAdapter에 대한 상속 다이어그램 :

Dreamine.Communication.Core.Protocols.RawJsonProtocolAdapter에 대한 협력 다이어그램:

Public 멤버 함수
	RawJsonProtocolAdapter ()
	RawJsonProtocolAdapter (string defaultRoute, string defaultName)
	RawJsonProtocolAdapter (Encoding encoding, string defaultRoute, string defaultName)
	RawJsonProtocolAdapter (RawJsonProtocolOptions options)
MessageEnvelope	Decode (byte[] payload)
byte[]	Encode (MessageEnvelope message)

속성
bool	NormalizePayloadToUtf8 [get]

정적 Private 멤버 함수
static ? string	TryGetString (JsonElement root, string propertyName)

Private 속성
readonly Encoding	_encoding
readonly string	_defaultRoute
readonly string	_defaultName

상세한 설명

고정 스키마가 없는 외부 JSON을 Dreamine 메시지 봉투로 감싸고 다시 송신 데이터로 변환합니다.

RawJsonProtocolAdapter.cs 파일의 16 번째 라인에서 정의되었습니다.

생성자 & 소멸자 문서화

RawJsonProtocolAdapter() [1/4]

Dreamine.Communication.Core.Protocols.RawJsonProtocolAdapter.RawJsonProtocolAdapter ( )

inline

기본 원시 JSON 설정으로 어댑터를 초기화합니다.

RawJsonProtocolAdapter.cs 파일의 54 번째 라인에서 정의되었습니다.

        : this(new RawJsonProtocolOptions())
    {
    }

RawJsonProtocolAdapter() [2/4]

Dreamine.Communication.Core.Protocols.RawJsonProtocolAdapter.RawJsonProtocolAdapter ( string defaultRoute, string defaultName )

inline

기본 라우트와 이름을 지정하여 어댑터를 초기화합니다.

매개변수

defaultRoute	JSON에서 라우트를 찾지 못할 때 사용할 값입니다.
defaultName	JSON에서 이름을 찾지 못할 때 사용할 값입니다.

예외

ArgumentException

기본 라우트 또는 이름이 비어 있는 경우 발생합니다.

RawJsonProtocolAdapter.cs 파일의 91 번째 라인에서 정의되었습니다.

        : this(new RawJsonProtocolOptions
        {
            DefaultRoute = defaultRoute,
            DefaultName = defaultName
        })
    {
    }

RawJsonProtocolAdapter() [3/4]

Dreamine.Communication.Core.Protocols.RawJsonProtocolAdapter.RawJsonProtocolAdapter ( Encoding encoding, string defaultRoute, string defaultName )

inline

외부 인코딩과 기본 메시지 메타데이터로 어댑터를 초기화합니다.

매개변수

encoding	외부 JSON 송수신에 사용할 인코딩입니다.
defaultRoute	라우트 추출 실패 시 사용할 값입니다.
defaultName	이름 추출 실패 시 사용할 값입니다.

예외

ArgumentNullException	encoding 이 null인 경우 발생합니다.
ArgumentException	기본 라우트 또는 이름이 비어 있는 경우 발생합니다.

RawJsonProtocolAdapter.cs 파일의 148 번째 라인에서 정의되었습니다.

        : this(new RawJsonProtocolOptions
        {
            Encoding = encoding ?? throw new ArgumentNullException(nameof(encoding)),
            DefaultRoute = defaultRoute,
            DefaultName = defaultName
        })
    {
    }

RawJsonProtocolAdapter() [4/4]

Dreamine.Communication.Core.Protocols.RawJsonProtocolAdapter.RawJsonProtocolAdapter ( RawJsonProtocolOptions options )

inline

지정한 원시 JSON 설정으로 어댑터를 초기화합니다.

매개변수

options

인코딩과 기본 메시지 메타데이터 설정입니다.

예외

ArgumentNullException	설정 또는 해당 인코딩이 null인 경우 발생합니다.
ArgumentException	설정의 기본 라우트 또는 이름이 비어 있는 경우 발생합니다.

RawJsonProtocolAdapter.cs 파일의 193 번째 라인에서 정의되었습니다.

    {
        ArgumentNullException.ThrowIfNull(options);
        ArgumentException.ThrowIfNullOrWhiteSpace(options.DefaultRoute);
        ArgumentException.ThrowIfNullOrWhiteSpace(options.DefaultName);
 
        _encoding = options.Encoding ?? throw new ArgumentNullException(nameof(options.Encoding));
        _defaultRoute = options.DefaultRoute;
        _defaultName = options.DefaultName;
        NormalizePayloadToUtf8 = options.NormalizePayloadToUtf8;
    }

다음을 참조함 : _defaultName, _defaultRoute, _encoding, Dreamine.Communication.Core.Protocols.RawJsonProtocolOptions.DefaultName, Dreamine.Communication.Core.Protocols.RawJsonProtocolOptions.DefaultRoute, Dreamine.Communication.Core.Protocols.RawJsonProtocolOptions.Encoding, NormalizePayloadToUtf8, Dreamine.Communication.Core.Protocols.RawJsonProtocolOptions.NormalizePayloadToUtf8.

멤버 함수 문서화

Decode()

MessageEnvelope Dreamine.Communication.Core.Protocols.RawJsonProtocolAdapter.Decode ( byte[] payload )

inline

원시 JSON을 분석하여 라우트와 이름을 가진 메시지 봉투로 변환합니다.

매개변수

payload

수신한 외부 JSON 바이트입니다.

반환값

JSON 페이로드와 추출한 메타데이터를 가진 메시지입니다.

예외

ArgumentNullException	payload 가 null인 경우 발생합니다.
JsonException	페이로드가 올바른 JSON 문서가 아닌 경우 발생합니다.

RawJsonProtocolAdapter.cs 파일의 255 번째 라인에서 정의되었습니다.

    {
        ArgumentNullException.ThrowIfNull(payload);
 
        var json = _encoding.GetString(payload);
        string route;
        string name;
 
        using (var document = JsonDocument.Parse(json))
        {
            var root = document.RootElement;
 
            route = TryGetString(root, "route")
                    ?? TryGetString(root, "Route")
                    ?? TryGetString(root, "routingKey")
                    ?? TryGetString(root, "topic")
                    ?? TryGetString(root, "type")
                    ?? TryGetString(root, "cmd")
                    ?? _defaultRoute;
 
            name = TryGetString(root, "name")
                   ?? TryGetString(root, "Name")
                   ?? TryGetString(root, "type")
                   ?? TryGetString(root, "cmd")
                   ?? _defaultName;
        }
 
        return new MessageEnvelope
        {
            Name = name,
            Route = route,
            Payload = NormalizePayloadToUtf8
                ? Encoding.UTF8.GetBytes(json)
                : _encoding.GetBytes(json),
            Headers = new Dictionary<string, string>
            {
                ["ContentType"] = "application/json",
                ["Protocol"] = "RawJson",
                ["ExternalEncoding"] = _encoding.WebName
            }
        };
    }

다음을 참조함 : _defaultName, _defaultRoute, _encoding, NormalizePayloadToUtf8, TryGetString().

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

Encode()

byte[] Dreamine.Communication.Core.Protocols.RawJsonProtocolAdapter.Encode ( MessageEnvelope message )

inline

메시지 페이로드 또는 메타데이터를 외부 인코딩의 JSON 바이트로 변환합니다.

매개변수

message

송신할 메시지입니다.

반환값

외부 시스템으로 송신할 JSON 바이트입니다.

예외

ArgumentNullException

message 가 null인 경우 발생합니다.

RawJsonProtocolAdapter.cs 파일의 330 번째 라인에서 정의되었습니다.

    {
        ArgumentNullException.ThrowIfNull(message);
 
        if (message.Payload.Length > 0)
        {
            var json = Encoding.UTF8.GetString(message.Payload);
            return _encoding.GetBytes(json);
        }
 
        var generatedJson = JsonSerializer.Serialize(new
        {
            name = message.Name,
            route = message.Route
        });
 
        return _encoding.GetBytes(generatedJson);
    }

다음을 참조함 : _encoding.

TryGetString()

? string Dreamine.Communication.Core.Protocols.RawJsonProtocolAdapter.TryGetString ( JsonElement root, string propertyName )

inlinestaticprivate

JSON 루트에서 지정한 속성을 찾아 문자열 표현으로 반환합니다.

매개변수

root	검색할 JSON 루트 요소입니다.
propertyName	찾을 속성 이름입니다.

반환값

속성의 문자열 값이며, 속성이 없으면 null입니다.

RawJsonProtocolAdapter.cs 파일의 381 번째 라인에서 정의되었습니다.

    {
        if (!root.TryGetProperty(propertyName, out var property))
        {
            return null;
        }
 
        return property.ValueKind == JsonValueKind.String
            ? property.GetString()
            : property.ToString();
    }

다음에 의해서 참조됨 : Decode().

이 함수를 호출하는 함수들에 대한 그래프입니다.:

멤버 데이터 문서화

_defaultName

readonly string Dreamine.Communication.Core.Protocols.RawJsonProtocolAdapter._defaultName

private

default Name 값을 보관합니다.

RawJsonProtocolAdapter.cs 파일의 44 번째 라인에서 정의되었습니다.

다음에 의해서 참조됨 : Decode(), RawJsonProtocolAdapter().

_defaultRoute

readonly string Dreamine.Communication.Core.Protocols.RawJsonProtocolAdapter._defaultRoute

private

default Route 값을 보관합니다.

RawJsonProtocolAdapter.cs 파일의 35 번째 라인에서 정의되었습니다.

다음에 의해서 참조됨 : Decode(), RawJsonProtocolAdapter().

_encoding

readonly Encoding Dreamine.Communication.Core.Protocols.RawJsonProtocolAdapter._encoding

private

encoding 값을 보관합니다.

RawJsonProtocolAdapter.cs 파일의 26 번째 라인에서 정의되었습니다.

다음에 의해서 참조됨 : Decode(), Encode(), RawJsonProtocolAdapter().

속성 문서화

NormalizePayloadToUtf8

bool Dreamine.Communication.Core.Protocols.RawJsonProtocolAdapter.NormalizePayloadToUtf8

get

디코딩한 JSON 페이로드를 내부 UTF-8 형식으로 정규화할지 여부를 가져옵니다.

RawJsonProtocolAdapter.cs 파일의 213 번째 라인에서 정의되었습니다.

{ get; }

다음에 의해서 참조됨 : Decode(), RawJsonProtocolAdapter().

---

이 클래스에 대한 문서화 페이지는 다음의 파일로부터 생성되었습니다.:

• RawJsonProtocolAdapter.cs