spi添加

go.mod

@@ -1,6 +1,6 @@
 module github.com/ecodeclub/ekit
 
-go 1.20
+go 1.22.0
 
 require (
 	github.com/DATA-DOG/go-sqlmock v1.5.0

spi/spi.go

@@ -0,0 +1,65 @@
+// Copyright 2021 ecodeclub
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package spi
+
+import (
+	"errors"
+	"os"
+	"path/filepath"
+	"plugin"
+)
+
+// LoadService 加载 dir 下面的所有的实现了 T 接口的类型
+// 举个例子来说，如果你有一个叫做 UserService 的接口
+// 而后你将所有的实现都放到了 /ext/user_service 目录下
+// 并且所有的实现，虽然在不同的包，但是都叫做 UserService
+// 那么我可以执行 LoadService("/ext/user_service", "UserService")
+// 加载到所有的实现
+// LoadService 加载 dir 下面的所有的实现了 T 接口的类型
+
+var DirNotFound = errors.New("目录不存在")
+
+func LoadService[T any](dir string, symName string) ([]T, error) {
+	var services []T
+	// 检查目录是否存在
+	if _, err := os.Stat(dir); os.IsNotExist(err) {
+		return nil, DirNotFound
+	}
+	// 遍历目录下的所有 .so 文件
+	err := filepath.Walk(dir, func(path string, info os.FileInfo, err error) error {
+		if !info.IsDir() && filepath.Ext(path) == ".so" {
+			// 打开插件
+			p, err := plugin.Open(path)
+			if err != nil {
+				return err
+			}
+			// 查找变量
+			sym, err := p.Lookup(symName)
+			if err != nil {
+				return err
+			}
+
+			// 尝试将符号断言为接口类型
+			service, ok := sym.(T)
+			if !ok {
+				return errors.New("插件非该接口类型")
+			}
+			// 收集服务
+			services = append(services, service)
+		}
+		return nil
+	})
+	return services, err
+}

spi/spi_test.go

@@ -0,0 +1,69 @@
+// Copyright 2021 ecodeclub
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package spi
+
+import (
+	"log"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func Test_LoadService(t *testing.T) {
+	testcases := []struct {
+		name    string
+		dir     string
+		svcName string
+		want    []string
+		wantErr error
+	}{
+		{
+			name:    "有一个插件",
+			dir:     "./user_service",
+			svcName: "UserSvc",
+			want:    []string{"Get"},
+		},
+		{
+			name:    "有两个插件",
+			dir:     "./user_service2",
+			svcName: "UserSvc",
+			want:    []string{"A", "B"},
+		},
+		{
+			name:    "目录不存在",
+			dir:     "./notfound",
+			wantErr: DirNotFound,
+		},
+	}
+	for _, tc := range testcases {
+		t.Run(tc.name, func(t *testing.T) {
+			list, err := LoadService[UserService](tc.dir, tc.svcName)
+			assert.Equal(t, tc.wantErr, err)
+			if err != nil {
+				return
+			}
+			ans := make([]string, 0, len(list))
+			for _, svc := range list {
+				ans = append(ans, svc.Get())
+			}
+			log.Println(ans)
+			assert.Equal(t, tc.want, ans)
+		})
+	}
+}
+
+type UserService interface {
+	Get() string
+}

spi/user_service/a.go

@@ -0,0 +1,25 @@
+// Copyright 2021 ecodeclub
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+package main
+
+// 测试用
+//go:generate go build --buildmode=plugin -o a.so ./a.go
+
+type UserService struct{}
+
+func (u UserService) Get() string {
+	return "Get"
+}
+
+var UserSvc UserService

spi/user_service2/a/a.go

@@ -0,0 +1,27 @@
+// Copyright 2021 ecodeclub
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package main
+
+// 测试用
+
+type UserService struct{}
+
+// GetName returns the name of the service
+func (u UserService) Get() string {
+	return "A"
+}
+
+// 导出对象
+var UserSvc UserService

spi/user_service2/b/b.go

@@ -0,0 +1,27 @@
+// Copyright 2021 ecodeclub
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package main
+
+// 测试用
+
+type UserService struct{}
+
+// GetName returns the name of the service
+func (u UserService) Get() string {
+	return "B"
+}
+
+// 导出对象
+var UserSvc UserService