Getting Started with gRPC-Go - Streaming

1. مقدمة

في هذا الدرس العملي، ستستخدم gRPC-Go لإنشاء عميل وخادم يشكّلان أساس تطبيق لربط المسارات مكتوب بلغة Go.

في نهاية هذا البرنامج التعليمي، سيكون لديك برنامج يتصل بخادم بعيد باستخدام gRPC للحصول على معلومات حول الميزات على مسار العميل، وإنشاء ملخّص لمسار العميل، وتبادل معلومات المسار، مثل آخر الأخبار عن حركة المرور، مع الخادم والعملاء الآخرين.

يتم تحديد الخدمة في ملف Protocol Buffers، وسيتم استخدام هذا الملف لإنشاء رمز نموذجي للبرنامج العميل والخادم حتى يتمكّنا من التواصل مع بعضهما البعض، ما يوفّر عليك الوقت والجهد في تنفيذ هذه الوظيفة.

لا يهتم هذا الرمز الذي تم إنشاؤه بتعقيدات الاتصال بين الخادم والعميل فحسب، بل أيضًا بتسلسل البيانات وإلغاء تسلسلها.

أهداف الدورة التعليمية

• كيفية استخدام مخزن البروتوكولات المؤقت لتحديد واجهة برمجة تطبيقات الخدمة
• كيفية إنشاء برنامج عميل وخادم يستندان إلى gRPC من تعريف Protocol Buffers باستخدام إنشاء الرموز البرمجية المبرمَج
• فهم عملية نقل البيانات المتدفقة بين العميل والخادم باستخدام gRPC

هذا الدرس التطبيقي حول الترميز موجّه لمطوّري Go الجدد على gRPC أو الذين يريدون مراجعة gRPC، أو أي شخص آخر مهتم بإنشاء أنظمة موزّعة. لا يُشترط توفّر خبرة سابقة في gRPC.

2. قبل البدء

المتطلبات الأساسية

تأكَّد من تثبيت ما يلي:

• الإصدار 1.24.5 أو الإصدارات الأحدث من سلسلة أدوات Go للحصول على تعليمات التثبيت، يُرجى الاطّلاع على دليل البدء في Go.
• برنامج تجميع البيانات المنظّمة protoc، الإصدار 3.27.1 أو إصدار أحدث للحصول على تعليمات التثبيت، يُرجى الاطّلاع على دليل التثبيت الخاص بالمترجم.
• مكوّنات إضافية لبرنامج تحويل مخزن البروتوكولات المؤقت إلى Go وgRPC لتثبيت هذه المكوّنات الإضافية، شغِّل الأوامر التالية:

go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest

عدِّل المتغيّر PATH ليتمكّن برنامج تجميع المخزن المؤقت للبروتوكول من العثور على المكوّنات الإضافية:

export PATH="$PATH:$(go env GOPATH)/bin"

الحصول على الشفرة‏

ولكي لا تضطر إلى البدء من الصفر تمامًا، يوفّر لك هذا الدرس التطبيقي حول الترميز بنية أساسية لرمز المصدر الخاص بالتطبيق لتتمكّن من إكماله. ستوضّح لك الخطوات التالية كيفية إكمال التطبيق، بما في ذلك استخدام مكوّنات برنامج تجميع بروتوكول المخزن المؤقت لإنشاء رمز gRPC النموذجي.

أولاً، أنشئ دليل عمل الدرس التطبيقي وcd فيه:

mkdir streaming-grpc-go-getting-started && cd streaming-grpc-go-getting-started

نزِّل الدرس التطبيقي حول الترميز واستخرِجه:

curl -sL https://github.com/grpc-ecosystem/grpc-codelabs/archive/refs/heads/v1.tar.gz \
  | tar xvz --strip-components=4 \
  grpc-codelabs-1/codelabs/grpc-go-streaming/start_here

