README
¶
Service Directory Documentation
Welcome to this documentation! 🎉🎉🎉 Here, we will delve into the main purpose and usage of the service directory.
1. The Service Provider: The Service Directory 📡
The
servicedirectory is the service provider of our project. It's a place where we declare the specific services that our application offers. You can think of it as the front desk 🎫 of a hotel, where guests (clients) can request specific services.
Each service provided corresponds one-to-one with the service interfaces generated under the
apidirectory'sprotofiles. This means our application can offer a wide array of services, each tailored to a specific need.
2. Protocol Compatibility and Request Handling 🎯
The
servicedirectory is also a protocol chameleon 🦎, capable of adapting to multiple protocols for service calls. In general, it allows service calls via HTTP and gRPC protocols, providing flexibility for various use-cases.
The logic in the
servicelayer mainly involves some parameter validation and request content conversion operations. Specifically, it performsreq -> bo(request to business object) conversions andbo -> rep(business object to response) operations.
By doing so, the
servicedirectory ensures that our services are robust, reliable, and adaptable to various client needs. 🚀🚀🚀
We hope this guide helps you navigate the
servicedirectory more effectively. Happy coding! 💻💻💻
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ProviderSet = wire.NewSet(NewLoginService)
ProviderSet is a Google Wire provider set used for dependency injection. This set contains the NewLoginService function, which means that when using Google Wire for dependency injection, LoginService instances can be automatically created. By adding this function to the set, it becomes convenient to manage and initialize LoginService related dependencies in the project.
Functions ¶
This section is empty.
Types ¶
type LoginService ¶
type LoginService struct {
v1.UnimplementedLoginServer // Embed UnimplementedLoginServer to automatically implement empty methods of the interface
// contains filtered or unexported fields
}
LoginService implements the v1.LoginServer interface for handling user login related RPC requests. This service depends on the business logic layer's LoginUseCase to complete specific login business.
func NewLoginService ¶
func NewLoginService(uc *biz.LoginUseCase) *LoginService
NewLoginService creates a new LoginService instance. Parameter uc is the login use case instance from the business logic layer. Returns a pointer to a LoginService instance.
func (*LoginService) Login ¶
func (svc *LoginService) Login(ctx context.Context, req *v1.LoginRequest) (*v1.LoginReply, error)
Login handles user login RPC requests. Parameters: ctx is the context for controlling the request lifecycle; req is the login request sent by the client. Returns login response and any possible errors.
Source Files