كتابة مدونة Microservice - الجزء 3 "المستخدم"

في الجزء الثاني من سلسلة مقالاتنا "كتابة مدونة على Microservices" وصفنا بوابة API .

نحن هنا وصف تنفيذ microservice المستخدم.

يجب أن تكون خدماتنا المصغرة قادرة على:

• مكالمات خدمة السجل والحالات الوسيطة التي تشير إلى TraceId (نفس المكالمات الصادرة عن api-gw ، راجع الجزء 2 "بوابة API" )
• تنفيذ وظائف تسجيل الدخول (SignIN) والتسجيل (SignUp)
• تنفيذ وظائف CRUD (إنشاء ، قراءة ، تحرير ، حذف السجلات في قاعدة البيانات). استخدم MongoDB كقاعدة البيانات.

أولاً ، نصف خدمتنا في ملف proto (./services/user/protobuf/user.proto).
حدد بناء الجملة المستخدم - proto3. نشير إلى اسم حزمة protobuf ، في هذه الحزمة سيتم تنفيذ الكود الذي تم إنشاؤه تلقائيًا للخادم وقطع العميل.

نحن نستورد google / api / annotations.proto مكتبة التعليقات التوضيحية ، وستكون هناك حاجة لوصف التوجيهات لإنشاء واجهة برمجة تطبيقات REST.

syntax = "proto3"; package protobuf; import "google/api/annotations.proto"; 

وصف خدمة المستخدم ، مباشرة واجهات (الطرق) التي ينبغي أن يكون. على سبيل المثال ، واجهة SignUp (التسجيل): تتلقى رسالة SignUpRequest تحتوي على سمات اسم المستخدم وكلمة المرور والاسم الأول واسم العائلة وتستجيب برسالة SignUpResponse التي تحتوي على سمات Slug (UserID) واسم المستخدم والدور. أيضًا في وصف الواجهة ، في قسم الخيارات ، حدد توجيه المنشور: "/ api / v1 / user / signup. بناءً عليه ، سينشئ منشئ الكود واجهة REST التي ستتلقى طلبات POST على http: {{api_gw_host}} / api / v1 / user / الاشتراك.

 //-------------------------------------------------- //   User //-------------------------------------------------- service UserService { //  rpc SignUp (SignUpRequest) returns (SignUpResponse) { option (google.api.http) = { post: "/api/v1/user/signup" }; } … } //-------------------------------------------------- // SignUp //-------------------------------------------------- message SignUpRequest { string Username = 1; string Password = 2; string FirstName = 3; string LastName = 4; } message SignUpResponse { string Slug = 1; string Username = 2; string Role = 3; } 

ويتوقع الهيكل التالي في نص الطلب:

 { Username: 'username_value', Password: 'password_value', FirstName: 'firstname_value', LastName: 'lastname_value', } 

وبناءً على ذلك ، إذا نجح ، فسوف يعطي الهيكل:

 { Slug: 'user_id_value', Username: 'username_value', Role: 'role_value', } 

أو خطأ. سنخبرك أكثر بالأخطاء في وقت لاحق في القسم الذي يصف الوظائف التي تنفذ الواجهات الموضحة في ملف التعريف.

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

الآن أن لدينا ملف تعريف جاهز. نذهب إلى الدليل الجذر للمشروع وننفذ الأمر sh ./bin/protogen.sh. سيقوم هذا البرنامج النصي بإنشاء الرمز الرئيسي.
بعد ذلك ، انتقل إلى دليل ./services/user وفي ملف jobs.go ، اكتب تنفيذ الواجهات المعلنة.

أولاً ، نطبق الوسيطة. عند كل طلب للخدمة ، نسحب معلمات TraceId و UserId و UserRole من سياق الطلب ونكتبها في ملف السجل. هنا يمكنك تنفيذ تفويض الطلب.

 //-------------------------------------------------- // Midelware //-------------------------------------------------- func AccessLogInterceptor(ctx context.Context,req interface{},info *grpc.UnaryServerInfo,handler grpc.UnaryHandler,) (interface{}, error) { start:=time.Now() md,_:=metadata.FromIncomingContext(ctx) // Calls the handler reply, err := handler(ctx, req) var traceId,userId,userRole string if len(md["trace-id"])>0{ traceId=md["trace-id"][0] } if len(md["user-id"])>0{ userId=md["user-id"][0] } if len(md["user-role"])>0{ userRole=md["user-role"][0] } msg:=fmt.Sprintf("Call:%v, traceId: %v, userId: %v, userRole: %v, time: %v", info.FullMethod,traceId,userId,userRole,time.Since(start)) app.AccesLog(msg) return reply, err } 

في طريقة SignUp ، نحدد بنية الاستجابة.

 //,   STATUS_FAIL out:=&SignUpResponse{} 