بدلاً من ذلك، يمكنك تنزيل ملف ‎ .zip الذي يحتوي على دليل الدرس العملي فقط وفك ضغطه يدويًا.

تنزيل ملف Zip

يتوفّر رمز المصدر المكتمل على GitHub إذا أردت تخطّي كتابة عملية التنفيذ.

3- تحديد الرسائل والخدمات

تتمثّل خطوتك الأولى في تحديد خدمة gRPC الخاصة بالتطبيق وطُرق RPC وأنواع رسائل الطلبات والاستجابات باستخدام بروتوكول المخازن المؤقتة. ستوفّر خدمتك ما يلي:

• طُرق استدعاء الإجراء عن بُعد (RPC) التي تحمل الأسماء ListFeatures وRecordRoute وRouteChat والتي ينفّذها الخادم ويستدعيها العميل
• أنواع الرسائل Point وFeature وRectangle وRouteNote وRouteSummary، وهي عبارة عن بنى بيانات يتم تبادلها بين العميل والخادم عند استدعاء الطرق المذكورة أعلاه.

سيتم تحديد جميع طرق RPC وأنواع الرسائل هذه في ملف routeguide/route_guide.proto لرمز المصدر المقدَّم.

يُشار إلى Protocol Buffers عادةً باسم protobufs. لمزيد من المعلومات عن مصطلحات gRPC، يُرجى الاطّلاع على المفاهيم الأساسية والبنية ودورة الحياة في gRPC.

تحديد أنواع الرسائل

في ملف routeguide/route_guide.proto الخاص بالرمز المصدر، حدِّد أولاً نوع الرسالة Point. يمثّل Point زوج إحداثيات خط العرض وخط الطول على الخريطة. في هذا الدرس العملي، استخدِم أعدادًا صحيحة للإحداثيات:

message Point {
  int32 latitude = 1;
  int32 longitude = 2;
}

الرقمان 1 و2 هما رقما تعريف فريدان لكل حقل من الحقول في بنية message.

بعد ذلك، حدِّد Feature نوع الرسالة. يستخدم Feature الحقل string للاسم أو العنوان البريدي الخاص بمكان محدّد من خلال Point:

message Feature {
  // The name or address of the feature.
  string name = 1;

  // The point where the feature is located.
  Point location = 2;
}

يلي ذلك رسالة Rectangle تمثّل مستطيلاً لخطوط الطول والعرض، ويتم تمثيله كنقطتَين متقابلتَين قطريًا "lo" و "hi".

message Rectangle {
  // One corner of the rectangle.
  Point lo = 1;

  // The other corner of the rectangle.
  Point hi = 2;
}

RouteNote رسالة تمثّل رسالة تم إرسالها في نقطة معيّنة.

message RouteNote {
  // The location from which the message is sent.
  Point location = 1;

  // The message to be sent.
  string message = 2;
}

سنحتاج أيضًا إلى رسالة RouteSummary. يتم تلقّي هذه الرسالة ردًا على RecordRoute RPC موضّحة في القسم التالي. يحتوي هذا الملف على عدد النقاط الفردية التي تم تلقّيها وعدد الميزات التي تم رصدها وإجمالي المسافة المقطوعة كمجموع تراكمي للمسافة بين كل نقطة.

message RouteSummary {
  // The number of points received.
  int32 point_count = 1;

  // The number of known features passed while traversing the route.
  int32 feature_count = 2;

  // The distance covered in metres.
  int32 distance = 3;

  // The duration of the traversal in seconds.
  int32 elapsed_time = 4;
}

تحديد طرق الخدمة

لتحديد خدمة، عليك تحديد خدمة مسماة في ملف ‎ .proto. يحتوي ملف route_guide.proto على بنية service باسم RouteGuide تحدّد طريقة واحدة أو أكثر تقدّمها خدمة التطبيق.

