Heighliner 项目教程-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00039/article/details/142014867

Heighliner 项目教程

heighlinerAn app development platform using cloud native stacks项目地址:https://gitcode.com/gh_mirrors/hei/heighliner

1. 项目目录结构及介绍

Heighliner 项目的目录结构如下：

heighliner/
├── docs/
│   ├── README.md
│   └── ...
├── src/
│   ├── main.go
│   ├── config/
│   │   ├── config.go
│   │   └── ...
│   └── ...
├── .gitignore
├── go.mod
├── go.sum
└── ...

目录结构介绍

docs/: 存放项目的文档文件，包括 README.md 等。
src/: 项目的源代码目录，包含主要的代码文件和子目录。
- main.go: 项目的启动文件。
- config/: 存放项目的配置文件和相关代码。
.gitignore: Git 忽略文件，指定哪些文件或目录不需要被版本控制。
go.mod: Go 模块文件，定义项目的依赖关系。
go.sum: Go 模块的校验文件，确保依赖的完整性和安全性。

2. 项目启动文件介绍

项目的启动文件是 src/main.go。该文件是整个项目的入口点，负责初始化项目并启动服务。

`main.go` 文件内容概览

package main

import (
    "fmt"
    "heighliner/config"
    "heighliner/src/server"
)

func main() {
    // 加载配置
    config.LoadConfig()

    // 启动服务器
    server.Start()

    fmt.Println("Heighliner 项目已启动")
}

启动文件功能

加载配置: 调用 config.LoadConfig() 函数加载项目的配置文件。
启动服务器: 调用 server.Start() 函数启动项目的服务器。

3. 项目配置文件介绍

项目的配置文件主要存放在 src/config/ 目录下，其中 config.go 是主要的配置文件。

`config.go` 文件内容概览

package config

import (
    "fmt"
    "os"
)

type Config struct {
    Port string
    Host string
}

var Cfg Config

func LoadConfig() {
    Cfg.Port = os.Getenv("PORT")
    Cfg.Host = os.Getenv("HOST")

    if Cfg.Port == "" {
        Cfg.Port = "8080"
    }

    if Cfg.Host == "" {
        Cfg.Host = "localhost"
    }

    fmt.Println("配置已加载")
}