Introduction to the structure of gocore-v2 framework scaffold generation project

Github
Official document address - Ongoing update

Scaffolding allows you to quickly build projects , No need to 0 Start creating directory structure , There is no need to copy historical items and replace the item name uniformly , You can quickly generate the project structure and basic skeleton code with one line of command , And integrate the concept of interface development ADM（Api-Domain-Model） Develop the constraints of specifications in a hierarchical way .

The directory structure is as follows ：

.
├── Dockerfile #docker Image packaging 
├── README.md # Project introduction 
├── app 
│   ├── api #api Interface entry 
│   │   └── user.go
│   ├── cronjob # Timing task , Business logic processing 
│   │   └── sync_user.go
│   ├── def #api Interface request parameter and response parameter declaration 
│   │   └── def.go
│   ├── domain # The final business logic processing 
│   │   └── user.go
│   ├── errcode # Error code declaration 
│   │   └── errcode.go
│   ├── job # One time task , Permanent mission , Business logic 
│   │   └── init_user.go
│   ├── model
│   │   └── app #model Catalog ,app For database name 
│   │       ├── mysql_client.go # database db Build table , obtain db example 
│   │       └── user.go #model file ,user It's the name of the table 
│   └── routes
│       └── routers.go  # Routing rule settings 
├── cmd # Program start entry 
│   ├── api.go #api Interface start command 
│   ├── cron.go # Scheduled task start command 
│   ├── init.go # To configure , database ,redis Equal initialization 
│   └── job.go # One time task , Resident task start command 
├── common # Store global variables , Public methods 
├── conf # Profile directory 
│   ├── base.go # Basic general configuration , It will eventually be incorporated into the project configuration 
│   ├── const.go # Global constants 
│   └── local.go # The local configuration environment variable is local Will use 
├── go.mod
├── go.sum
├── gocore.yaml #gocore Project generation configuration file 
├── main.go # Program entrance 
└── pkg # Public kits 

ADM（Api-Domain-Model）

The project directory structure follows a certain development concept .

Api Layer can be understood as the place where the request starts and ends and the business is combined

• Mainly responsible for the following things :
  • Get the request parameters and verify the validity of the request parameters
  • Yes Domain The implementation of the domain layer is spliced to form the business of the whole interface
  • Process the returned results
• Api The interface layer should do ：
  • Perform necessary detection of user login status
  • Control the main process of business scenarios , Create a domain business instance , And call
  • Make necessary log records
  • Return interface result
• Api The interface layer should not ：
  • Process or calculate business rules
  • Care about whether data is cached , Or perform cache related direct operations
  • Direct operation database

Domain The layer is responsible for handling specific business logic

• Divide and reuse complex business code ：
  • One method can only accomplish one thing , Complex logic should be split
  • Domain Layers minimize calls to each other , Should be determined by the API Layer splicing （API The layer can see at a glance what the whole interface should do ）
  • The core single test focuses on Domain In the layer

Model The layer is responsible for obtaining data

• Unified data access improves scalability ：
  • Each method accomplishes only one thing , such as GetInfoById、UpdateNameById、GetCountUser
  • Avoid defining very general methods , such as where Conditions are passed as strings , Easily lead to SQL Injection problem
  • You can adjust the data structure or optimize the cache by modifying only one file , There is no need to modify the business logic layer