حدِّد طرق RPC داخل تعريف الخدمة، مع تحديد أنواع الطلبات والاستجابات. في هذا القسم من الدرس العملي، لنحدّد ما يلي:

ListFeatures

يحصل على Features المتاحة ضمن Rectangle المحدّدة. يتم بث النتائج بدلاً من عرضها دفعة واحدة (مثلاً في رسالة رد تتضمّن حقلًا متكرّرًا)، لأنّ المستطيل قد يغطّي مساحة كبيرة ويحتوي على عدد كبير من العناصر.

إنّ النوع المناسب لهذا الإجراء عن بُعد هو إجراء عن بُعد بث من جهة الخادم: يرسل البرنامج العميل طلبًا إلى الخادم ويتلقّى بثًا لقراءة سلسلة من الرسائل. يقرأ العميل من البث الذي تم إرجاعه إلى أن لا تتبقى أي رسائل. كما ترى في مثالنا، يمكنك تحديد طريقة البث من جهة الخادم عن طريق وضع الكلمة الرئيسية stream قبل نوع الاستجابة.

rpc ListFeatures(Rectangle) returns (stream Feature) {}

RecordRoute

تقبل هذه السمة سلسلة من Points على مسار يتم اجتيازه، وتعرض RouteSummary عند اكتمال عملية الاجتياز.

يبدو أنّ طلب إجراء RPC للبث من جهة العميل مناسب في هذه الحالة: يكتب العميل سلسلة من الرسائل ويرسلها إلى الخادم، وذلك باستخدام بث متوفّر أيضًا. بعد أن ينتهي العميل من كتابة الرسائل، ينتظر أن يقرأها الخادم كلها ويرسل رده. يمكنك تحديد طريقة البث من جهة العميل عن طريق وضع الكلمة الرئيسية stream قبل نوع الطلب.

rpc RecordRoute(stream Point) returns (RouteSummary) {}

RouteChat

يقبل هذا النوع سلسلة من RouteNotes يتم إرسالها أثناء التنقّل في مسار، مع تلقّي RouteNotes أخرى (مثل تلك الواردة من مستخدمين آخرين).

هذه هي بالضبط حالة الاستخدام المناسبة للبث ثنائي الاتجاه. يتم في استدعاء الإجراء عن بُعد (RPC) ثنائي الاتجاه إرسال تسلسل من الرسائل من كلا الجانبين باستخدام بث للقراءة والكتابة. يعمل كل من التدفقين بشكل مستقل، لذا يمكن للعملاء والخوادم القراءة والكتابة بأي ترتيب يريدونه.

على سبيل المثال، يمكن للخادم الانتظار إلى أن يتلقّى جميع رسائل العميل قبل كتابة ردوده، أو يمكنه بدلاً من ذلك قراءة رسالة ثم كتابة رسالة، أو أي مجموعة أخرى من عمليات القراءة والكتابة.

يتم الحفاظ على ترتيب الرسائل في كل بث. يمكنك تحديد هذا النوع من الطرق من خلال وضع الكلمة الرئيسية "بث" قبل كلّ من الطلب والاستجابة.

rpc RouteChat(stream RouteNote) returns (stream RouteNote) {}

4. إنشاء رمز العميل والخادم

بعد ذلك، أنشئ رمز gRPC النموذجي لكل من البرنامج الخادم والبرنامج العميل من ملف .proto باستخدام برنامج ترجمة مخزن البروتوكولات المؤقت. في الدليل routeguide، نفِّذ ما يلي:

protoc --go_out=. --go_opt=paths=source_relative \
       --go-grpc_out=. --go-grpc_opt=paths=source_relative \
       route_guide.proto

ينشئ هذا الأمر الملفات التالية:

• ‫route_guide.pb.go، الذي يحتوي على وظائف لإنشاء أنواع رسائل التطبيق والوصول إلى بياناتها وتعريف الأنواع التي تمثّل الرسائل
• route_guide_grpc.pb.go، الذي يحتوي على دوال يستخدمها العميل لاستدعاء طريقة gRPC البعيدة للخدمة، ودوال يستخدمها الخادم لتقديم تلك الخدمة البعيدة

