# 1111

**Repository Path**: bks-czy/1111

## Basic Information

- **Project Name**: 1111
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-26
- **Last Updated**: 2026-07-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Go 微服务项目

本项目由 `bw-cli new` 生成，默认是不带业务 demo 的干净框架。当前 module：

```text
xiaolansu
```

## 快速启动

安装依赖并验证：

```bash
make tidy
make proto
make test
```

Makefile 只调用 Go 命令，不依赖 `find`、`sed`、`if [ ... ]` 等 Unix shell 语法；`make proto` 会通过 `tools/protogen` 自动适配 Windows、macOS、Linux。
Windows 仍需要安装 GNU Make；如果没有 `make`，可以直接执行等价的 Go 命令，例如 `go run ./tools/protogen`、`go test ./...`、`go run ./cmd/gateway`。

启动 HTTP gateway：

```bash
make run-gateway
```

端口监听成功后，控制台会输出：

```text
[Gateway Started]
  service: gateway
  env: local
  listen: 0.0.0.0:8080
  http: http://127.0.0.1:8080
  health: http://127.0.0.1:8080/healthz
  api: http://127.0.0.1:8080/api/v1
```

如果端口被占用，控制台会输出 `[Gateway Start Failed]`，并显示失败的监听地址和系统错误。

健康检查：

```bash
curl http://localhost:8080/healthz
```

## 目录结构

```text
api/proto      # 新增 gRPC proto 时放这里
api/gen        # protoc 生成代码
cmd/gateway    # Gin HTTP 网关入口
configs        # YAML 配置
internal       # 业务代码，按服务拆分
pkg            # 公共工具包
docs           # 使用和架构文档
```

新增业务服务时使用脚手架命令：

```bash
bw-cli service order --tidy
```

命令会生成 `cmd/order`、`api/proto/order`、`internal/order/entity`、`internal/order/model`、`internal/order/dto`、`internal/order/service/service.go`、`repo/gorm_repository.go`、`repo/mongo_repository.go`、`handler`、gateway request/handler/router 和 `docs/services/order.md`。生成后的服务默认带 Create/Get/List/Update/Delete 基础 CRUD，并会把服务名、gRPC 端口和 gateway target 写入 `configs/config.yaml`。默认启动使用 Gorm，MongoDB 仓储已通过 `mongox.NewDocumentStore[T]` 预先接好。

需要指定端口时使用：

```bash
bw-cli service order --port 9103 --tidy
```

启动后控制台会输出服务名、环境、监听地址、gRPC 地址和配置项。

绑定已有单表时使用：

```bash
bw-cli service order --table orders --tidy
```

配置单表或多表关联时，可以打开本地可视化设计器：

```bash
bw-cli designer --dir . --addr 127.0.0.1:6060
```

设计器默认使用 `mysql`，DSN 默认示例为：

```text
账号:密码@tcp(服务器IP:3306)/数据库?charset=utf8mb4&parseTime=True&loc=Local
```

界面保存的计划位于 `scaffold-plans/<service>.json`，也可以通过命令行生成：

```bash
bw-cli service product --plan scaffold-plans/product.json --tidy
```

单表计划只选择一张表即可。多表计划会额外生成 `internal/<service>/repo/relationships.go`，包含所选表、表关系和 Gorm Join 查询入口。

如果项目包含 gateway，HTTP CRUD 路由也会自动挂载：

```text
POST   /api/v1/orders
GET    /api/v1/orders
GET    /api/v1/orders/:id
PUT    /api/v1/orders/:id
DELETE /api/v1/orders/:id
```

需要演示项目时请使用：

```bash
bw-cli demo demo-service --module github.com/acme/demo-service --tidy
```