ZayniFramework.Middle.Service.Client 2.3.2

Middleware Middle.Service.Client module example.

You have define your own business logic service by using Middle.Service module. Now you can use Middle.Service.Client module to send a RPC request, trigger a service event or publish a message to your service action.

First, add a serviceClientConfig.json in your client-side app project.

{
    "serviceClients": [
        {
            "serviceClientName": "PaymentServiceProxy",
            "remoteServiceName": "PaymentService",
            "remoteHostType": "TCPSocket",
            "remoteClient": "GCP-Production",
            "enableActionLogToDB": true
        },
        {
            "serviceClientName": "SomeService",
            "remoteServiceName": "SomeInProcessService",
            
            // This is a in-process proxy. That means the 'SomeInProcessService' is a in-process service in your client side process.
            // You will need to config the serviceHostConfig.json your client side application too!
            "remoteHostType": "InProcess",
            "enableActionLogToDB": true
        }
    ],
    "rabbitMQProtocol": {
        "defaultRemoteClient": "GCP-Production",
        "remoteClients": [
            {
                "name": "GCP-Production",
                "mbHost": "XXX",
                "mbPort": 5672,
                "mbUserId": "XXX",
                "mbPassword": "XXX",
                "mbVHost": "SomeHost",
                "defaultExchange": "Middle.Test.Topic",
                "rpc": {
                    "exchange": "Middle.Test.Topic",
                    "routingKey": "RPC.Server.",
                    "rpcReplyQueue": "Middle.Server.RPC.Res",
                    "rcpResponseTimeout": 5
                },
                "publish": {
                    "exchange": "Middle.Test.Topic",
                    "routingKey": "Event.Client."
                },
                "listen": {
                    "msgQueue": "Middle.Client.ListenServer.Msg",
                    "msgRoutingKey": "Event.Server."
                }
            }
        ]
    },
    "tcpSocketProtocol": {
        "defaultRemoteClient": "GCP-Production",
        "remoteClients": [
            {
                "name": "GCP-Production",
                "tcpServerHost": "XXX",
                "tcpServerPort": 5590,
                "tcpSendBufferSize": 5,
                "tcpReceiveBufferSize": 10,
                "connectionTimeout": 1,
                "tcpResponseTimeout": 5
            }
        ]
    },
    "webSocketProtocol": {
        "defaultRemoteClient": "GCP-Production",
        "remoteClients": [
            {
                "name": "GCP-Production",
                "webSocketHostBaseUrl": "ws://XXX.XXX.XXX.XXX:5580",
                "wsResponseTimeout": 5
            }
        ]
    },
    "gRPCProtocol": {
        "remoteClients": [
            {
                "name": "Azure-Procution",
                "serverHost": "XXX.XXX.XXX.XXX",
                "serverPort": 1155
            }
        ]
    },
    "httpCoreProtocol": {
        "remoteClients": [
            {
                "name": "GCP-Production",
                "httpHostUrl": "http://XXX.XXX.XXX.XXX:5110/action",
                "httpResponseTimeout": 5
            }
        ]
    }
}

Write your ClientProxy class and extends RemoteProxy class.<br/> Add namespace using.

using ZayniFramework.Common;
using ZayniFramework.Middle.Service.Client;

/// <summary>Some client proxy.
/// </summary>
public class PaymentProxy : RemoteProxy

Write your constructor and pass the service client name to base class.

/// <summary>預設建構子
/// </summary>
public PaymentProxy() : base( "PaymentServiceProxy" )
{
}

/// <summary>多載建構子
/// </summary>
/// <param name="path">服務客戶端 serviceClientConfig.json 設定檔的路徑</param>
public PaymentProxy( string path = "./serviceClientConfig.json" ) : base( serviceClientName: "PaymentServiceProxy", configPath: "./serviceClientConfig.json" )
{
}

Then, you can use the RemoteProxy base methods, you can send a RPC request or publish message to your Middle.Service service action.

/// <summary>執行遠端服務動作的測試
/// </summary>
public new Result<TResDTO> Execute<TReqDTO, TResDTO>( string actionName, TReqDTO request ) => base.Execute<TReqDTO, TResDTO>( actionName, request );

/// <summary>發佈 ServiceEvent 服務事件訊息的測試
/// </summary>
public new Result Publish<TMsgDTO>( string actionName, TMsgDTO dto ) => base.Publish<TMsgDTO>( actionName, dto );

You might need to register the extension IRemoteClient type into RemoteClientFactory before you create your RemoteProxy.<br/> If you don't have other extension IRemoteClient, then you won't need to do this.

// Register the 'gRPCRemoteClient' into the RemoteClientFactory. The name is 'gRPC'.
RemoteClientFactory.RegisterRemoteClientType<gRPCRemoteClient>( "gRPC" );

Finally, you can use your own ClientProxy object to send RPC request or publish message.

var paymentProxy = new PaymentProxy( "./serviceClientConfig.json" );

var reqDTO = new SomethingDTO() 
{
    SomeMessage     = "This is a message from masOS or linux.",
    SomeDate        = DateTime.Now,
    SomeMagicNumber = 24.52D,
    LuckyNumber     = 333,
    IsSuperMan      = true
};

// Send a RPC request to the ServiceHost server-side.
var r = paymentProxy.Execute<SomethingDTO, MagicDTO>( "MagicTestAction", reqDTO );

More detail sample code. You can go to Test/ServieHostTest/ServiceHost.Client.ConsoleApp directory to see the complete sample code.