kohvip/gin_template
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Cập nhật cấu hình môi trường production và development

Browse Source 
- Thêm file .env.prod với cấu hình chi tiết cho môi trường production
- Cập nhật docker-compose.dev.yml và docker-compose.prod.yml
- Tạo Dockerfile.prod với cấu hình chi tiết cho production
- Bổ sung cấu hình nginx, prometheus, grafana
- Thêm cấu hình backup và monitoring
- Cập nhật README với hướng dẫn chi tiết
This commit is contained in:
koh
2025-03-03 16:31:52 +07:00
parent e2a219cacd
commit 86a60a7861
20 changed files with 572 additions and 509 deletions
Download Patch File Download Diff File Expand all files Collapse all files

524
README.md
View File

@@ -1,410 +1,220 @@
# Senflow Server
# Senflow App
Ứng dụng backend được viết bằng Go, sử dụng MySQL làm cơ sở dữ liệu và Google Wire cho dependency injection.
Ứng dụng Go với Docker cho môi trường development và production.
## Yêu cầu hệ thống
- Go 1.21 hoặc cao hơn
- Docker và Docker Compose
- Make
## Cấu trúc dự án chi tiết
## Cấu Trúc Thư Mục
```
.
├── cmd/ # Điểm vào ứng dụng
│ └── api/ # API server
│ └── main.go # File main khởi động ứng dụng
├── global/ # Biến toàn cục và cấu trúc cấu hình
│ └── global.go # Định nghĩa các biến và cấu trúc toàn cục
├── internal/ # Mã nguồn nội bộ
│ ├── controllers/ # Xử lý request và response
│ │ └── user_controller.go # Controller xử lý các request liên quan đến user
│ ├── initialize/ # Khởi tạo các thành phần của ứng dụng
│ │ ├── loadconfig.go # Đọc cấu hình từ file .env
│ │ ├── logger.go # Khởi tạo logger
│ │ ├── mysql.go # Khởi tạo kết nối MySQL
│ │ └── run.go # Điểm khởi động chính của ứng dụng
│ ├── models/ # Định nghĩa các model dữ liệu
│ │ └── user.go # Model User
│ ├── repositories/ # Tương tác với cơ sở dữ liệu
│ │ └── user_repository.go # Repository xử lý dữ liệu user
│ ├── routers/ # Định nghĩa các router
│ │ ├── router_group.go # Nhóm các router
│ │ └── user/ # Router liên quan đến user
│ │ ├── router_group.go # Nhóm các router user
│ │ └── user_router.go # Định nghĩa các endpoint user
│ ├── services/ # Xử lý logic nghiệp vụ
│ │ └── user_service.go # Service xử lý logic liên quan đến user
│ └── wire/ # Dependency injection với Google Wire
│ ├── injector.go # Định nghĩa các injector
│ ├── wire.go # Định nghĩa các provider
│ └── wire_gen.go # File được tạo tự động bởi Wire
├── logs/ # Thư mục chứa log
├── .air.toml # Cấu hình cho Air (hot-reload)
├── .env # Biến môi trường
├── Dockerfile # Cấu hình Docker cho môi trường production
├── Dockerfile.dev # Cấu hình Docker cho môi trường phát triển
├── Makefile # Các lệnh make
└── docker-compose.yml, docker-compose.dev.yml # Cấu hình Docker Compose
├── Dockerfile.dev
├── Dockerfile.prod
├── docker-compose.dev.yml
├── docker-compose.prod.yml
├── .env.dev
├── .env.prod
├── nginx/
│ └── conf.d/
│ └── default.conf
├── prometheus/
│ └── prometheus.yml
└── scripts/
└── backup.sh
```
## Quy tắc đặt tên file
## Yêu Cầu Hệ Thống
Dự án tuân theo các quy tắc đặt tên file sau để đảm bảo tính nhất quán:
- Docker
- Docker Compose
- Go 1.21 trở lên
1. **Sử dụng dấu gạch dưới (_) để phân tách các từ** trong tên file, ví dụ: `user_controller.go`, `user_repository.go`.
## Môi Trường Development
2. **Tên file mô tả rõ chức năng** của file đó:
- Controllers: `<entity>_controller.go` (ví dụ: `user_controller.go`)
- Services: `<entity>_service.go` (ví dụ: `user_service.go`)
- Repositories: `<entity>_repository.go` (ví dụ: `user_repository.go`)
- Routers: `<entity>_router.go` (ví dụ: `user_router.go`)
- Models: `<entity>.go` (ví dụ: `user.go`)
### Cấu Hình
3. **File khởi tạo và cấu hình** sử dụng tên mô tả chức năng:
- `loadconfig.go`: Đọc cấu hình
- `logger.go`: Khởi tạo logger
- `mysql.go`: Khởi tạo kết nối MySQL
- `run.go`: Điểm khởi động ứng dụng
4. **File Wire** tuân theo quy ước của Google Wire:
- `wire.go`: Định nghĩa các provider
- `injector.go`: Định nghĩa các injector
- `wire_gen.go`: File được tạo tự động bởi Wire
## Kiến trúc ứng dụng
Ứng dụng được tổ chức theo kiến trúc phân lớp:
1. **Controllers**: Xử lý request và response, gọi các service để thực hiện logic nghiệp vụ.
2. **Services**: Chứa logic nghiệp vụ, gọi các repository để tương tác với dữ liệu.
3. **Repositories**: Tương tác trực tiếp với cơ sở dữ liệu, thực hiện các thao tác CRUD.
4. **Models**: Định nghĩa cấu trúc dữ liệu.
5. **Routers**: Định nghĩa các endpoint API và kết nối với controllers.
6. **Wire**: Quản lý dependency injection, kết nối các thành phần lại với nhau.
## Dependency Injection với Google Wire
Dự án sử dụng Google Wire để quản lý dependency injection. Các thành phần chính:
1. **Provider**: Định nghĩa cách tạo các dependency (trong `wire.go`).
2. **Injector**: Định nghĩa cách kết nối các dependency (trong `injector.go`).
3. **Wire Gen**: File được tạo tự động bởi Wire, chứa code khởi tạo dependency (trong `wire_gen.go`).
Để cập nhật file `wire_gen.go` sau khi thay đổi các provider hoặc injector:
```bash
cd internal/wire
go run github.com/google/wire/cmd/wire
1. Tạo file `.env.dev`:
```env
PORT=8080
APP_ENV=development
BLUEPRINT_DB_HOST=mysql_bp
BLUEPRINT_DB_PORT=3306
BLUEPRINT_DB_DATABASE=blueprint
BLUEPRINT_DB_USERNAME=root
BLUEPRINT_DB_PASSWORD=root
BLUEPRINT_DB_ROOT_PASSWORD=root
BLUEPRINT_DB_MAX_IDLE_CONNS=10
BLUEPRINT_DB_MAX_OPEN_CONNS=100
BLUEPRINT_DB_CONN_MAX_LIFETIME=1h
LOGGER_LOG_LEVEL=debug
LOGGER_FILE_LOG_NAME=logs/app.log
LOGGER_MAX_SIZE=100
LOGGER_MAX_BACKUPS=3
LOGGER_MAX_AGE=28
LOGGER_COMPRESS=true
```
## Môi trường phát triển (Development)
### Phương pháp 1: Sử dụng Docker Compose cho toàn bộ stack
Phương pháp này sử dụng Docker Compose để chạy cả ứng dụng Go và MySQL, với hot-reload được hỗ trợ bởi Air.
### Chạy Ứng Dụng
```bash
# Khởi động môi trường phát triển
# Build và chạy
docker-compose -f docker-compose.dev.yml up --build
# Chạy ở chế độ detached
docker-compose -f docker-compose.dev.yml up -d
# Xem logs
docker-compose -f docker-compose.dev.yml logs -f
# Dừng môi trường phát triển
# Dừng ứng dụng
docker-compose -f docker-compose.dev.yml down
```
### Phương pháp 2: Chạy ứng dụng Go trực tiếp, MySQL trong Docker
## Môi Trường Production
```bash
# Khởi động MySQL trong Docker
make docker-run
### Cấu Hình
# Chạy ứng dụng với hot-reload
make watch
# Hoặc chạy ứng dụng thông thường
make run
# Dừng MySQL
make docker-down
```
## Môi trường sản xuất (Production)
### Phương pháp 1: Sử dụng Docker Compose
```bash
# Khởi động môi trường sản xuất
docker-compose up -d
# Xem logs
docker-compose logs -f
# Dừng môi trường sản xuất
docker-compose down
```
### Phương pháp 2: Triển khai thủ công
```bash
# Build ứng dụng
make build
# Hoặc build với Go trực tiếp
go build -o main cmd/api/main.go
# Chạy ứng dụng
./main
```
## Các lệnh Make hữu ích
```bash
# Build ứng dụng
make build
# Chạy ứng dụng
make run
# Chạy tests
make test
# Chạy integration tests
make itest
# Dọn dẹp binary
make clean
# Hot-reload trong quá trình phát triển
make watch
# Khởi động container MySQL
make docker-run
# Dừng container MySQL
make docker-down
```
## Biến môi trường
Sao chép file `.env.example` thành `.env` và điều chỉnh các giá trị theo nhu cầu của bạn:
```
# Cấu hình ứng dụng
APP_ENV=development # development hoặc production
1. Tạo file `.env.prod`:
```env
PORT=8080
# Cấu hình database
APP_ENV=production
BLUEPRINT_DB_HOST=mysql_bp
BLUEPRINT_DB_PORT=3306
BLUEPRINT_DB_DATABASE=blueprint
BLUEPRINT_DB_USERNAME=user
BLUEPRINT_DB_PASSWORD=password
BLUEPRINT_DB_ROOT_PASSWORD=root_password
BLUEPRINT_DB_USERNAME=root
BLUEPRINT_DB_PASSWORD=your_secure_password
BLUEPRINT_DB_ROOT_PASSWORD=your_secure_root_password
BLUEPRINT_DB_MAX_IDLE_CONNS=10
BLUEPRINT_DB_MAX_OPEN_CONNS=100
BLUEPRINT_DB_CONN_MAX_LIFETIME=3600
# Cấu hình logger
LOGGER_LOG_LEVEL=debug
LOGGER_FILE_LOG_NAME=./logs/app.log
LOGGER_MAX_SIZE=10
LOGGER_MAX_BACKUPS=5
BLUEPRINT_DB_CONN_MAX_LIFETIME=1h
LOGGER_LOG_LEVEL=info
LOGGER_FILE_LOG_NAME=logs/app.log
LOGGER_MAX_SIZE=1000
LOGGER_MAX_BACKUPS=7
LOGGER_MAX_AGE=30
LOGGER_COMPRESS=true
GRAFANA_ADMIN_PASSWORD=your_secure_grafana_password
```
## Graceful Shutdown
### Tính Năng Production
Ứng dụng hỗ trợ graceful shutdown để đảm bảo tất cả các request đang xử lý được hoàn thành trước khi ứng dụng dừng lại. Khi nhận tín hiệu SIGINT hoặc SIGTERM (ví dụ: khi nhấn Ctrl+C), ứng dụng sẽ:
1. **Load Balancing**
- Nginx làm load balancer
- 3 instance của ứng dụng
- Health check tự động
- SSL/TLS support
1. Dừng nhận request mới
2. Đợi các request đang xử lý hoàn thành (tối đa 5 giây)
3. Đóng kết nối đến cơ sở dữ liệu
4. Hiển thị thông báo "Graceful shutdown complete."
2. **Monitoring**
- Prometheus cho metrics collection
- Grafana cho visualization
- Metrics từ app và MySQL
- Persistent storage cho dữ liệu monitoring
## Thêm tính năng mới
3. **Backup**
- Backup MySQL tự động hàng ngày
- Nén backup với gzip
- Giữ backup trong 7 ngày
- Volume riêng cho backups
Để thêm một tính năng mới vào ứng dụng, bạn cần:
4. **High Availability**
- Health checks cho tất cả services
- Auto-restart policy
- Network isolation
- Replica management
1. Tạo model mới trong thư mục `internal/models`
2. Tạo repository mới trong thư mục `internal/repositories`
3. Tạo service mới trong thư mục `internal/services`
4. Tạo controller mới trong thư mục `internal/controllers`
5. Tạo router mới trong thư mục `internal/routers`
6. Cập nhật các provider trong `internal/wire/wire.go`
7. Cập nhật injector trong `internal/wire/injector.go`
8. Chạy lệnh wire để cập nhật `wire_gen.go`
9. Cập nhật `internal/initialize/run.go` để khởi tạo router mới
## Đóng góp
Vui lòng đảm bảo code của bạn tuân theo các quy tắc đặt tên và cấu trúc dự án đã được mô tả ở trên. Sử dụng `gofmt` để định dạng code trước khi commit.
## Chức năng của các thư mục chính
### cmd
Chứa điểm vào của ứng dụng. Thư mục `api` chứa file `main.go` - nơi khởi động ứng dụng.
### global
Chứa các biến và cấu hình toàn cục được sử dụng trong toàn bộ ứng dụng:
- `global.go`: Định nghĩa các biến toàn cục như DB, Logger
- `config.go`: Định nghĩa cấu trúc cấu hình ứng dụng
### internal
Chứa mã nguồn nội bộ của ứng dụng, được tổ chức theo kiến trúc phân lớp:
#### controllers
Xử lý HTTP request và response, gọi đến services để thực hiện logic nghiệp vụ:
- `interfaces.go`: Định nghĩa các interface cho controllers
- `controllers.go`: Struct chứa tất cả controllers để sử dụng với dependency injection
- Các file controller cụ thể: `user_controller.go`, `product_controller.go`, ...
#### services
Chứa logic nghiệp vụ của ứng dụng:
- `interfaces.go`: Định nghĩa các interface cho services
- Các file service cụ thể: `user_service.go`, `product_service.go`, ...
#### repositories
Tương tác với cơ sở dữ liệu, thực hiện các thao tác CRUD:
- `interfaces.go`: Định nghĩa các interface cho repositories
- Các file repository cụ thể: `user_repository.go`, `product_repository.go`, ...
#### models
Định nghĩa cấu trúc dữ liệu và các phương thức liên quan:
- Các file model cụ thể: `user.go`, `product.go`, ...
#### routers
Định nghĩa các routes của ứng dụng:
- `router_group.go`: Khởi tạo tất cả routes
- Các thư mục route cụ thể: `user/`, `product/`, ...
#### middleware
Chứa các middleware được sử dụng trong ứng dụng như authentication, logging, ...
#### initialize
Khởi tạo các thành phần của ứng dụng:
- `loadconfig.go`: Tải cấu hình từ file .env
- `logger.go`: Khởi tạo logger
- `mysql.go`: Khởi tạo kết nối MySQL
- `run.go`: Khởi động ứng dụng
#### wire
Quản lý dependency injection với Google Wire:
- `wire.go`: Định nghĩa các providers
- `injector.go`: Định nghĩa các injectors
- `wire_gen.go`: File được tạo tự động bởi Wire
### pkg
Chứa các thư viện và tiện ích có thể được sử dụng bởi các ứng dụng khác:
- `utils/`: Các hàm tiện ích
### configs
Chứa các file cấu hình của ứng dụng.
## Kiến trúc ứng dụng
Ứng dụng được thiết kế theo kiến trúc phân lớp:
1. **Controller Layer**: Xử lý HTTP request và response
2. **Service Layer**: Xử lý logic nghiệp vụ
3. **Repository Layer**: Tương tác với cơ sở dữ liệu
4. **Model Layer**: Định nghĩa cấu trúc dữ liệu
Mỗi lớp chỉ giao tiếp với lớp liền kề, giúp giảm sự phụ thuộc và dễ dàng thay đổi implementation mà không ảnh hưởng đến các lớp khác.
## Dependency Injection với Google Wire
Ứng dụng sử dụng Google Wire để quản lý dependency injection. Các thành phần được định nghĩa trong `wire.go` và được kết nối tự động bởi Wire.
Cấu trúc Wire:
- `RepositorySet`: Providers cho repositories
- `ServiceSet`: Providers cho services
- `ControllerSet`: Providers cho controllers
- `AppSet`: Tập hợp tất cả providers
Khi thêm một thành phần mới (ví dụ: Product, Gift), bạn cần:
1. Tạo model, repository, service, controller tương ứng
2. Thêm interface vào các file `interfaces.go`
3. Cập nhật struct `Controllers` trong `controllers.go`
4. Thêm providers vào `wire.go`
5. Chạy lệnh wire để cập nhật `wire_gen.go`
## Môi trường phát triển
### Yêu cầu
- Go 1.16+
- MySQL 8.0+
- Docker và Docker Compose (tùy chọn)
### Cài đặt và chạy
1. Clone repository:
```
git clone https://github.com/dungnt11/senflow_app.git
cd senflow_app
```
2. Cài đặt dependencies:
```
go mod download
```
3. Tạo file .env từ .env.example:
```
cp .env.example .env
```
4. Chạy ứng dụng:
```
go run cmd/api/main.go
```
### Sử dụng Docker
### Chạy Production
```bash
docker-compose up -d
# Build và chạy
docker-compose -f docker-compose.prod.yml --env-file .env.prod up --build -d
# Xem logs
docker-compose -f docker-compose.prod.yml logs -f
# Dừng services
docker-compose -f docker-compose.prod.yml down
```
## API Endpoints
### Endpoints
### User
- `POST /api/v1/users/register`: Đăng ký người dùng mới
- `POST /api/v1/users/login`: Đăng nhập
- `GET /api/v1/users/profile`: Lấy thông tin profile
- `PUT /api/v1/users/profile`: Cập nhật profile
- App instances: http://localhost:8083, http://localhost:8084, http://localhost:8085
- Nginx (Load Balancer): http://localhost:80
- Grafana: http://localhost:3000
- Prometheus: http://localhost:9090
### Product
- `POST /api/v1/products`: Tạo sản phẩm mới
- `GET /api/v1/products`: Lấy tất cả sản phẩm
- `GET /api/v1/products/:id`: Lấy thông tin sản phẩm theo ID
- `PUT /api/v1/products/:id`: Cập nhật sản phẩm
- `DELETE /api/v1/products/:id`: Xóa sản phẩm
## Bảo Mật
## Quy ước đặt tên
1. **SSL/TLS**
- Thêm certificates vào `nginx/ssl/`
- Cấu hình SSL trong Nginx
### Files
- Controllers: `<entity>_controller.go`
- Services: `<entity>_service.go`
- Repositories: `<entity>_repository.go`
- Models: `<entity>.go`
- Routers: `<entity>_router.go`
2. **Mật Khẩu**
- Thay đổi mật khẩu trong `.env.prod`
- Sử dụng mật khẩu mạnh
- Không commit file .env
### Interfaces
- Controllers: `I<Entity>Controller`
- Services: `I<Entity>Service`
- Repositories: `I<Entity>Repository`
3. **Network**
- Cấu hình firewall
- Giới hạn ports
- Sử dụng internal networks
## Đóng góp
## Monitoring
1. Fork repository
2. Tạo branch mới: `git checkout -b feature/your-feature-name`
3. Commit changes: `git commit -m 'Add some feature'`
4. Push to branch: `git push origin feature/your-feature-name`
5. Submit pull request
1. **Grafana Dashboards**
- App metrics
- MySQL metrics
- System metrics
## License
2. **Alerts**
- Cấu hình trong Prometheus
- Thông báo qua email/Slack
[MIT](LICENSE)
## Backup & Recovery
1. **Backup**
- Tự động hàng ngày
- Nén với gzip
- Giữ 7 ngày
2. **Recovery**
```bash
# Restore từ backup
gunzip -c backup_YYYYMMDD_HHMMSS.sql.gz | mysql -h mysql_bp -u root -p blueprint
```
## Troubleshooting
1. **Logs**
```bash
# App logs
docker-compose -f docker-compose.prod.yml logs app
# MySQL logs
docker-compose -f docker-compose.prod.yml logs mysql_bp
# Nginx logs
docker-compose -f docker-compose.prod.yml logs nginx
```
2. **Health Checks**
- App: http://localhost:8080/health
- MySQL: docker-compose exec mysql_bp mysqladmin ping
- Nginx: http://localhost/health
## Maintenance
1. **Update**
```bash
# Pull latest images
docker-compose -f docker-compose.prod.yml pull
# Rebuild và restart
docker-compose -f docker-compose.prod.yml up -d --build
```
2. **Cleanup**
```bash
# Xóa unused volumes
docker volume prune
# Xóa old images
docker image prune
```