بعد ذلك، سننفّذ الطرق من جهة الخادم، حتى يتمكّن الخادم من الردّ على الطلب الذي يرسله العميل.

5- تنفيذ الخدمة

لنلقِ نظرة أولاً على كيفية إنشاء خادم RouteGuide. تتضمّن عملية إنجاز خدمة RouteGuide لمهمتها جزأين:

• تنفيذ واجهة الخدمة التي تم إنشاؤها من تعريف الخدمة: تنفيذ "العمل" الفعلي لخدمتنا
• تشغيل خادم gRPC للاستماع إلى الطلبات من العملاء وإرسالها إلى تنفيذ الخدمة المناسب

لننفّذ RouteGuide في server/server.go.

تنفيذ RouteGuide

علينا تنفيذ واجهة RouteGuideService التي تم إنشاؤها. إليك كيف سيبدو التنفيذ.

type routeGuideServer struct {
        ...
}
...
func (s *routeGuideServer) ListFeatures(rect *pb.Rectangle, stream pb.RouteGuide_ListFeaturesServer) error {
        ...
}
...

func (s *routeGuideServer) RecordRoute(stream pb.RouteGuide_RecordRouteServer) error {
        ...
}
...

func (s *routeGuideServer) RouteChat(stream pb.RouteGuide_RouteChatServer) error {
        ...
}

دعونا نلقي نظرة على كل عملية تنفيذ لبروتوكول RPC بالتفصيل.

Server-side streaming RPC

ابدأ بأحد إجراءات استدعاء الإجراءات عن بُعد (RPC) الخاصة بالبث. ‫ListFeatures هي عملية RPC لبث البيانات من جهة الخادم، لذا علينا إرسال عدة Feature إلى العميل.

func (s *routeGuideServer) ListFeatures(rect *pb.Rectangle, stream pb.RouteGuide_ListFeaturesServer) error {
  for _, feature := range s.savedFeatures {
    if inRange(feature.Location, rect) {
      if err := stream.Send(feature); err != nil {
        return err
      }
    }
  }
  return nil
}

كما ترى، بدلاً من الحصول على عناصر طلب واستجابة بسيطة في مَعلمات طريقتنا، نحصل هذه المرة على عنصر طلب (Rectangle الذي يريد عميلنا العثور على Features فيه) وعنصر RouteGuide_ListFeaturesServer خاص لكتابة ردودنا. في الطريقة، نملأ أكبر عدد ممكن من كائنات Feature التي نحتاج إلى إرجاعها، ونكتبها في RouteGuide_ListFeaturesServer باستخدام طريقتها Send(). أخيرًا، كما هو الحال في RPC البسيط، نعرض خطأ nil لإعلام gRPC بأنّنا انتهينا من كتابة الردود. في حال حدوث أي خطأ في هذا الاستدعاء، نعرض خطأ غير فارغ، وستحوّله طبقة gRPC إلى حالة RPC مناسبة ليتم إرسالها عبر الشبكة.

إجراء RPC للبث من جهة العميل

لنلقِ نظرة الآن على طريقة أكثر تعقيدًا: طريقة البث من جهة العميل RecordRoute، حيث نحصل على بث من Points من العميل ونعرض RouteSummary واحدًا يتضمّن معلومات عن رحلته. كما تلاحظ، لا تتضمّن الطريقة هذه المرة أي مَعلمة طلب. بدلاً من ذلك، يحصل على بث RouteGuide_RecordRouteServer، ويمكن للخادم استخدامه لقراءة الرسائل وكتابتها. ويمكنه تلقّي رسائل العميل باستخدام طريقة Recv() وعرض استجابته الفردية باستخدام طريقة SendAndClose().

