user

package
v0.0.0-...-2c311f4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 15, 2023 License: MIT Imports: 14 Imported by: 0

README

用户管理

定义接口

Documentation

Index

Constants

View Source 
const (
	AppName = "users"
)

Variables

View Source 
var (
	DESCRIBE_BY_name = map[int32]string{
		0: "USER_ID",
		1: "USERNAME",
	}
	DESCRIBE_BY_value = map[string]int32{
		"USER_ID":  0,
		"USERNAME": 1,
	}
)

Enum value maps for DESCRIBE_BY.

View Source 
var File_apps_user_pb_rpc_proto protoreflect.FileDescriptor
View Source 
var File_apps_user_pb_user_proto protoreflect.FileDescriptor
View Source 
var RPC_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "go9.devcloud.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 {

	// 用户所属的Domain(公司或者组织名字)
	// @gotags: bson:"domain" json:"domain" validate:"required"
	Domain string `protobuf:"bytes,1,opt,name=domain,proto3" json:"domain" bson:"domain" validate:"required"`
	// 创建时间
	// @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 NewCreateUserRequest 

func NewCreateUserRequest() *CreateUserRequest

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

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

type DESCRIBE_BY 

type DESCRIBE_BY int32
const (
	DESCRIBE_BY_USER_ID  DESCRIBE_BY = 0
	DESCRIBE_BY_USERNAME 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 {
	// contains filtered or unexported fields
}

func (*DeleteUserRequest) Descriptor deprecated 

func (*DeleteUserRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteUserRequest.ProtoReflect.Descriptor instead.

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

type DescribeUserRequest 

type DescribeUserRequest struct {

	// 查询方式
	DescribeBy DESCRIBE_BY `` /* 127-byte string literal not displayed */
	// 具体的值
	DescribeVaule string `protobuf:"bytes,2,opt,name=describe_vaule,json=describeVaule,proto3" json:"describe_vaule,omitempty"`
	// contains filtered or unexported fields
}

func NewDescribeUserRequestByUsername 

func NewDescribeUserRequestByUsername(username string) *DescribeUserRequest

func (*DescribeUserRequest) Descriptor deprecated 

func (*DescribeUserRequest) Descriptor() ([]byte, []int)

Deprecated: Use DescribeUserRequest.ProtoReflect.Descriptor instead.

func (*DescribeUserRequest) GetDescribeBy 

func (x *DescribeUserRequest) GetDescribeBy() DESCRIBE_BY

func (*DescribeUserRequest) GetDescribeVaule 

func (x *DescribeUserRequest) GetDescribeVaule() 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 {

	// 分页参数
	Page *request.PageRequest `protobuf:"bytes,1,opt,name=page,proto3" json:"page,omitempty"`
	// 关键字查询
	Keywords string `protobuf:"bytes,2,opt,name=keywords,proto3" json:"keywords,omitempty"`
	// contains filtered or unexported fields
}

需要做分页: page_size page_number 依赖的代码 抽离成一个 第三方库: 公共代码库, 所有的项目都依赖这部分公共代码 mcube 就是这样的公共代码库: https://github.com/infraboard/mcube

func NewQueryUserRequest 

func NewQueryUserRequest() *QueryUserRequest

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() *request.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 {
	// 查询用户列表
	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 {
	// 查询用户列表
	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)
	// 用户更新
	UpdateUser(context.Context, *UpdateUserRequest) (*User, error)
	// 用户删除
	DeleteUser(context.Context, *DeleteUserRequest) (*User, error)
	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 {
	// contains filtered or unexported fields
}

func (*UpdateUserRequest) Descriptor deprecated 

func (*UpdateUserRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateUserRequest.ProtoReflect.Descriptor instead.

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

type User 

type User struct {

	// 对象元数据
	// @gotags: bson:",inline" json:"meta"
	Meta *meta.Meta `protobuf:"bytes,1,opt,name=meta,proto3" json:"meta" bson:",inline"`
	// 创建用户的请求 {"spec": {"username": ""}}  -->inline-- {"username": ""}
	// @gotags: bson:",inline" json:"spec"
	Spec *CreateUserRequest `protobuf:"bytes,15,opt,name=spec,proto3" json:"spec" bson:",inline"`
	// contains filtered or unexported fields
}

func New 

func New(req *CreateUserRequest) (*User, error)

func NewDefaultUser 

func NewDefaultUser() *User

func (*User) CheckPassword 

func (i *User) CheckPassword(pass string) error

func (*User) Descriptor deprecated 

func (*User) Descriptor() ([]byte, []int)

Deprecated: Use User.ProtoReflect.Descriptor instead.

func (*User) Desense 

func (i *User) Desense()

func (*User) GetMeta 

func (x *User) GetMeta() *meta.Meta

func (*User) GetSpec 

func (x *User) GetSpec() *CreateUserRequest

func (*User) MarshalJSON 

func (u *User) MarshalJSON() ([]byte, error)

自定义对象序号化方法

func (*User) ProtoMessage 

func (*User) ProtoMessage()

func (*User) ProtoReflect 

func (x *User) ProtoReflect() protoreflect.Message

func (*User) Reset 

func (x *User) Reset()

func (*User) String 

func (x *User) String() string

type UserSet 

type UserSet struct {

	// 用户总数量
	// @gotags: json:"total"
	Total int64 `protobuf:"varint,1,opt,name=total,proto3" json:"total"`
	// 分页的用户列表
	// @gotags: json:"items"
	Items []*User `protobuf:"bytes,2,rep,name=items,proto3" json:"items"`
	// contains filtered or unexported fields
}

用户集合

func NewUserSet 

func NewUserSet() *UserSet

func (*UserSet) Add 

func (s *UserSet) Add(item *User)

func (*UserSet) Descriptor deprecated 

func (*UserSet) Descriptor() ([]byte, []int)

Deprecated: Use UserSet.ProtoReflect.Descriptor instead.

func (*UserSet) GetItems 

func (x *UserSet) GetItems() []*User

func (*UserSet) GetTotal 

func (x *UserSet) GetTotal() int64

func (*UserSet) ProtoMessage 

func (*UserSet) ProtoMessage()

func (*UserSet) ProtoReflect 

func (x *UserSet) ProtoReflect() protoreflect.Message

func (*UserSet) Reset 

func (x *UserSet) Reset()

func (*UserSet) String 

func (x *UserSet) String() string

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.