这是我参与「第三届青训营 -后端场」笔记创作活动的的第1篇笔记

MVC分层结构

工程实践-2022-05-10-1930.png

Model-View-Controller

每个层级都自己的职责，各层间禁止跨层级调用，这样可以保证在后期维护中，在底层修改的内容，只需在上一层进行相应的调整，而不需要关心其他层级

数据层（model）：与底层数据的交互
逻辑层（controller）：具体业务逻辑的封装
视图层（view）:数据展示，与与用户交互

view-controller-service-dao

业务层(service)：业务处理，调用数据访问层与数据库进行交互

数据访问层(dao)：它与数据库进行交互，封装了对数据库的CURD操作

代码注释

Repository

元数据定义

type Topic struct {
    Id         int64  `json:"id"`
    Title      string `json:"title"`
    Content    string `json:"content"`
    CreateTime int64  `json:"create_time"`
}

post类似，一个topic对应有多个post，故是切片的形式

创建话题数据索引和对应的初始化函数

var (
    topicIndexMap map[int64]*Topic
    postIndexMap  map[int64][]*Post
)

func initTopicIndexMap(filePath string) error {
    open, err := os.Open(filePath + "topic")
    if err != nil {
        return err
    }
    scanner := bufio.NewScanner(open)
    topicTmpMap := make(map[int64]*Topic)
    for scanner.Scan() {
        text := scanner.Text()
        var topic Topic
        if err := json.Unmarshal([]byte(text), &topic); err != nil {
            return err
        }
        topicTmpMap[topic.Id] = &topic
    }
    topicIndexMap = topicTmpMap
    return nil
}

变量topicIndexMap:

话题topic的索引，通过输入key值topic.Id可以找到对应value，即topic地址

函数initTopicIndexMap:

读取filePath下的topic数据并写入topicIndexMap索引，

根据id查询索引

type TopicDao struct {
}

var (
    topicDao  *TopicDao
    topicOnce sync.Once
)

func NewTopicDaoInstance() *TopicDao {
    topicOnce.Do(
        func() {
            topicDao = &TopicDao{}
        })
    return topicDao
}

func (*TopicDao) QueryTopicById(id int64) *Topic {
    return topicIndexMap[id]
}

变量topicOnce： once类型对应Do方法只被使用一次，适用于高并发场景

函数QueryTopicById:直接从上述的索引topicIndexMap中获取对应id的topic地址，就是做了一层封装

Service

type PageInfo struct {
    Topic    *repository.Topic
    PostList []*repository.Post
}

type QueryPageInfoFlow struct {
    topicId  int64
    pageInfo *PageInfo

    topic *repository.Topic
    posts []*repository.Post
}

QueryPageInfoFlow方法

func (f *QueryPageInfoFlow) Do() (*PageInfo, error) {
    if err := f.checkParam(); err != nil {
        return nil, err
    }
    if err := f.prepareInfo(); err != nil {
        return nil, err
    }
    if err := f.packPageInfo(); err != nil {
        return nil, err
    }
    return f.pageInfo, nil
}

func (f *QueryPageInfoFlow) checkParam() error {
    if f.topicId <= 0 {
        return errors.New("topic id must be larger than 0")
    }
    return nil
}

func (f *QueryPageInfoFlow) prepareInfo() error {
    // 获取topic信息
    var wg sync.WaitGroup
    wg.Add(2)
    go func() {
        defer wg.Done()
        topic := repository.NewTopicDaoInstance().QueryTopicById(f.topicId)
        f.topic = topic
    }()
    // 获取post列表
    go func() {
        defer wg.Done()
        posts := repository.NewPostDaoInstance().QueryPostsByParentId(f.topicId)
        f.posts = posts
    }()
    wg.Wait()
    return nil
}

func (f *QueryPageInfoFlow) packPageInfo() error {
    f.pageInfo = &PageInfo{
        Topic:    f.topic,
        PostList: f.posts,
    }
    return nil
}

方法Do： 用于流程编排，调用下面定义的一系列函数，返回PageInfo信息。包括查验参数合法性、获取topic数据对应地址等

方法checkParam： 检查参数合法性

方法prepareInfo： 通过WaitGroup并发查询topic和对应post地址

Controller

type PageData struct {
    Code int64       `json:"code"`
    Msg  string      `json:"msg"`
    Data interface{} `json:"data"`
}

func QueryPageInfo(topicIdStr string) *PageData {
    topicId, err := strconv.ParseInt(topicIdStr, 10, 64)
    if err != nil {
        return &PageData{
            Code: -1,
            Msg:  err.Error(),
        }
    }
    pageInfo, err := service.QueryPageInfo(topicId)
    if err != nil {
        return &PageData{
            Code: -1,
            Msg:  err.Error(),
        }
    }
    return &PageData{
        Code: 0,
        Msg:  "success",
        Data: pageInfo,
    }

}

QueryPageInfo: 设置状态码，调用service中的方法查询页面数据

Router

func main() {
    if err := Init("./data/"); err != nil {
        os.Exit(-1)
    }
    r := gin.Default()
    r.GET("/community/page/get/:id", func(c *gin.Context) {
        topicId := c.Param("id")
        data := cotroller.QueryPageInfo(topicId)
        c.JSON(200, data)
    })
    err := r.Run()
    if err != nil {
        return
    }
}

func Init(filePath string) error {
    if err := repository.Init(filePath); err != nil {
        return err
    }
    return nil
}

Init: 传入数据地址初始化实例

gin: 启动路由，根据网址传入id返回对应数据（页面的topic和post）

go工程实践：分层结构和实践 | 青训营笔记