func (s *routeGuideServer) RecordRoute(stream pb.RouteGuide_RecordRouteServer) error {
  var pointCount, featureCount, distance int32
  var lastPoint *pb.Point
  startTime := time.Now()
  for {
    point, err := stream.Recv()
    if err == io.EOF {
      endTime := time.Now()
      return stream.SendAndClose(&pb.RouteSummary{
        PointCount:   pointCount,
        FeatureCount: featureCount,
        Distance:     distance,
        ElapsedTime:  int32(endTime.Sub(startTime).Seconds()),
      })
    }
    if err != nil {
      return err
    }
    pointCount++
    for _, feature := range s.savedFeatures {
      if proto.Equal(feature.Location, point) {
        featureCount++
      }
    }
    if lastPoint != nil {
      distance += calcDistance(lastPoint, point)
    }
    lastPoint = point
  }
}

في نص الطريقة، نستخدم طريقة Recv() الخاصة بـ RouteGuide_RecordRouteServer لقراءة طلبات العميل بشكل متكرر في عنصر طلب (في هذه الحالة Point) إلى أن لا تكون هناك المزيد من الرسائل: على الخادم التحقّق من الخطأ الذي تم إرجاعه من Recv() بعد كل عملية استدعاء. إذا كانت القيمة nil، يكون البث جيدًا ويمكن مواصلة القراءة، أما إذا كانت القيمة io.EOF، يكون بث الرسائل قد انتهى ويمكن للخادم عرض RouteSummary. إذا كانت تتضمّن أي قيمة أخرى، نعرض الخطأ "كما هو" ليتم ترجمته إلى حالة RPC من خلال طبقة gRPC.

إجراءات RPC للبث الثنائي الاتجاه

أخيرًا، لنلقِ نظرة على RouteChat() RPC ثنائي الاتجاه.

func (s *routeGuideServer) RouteChat(stream pb.RouteGuide_RouteChatServer) error {
  for {
    in, err := stream.Recv()
    if err == io.EOF {
      return nil
    }
    if err != nil {
      return err
    }
    key := serialize(in.Location)

    s.mu.Lock()
    s.routeNotes[key] = append(s.routeNotes[key], in)
    // Note: this copy prevents blocking other clients while serving this one.
    // We don't need to do a deep copy, because elements in the slice are
    // insert-only and never modified.
    rn := make([]*pb.RouteNote, len(s.routeNotes[key]))
    copy(rn, s.routeNotes[key])
    s.mu.Unlock()

    for _, note := range rn {
      if err := stream.Send(note); err != nil {
        return err
      }
    }
  }
}

في هذه المرة، نحصل على بث RouteGuide_RouteChatServer يمكن استخدامه لقراءة الرسائل وكتابتها، كما هو الحال في مثال البث من جهة العميل. ومع ذلك، فإنّنا نعرض هذه المرة القيم من خلال بث الطريقة بينما لا يزال العميل يكتب الرسائل في بث الرسائل. إنّ بنية القراءة والكتابة هنا تشبه إلى حد كبير طريقة بث البيانات من العميل، باستثناء أنّ الخادم يستخدم طريقة send() الخاصة بالبث بدلاً من SendAndClose() لأنّه يكتب ردودًا متعددة. على الرغم من أنّ كل طرف سيتلقّى دائمًا رسائل الطرف الآخر بالترتيب الذي تمت كتابتها به، يمكن لكل من العميل والخادم القراءة والكتابة بأي ترتيب، إذ تعمل عمليات البث بشكل مستقل تمامًا.

بدء تشغيل الخادم

بعد تنفيذ جميع طرقنا، نحتاج أيضًا إلى بدء تشغيل خادم gRPC حتى يتمكّن العملاء من استخدام خدمتنا. يوضّح المقتطف التالي كيفية إجراء ذلك لخدمة RouteGuide:

