CHANGELOG.md

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

## v0.15.1

### Changed

- GoFrame 版本升级到 `v2.5.6`
- 优化 `make build` 的版本生成功能, 解决每次执行完 `make build` 后, 仓库从 `clean` 状态变为 `dirty` 状态的问题.

## v0.15.0

### Added

- 增加`hack/go_switcher.sh`脚本, 用于便捷切换 Go 版本(For macOS)

### Changed

- GoFrame 版本升级到 `v2.5.5`
- 优化 `make run`, 支持配置文件变化自动 reload 功能

## v0.14.0

### Changed

- GoFrame 版本升级到 `v2.5.4`
- Go 的最低版本要求由`1.15`变更为`1.18`
- 优化命令行 `make cli.install`
- 优化脚本 `hack/change_project_name.sh`
- 优化`systemctl`和`supervisor`部署方式

## v0.13.0

### Added

- `make ctrl` 增加自动生成 sdk 代码功能 (生成的 sdk 代码位置: `api/sdk/`)

### Changed

- gf 版本升级到 `v2.5.1`
- 当前项目 package 名称由 `gf2-demo` 改为 `github.com/windvalley/gf2-demo`
- 优化 `hack/change_project_name.sh`, 支持带有路径的项目名称

## v0.12.0

### Added

- 增加 mongodb client (`internal/pkg/mongodb`)
- `Makefile` 增加 `make ctrl`
- gf 版本升级到 `v2.5.0`

### Changed

- 优化 redis 配置
- `api/`, `internal/controller/` 代码适配 `gf v2.5.0`
- 更新 README.md 文档, 适配 `gf v2.5.0`

## v0.11.0

### Added

- 新增 redis 常用工具库: `internal/pkg/rediscache`)
- 新增 kafka 客户端以及使用示例(`internal/pkg/kafka` )

### Fixed

- `Makefile`
  - 优化`make cli.install`, 解决因官方 gf cli 升级可能导致的本项目编译报错问题: [#2](https://github.com/windvalley/gf2-demo/issues/2), [#3](https://github.com/windvalley/gf2-demo/issues/3)

## v0.10.0

### Added

封装 redis 常用工具库(位于 `internal/pkg/`), 加速开发效率:

- `redismq`
  常规消息队列, 应用场景: 异步任务处理、解耦系统组件、削峰填谷、日志收集和事件驱动等
- `redisdelaymq`
  延时消息队列, 应用场景: 定时任务调度、延迟通知和订单超时处理等
- `redispubsub`
  发布订阅, 应用场景: 消息广播、实时通知、日志订阅和事件驱动等
- `redislock`
  分布式锁, 应用场景: 并发控制、排他资源访问、分布式任务调度和避免重复操作等

## v0.9.0

### Added

- 增加 `golangci-lint` 的配置文件 `.golangci.yml`, 保障团队代码风格统一, 提高团队代码质量
- 增加关于保障代码质量的相关文档
- `Makefile` 增加 `make lint`, 可进行代码检查(`golangci-lint` 不存在会自动安装)

### Changed

- 根据 `golangci-lint` 的提示, 优化原有代码

## v0.8.0

### Changed

- gf 框架版本升级到 `v2.4.0`, 已支持优雅关闭特性
- README.md
  - 增加优雅关闭特性的相关文档: `项目部署`-`优雅关闭测试`
  - 增加响应 json 中添加`traceid`字段的用途说明: `错误码管理`-`规范制定`-`统一响应格式`

## v0.7.5

### Changed

- gf 框架版本升级到 `v2.3.3`
- 美化 README.md 文档格式

### Fixed

- 修复 `hack/change_project_name.sh` 脚本变更项目名称后 `make build` 失败的问题

## v0.7.4

### Changed

- 优化配置文件, 使服务启动过程中产生的日志和开发者打印的日志(`g.Log()`)使用同一个日志文件.
  问题描述请见: [gogf#2462](https://github.com/gogf/gf/issues/2462)

## v0.7.3

### Changed

- 优化 systemctl 部署服务方式
  - 优化服务文件 `manifest/deploy/systemctl/gf2-demo-api*.service`
  - 优化一键部署脚本 `manifest/deploy/systemctl/deploy.sh`
  - 增加说明文档 `manifest/deploy/systemctl/README.md`
- 优化 `supervisor` 部署服务方式
  - 优化说明文档 `manifest/deploy/supervisor/README.md`
- 优化 README.md 文档
  - 增加 `systemctl/supervisor/docker` 如何优雅关闭服务的说明, 不过需要 `GoFrameV2` 框架提供支持通过捕获 `SIGTERM` 信号实现优雅关闭的功能, 目前测试此功能还不可用(仅优雅重启可用).

## v0.7.2

### Changed

- 进一步优化 Dockerfile, 提高编译速度
- 优化 Makefile
  - 增加参数 OS 和 ARCH, 用于灵活 `make build`
  - 优化 `make image`, 制作 docker 镜像
  - 优化 `make image.push`, 制作 docker 镜像并推送到 docker 仓库
  - 增加 TAG 参数, 用于灵活 `make image`
  - 优化 make 帮助信息: `make` / `make help`
- 优化 README.md 文档

## v0.7.1

### Changed

- 优化 Dockerfile, 暴露编译过程, 使用两阶段构建, 依赖包可缓存, 编译速度快
- 优化 Makefile 文件
- GoFrame V2.3.1 -> V2.3.2

## v0.7.0

### Added

- 增加通过 `systemctl` 一键部署方式
- 增加通过 `supervisor` 一键部署方式
- 增加 `Dockerfile`

### Changed

- 进一步完善 README.md 文档

### Removed

- 删除了 `manifest/docker/`

## v0.6.1

### Added

- 增加获取资源列表接口的代码示例

### Changed

- 响应 json 增加`traceid`字段, 将`msg`字段修改为`message`:

```json
{
  "code": "string",
  "message": "string",
  "traceid": "string",
  "data": null
}
```

- 优化 `401` 和 `403` 的业务错误码描述
- 完善 README.md 文档, 增加详细的开发流程

## v0.6.0

### Added

- 增加关系数据库配置和 sql 日志配置
- 增加将各层串起来的简单 CRUD 示例接口供参考

### Changed

- 优化响应 json 的字段顺序: code -> msg -> data

## v0.5.0

### Added

- 优化工程目录结构, 使支持多个可执行命令
- 规范业务错误码, 中间件统一拦截响应, 规范响应格式
- 完善 HTTP 服务访问日志、HTTP 服务错误日志、开发者打印的日志、其他可执行命令的日志配置
- 多环境管理: 开发环境、测试环境、生产环境
- 编译的二进制文件可打印当前应用的版本信息
- 链路跟踪中间件, 默认使用客户端按规范传递的`X-Request-Id`
- 通过 Makefile 管理项目: `make run`, `make run.cli`, `make build`, `make build.cli` 等

## v0.0.0

### Added

### Changed

### Removed

### Fixed

### Security