go-course/go18
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

补充endpoint模块

Browse Source
This commit is contained in:
yumaojun03 2025-06-08 12:04:18 +08:00
parent f1d8684ab7
commit d10c26eb3b
10 changed files with 275 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
devcloud/etc/application.toml
View File

@ -11,7 +11,7 @@
database = "devcloud_go18"
username = "root"
password = "123456"
auto_migrate = false
auto_migrate = true
debug = true
[http]

15
devcloud/mcenter/apps/endpoint/README.md
View File

@ -1,2 +1,17 @@
# 接口管理
如何提取 当前这个服务的路由条目, GoRestful框架的Container这一层 获取
```go
func NewEntryFromRestfulContainer(c *restful.Container) (entries []*RouteEntry) {
wss := c.RegisteredWebServices()
for i := range wss {
for _, route := range wss[i].Routes() {
es := NewEntryFromRestRoute(route)
entries = append(entries, es)
}
}
return entries
}
```

92
devcloud/mcenter/apps/endpoint/impl/endpoint.go Normal file
View File

@ -0,0 +1,92 @@
package impl
import (
"context"
"122.51.31.227/go-course/go18/devcloud/mcenter/apps/endpoint"
"github.com/infraboard/mcube/v2/exception"
"github.com/infraboard/mcube/v2/ioc/config/datasource"
"github.com/infraboard/mcube/v2/types"
"gorm.io/gorm"
)
// 注册API接口
// 这是一个批量接口, 一次添加多条记录
// 需要保证事务: 同时成功，或者同时失败, MySQL事务
func (i *EndpointServiceImpl) RegistryEndpoint(ctx context.Context, in *endpoint.RegistryEndpointRequest) (*types.Set[*endpoint.Endpoint], error) {
if err := in.Validate(); err != nil {
return nil, err
}
set := types.New[*endpoint.Endpoint]()
err := datasource.DBFromCtx(ctx).Transaction(func(tx *gorm.DB) error {
for i := range in.Items {
item := in.Items[i].BuildUUID()
ins := endpoint.NewEndpoint().SetRouteEntry(*item)
oldEnpoint := endpoint.NewEndpoint()
if err := tx.Where("uuid = ?", item.UUID).Take(oldEnpoint).Error; err != nil {
if err != gorm.ErrRecordNotFound {
return err
}
// 需要创建
if err := tx.Save(ins).Error; err != nil {
return err
}
} else {
// 需要更新
ins.Id = oldEnpoint.Id
if err := tx.Where("uuid = ?", item.UUID).Updates(ins).Error; err != nil {
return err
}
}
set.Add(ins)
}
return nil
})
if err != nil {
return nil, err
}
return set, nil
}
// 查询API接口列表
func (i *EndpointServiceImpl) QueryEndpoint(ctx context.Context, in *endpoint.QueryEndpointRequest) (*types.Set[*endpoint.Endpoint], error) {
set := types.New[*endpoint.Endpoint]()
query := datasource.DBFromCtx(ctx).Model(&endpoint.Endpoint{})
if len(in.Services) > 0 && !in.IsMatchAllService() {
query = query.Where("service IN ?", in.Services)
}
err := query.Count(&set.Total).Error
if err != nil {
return nil, err
}
err = query.
Order("created_at desc").
Find(&set.Items).
Error
if err != nil {
return nil, err
}
return set, nil
}
// 查询API接口详情
func (i *EndpointServiceImpl) DescribeEndpoint(ctx context.Context, in *endpoint.DescribeEndpointRequest) (*endpoint.Endpoint, error) {
query := datasource.DBFromCtx(ctx)
ins := &endpoint.Endpoint{}
if err := query.First(ins).Error; err != nil {
if err == gorm.ErrRecordNotFound {
return nil, exception.NewNotFound("endpoint %d not found", in.Id)
}
return nil, err
}
return ins, nil
}

34
devcloud/mcenter/apps/endpoint/impl/impl.go Normal file
View File

@ -0,0 +1,34 @@
package impl
import (
"122.51.31.227/go-course/go18/devcloud/mcenter/apps/endpoint"
"github.com/infraboard/mcube/v2/ioc"
"github.com/infraboard/mcube/v2/ioc/config/datasource"
)
func init() {
ioc.Controller().Registry(&EndpointServiceImpl{})
}
var _ endpoint.Service = (*EndpointServiceImpl)(nil)
// 他是user service 服务的控制器
type EndpointServiceImpl struct {
ioc.ObjectImpl
}
func (i *EndpointServiceImpl) Init() error {
// 自动创建表
if datasource.Get().AutoMigrate {
err := datasource.DB().AutoMigrate(&endpoint.Endpoint{})
if err != nil {
return err
}
}
return nil
}
// 定义托管到Ioc里面的名称
func (i *EndpointServiceImpl) Name() string {
return endpoint.APP_NAME
}

77
devcloud/mcenter/apps/endpoint/interface.go Normal file
View File

