init

Author: CC11001100

.gitignore

@@ -0,0 +1 @@
+.idea

README.md

@@ -0,0 +1,10 @@
+# SCA基础配置模块（Base Module Config） 
+
+
+
+
+
+
+
+
+

config.example.yaml

@@ -0,0 +1,43 @@
+# 日志相关参数配置
+logger:
+  # 日志文件的输出目录
+  directory: "./"
+  # 日志开启哪些端
+  enable:
+    # 是否开启标准输出
+    stdout: true
+    # 是否开启文件输出
+    file: true
+
+# 爬虫相关配置
+crawler:
+  # 爬虫使用到的代理
+  proxy:
+    # 动态代理
+    dynamic-proxy: "xxx"
+  # 爬虫的队列
+  queue:
+    # 队列名称
+    name: "xxxx"
+  # 消费者参数 
+  consumer:
+    # 消费者数量
+    worker-num: 1
+
+# OSS相关参数配置
+oss:
+  # 公网
+  endpoint: "oss-cn-beijing.aliyuncs.com"
+  # 认证相关
+  access-key-id: "xxxx"
+  access-key-secret: "xxxx"
+
+# Redis配置
+redis:
+  address: "xxx:6379"
+  passwd: "xxxx:xxxx"
+
+# 数据库配置
+database:
+  mysql:
+    dsn: "xxxx:xxxxxxxx@tcp(xxxx)/xxxx?parseTime=true&loc=Local&charset=utf8mb4"

config.go

@@ -0,0 +1,22 @@
+package sca_base_module_config
+
+import "github.com/spf13/viper"
+
+// Configuration 对应着一个映射文件
+type Configuration struct {
+	Database Database `yaml:"database" mapstructure:"database"`
+	Redis    Redis    `yaml:"redis" mapstructure:"redis"`
+	Logger   Logger   `yaml:"logger" mapstructure:"logger"`
+	OSS      OSS      `yaml:"oss" mapstructure:"oss"`
+	Crawler  Crawler  `yaml:"crawler" mapstructure:"crawler"`
+
+	// 把原来的viper也获取一下放在这里，随时都可以通过viper的方法来获取
+	*viper.Viper
+
+	// 未明确声明的就放在这里吧...
+	ViperRemainMap map[string]any `mapstructure:",remain"`
+}
+
+func (x *Configuration) GetStringOrDefault(name, defaultValue string) string {
+	return OrDefault(x.Viper.GetString(name), defaultValue)
+}

crawler.go

@@ -0,0 +1,15 @@
+package sca_base_module_config
+
+type Crawler struct {
+	Proxy CrawlerProxy `yaml:"proxy" mapstructure:"proxy"`
+	Queue CrawlerQueue `yaml:"queue" mapstructure:"queue"`
+	Consumer CrawlerConsumer `yaml:"consumer" mapstructure:"consumer"`
+}
+
+type CrawlerQueue struct {
+	Name string `yaml:"name" mapstructure:"name"`
+}
+
+type CrawlerConsumer struct {
+	WorkerNum int `yaml:"worker-num" mapstructure:"worker-num"`
+}

database.go

@@ -0,0 +1,5 @@
+package sca_base_module_config
+
+type Database struct {
+	Mysql Mysql `yaml:"mysql" mapstructure:"mysql"`
+}

default.go

@@ -0,0 +1,14 @@
+package sca_base_module_config
+
+import (
+	reflect_utils "github.com/golang-infrastructure/go-reflect-utils"
+)
+
+// OrDefault 如果给定的值为空的话则返回默认值
+func OrDefault[T any](value, defaultValue T) T {
+	if reflect_utils.IsNil(value) {
+		return defaultValue
+	} else {
+		return value
+	}
+}

env.go

@@ -0,0 +1,49 @@
+package sca_base_module_config
+
+import (
+	"github.com/golang-infrastructure/go-pointer"
+	"os"
+	"strconv"
+	"strings"
+)
+
+const ScaAutoInitConfigEnvName = "SCA_AUTO_INIT_CONFIG"
+
+func GetEnvString(name string) *string {
+	env, b := os.LookupEnv(name)
+	if !b {
+		return nil
+	}
+	return pointer.ToPointer(env)
+}
+
+func GetEnvStringOrDefault(name, defaultValue string) string {
+	return pointer.FromPointerOrDefault(GetEnvString(name), defaultValue)
+}
+
+func GetEnvBool(name string) *bool {
+	env, b := os.LookupEnv(name)
+	if !b {
+		return nil
+	}
+	return pointer.ToPointer(strings.ToLower(env) == "true")
+}
+
+func GetEnvBoolOrDefault(name string, defaultValue bool) bool {
+	return pointer.FromPointerOrDefault(GetEnvBool(name), defaultValue)
+}
+
+func GetEnvInt(name string) *int {
+	env, b := os.LookupEnv(name)
+	if !b {
+		return nil
+	}
+	atoi, err := strconv.Atoi(env)
+	if err != nil {
+		return nil
+	}
+	return pointer.ToPointer(atoi)
+}
+func GetEnvIntOrDefault(name string, defaultValue int) int {
+	return pointer.FromPointerOrDefault(GetEnvInt(name), defaultValue)
+}

go.mod

@@ -0,0 +1,31 @@
+module github.com/scagogogo/sca-base-module-config
+
+go 1.18
+
+require (
+	github.com/golang-infrastructure/go-pointer v0.0.4
+	github.com/golang-infrastructure/go-project-root-directory v0.0.1
+	github.com/golang-infrastructure/go-reflect-utils v0.0.0-20221130143747-965ef2eb09c3
+	github.com/spf13/viper v1.16.0
+	github.com/stretchr/testify v1.8.3
+)
+
+require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/fsnotify/fsnotify v1.6.0 // indirect
+	github.com/golang-infrastructure/go-how-run v0.0.0-20230107060855-56163adc7748 // indirect
+	github.com/hashicorp/hcl v1.0.0 // indirect
+	github.com/magiconair/properties v1.8.7 // indirect
+	github.com/mitchellh/mapstructure v1.5.0 // indirect
+	github.com/pelletier/go-toml/v2 v2.0.8 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/spf13/afero v1.9.5 // indirect
+	github.com/spf13/cast v1.5.1 // indirect
+	github.com/spf13/jwalterweatherman v1.1.0 // indirect
+	github.com/spf13/pflag v1.0.5 // indirect
+	github.com/subosito/gotenv v1.4.2 // indirect
+	golang.org/x/sys v0.10.0 // indirect
+	golang.org/x/text v0.11.0 // indirect
+	gopkg.in/ini.v1 v1.67.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)