بعد ذلك ، تحقق من معلمات الطلب.

 //     // Username err:=checkUserName(in.Username) if err!=nil{ log.Printf("[ERR] %s.SignUp, %v", app.SERVICE_NAME,err) return out,err } // Username   err=o.checkUserNameExist(in.Username) if err!=nil{ log.Printf("[ERR] %s.SignUp, %v", app.SERVICE_NAME,err) return out,err } // Password err=checkPassword(in.Password) if err!=nil{ log.Printf("[ERR] %s.SignUp, %v", app.SERVICE_NAME,err) return out,err } 

وإذا كان كل شيء على ما يرام ، فاملأ هيكل المستخدم ، واكتب إلى قاعدة البيانات وأرجع الإجابة.

 user:=&User{ Username:in.Username, FirstName:in.FirstName, LastName:in.LastName, Password:getMD5(in.Password), } var slug string collection:= o.DbClient.Database("blog").Collection("users") insertResult, err := collection.InsertOne(context.TODO(), user) if err != nil { return out,err } if oid, ok := insertResult.InsertedID.(primitive.ObjectID); ok { slug=fmt.Sprintf("%s",oid.Hex()) }else { err:=app.ErrInsert return out,err } out.Slug=slug out.Username=in.Username out.Role=app.ROLE_USER return out,nil 

بشكل منفصل ، ننتبه إلى عودة الخطأ ، على سبيل المثال:

 err:=app.ErrInsert 

نظرًا لأن هذا الخطأ سيعود في النهاية إلى api-wg (في جزء REST الخاص به) وسيكون من الجيد تحويله إلى رمز استجابة HTTP قياسي. من أجل عدم كتابة مجموعة من التعليمات البرمجية الإضافية ، يجب ألا تستخدم خطأ go القياسي ، ولكن status.error من google.golang.org/grpc/status package.

يتم توضيح جميع الأخطاء النموذجية لخدمة المستخدم الصغيرة وكيفية تحويلها إلى رموز استجابة HTTP في الملف. / Services / user / app / errors.go.

 package app import ( "google.golang.org/grpc/codes" "google.golang.org/grpc/status" ) //    var ( //  ErrEmailIncorrect = status.Error(codes.InvalidArgument, " E-mail") ErrPasswordIsEmpty = status.Error(codes.InvalidArgument, "Password  ") ErrUserNameIsEmpty = status.Error(codes.InvalidArgument, "E-mail  ") ErrUserNameIsExist = status.Error(codes.AlreadyExists, "  ") ErrNotFound = status.Error(codes.NotFound, "  ") ErrIncorrectLoginOrPassword = status.Error(codes.Unauthenticated,"   ") // CRUD ErrInsert = status.Error(codes.Internal, "  ") ErrUpdate = status.Error(codes.Internal, "  ") ) //================================================== // All gRPC err codes //================================================== // codes.OK - http.StatusOK // codes.Canceled - http.StatusRequestTimeout // codes.Unknown - http.StatusInternalServerError // codes.InvalidArgument - http.StatusBadRequest // codes.DeadlineExceeded - http.StatusGatewayTimeout // codes.NotFound - http.StatusNotFound // codes.AlreadyExists - http.StatusConflict // codes.PermissionDenied - http.StatusForbidden // codes.Unauthenticated - http.StatusUnauthorized // codes.ResourceExhausted - http.StatusTooManyRequests // codes.FailedPrecondition - http.StatusBadRequest // codes.Aborted - http.StatusConflict // codes.OutOfRange - http.StatusBadRequest // codes.Unimplemented - http.StatusNotImplemented // codes.Internal - http.StatusInternalServerError // codes.Unavailable - http.StatusServiceUnavailable // codes.DataLoss - http.StatusInternalServerError 

وآخر شيء أود أن أخبره عن خدمة المستخدم الصغيرة هو كيفية بدء تشغيله والاتصال بقاعدة البيانات. يتم تنفيذ هذه العمليات في الملف ./services/user/main.go.

إطلاق الخدمة:

 lis,err:= net.Listen("tcp", fmt.Sprintf(":%s", Port)) if err != nil { log.Fatalf("failed to listen: %v", err) } grpcServer:= grpc.NewServer( grpc.UnaryInterceptor(protobuf.AccessLogInterceptor), ) s:=&protobuf.Server{} … // attach the user service to the server protobuf.RegisterUserServiceServer(grpcServer, s) 

الاتصال بقاعدة البيانات (main.go):

 //   s.DbConnect() defer s.DbDisconnect() 

تنفيذ وظيفة DbConnect (./services/user/functions.go):

 //-------------------------------------------------- // /   //-------------------------------------------------- func (o *Server) DbConnect() error { var client *mongo.Client // Create client strURI:=fmt.Sprintf("mongodb://%s:%s@%s:%s",os.Getenv("MONGO_USER"),os.Getenv("MONGO_PASS"),os.Getenv("MONGO_HOST"),os.Getenv("MONGO_PORT")) client, err:= mongo.NewClient(options.Client().ApplyURI(strURI)) if err != nil { return err } // Create connect err = client.Connect(context.TODO()) if err != nil { return err } o.DbClient=client return nil }