mirror of
https://github.com/Syngnat/GoNavi.git
synced 2026-05-22 08:50:17 +08:00
✨feat(drivers): 支持按需启动数据源并通过外置驱动代理减少发行包体积
- MySQL/Redis/Oracle/PostgreSQL 内置可用，其余数据源改为“安装启用”后可用 - 新建连接对未安装驱动做弹窗内拦截提示，并支持一键跳转驱动管理安装 - 驱动管理展示安装包真实大小（从 Release 资产元数据读取）并优化加载性能 - Release 工作流发布各平台驱动代理资产，主程序构建启用 -s -w 精简
This commit is contained in:
Syngnat
@@ -1,164 +0,0 @@
|
||||
# HighGo 可选代码优化建议
|
||||
|
||||
## 一、sslmode 配置优化
|
||||
|
||||
### 当前状态
|
||||
|
||||
**文件**：`internal/db/highgo_impl.go:43`
|
||||
|
||||
**当前代码**：
|
||||
```go
|
||||
q.Set("sslmode", "disable")
|
||||
```
|
||||
|
||||
### 建议修改
|
||||
|
||||
根据瀚高官方文档，sslmode 的默认值应该是 `require`。建议修改为：
|
||||
|
||||
```go
|
||||
q.Set("sslmode", "require")
|
||||
```
|
||||
|
||||
### 修改原因
|
||||
|
||||
1. **符合官方规范**：瀚高官方文档明确指出默认 sslmode 为 `require`
|
||||
2. **安全性提升**：启用 SSL 加密可以保护数据传输安全
|
||||
3. **生产环境最佳实践**：生产环境应该启用 SSL 连接
|
||||
|
||||
### 是否需要修改？
|
||||
|
||||
**不一定需要修改**，取决于您的实际环境：
|
||||
|
||||
#### 保持 `disable` 的场景：
|
||||
- ✅ 开发/测试环境
|
||||
- ✅ HighGo 服务器未配置 SSL 证书
|
||||
- ✅ 内网环境，不需要加密传输
|
||||
- ✅ 快速测试连接功能
|
||||
|
||||
#### 修改为 `require` 的场景：
|
||||
- ✅ 生产环境
|
||||
- ✅ HighGo 服务器已配置 SSL 证书
|
||||
- ✅ 跨网络连接，需要加密保护
|
||||
- ✅ 符合安全合规要求
|
||||
|
||||
### 如何修改
|
||||
|
||||
如果您决定修改，可以使用以下命令：
|
||||
|
||||
**方式 1：直接修改（固定为 require）**
|
||||
```go
|
||||
// 文件：internal/db/highgo_impl.go 第 43 行
|
||||
q.Set("sslmode", "require")
|
||||
```
|
||||
|
||||
**方式 2：可配置（推荐）**
|
||||
|
||||
如果希望让用户可以选择 sslmode，可以修改为：
|
||||
|
||||
```go
|
||||
// 在 getDSN 方法中
|
||||
sslmode := "disable" // 默认值
|
||||
if config.SSLMode != "" {
|
||||
sslmode = config.SSLMode
|
||||
}
|
||||
q.Set("sslmode", sslmode)
|
||||
```
|
||||
|
||||
然后在 `internal/connection/connection.go` 的 `ConnectionConfig` 结构体中添加字段：
|
||||
|
||||
```go
|
||||
type ConnectionConfig struct {
|
||||
// ... 现有字段
|
||||
SSLMode string `json:"sslMode,omitempty"` // SSL 模式：disable, require, verify-ca, verify-full
|
||||
}
|
||||
```
|
||||
|
||||
前端 UI 也需要相应添加 sslmode 选择控件。
|
||||
|
||||
### 测试建议
|
||||
|
||||
修改后请务必测试：
|
||||
|
||||
1. **SSL 启用测试**：
|
||||
- 连接配置了 SSL 的 HighGo 服务器
|
||||
- 验证连接成功
|
||||
|
||||
2. **SSL 禁用测试**：
|
||||
- 连接未配置 SSL 的 HighGo 服务器
|
||||
- 验证是否会报错（如果设置为 `require` 会报错）
|
||||
|
||||
3. **兼容性测试**：
|
||||
- 测试现有的 HighGo 连接配置是否仍然可用
|
||||
|
||||
## 二、其他可选优化
|
||||
|
||||
### 1. 默认端口提示优化
|
||||
|
||||
**文件**：`frontend/src/components/ConnectionModal.tsx`
|
||||
|
||||
**当前状态**：HighGo 的默认端口已正确设置为 5866
|
||||
|
||||
**建议**：无需修改，已符合官方规范
|
||||
|
||||
### 2. 默认数据库名称
|
||||
|
||||
**文件**：`internal/db/highgo_impl.go:33`
|
||||
|
||||
**当前代码**：
|
||||
```go
|
||||
if dbname == "" {
|
||||
dbname = "highgo" // HighGo default database
|
||||
}
|
||||
```
|
||||
|
||||
**建议**：无需修改，已符合官方规范（默认数据库为 `highgo`）
|
||||
|
||||
### 3. 默认用户名
|
||||
|
||||
**当前状态**：未在代码中硬编码默认用户名
|
||||
|
||||
**瀚高官方默认**：`sysdba`
|
||||
|
||||
**建议**：
|
||||
- 可以在前端 UI 的 HighGo 连接表单中，将用户名输入框的 placeholder 设置为 `sysdba`
|
||||
- 但不建议硬编码默认值，让用户自行输入更安全
|
||||
|
||||
## 三、总结
|
||||
|
||||
### 必须修改的项目
|
||||
- ✅ **无**（当前代码已基本符合规范）
|
||||
|
||||
### 建议修改的项目
|
||||
1. **sslmode 配置**（根据实际环境决定）
|
||||
- 开发环境：保持 `disable`
|
||||
- 生产环境：修改为 `require`
|
||||
|
||||
### 可选优化的项目
|
||||
1. 将 sslmode 改为可配置（需要修改前后端）
|
||||
2. 前端 UI 添加 sslmode 选择控件
|
||||
3. 用户名输入框添加 `sysdba` 提示
|
||||
|
||||
## 四、修改优先级
|
||||
|
||||
**优先级 1（高）**：
|
||||
- 集成瀚高 SM3 驱动（参考 `HighGo_SM3_Integration_Guide.md`）
|
||||
|
||||
**优先级 2（中）**：
|
||||
- 根据部署环境调整 sslmode 配置
|
||||
|
||||
**优先级 3（低）**：
|
||||
- 将 sslmode 改为可配置
|
||||
- UI 优化（placeholder 提示等）
|
||||
|
||||
## 五、下一步行动
|
||||
|
||||
建议按以下顺序执行：
|
||||
|
||||
1. **先集成 SM3 驱动**（参考集成指南）
|
||||
2. **测试基本连接功能**（使用 sslmode=disable）
|
||||
3. **如果生产环境需要 SSL**，再修改 sslmode 配置
|
||||
4. **验证所有功能正常**后，考虑可选优化项
|
||||
|
||||
---
|
||||
|
||||
**注意**：所有代码修改都应该在集成 SM3 驱动并验证基本功能正常后再进行。
|
||||
@@ -1,196 +0,0 @@
|
||||
# HighGo SM3 国密驱动集成指南
|
||||
|
||||
## 一、背景说明
|
||||
|
||||
HighGo（瀚高）数据库需要使用支持 SM3 国密认证的 PostgreSQL 驱动。瀚高官方提供了基于 `lib/pq` 的安全增强版本。
|
||||
|
||||
## 二、集成步骤
|
||||
|
||||
### 步骤 1：下载瀚高 pq 驱动
|
||||
|
||||
1. 访问百度网盘链接：
|
||||
```
|
||||
https://pan.baidu.com/s/1xuz6uJz0utRgKWecXhpOiA?pwd=o0tj
|
||||
```
|
||||
|
||||
2. 下载驱动源码压缩包
|
||||
|
||||
### 步骤 2：放置驱动源码
|
||||
|
||||
1. 在项目根目录创建目录（如果不存在）：
|
||||
```bash
|
||||
mkdir -p third_party/highgo-pq
|
||||
```
|
||||
|
||||
2. 解压下载的驱动源码到 `third_party/highgo-pq/` 目录
|
||||
|
||||
3. 确保目录结构如下：
|
||||
```
|
||||
GoNavi/
|
||||
├── third_party/
|
||||
│ └── highgo-pq/
|
||||
│ ├── go.mod
|
||||
│ ├── conn.go
|
||||
│ ├── ... (其他 pq 驱动源文件)
|
||||
```
|
||||
|
||||
### 步骤 3：修改 go.mod
|
||||
|
||||
在 `go.mod` 中添加独立的 HighGo 驱动依赖与本地替换：
|
||||
|
||||
```go
|
||||
require github.com/highgo/pq-sm3 v0.0.0
|
||||
replace github.com/highgo/pq-sm3 => ./third_party/highgo-pq
|
||||
```
|
||||
|
||||
完整示例：
|
||||
```go
|
||||
module GoNavi-Wails
|
||||
|
||||
go 1.24.3
|
||||
|
||||
require (
|
||||
// ... 现有依赖
|
||||
github.com/lib/pq v1.11.1
|
||||
github.com/highgo/pq-sm3 v0.0.0
|
||||
// ... 其他依赖
|
||||
)
|
||||
|
||||
// 在文件末尾添加
|
||||
replace github.com/highgo/pq-sm3 => ./third_party/highgo-pq
|
||||
```
|
||||
|
||||
并将 `third_party/highgo-pq/go.mod` 的 module 修改为：
|
||||
|
||||
```go
|
||||
module github.com/highgo/pq-sm3
|
||||
```
|
||||
|
||||
同时在驱动源码中把注册名改为 `highgo`，确保不覆盖 `postgres`：
|
||||
|
||||
```go
|
||||
sql.Register("highgo", &Driver{})
|
||||
```
|
||||
|
||||
### 步骤 4：更新 HighGo 连接配置（可选）
|
||||
|
||||
根据瀚高官方文档，建议修改 `internal/db/highgo_impl.go:43` 的 sslmode：
|
||||
|
||||
**当前代码**：
|
||||
```go
|
||||
q.Set("sslmode", "disable")
|
||||
```
|
||||
|
||||
**建议修改为**（瀚高默认）：
|
||||
```go
|
||||
q.Set("sslmode", "require")
|
||||
```
|
||||
|
||||
> ⚠️ 注意：如果您的 HighGo 服务器未配置 SSL，保持 `disable` 即可。
|
||||
|
||||
### 步骤 5：验证集成
|
||||
|
||||
1. 清理依赖缓存：
|
||||
```bash
|
||||
go clean -modcache
|
||||
```
|
||||
|
||||
2. 重新下载依赖：
|
||||
```bash
|
||||
go mod download
|
||||
```
|
||||
|
||||
3. 编译项目：
|
||||
```bash
|
||||
go build ./...
|
||||
```
|
||||
|
||||
4. 测试 HighGo 连接：
|
||||
- 启动应用
|
||||
- 创建 HighGo 连接
|
||||
- 测试连接是否成功
|
||||
|
||||
## 三、重要说明
|
||||
|
||||
### ⚠️ 影响范围
|
||||
|
||||
采用独立驱动名后，影响范围如下：
|
||||
|
||||
1. **PostgreSQL 继续使用原生 `github.com/lib/pq`**
|
||||
2. **HighGo 使用 `github.com/highgo/pq-sm3`（本地替换到官方源码）**
|
||||
3. 两条连接链路互不覆盖，降低兼容性风险
|
||||
|
||||
### 兼容性验证
|
||||
|
||||
集成后，请务必测试：
|
||||
|
||||
1. ✅ HighGo 数据库连接（SM3 认证）
|
||||
2. ✅ 标准 PostgreSQL 连接（确保仍然可用）
|
||||
|
||||
若 PostgreSQL 或 HighGo 任一连接异常，优先检查驱动注册名与 `go.mod` replace 是否一致。
|
||||
|
||||
### 回滚方案
|
||||
|
||||
如果集成后出现问题，可以快速回滚：
|
||||
|
||||
1. 删除 `go.mod` 中的 replace 指令
|
||||
2. 删除 `go.mod` 中 `github.com/highgo/pq-sm3` 的 require
|
||||
3. 删除 `third_party/highgo-pq/` 目录
|
||||
4. 运行 `go mod tidy`
|
||||
5. 重新编译
|
||||
|
||||
## 四、瀚高驱动特性
|
||||
|
||||
根据官方文档：
|
||||
|
||||
- **项目内包路径**：`github.com/highgo/pq-sm3`（映射到本地 `third_party/highgo-pq`）
|
||||
- **驱动名**：`highgo`（项目内独立注册，避免覆盖 `postgres`）
|
||||
- **SM3 支持**：自动启用国密认证
|
||||
- **默认端口**：5866
|
||||
- **默认数据库**：`highgo`
|
||||
- **默认用户**：`sysdba`
|
||||
- **sslmode 默认**：`require`
|
||||
|
||||
## 五、故障排查
|
||||
|
||||
### 问题 1：编译失败
|
||||
|
||||
**现象**：`go build` 报错找不到 `github.com/highgo/pq-sm3`
|
||||
|
||||
**解决**：
|
||||
1. 检查 `third_party/highgo-pq/` 目录是否存在
|
||||
2. 检查 `go.mod` 中 `github.com/highgo/pq-sm3` 的 require/replace 是否正确
|
||||
3. 运行 `go mod download`
|
||||
|
||||
### 问题 2：HighGo 连接失败
|
||||
|
||||
**现象**：连接 HighGo 时报认证错误
|
||||
|
||||
**解决**：
|
||||
1. 确认瀚高驱动已正确替换（检查 `go.mod`）
|
||||
2. 确认项目内驱动注册名为 `highgo`
|
||||
3. 确认 HighGo 服务器支持 SM3 认证
|
||||
4. 检查用户名、密码、端口是否正确
|
||||
|
||||
### 问题 3：PostgreSQL 连接失败
|
||||
|
||||
**现象**：集成后标准 PostgreSQL 无法连接
|
||||
|
||||
**解决**：
|
||||
1. 检查是否误将 `github.com/lib/pq` 全局 replace 到 HighGo 驱动
|
||||
2. 确认 PostgreSQL 仍使用 `sql.Open("postgres", dsn)`
|
||||
3. 确认 HighGo 使用 `sql.Open("highgo", dsn)`
|
||||
|
||||
## 六、后续优化建议
|
||||
|
||||
如果后续需要增强，可考虑：
|
||||
|
||||
1. 将 HighGo `sslmode` 做成可配置项（前后端联动）
|
||||
2. 增加 HighGo/PG 驱动链路健康检查项
|
||||
3. 联系瀚高技术支持确认 SM3 + SSL 最佳参数组合
|
||||
|
||||
## 七、参考资料
|
||||
|
||||
- 瀚高官方文档：https://www.highgo.com/document/zh-cn/application/pq%E6%8E%A5%E5%8F%A3.html
|
||||
- 瀚高驱动下载：https://pan.baidu.com/s/1xuz6uJz0utRgKWecXhpOiA?pwd=o0tj
|
||||
- 标准 lib/pq：https://github.com/lib/pq
|
||||
83
docs/driver-manifest.json
Normal file
83
docs/driver-manifest.json
Normal file
@@ -0,0 +1,83 @@
|
||||
{
|
||||
"engine": "go",
|
||||
"drivers": {
|
||||
"mariadb": {
|
||||
"engine": "go",
|
||||
"version": "go-embedded",
|
||||
"checksumPolicy": "off",
|
||||
"downloadUrl": "builtin://activate/mariadb"
|
||||
},
|
||||
"diros": {
|
||||
"engine": "go",
|
||||
"version": "go-embedded",
|
||||
"checksumPolicy": "off",
|
||||
"downloadUrl": "builtin://activate/diros"
|
||||
},
|
||||
"sphinx": {
|
||||
"engine": "go",
|
||||
"version": "go-embedded",
|
||||
"checksumPolicy": "off",
|
||||
"downloadUrl": "builtin://activate/sphinx"
|
||||
},
|
||||
"sqlserver": {
|
||||
"engine": "go",
|
||||
"version": "go-embedded",
|
||||
"checksumPolicy": "off",
|
||||
"downloadUrl": "builtin://activate/sqlserver"
|
||||
},
|
||||
"sqlite": {
|
||||
"engine": "go",
|
||||
"version": "go-embedded",
|
||||
"checksumPolicy": "off",
|
||||
"downloadUrl": "builtin://activate/sqlite"
|
||||
},
|
||||
"duckdb": {
|
||||
"engine": "go",
|
||||
"version": "go-embedded",
|
||||
"checksumPolicy": "off",
|
||||
"downloadUrl": "builtin://activate/duckdb"
|
||||
},
|
||||
"dameng": {
|
||||
"engine": "go",
|
||||
"version": "go-embedded",
|
||||
"checksumPolicy": "off",
|
||||
"downloadUrl": "builtin://activate/dameng"
|
||||
},
|
||||
"kingbase": {
|
||||
"engine": "go",
|
||||
"version": "go-embedded",
|
||||
"checksumPolicy": "off",
|
||||
"downloadUrl": "builtin://activate/kingbase"
|
||||
},
|
||||
"highgo": {
|
||||
"engine": "go",
|
||||
"version": "go-embedded",
|
||||
"checksumPolicy": "off",
|
||||
"downloadUrl": "builtin://activate/highgo"
|
||||
},
|
||||
"vastbase": {
|
||||
"engine": "go",
|
||||
"version": "go-embedded",
|
||||
"checksumPolicy": "off",
|
||||
"downloadUrl": "builtin://activate/vastbase"
|
||||
},
|
||||
"mongodb": {
|
||||
"engine": "go",
|
||||
"version": "go-embedded",
|
||||
"checksumPolicy": "off",
|
||||
"downloadUrl": "builtin://activate/mongodb"
|
||||
},
|
||||
"tdengine": {
|
||||
"engine": "go",
|
||||
"version": "go-embedded",
|
||||
"checksumPolicy": "off",
|
||||
"downloadUrl": "builtin://activate/tdengine"
|
||||
},
|
||||
"postgres": {
|
||||
"engine": "go",
|
||||
"version": "go-embedded",
|
||||
"checksumPolicy": "off",
|
||||
"downloadUrl": "builtin://activate/postgres"
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user