Locus 开源项目使用教程

1. 项目目录结构及介绍

Locus 项目的目录结构如下：

locus/
├── cmd/
│   ├── locus/
│   │   └── main.go
├── config/
│   └── config.yaml
├── internal/
│   ├── api/
│   ├── service/
│   └── repository/
├── pkg/
│   ├── logger/
│   └── utils/
├── .gitignore
├── go.mod
├── go.sum
└── README.md

目录结构介绍

• cmd/: 包含项目的启动文件。
  • locus/: 主程序入口目录。
    • main.go: 项目的启动文件。
• config/: 包含项目的配置文件。
  • config.yaml: 项目的配置文件，用于配置应用程序的各种参数。
• internal/: 包含项目的内部逻辑代码。
  • api/: 处理HTTP请求的API层。
  • service/: 业务逻辑层。
  • repository/: 数据访问层。
• pkg/: 包含项目的公共包。
  • logger/: 日志记录包。
  • utils/: 工具包。
• .gitignore: Git忽略文件配置。
• go.mod: Go模块定义文件。
• go.sum: Go模块依赖校验文件。
• README.md: 项目说明文件。

2. 项目启动文件介绍

项目的启动文件位于 cmd/locus/main.go。该文件是整个应用程序的入口点，负责初始化配置、启动服务等操作。

main.go 文件内容概述

package main

import (
    "fmt"
    "log"
    "os"

    "github.com/g-andrade/locus/config"
    "github.com/g-andrade/locus/internal/api"
)

func main() {
    // 加载配置文件
    cfg, err := config.LoadConfig("config/config.yaml")
    if err != nil {
        log.Fatalf("无法加载配置文件: %v", err)
    }

    // 初始化API服务
    server := api.NewServer(cfg)

    // 启动服务
    if err := server.Start(); err != nil {
        log.Fatalf("服务启动失败: %v", err)
    }
}

启动文件功能

• 加载配置文件: 通过 config.LoadConfig 函数加载 config/config.yaml 配置文件。
• 初始化API服务: 使用加载的配置初始化API服务。
• 启动服务: 调用 server.Start() 启动服务。

3. 项目配置文件介绍

项目的配置文件位于 config/config.yaml。该文件用于配置应用程序的各种参数，如数据库连接、日志级别等。

config.yaml 文件内容示例

server:
  port: 8080
  timeout: 30s

database:
  host: localhost
  port: 5432
  user: postgres
  password: secret
  name: locus_db

logging:
  level: info
  output: file
  file: logs/app.log

配置文件参数说明

• server: 服务器配置。
  • port: 服务器监听端口。
  • timeout: 请求超时时间。
• database: 数据库配置。
  • host: 数据库主机地址。
  • port: 数据库端口。
  • user: 数据库用户名。
  • password: 数据库密码。
  • name: 数据库名称。
• logging: 日志配置。
  • level: 日志级别（如 info, debug 等）。
  • output: 日志输出方式（如 file, console 等）。
  • file: 日志文件路径。

通过以上配置文件，可以灵活调整应用程序的行为，以适应不同的运行环境。