Skip to content

Latest commit

 

History

History
253 lines (193 loc) · 6.58 KB

README.Md

File metadata and controls

253 lines (193 loc) · 6.58 KB
Raw

Go Clean Architecture Example

Go Version Last Commit Open Issues License: MIT

This is an example project demonstrating Clean Architecture principles in Go. It is a simple blog application that allows you to create and retrieve blog posts. The project structure is designed to separate concerns and make the application easy to maintain and test.

Project Structure

The project is organized into the following layers:

  1. Entities: Core business logic.
  2. Use Cases (Interactors): Application-specific business rules.
  3. Interface Adapters: Adapters for the user interface, database, web controllers, etc.
  4. Frameworks and Drivers: Framework-specific code, like routing, databases, etc.

Directory Structure

.
│   .gitignore
│   coverage
│   go.mod
│   go.sum
│   gocleanarchitecture.exe
│   GoCleanArchitecture.Md
│   LICENSE
│   README.Md
│
├───.vscode
│       settings.json
│
├───cmd
│       blog.db
│       blogposts.json
│       gocleanarchitecture.exe
│       main.go
│       server.log
│
├───config
│       config.go
│
├───entities
│       blog_post.go
│
├───errors
│       errors.go
│
├───frameworks
│   ├───db
│   │   │   in_memory_blog_post_repository.go
│   │   │
│   │   └───sqlite
│   │           blog_post_repository.go
│   │           sqlite.go
│   │
│   ├───logger
│   │       logger.go
│   │
│   └───web
│       │   router.go
│       │
│       └───middleware
│               logging.go
│               recovery.go
│
├───interfaces
│       blog_post_controller.go
│       blog_post_repository.go
│
├───tests
│   ├───entities
│   │       blog_post_test.go
│   │
│   ├───errors
│   │       errors_test.go
│   │
│   ├───frameworks
│   │   ├───db
│   │   │       in_memory_blog_post_repository_test.go
│   │   │       sqlite_blog_post_repository_test.go
│   │   │
│   │   └───logger
│   │           logger_test.go
│   │
│   ├───interfaces
│   │       blog_post_controller_test.go
│   │
│   └───usecases
│           blog_post_usecase_test.go
│
└───usecases
        blog_post_usecase.go

Why Clean Architecture?

Clean Architecture promotes separation of concerns, making your codebase easier to maintain and test. Here are some benefits:

  • Testability: Each layer can be tested independently.
  • Maintainability: Changes in one layer have minimal impact on other layers.
  • Scalability: Easily extend functionality by adding new layers or components.
  • Flexibility: Swap out frameworks or tools with minimal changes to the overall architecture.

Getting Started

Features

  • CRUD operations for blog posts
  • Clean Architecture implementation
  • SQLite database integration
  • In-memory database option
  • Custom error handling
  • Structured logging
  • Middleware for logging and recovery

Prerequisites

  • Go 1.17 or higher
  • SQLite3 (for this sample) You can use SQL, Firebase, Postgresql or whatever you choose.

Installation

  1. Clone the repository:

    git clone https://github.com/tomblanchard312/gocleanarchitecture.git
cd gocleanarchitecture

  2. Install dependencies:

    go mod tidy

Running the Application

  1. Build the application:

    cd cmd
go build -o gocleanarchitecture.exe ./cmd

  2. Run the application:

    ./gocleanarchitecture.exe

  3. The server will start on port 8080. You can test the endpoints using curl or any API testing tool.

API Endpoints

  • POST /blogposts: Create a new blog post
  • GET /blogposts: Retrieve all blog posts
  • GET /blogposts/{id}: Retrieve a specific blog post
  • PUT /blogposts/{id}: Update a blog post
  • DELETE /blogposts/{id}: Delete a blog post

Create a Blog Post

curl -X POST http://localhost:8080/blogposts -H "Content-Type: application/json" -d '{"ID":"1", "Title":"Test Title", "Content":"Test Content"}'

Get All Blog Posts

curl http://localhost:8080/blogposts

Running Tests

To run all tests:

go test ./...

To run tests for a specific package:

go test ./tests/entities
go test ./tests/usecases
go test ./tests/interfaces
go test ./tests/frameworks/db
go test ./tests/frameworks/logger

To run a specific test function:

go test ./tests/entities -run TestBlogPostCreation
go test ./tests/usecases -run TestCreateBlogPost

To run tests with verbose output:

go test -v ./tests/...

To run tests and see coverage:

go test ./tests/... -coverprofile=coverage.out
go tool cover -html=coverage.out

Logging

Logs are written to server.log for debugging purposes. Ensure the log file is writable and check it for any server-related errors. License

Error Handling

This project uses custom error types defined in the errors package. All errors are logged and appropriate HTTP status codes are returned to the client.

Dependencies

Configuration

The application can be configured using environment variables:

  • SERVER_PORT: The port on which the server will run (default: ":8080")
  • DB_PATH: The path to the SQLite database file (default: "./blog.db")
  • LOG_LEVEL: The logging level (default: "info")
  • LOG_FILE: The path to the log file (default: "server.log")

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Future Improvements

  • Add authentication and authorization
  • Implement a persistent database
  • Add more CRUD operations for blog posts

Licensing

This project is licensed under the MIT License. See the LICENSE file for details.

Acknowledgments