Simple Bank 项目教程

1. 项目介绍

Simple Bank 是一个由 TECH SCHOOL 开发的 Go 语言后端项目，旨在教授如何从零开始设计和开发一个后端 Web 服务。该项目模拟了一个简单的银行服务，提供了创建和管理银行账户、记录账户余额变化以及在两个账户之间进行资金转账的功能。

该项目涵盖了从数据库设计、代码生成、API 开发到部署的完整流程，适合初学者和有一定经验的开发者学习 Go 语言后端开发。

2. 项目快速启动

2.1 环境准备

在开始之前，请确保你已经安装了以下工具：

• Docker
• TablePlus
• Golang
• Homebrew
• Migrate
• DB Docs
• DBML CLI
• Sqlc
• Gomock

2.2 克隆项目

首先，克隆项目到本地：

git clone https://github.com/techschool/simplebank.git
cd simplebank

2.3 启动数据库

使用 Docker 启动 PostgreSQL 数据库：

make postgres

创建 simple_bank 数据库：

make createdb

2.4 运行数据库迁移

运行所有数据库迁移：

make migrateup

2.5 启动服务器

启动 Go 服务器：

make server

2.6 运行测试

运行单元测试：

make test

3. 应用案例和最佳实践

3.1 创建和管理银行账户

Simple Bank 提供了创建和管理银行账户的 API。以下是一个创建账户的示例请求：

curl -X POST http://localhost:8080/accounts \
-H "Content-Type: application/json" \
-d '{"owner": "John Doe", "balance": 1000, "currency": "USD"}'

3.2 记录账户余额变化

每次账户余额发生变化时，Simple Bank 会记录一条账户变更记录。这有助于跟踪账户的历史交易。

3.3 资金转账

Simple Bank 支持在两个账户之间进行资金转账。以下是一个转账请求的示例：

curl -X POST http://localhost:8080/transfers \
-H "Content-Type: application/json" \
-d '{"from_account_id": 1, "to_account_id": 2, "amount": 100, "currency": "USD"}'

3.4 最佳实践

• 数据库事务：在处理资金转账等关键操作时，使用数据库事务确保数据一致性。
• 错误处理：正确处理数据库错误和 API 请求错误，提供友好的错误信息。
• 单元测试：编写全面的单元测试，确保代码的正确性和稳定性。

4. 典型生态项目

4.1 Docker

Simple Bank 使用 Docker 来管理数据库和应用的容器化部署，简化了开发和测试环境的搭建。

4.2 Kubernetes

项目教程中还介绍了如何将应用部署到 Kubernetes 集群，适合学习如何在生产环境中管理微服务。

4.3 Gin

Gin 是一个高性能的 Go 语言 Web 框架，Simple Bank 使用 Gin 来构建 RESTful API。

4.4 PostgreSQL

PostgreSQL 是一个强大的开源关系型数据库，Simple Bank 使用 PostgreSQL 来存储和管理数据。

通过学习 Simple Bank 项目，你将掌握 Go 语言后端开发的核心技能，并了解如何使用现代工具和技术构建和部署 Web 服务。