lis, err := net.Listen("tcp", fmt.Sprintf("localhost:%d", *port))
if err != nil {
  log.Fatalf("failed to listen: %v", err)
}

grpcServer := grpc.NewServer()

s := &routeGuideServer{routeNotes: make(map[string][]*pb.RouteNote)}
s.loadFeatures()
pb.RegisterRouteGuideServer(grpcServer, s)
grpcServer.Serve(lis)

في ما يلي الخطوات التي تحدث في main():

1. حدِّد منفذ TCP الذي سيتم استخدامه للاستماع إلى طلبات العميل البعيد باستخدام lis, err := net.Listen(...). تستخدم التطبيقات تلقائيًا منفذ TCP رقم 50051 كما هو محدّد في المتغيّر port أو من خلال تمرير الخيار --port في سطر الأوامر عند تشغيل الخادم. إذا تعذّر فتح منفذ TCP، ينتهي التطبيق بحدوث خطأ فادح.
2. أنشئ مثيلاً لخادم gRPC باستخدام grpc.NewServer(...)، وسمِّ هذا المثيل grpcServer.
3. أنشئ مؤشرًا إلى routeGuideServer، وهو بنية تمثّل خدمة واجهة برمجة التطبيقات للتطبيق، وسمِّ المؤشر s.
4. استخدِم s.loadFeatures() لتعبئة الصفيفة s.savedFeatures.
5. تسجيل تنفيذ الخدمة في خادم gRPC
6. اتّصِل بـ Serve() على الخادم مع تفاصيل المنفذ لإجراء انتظار حظر لطلبات العميل، ويستمر ذلك إلى أن يتم إيقاف العملية أو يتم استدعاء Stop().

تستمدّ الدالة loadFeatures() عمليات الربط بين الإحداثيات والمواقع الجغرافية من server/testdata.go.

6. إنشاء العميل

عدِّل الآن client/client.go، وهو المكان الذي ستنفّذ فيه رمز العميل.

لاستدعاء طرق الخدمة البعيدة، علينا أولاً إنشاء قناة gRPC للتواصل مع الخادم. ننشئ ذلك من خلال تمرير سلسلة URI المستهدَفة للخادم (وهي في هذه الحالة ببساطة العنوان ورقم المنفذ) إلى grpc.NewClient() في دالة main() الخاصة بالعميل على النحو التالي:

// Set up a connection to the gRPC server.
conn, err := grpc.NewClient("dns:///"+*serverAddr, grpc.WithTransportCredentials(insecure.NewCredentials()))
if err != nil {
  log.Fatalf("fail to dial: %v", err)
}
defer conn.Close()

عنوان الخادم، الذي يحدّده المتغيّر serverAddr، هو localhost:50051 تلقائيًا، ويمكن تجاوزه باستخدام الخيار --addr في سطر الأوامر عند تشغيل العميل.

إذا كان العميل بحاجة إلى الاتصال بخدمة تتطلّب بيانات اعتماد المصادقة، مثل بيانات اعتماد TLS أو JWT، يمكن للعميل تمرير كائن DialOptions كمعلَمة إلى grpc.NewClient يحتوي على بيانات الاعتماد المطلوبة. لا تتطلّب خدمة RouteGuide أي بيانات اعتماد.

بعد إعداد القناة في gRPC، نحتاج إلى رمز بديل للعميل من أجل تنفيذ استدعاءات الإجراء عن بُعد (RPC) من خلال استدعاءات دوال Go. نحصل على الرمز الصوري باستخدام طريقة NewRouteGuideClient التي يوفّرها ملف route_guide_grpc.pb.go الذي تم إنشاؤه من ملف .proto الخاص بالتطبيق.

import (pb "github.com/grpc-ecosystem/codelabs/getting_started_streaming/routeguide")

client := pb.NewRouteGuideClient(conn)

طُرق استدعاء الخدمات

