Go语言项目结构指南：从代码包的角度看如何编写高质量的Go代码

// 项目根目录下的cmd子目录中的app子目录
package main

import (
  "flag"
  "fmt"
  "log"
  "myproject/pkg/server"
)

func main() {
  // 解析命令行参数
  port := flag.Int("port", 8080, "server port")
  flag.Parse()

  // 创建并启动服务器
  s := server.New(*port)
  if err := s.Start(); err != nil {
    log.Fatal(err)
  }

  // 等待用户输入退出信号
  fmt.Println("Press Ctrl+C to exit...")
  <-s.Done()

  // 停止服务器
  if err := s.Stop(); err != nil {
    log.Println(err)
  }
}

// 项目根目录下的pkg子目录中的server子目录
package server

import (
  "context"
  "fmt"
  "net/http"
)

// Server 是一个HTTP服务器
type Server struct {
  port   int
  server *http.Server
  done   chan struct{}
}

// New 创建一个新的Server
func New(port int) *Server {
  return &Server{
    port: port,
    done: make(chan struct{}),
  }
}

// Start 启动Server
func (s *Server) Start() error {
  // 创建一个HTTP多路复用器
  mux := http.NewServeMux()

  // 注册路由处理函数
  mux.HandleFunc("/", s.handleIndex)
  mux.HandleFunc("/hello", s.handleHello)

  // 创建一个HTTP服务器
  s.server = &http.Server{
    Addr:    fmt.Sprintf(":%d", s.port),
    Handler: mux,
  }

  // 在一个新的协程中启动服务器
  go func() {
    if err := s.server.ListenAndServe(); err != nil && err != http.ErrServerClosed {
      panic(err)
    }
  }()

  return nil
}

// Stop 停止Server
func (s *Server) Stop() error {
  // 关闭服务器
  if err := s.server.Shutdown(context.Background()); err != nil {
    return err
  }

  // 关闭信号通道
  close(s.done)

  return nil
}

// Done 返回一个只读的信号通道
func (s *Server) Done() <-chan struct{} { return s.done }

// handleIndex 处理根路径的请求 
func (s *Server) handleIndex(w http.ResponseWriter, r *http.Request){ 
  fmt.Fprintln(w, “Welcome to my server!”) 
}

// handleHello 处理/hello路径的请求 
func (s *Server) handleHello(w http.ResponseWriter, r *http.Request) { 
  name := r.URL.Query().Get(“name”)
  if name == “” { 
    name = “world” 
  } 
  fmt.Fprintf(w, “Hello, %s!\n”, name)
}

// 项目根目录下的internal子目录中的service子目录
package service

import (
  "myproject/pkg/client"
  "myproject/pkg/model"
)

// Service 是一个业务逻辑层
type Service struct {
  client *client.Client
}

// New 创建一个新的Service
func New(client *client.Client) *Service {
  return &Service{
    client: client,
  }
}

// GetUsers 获取所有用户信息
func (s *Service) GetUsers() ([]*model.User, error) {
  // 调用client获取用户数据
  users, err := s.client.GetUsers()
  if err != nil {
    return nil, err
  }

  // 对用户数据进行一些处理或转换
  // ...

  return users, nil
}

// GetUserByID 根据ID获取用户信息
func (s *Service) GetUserByID(id int) (*model.User, error) {
  // 调用client获取用户数据
  user, err := s.client.GetUserByID(id)
  if err != nil {
    return nil, err
  }

  // 对用户数据进行一些处理或转换
  // ...

  return user, nil
}

// 项目根目录下的pkg子目录中的client子目录
package client

import (
  "encoding/json"
  "fmt"
  "io/ioutil"
  "net/http"
  "myproject/pkg/model"
)

// Client 是一个用来连接第三方服务的客户端
type Client struct {
  baseURL string
  client  *http.Client
}

// New 创建一个新的Client
func New(baseURL string) *Client {
  return &Client{
    baseURL: baseURL,
    client:  &http.Client{},
  }
}

// GetUsers 获取所有用户信息
func (c *Client) GetUsers() ([]*model.User, error) {
  // 构造请求URL
  url := fmt.Sprintf("%s/users", c.baseURL)

  // 发送GET请求
  resp, err := c.client.Get(url)
  if err != nil {
    return nil, err
  }
  defer resp.Body.Close()

  // 读取响应体数据
  data, err := ioutil.ReadAll(resp.Body)
  if err != nil {
    return nil, err
  }

  // 解析响应体数据为用户切片
  var users []*model.User
  if err := json.Unmarshal(data, &users); err != nil {
    return nil, err
  }

  return users, nil
}

// GetUserByID 根据ID获取用户信息
func (c *Client) GetUserByID(id int) (*model.User, error) {
  // 构造请求URL
  url := fmt.Sprintf("%s/users/%d", c.baseURL, id)
  // 发送GET请求 
  resp, err := c.client.Get(url) 
  if err != nil {
   return nil, err 
  } 
  defer resp.Body.Close()
  // 读取响应体数据
  data, err := ioutil.ReadAll(resp.Body)
  if err != nil {
    return nil, err
  }

  // 解析响应体数据为用户结构体
  var user *model.User
  if err := json.Unmarshal(data, &user); err != nil {
    return nil, err
  }
  return user, nil
}

// 项目根目录下的pkg子目录中的model子目录
package model

// User 是一个用户数据模型
type User struct {
  ID    int    `json:"id"`
  Name  string `json:"name"`
  Email string `json:"email"`
}