@ -0,0 +1,77 @@
package endpoint
import (
"context"
"slices"
"github.com/infraboard/mcube/v2/ioc"
"github.com/infraboard/mcube/v2/ioc/config/validator"
"github.com/infraboard/mcube/v2/types"
"github.com/infraboard/modules/iam/apps"
)
const (
APP_NAME = "endpoint"
)
func GetService() Service {
return ioc.Controller().Get(APP_NAME).(Service)
}
type Service interface {
// 注册API接口
RegistryEndpoint(context.Context, *RegistryEndpointRequest) (*types.Set[*Endpoint], error)
// 查询API接口列表
QueryEndpoint(context.Context, *QueryEndpointRequest) (*types.Set[*Endpoint], error)
// 查询API接口详情
DescribeEndpoint(context.Context, *DescribeEndpointRequest) (*Endpoint, error)
}
func NewQueryEndpointRequest() *QueryEndpointRequest {
return &QueryEndpointRequest{}
}
type QueryEndpointRequest struct {
Services []string `form:"services" json:"serivces"`
}
func (r *QueryEndpointRequest) WithService(services ...string) *QueryEndpointRequest {
for _, service := range services {
if !slices.Contains(r.Services, service) {
r.Services = append(r.Services, services...)
}
}
return r
}
func (r *QueryEndpointRequest) IsMatchAllService() bool {
return slices.Contains(r.Services, "*")
}
func NewDescribeEndpointRequest() *DescribeEndpointRequest {
return &DescribeEndpointRequest{}
}
type DescribeEndpointRequest struct {
apps.GetRequest
}
func NewRegistryEndpointRequest() *RegistryEndpointRequest {
return &RegistryEndpointRequest{
Items: []*RouteEntry{},
}
}
type RegistryEndpointRequest struct {
Items []*RouteEntry `json:"items"`
}
func (r *RegistryEndpointRequest) AddItem(items ...*RouteEntry) *RegistryEndpointRequest {
r.Items = append(r.Items, items...)
return r
}
func (r *RegistryEndpointRequest) Validate() error {
return validator.Validate(r)
}

2
devcloud/mcenter/apps/endpoint/model.go
View File

@ -238,8 +238,10 @@ func NewEntryFromRestRoute(route restful.Route) *RouteEntry {
}
func NewEntryFromRestfulContainer(c *restful.Container) (entries []*RouteEntry) {
// 获取当前Container里面所有的 WebService
wss := c.RegisteredWebServices()
for i := range wss {
// 获取WebService下的路由条目
for _, route := range wss[i].Routes() {
es := NewEntryFromRestRoute(route)
entries = append(entries, es)

2
devcloud/mcenter/apps/registry.go
View File

@ -7,6 +7,8 @@ import (
_ "122.51.31.227/go-course/go18/devcloud/mcenter/apps/token/api"
_ "122.51.31.227/go-course/go18/devcloud/mcenter/apps/token/impl"
_ "122.51.31.227/go-course/go18/devcloud/mcenter/apps/endpoint/impl"
// 颁发器
_ "122.51.31.227/go-course/go18/devcloud/mcenter/apps/token/issuers"
// 鉴权中间件

2
devcloud/mcenter/apps/user/api/api.go
View File

@ -37,6 +37,8 @@ func (h *UserRestfulApiHandler) Init() error {
// 这个开关怎么生效
// 中间件需求读取接口的描述信息，来决定是否需要认证
Metadata(permission.Auth(true)).
Metadata(permission.Resource("user")).
Metadata(permission.Action("list")).
Param(restful.QueryParameter("page_size", "分页大小").DataType("integer")).
Param(restful.QueryParameter("page_number", "页码").DataType("integer")).
Writes(Set{}).

2
devcloud/mcenter/apps/user/design.drawio
View File

@ -43,7 +43,7 @@
<mxCell id="12" value="UI" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="40" y="25" width="60" height="30" as="geometry"/>
</mxCell>
<mxCell id="16" value="&lt;h1 style=&quot;margin-top: 0px;&quot;&gt;Heading&lt;/h1&gt;&lt;p&gt;Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.&lt;/p&gt;" style="text;html=1;whiteSpace=wrap;overflow=hidden;rounded=0;" vertex="1" parent="1">
<mxCell id="16" value="&lt;h1 style=&quot;margin-top: 0px;&quot;&gt;脱敏&lt;/h1&gt;&lt;p&gt;数据出去时&lt;/p&gt;" style="text;html=1;whiteSpace=wrap;overflow=hidden;rounded=0;" vertex="1" parent="1">
<mxGeometry x="580" y="100" width="180" height="120" as="geometry"/>
</mxCell>
</root>

49
devcloud/mcenter/permission/endpoint.go Normal file
View File

@ -0,0 +1,49 @@
package permission
import (
"context"
"122.51.31.227/go-course/go18/devcloud/mcenter/apps/endpoint"
"github.com/infraboard/mcube/v2/ioc"
"github.com/infraboard/mcube/v2/ioc/config/gorestful"
"github.com/infraboard/mcube/v2/ioc/config/log"
"github.com/rs/zerolog"
)
func init() {
ioc.Api().Registry(&ApiRegister{})
}
func GetApiRegister() *ApiRegister {
return ioc.Api().Get("api_register").(*ApiRegister)
}
// 接口注册模块: 扫描当前GoResuful Container下所有路径，并完成注册
type ApiRegister struct {
ioc.ObjectImpl
log *zerolog.Logger
}
func (c *ApiRegister) Name() string {
return "api_register"
}
// 这个Init一定要放到所有的路由都添加完成后进行
func (i *ApiRegister) Priority() int {
return -100
}
func (a *ApiRegister) Init() error {
a.log = log.Sub(a.Name())
// 注册认证中间件
entries := endpoint.NewEntryFromRestfulContainer(gorestful.RootRouter())
req := endpoint.NewRegistryEndpointRequest()
req.AddItem(entries...)
set, err := endpoint.GetService().RegistryEndpoint(context.Background(), req)
if err != nil {
return err
}
a.log.Info().Msgf("registry endpoinst: %s", set.Items)
return nil
}