لنلقِ نظرة الآن على كيفية استدعاء طرق الخدمة. في gRPC-Go، تعمل طلبات RPC في وضع الحظر/التزامن، ما يعني أنّ طلب RPC ينتظر استجابة الخادم، وسيعرض إما استجابة أو خطأ.

Server-side streaming RPC

هنا نستدعي طريقة البث من جهة الخادم ListFeatures، التي تعرض بثًا لكائنات Feature جغرافية.

rect := &pb.Rectangle{ ... }  // initialize a pb.Rectangle
log.Printf("Looking for features within %v", rect)
stream, err := client.ListFeatures(context.Background(), rect)
if err != nil {
  log.Fatalf("client.ListFeatures failed: %v", err)
}
for {
  // For server-to-client streaming RPCs, you call stream.Recv() until it
  // returns io.EOF.
  feature, err := stream.Recv()
  if err == io.EOF {
    break
  }
  if err != nil {
    log.Fatalf("client.ListFeatures failed: %v", err)
  }
  log.Printf("Feature: name: %q, point:(%v, %v)", feature.GetName(),
    feature.GetLocation().GetLatitude(), feature.GetLocation().GetLongitude())
}

كما هو الحال في RPC البسيط، نمرّر إلى الطريقة سياقًا وطلبًا. ومع ذلك، بدلاً من الحصول على عنصر استجابة، نحصل على مثيل من RouteGuide_ListFeaturesClient. يمكن للعميل استخدام بث RouteGuide_ListFeaturesClient لقراءة ردود الخادم. نستخدم طريقة RouteGuide_ListFeaturesClient's Recv() لقراءة ردود الخادم بشكل متكرّر في عنصر بروتوكول تخزين مؤقت للرد (في هذه الحالة Feature) إلى أن لا تتوفر المزيد من الرسائل: على العميل التحقّق من الخطأ err الذي تم إرجاعه من Recv() بعد كل عملية استدعاء. إذا كانت القيمة nil، يكون البث جيدًا ويمكن مواصلة القراءة، وإذا كانت القيمة io.EOF، يكون بث الرسائل قد انتهى، وإلا يجب أن يكون هناك خطأ في استدعاء الإجراء عن بُعد (RPC)، ويتم تمريره عبر err.

إجراء RPC للبث من جهة العميل

تشبه طريقة البث من جهة العميل RecordRoute طريقة البث من جهة الخادم، باستثناء أنّنا نمرّر إلى الطريقة سياقًا فقط ونحصل على بث RouteGuide_RecordRouteClient، يمكننا استخدامه في كل من كتابة الرسائل وقراءتها.

// Create a random number of random points
r := rand.New(rand.NewSource(time.Now().UnixNano()))
pointCount := int(r.Int31n(100)) + 2 // Traverse at least two points
var points []*pb.Point
for i := 0; i < pointCount; i++ {
  points = append(points, randomPoint(r))
}
log.Printf("Traversing %d points.", len(points))
c2sStream, err := client.RecordRoute(context.TODO())
if err != nil {
  log.Fatalf("client.RecordRoute failed: %v", err)
}
// Stream each point to the server.
for _, point := range points {
  if err := c2sStream.Send(point); err != nil {
    log.Fatalf("client.RecordRoute: stream.Send(%v) failed: %v", point, err)
  }
}
// Close the stream and receive the RouteSummary from the server.
reply, err := c2sStream.CloseAndRecv()
if err != nil {
  log.Fatalf("client.RecordRoute failed: %v", err)
}
log.Printf("Route summary: %v", reply)

يحتوي RouteGuide_RecordRouteClient على طريقة Send() يمكننا استخدامها لإرسال الطلبات إلى الخادم. بعد الانتهاء من كتابة طلبات العميل إلى البث باستخدام Send()، علينا استدعاء CloseAndRecv() في البث لإعلام gRPC بأنّنا انتهينا من الكتابة ونتوقّع تلقّي ردّ. نحصل على حالة RPC من الخطأ الذي تم إرجاعه من CloseAndRecv(). إذا كانت الحالة nil، ستكون قيمة العرض الأولى من CloseAndRecv() استجابة صالحة من الخادم.

