Documentation
¶
Index ¶
- Constants
- Variables
- func RegisterRPCServer(s grpc.ServiceRegistrar, srv RPCServer)
- type CreateUserRequest
- func (*CreateUserRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CreateUserRequest) GetDomain() string
- func (x *CreateUserRequest) GetPassword() string
- func (x *CreateUserRequest) GetUsername() string
- func (req *CreateUserRequest) HashPassword() error
- func (*CreateUserRequest) ProtoMessage()
- func (x *CreateUserRequest) ProtoReflect() protoreflect.Message
- func (x *CreateUserRequest) Reset()
- func (x *CreateUserRequest) String() string
- func (req *CreateUserRequest) Validate() error
- type DESCRIBE_BY
- func (DESCRIBE_BY) Descriptor() protoreflect.EnumDescriptor
- func (x DESCRIBE_BY) Enum() *DESCRIBE_BY
- func (DESCRIBE_BY) EnumDescriptor() ([]byte, []int)deprecated
- func (x DESCRIBE_BY) Number() protoreflect.EnumNumber
- func (x DESCRIBE_BY) String() string
- func (DESCRIBE_BY) Type() protoreflect.EnumType
- type DeleteUserRequest
- func (*DeleteUserRequest) Descriptor() ([]byte, []int)deprecated
- func (x *DeleteUserRequest) GetUsername() string
- func (*DeleteUserRequest) ProtoMessage()
- func (x *DeleteUserRequest) ProtoReflect() protoreflect.Message
- func (x *DeleteUserRequest) Reset()
- func (x *DeleteUserRequest) String() string
- func (req *DeleteUserRequest) Validate() error
- type DescribeUserRequest
- func (*DescribeUserRequest) Descriptor() ([]byte, []int)deprecated
- func (x *DescribeUserRequest) GetDescribeType() DESCRIBE_BY
- func (x *DescribeUserRequest) GetDescribeValue() string
- func (*DescribeUserRequest) ProtoMessage()
- func (x *DescribeUserRequest) ProtoReflect() protoreflect.Message
- func (x *DescribeUserRequest) Reset()
- func (x *DescribeUserRequest) String() string
- type QueryUserRequest
- func (*QueryUserRequest) Descriptor() ([]byte, []int)deprecated
- func (x *QueryUserRequest) GetKeywords() string
- func (x *QueryUserRequest) GetPage() *page.PageRequest
- func (*QueryUserRequest) ProtoMessage()
- func (x *QueryUserRequest) ProtoReflect() protoreflect.Message
- func (x *QueryUserRequest) Reset()
- func (x *QueryUserRequest) String() string
- type RPCClient
- type RPCServer
- type Service
- type UnimplementedRPCServer
- type UnsafeRPCServer
- type UpdateUserRequest
- func (*UpdateUserRequest) Descriptor() ([]byte, []int)deprecated
- func (x *UpdateUserRequest) GetPassword() string
- func (x *UpdateUserRequest) GetUsername() string
- func (req *UpdateUserRequest) HashPassword() error
- func (*UpdateUserRequest) ProtoMessage()
- func (x *UpdateUserRequest) ProtoReflect() protoreflect.Message
- func (x *UpdateUserRequest) Reset()
- func (x *UpdateUserRequest) String() string
- func (req *UpdateUserRequest) Validate() error
- type User
- func (u *User) CheckPassword(password string) error
- func (*User) Descriptor() ([]byte, []int)deprecated
- func (u *User) Desense()
- func (x *User) GetMeta() *meta.Meta
- func (x *User) GetSpec() *CreateUserRequest
- func (u *User) MarshalJSON() ([]byte, error)
- func (*User) ProtoMessage()
- func (x *User) ProtoReflect() protoreflect.Message
- func (x *User) Reset()
- func (x *User) String() string
- type UserSet
- func (u *UserSet) AddItems(items ...*User)
- func (*UserSet) Descriptor() ([]byte, []int)deprecated
- func (x *UserSet) GetItems() []*User
- func (x *UserSet) GetTotal() int64
- func (*UserSet) ProtoMessage()
- func (x *UserSet) ProtoReflect() protoreflect.Message
- func (x *UserSet) Reset()
- func (x *UserSet) String() string
Constants ¶
const ( RPC_Queryuser_FullMethodName = "/codehorse.mcenter.user.RPC/Queryuser" RPC_DescribeUser_FullMethodName = "/codehorse.mcenter.user.RPC/DescribeUser" )
const (
AppName = "user"
)
业务模块名称
Variables ¶
var ( DESCRIBE_BY_name = map[int32]string{ 0: "USERNAME", 1: "USER_ID", } DESCRIBE_BY_value = map[string]int32{ "USERNAME": 0, "USER_ID": 1, } )
Enum value maps for DESCRIBE_BY.
var File_apps_user_pb_rpc_proto protoreflect.FileDescriptor
var File_apps_user_pb_user_proto protoreflect.FileDescriptor
var RPC_ServiceDesc = grpc.ServiceDesc{ ServiceName: "codehorse.mcenter.user.RPC", HandlerType: (*RPCServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "Queryuser", Handler: _RPC_Queryuser_Handler, }, { MethodName: "DescribeUser", Handler: _RPC_DescribeUser_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "apps/user/pb/rpc.proto", }
RPC_ServiceDesc is the grpc.ServiceDesc for RPC service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterRPCServer ¶
func RegisterRPCServer(s grpc.ServiceRegistrar, srv RPCServer)
Types ¶
type CreateUserRequest ¶
type CreateUserRequest struct { // @gotags: bson:"domain" json:"domain" Domain string `protobuf:"bytes,1,opt,name=domain,proto3" json:"domain" bson:"domain"` // @gotags: bson:"username" json:"username" validate:"required" Username string `protobuf:"bytes,2,opt,name=username,proto3" json:"username" bson:"username" validate:"required"` // @gotags: bson:"password" json:"password" validate:"required" Password string `protobuf:"bytes,3,opt,name=password,proto3" json:"password" bson:"password" validate:"required"` // contains filtered or unexported fields }
创建用户请求
func (*CreateUserRequest) Descriptor
deprecated
func (*CreateUserRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateUserRequest.ProtoReflect.Descriptor instead.
func (*CreateUserRequest) GetDomain ¶
func (x *CreateUserRequest) GetDomain() string
func (*CreateUserRequest) GetPassword ¶
func (x *CreateUserRequest) GetPassword() string
func (*CreateUserRequest) GetUsername ¶
func (x *CreateUserRequest) GetUsername() string
func (*CreateUserRequest) HashPassword ¶
func (req *CreateUserRequest) HashPassword() error
CreateUserRequest结构体中密码加密
func (*CreateUserRequest) ProtoMessage ¶
func (*CreateUserRequest) ProtoMessage()
func (*CreateUserRequest) ProtoReflect ¶
func (x *CreateUserRequest) ProtoReflect() protoreflect.Message
func (*CreateUserRequest) Reset ¶
func (x *CreateUserRequest) Reset()
func (*CreateUserRequest) String ¶
func (x *CreateUserRequest) String() string
func (*CreateUserRequest) Validate ¶
func (req *CreateUserRequest) Validate() error
CreateUserRequest结构体必要参数校验
type DESCRIBE_BY ¶
type DESCRIBE_BY int32
定义查询用户详情方式枚举类型
const ( DESCRIBE_BY_USERNAME DESCRIBE_BY = 0 DESCRIBE_BY_USER_ID DESCRIBE_BY = 1 )
func (DESCRIBE_BY) Descriptor ¶
func (DESCRIBE_BY) Descriptor() protoreflect.EnumDescriptor
func (DESCRIBE_BY) Enum ¶
func (x DESCRIBE_BY) Enum() *DESCRIBE_BY
func (DESCRIBE_BY) EnumDescriptor
deprecated
func (DESCRIBE_BY) EnumDescriptor() ([]byte, []int)
Deprecated: Use DESCRIBE_BY.Descriptor instead.
func (DESCRIBE_BY) Number ¶
func (x DESCRIBE_BY) Number() protoreflect.EnumNumber
func (DESCRIBE_BY) String ¶
func (x DESCRIBE_BY) String() string
func (DESCRIBE_BY) Type ¶
func (DESCRIBE_BY) Type() protoreflect.EnumType
type DeleteUserRequest ¶
type DeleteUserRequest struct { // @gotags: bson:"username" json:"username" validate:"required" Username string `protobuf:"bytes,1,opt,name=username,proto3" json:"username" bson:"username" validate:"required"` // contains filtered or unexported fields }
删除用户
func NewDeleteUserRequest ¶
func NewDeleteUserRequest() *DeleteUserRequest
DeleteUserRequest结构体初始化方法
func (*DeleteUserRequest) Descriptor
deprecated
func (*DeleteUserRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteUserRequest.ProtoReflect.Descriptor instead.
func (*DeleteUserRequest) GetUsername ¶
func (x *DeleteUserRequest) GetUsername() string
func (*DeleteUserRequest) ProtoMessage ¶
func (*DeleteUserRequest) ProtoMessage()
func (*DeleteUserRequest) ProtoReflect ¶
func (x *DeleteUserRequest) ProtoReflect() protoreflect.Message
func (*DeleteUserRequest) Reset ¶
func (x *DeleteUserRequest) Reset()
func (*DeleteUserRequest) String ¶
func (x *DeleteUserRequest) String() string
func (*DeleteUserRequest) Validate ¶
func (req *DeleteUserRequest) Validate() error
DeleteUserRequest结构体添加校验方法
type DescribeUserRequest ¶
type DescribeUserRequest struct { // @gotags: bson:"describe_type" json:"describe_type" DescribeType DESCRIBE_BY `` /* 149-byte string literal not displayed */ // @gotags: bson:"describe_value" json:"describe_value" DescribeValue string `protobuf:"bytes,2,opt,name=describe_value,json=describeValue,proto3" json:"describe_value" bson:"describe_value"` // contains filtered or unexported fields }
查询用户详情
func NewDescribeUserRequest ¶
func NewDescribeUserRequest() *DescribeUserRequest
DescribeUserRequest结构体
func (*DescribeUserRequest) Descriptor
deprecated
func (*DescribeUserRequest) Descriptor() ([]byte, []int)
Deprecated: Use DescribeUserRequest.ProtoReflect.Descriptor instead.
func (*DescribeUserRequest) GetDescribeType ¶
func (x *DescribeUserRequest) GetDescribeType() DESCRIBE_BY
func (*DescribeUserRequest) GetDescribeValue ¶
func (x *DescribeUserRequest) GetDescribeValue() string
func (*DescribeUserRequest) ProtoMessage ¶
func (*DescribeUserRequest) ProtoMessage()
func (*DescribeUserRequest) ProtoReflect ¶
func (x *DescribeUserRequest) ProtoReflect() protoreflect.Message
func (*DescribeUserRequest) Reset ¶
func (x *DescribeUserRequest) Reset()
func (*DescribeUserRequest) String ¶
func (x *DescribeUserRequest) String() string
type QueryUserRequest ¶
type QueryUserRequest struct { // @gotags: bson:",inline" json:"page" Page *page.PageRequest `protobuf:"bytes,1,opt,name=page,proto3" json:"page" bson:",inline"` // @gotags: bson:"keywords" json:"keywords" Keywords string `protobuf:"bytes,2,opt,name=keywords,proto3" json:"keywords" bson:"keywords"` // contains filtered or unexported fields }
查询用户
func (*QueryUserRequest) Descriptor
deprecated
func (*QueryUserRequest) Descriptor() ([]byte, []int)
Deprecated: Use QueryUserRequest.ProtoReflect.Descriptor instead.
func (*QueryUserRequest) GetKeywords ¶
func (x *QueryUserRequest) GetKeywords() string
func (*QueryUserRequest) GetPage ¶
func (x *QueryUserRequest) GetPage() *page.PageRequest
func (*QueryUserRequest) ProtoMessage ¶
func (*QueryUserRequest) ProtoMessage()
func (*QueryUserRequest) ProtoReflect ¶
func (x *QueryUserRequest) ProtoReflect() protoreflect.Message
func (*QueryUserRequest) Reset ¶
func (x *QueryUserRequest) Reset()
func (*QueryUserRequest) String ¶
func (x *QueryUserRequest) String() string
type RPCClient ¶
type RPCClient interface { // 创建用户 // rpc CreateUser(CreateUserRequest) returns(User); // 删除用户 // rpc DeleteUser(DeleteUserRequest) returns(User); // 更新用户 // rpc UpdateUser(UpdateUserRequest) returns(User); // 查询用户 Queryuser(ctx context.Context, in *QueryUserRequest, opts ...grpc.CallOption) (*UserSet, error) // 查询用户详情 DescribeUser(ctx context.Context, in *DescribeUserRequest, opts ...grpc.CallOption) (*User, error) }
RPCClient is the client API for RPC service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewRPCClient ¶
func NewRPCClient(cc grpc.ClientConnInterface) RPCClient
type RPCServer ¶
type RPCServer interface { // 创建用户 // rpc CreateUser(CreateUserRequest) returns(User); // 删除用户 // rpc DeleteUser(DeleteUserRequest) returns(User); // 更新用户 // rpc UpdateUser(UpdateUserRequest) returns(User); // 查询用户 Queryuser(context.Context, *QueryUserRequest) (*UserSet, error) // 查询用户详情 DescribeUser(context.Context, *DescribeUserRequest) (*User, error) // contains filtered or unexported methods }
RPCServer is the server API for RPC service. All implementations must embed UnimplementedRPCServer for forward compatibility
type Service ¶
type Service interface { // 创建用户 CreateUser(context.Context, *CreateUserRequest) (*User, error) // 删除用户 DeleteUser(context.Context, *DeleteUserRequest) (*User, error) // 更新用户 UpdateUser(context.Context, *UpdateUserRequest) (*User, error) // GRPC业务接口 RPCServer }
定义业务接口
type UnimplementedRPCServer ¶
type UnimplementedRPCServer struct { }
UnimplementedRPCServer must be embedded to have forward compatible implementations.
func (UnimplementedRPCServer) DescribeUser ¶
func (UnimplementedRPCServer) DescribeUser(context.Context, *DescribeUserRequest) (*User, error)
func (UnimplementedRPCServer) Queryuser ¶
func (UnimplementedRPCServer) Queryuser(context.Context, *QueryUserRequest) (*UserSet, error)
type UnsafeRPCServer ¶
type UnsafeRPCServer interface {
// contains filtered or unexported methods
}
UnsafeRPCServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to RPCServer will result in compilation errors.
type UpdateUserRequest ¶
type UpdateUserRequest struct { // @gotags: bson:"username" json:"username" validate:"required" Username string `protobuf:"bytes,1,opt,name=username,proto3" json:"username" bson:"username" validate:"required"` // @gotags: bson:"password" json:"password" validate:"required" Password string `protobuf:"bytes,2,opt,name=password,proto3" json:"password" bson:"password" validate:"required"` // contains filtered or unexported fields }
更新用户
func NewUpdateUserRequest ¶
func NewUpdateUserRequest() *UpdateUserRequest
UpdateUserRequest结构体初始化方法
func (*UpdateUserRequest) Descriptor
deprecated
func (*UpdateUserRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateUserRequest.ProtoReflect.Descriptor instead.
func (*UpdateUserRequest) GetPassword ¶
func (x *UpdateUserRequest) GetPassword() string
func (*UpdateUserRequest) GetUsername ¶
func (x *UpdateUserRequest) GetUsername() string
func (*UpdateUserRequest) HashPassword ¶
func (req *UpdateUserRequest) HashPassword() error
UpdateUserRequest结构体密码加密方法
func (*UpdateUserRequest) ProtoMessage ¶
func (*UpdateUserRequest) ProtoMessage()
func (*UpdateUserRequest) ProtoReflect ¶
func (x *UpdateUserRequest) ProtoReflect() protoreflect.Message
func (*UpdateUserRequest) Reset ¶
func (x *UpdateUserRequest) Reset()
func (*UpdateUserRequest) String ¶
func (x *UpdateUserRequest) String() string
func (*UpdateUserRequest) Validate ¶
func (req *UpdateUserRequest) Validate() error
UpdateUserRequest结构体添加校验方法
type User ¶
type User struct { // @gotags: bson:",inline" json:"meta" Meta *meta.Meta `protobuf:"bytes,1,opt,name=meta,proto3" json:"meta" bson:",inline"` // @gotags: bson:",inline" json:"spec" Spec *CreateUserRequest `protobuf:"bytes,2,opt,name=spec,proto3" json:"spec" bson:",inline"` // contains filtered or unexported fields }
用户结构体
func (*User) Descriptor
deprecated
func (*User) GetSpec ¶
func (x *User) GetSpec() *CreateUserRequest
func (*User) ProtoMessage ¶
func (*User) ProtoMessage()
func (*User) ProtoReflect ¶
func (x *User) ProtoReflect() protoreflect.Message
type UserSet ¶
type UserSet struct { // @gotags: bson:"total" json:"total" Total int64 `protobuf:"varint,1,opt,name=total,proto3" json:"total" bson:"total"` // @gotags: bson:"items" json:"items" Items []*User `protobuf:"bytes,2,rep,name=items,proto3" json:"items" bson:"items"` // contains filtered or unexported fields }
用户列表结构体
func (*UserSet) Descriptor
deprecated
func (*UserSet) ProtoMessage ¶
func (*UserSet) ProtoMessage()
func (*UserSet) ProtoReflect ¶
func (x *UserSet) ProtoReflect() protoreflect.Message