golang项目的一般源码架构

原创

mob64ca12f55920 2024-05-07 06:31:43 ©著作权

©著作权归作者所有：来自51CTO博客作者mob64ca12f55920的原创作品，请联系作者获取转载授权，否则将追究法律责任

Golang项目的一般源码架构

在编写一个Golang项目时，良好的源码架构是非常重要的。一个合理的架构可以使项目更易于维护、扩展和测试。下面我们将介绍一般的Golang项目源码架构，并通过代码示例来展示。

1. 项目结构

一个典型的Golang项目一般会有如下的源码结构：

project/
|-- cmd/
|   |-- main.go
|
|-- pkg/
|   |-- module1/
|   |-- module2/
|
|-- internal/
|   |-- module3/
|   |-- module4/
|
|-- test/
|   |-- module1_test.go
|   |-- module2_test.go
|
|-- go.mod
|-- go.sum

cmd/: 存放项目的入口文件，一般会有一个main.go文件。
pkg/: 存放项目内部可导出的包（公共接口）。
internal/: 存放项目内部私有的包，只能在本项目中使用。
test/: 存放各个模块的单元测试文件。
go.mod和go.sum: 用来管理项目的依赖关系。

2. 代码示例

下面我们以一个简单的旅行图模块为例来展示源码架构。

2.1 旅行图类图

classDiagram
    class Graph {
        -nodes map[string]*Node
        -edges map[string]map[string]*Edge
        +AddNode(id string)
        +AddEdge(from, to string, weight int)
        +ShortestPath(start, end string) []string
    }
    class Node {
        -id string
        +GetID() string
    }
    class Edge {
        -from string
        -to string
        -weight int
        +GetFrom() string
        +GetTo() string
        +GetWeight() int
    }

2.2 旅行图代码示例

package main

import "fmt"

type Node struct {
    id string
}

func (n *Node) GetID() string {
    return n.id
}

type Edge struct {
    from   string
    to     string
    weight int
}

func (e *Edge) GetFrom() string {
    return e.from
}

func (e *Edge) GetTo() string {
    return e.to
}

func (e *Edge) GetWeight() int {
    return e.weight
}

type Graph struct {
    nodes map[string]*Node
    edges map[string]map[string]*Edge
}

func (g *Graph) AddNode(id string) {
    g.nodes[id] = &Node{id}
    g.edges[id] = make(map[string]*Edge)
}

func (g *Graph) AddEdge(from, to string, weight int) {
    g.edges[from][to] = &Edge{from, to, weight}
}

func (g *Graph) ShortestPath(start, end string) []string {
    // 算法实现
    return []string{}
}

func main() {
    g := &Graph{
        nodes: make(map[string]*Node),
        edges: make(map[string]map[string]*Edge),
    }

    g.AddNode("A")
    g.AddNode("B")
    g.AddEdge("A", "B", 10)

    fmt.Println(g.ShortestPath("A", "B"))
}