إجراءات RPC للبث الثنائي الاتجاه

أخيرًا، لنلقِ نظرة على RouteChat() RPC ثنائي الاتجاه. كما هو الحال في RecordRoute، لا نمرّر إلى الطريقة سوى عنصر سياق ونستردّ منها مصدر بيانات يمكننا استخدامه لكتابة الرسائل وقراءتها. ومع ذلك، فإنّنا نعرض هذه المرة القيم من خلال بث الطريقة بينما لا يزال الخادم يكتب الرسائل إلى بث الرسائل.

biDiStream, err := client.RouteChat(context.Background())
if err != nil {
  log.Fatalf("client.RouteChat failed: %v", err)
}
// this channel is used to wait for the receive goroutine to finish.
recvDoneCh := make(chan struct{})
// receive goroutine.
go func() {
  for {
    in, err := biDiStream.Recv()
    if err == io.EOF {
      // read done.
      close(recvDoneCh)
      return
    }
    if err != nil {
      log.Fatalf("client.RouteChat failed: %v", err)
    }
    log.Printf("Got message %s at point(%d, %d)", in.Message, in.Location.Latitude, in.Location.Longitude)
  }
}()
// send messages simultaneously.
for _, note := range notes {
  if err := biDiStream.Send(note); err != nil {
    log.Fatalf("client.RouteChat: stream.Send(%v) failed: %v", note, err)
  }
}
biDiStream.CloseSend()
// wait for the receive goroutine to finish.
<-recvDoneCh

إنّ بنية القراءة والكتابة هنا تشبه إلى حد كبير طريقة البث من جهة العميل، باستثناء أنّنا نستخدم طريقة CloseSend() للبث بعد الانتهاء من مكالمتنا. على الرغم من أنّ كل طرف سيتلقّى دائمًا رسائل الطرف الآخر بالترتيب الذي تمت كتابتها به، يمكن لكل من العميل والخادم القراءة والكتابة بأي ترتيب، إذ تعمل عمليات البث بشكل مستقل تمامًا.

7. جرّبه الآن

تأكَّد من أنّ الخادم والعميل يعملان معًا بشكل صحيح من خلال تنفيذ الأوامر التالية في دليل العمل الخاص بالتطبيق:

1. شغِّل الخادم في إحدى الوحدات الطرفية:

cd server
go run .

2. شغِّل العميل من وحدة طرفية أخرى:

cd client
go run .

ستظهر لك نتيجة مشابهة لما يلي، مع حذف الطوابع الزمنية لتوضيح الصورة:

Looking for features within lo:<latitude:400000000 longitude:-750000000 > hi:<latitude:420000000 longitude:-730000000 >
name:"Patriots Path, Mendham, NJ 07945, USA" location:<latitude:407838351 longitude:-746143763 >
...
name:"3 Hasta Way, Newton, NJ 07860, USA" location:<latitude:410248224 longitude:-747127767 >
Traversing 56 points.
Route summary: point_count:56 distance:497013163
Got message First message at point(0, 1)
Got message Second message at point(0, 2)
Got message Third message at point(0, 3)
Got message First message at point(0, 1)
Got message Fourth message at point(0, 1)
Got message Second message at point(0, 2)
Got message Fifth message at point(0, 2)
Got message Third message at point(0, 3)
Got message Sixth message at point(0, 3)

8. الخطوات التالية

• يمكنك التعرّف على طريقة عمل gRPC في مقدمة عن gRPC والمفاهيم الأساسية.
• اتّبِع الخطوات الواردة في البرنامج التعليمي الخاص بالأساسيات.
• استكشاف مرجع واجهة برمجة التطبيقات