Shiori 项目教程

Shiori 项目教程

Shiori The app you need for Genshin Impact 项目地址: https://gitcode.com/gh_mirrors/shio/Shiori

1. 项目的目录结构及介绍

Shiori 项目的目录结构如下：

Shiori/
├── cmd/
│   ├── shiori/
│   │   └── main.go
├── docs/
│   ├── README.md
│   └── ...
├── internal/
│   ├── handler/
│   ├── model/
│   ├── service/
│   └── ...
├── web/
│   ├── assets/
│   ├── templates/
│   └── ...
├── go.mod
├── go.sum
└── ...

目录结构介绍

• cmd/: 包含项目的入口文件，通常是 main.go 文件所在的位置。
• docs/: 包含项目的文档文件，如 README.md 等。
• internal/: 包含项目的内部逻辑代码，如处理请求的 handler、数据模型 model、业务逻辑 service 等。
• web/: 包含项目的 Web 相关资源，如静态文件 assets 和模板文件 templates。
• go.mod 和 go.sum: Go 语言项目的依赖管理文件。

2. 项目的启动文件介绍

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

main.go 文件内容概览

package main

import (
    "log"
    "net/http"
    "github.com/Wolfteam/Shiori/internal/handler"
)

func main() {
    // 初始化配置
    config := loadConfig()

    // 初始化路由
    router := handler.NewRouter(config)

    // 启动服务器
    log.Fatal(http.ListenAndServe(":8080", router))
}

启动文件功能

• 初始化配置: 从配置文件或环境变量中加载配置。
• 初始化路由: 设置 HTTP 请求的路由规则。
• 启动服务器: 启动 HTTP 服务器，监听指定端口。

3. 项目的配置文件介绍

Shiori 项目的配置文件通常是一个 JSON 或 YAML 文件，用于配置数据库连接、服务器端口等信息。

配置文件示例

{
    "server": {
        "port": 8080
    },
    "database": {
        "type": "sqlite3",
        "connectionString": "shiori.db"
    }
}

配置文件字段介绍

• server.port: 服务器监听的端口号。
• database.type: 数据库类型，如 sqlite3、mysql 等。
• database.connectionString: 数据库连接字符串，指定数据库文件路径或连接信息。

配置文件加载

在 main.go 中，通常会有一个 loadConfig 函数来加载配置文件：

func loadConfig() *Config {
    var config Config
    configFile, err := os.Open("config.json")
    if err != nil {
        log.Fatal(err)
    }
    defer configFile.Close()

    jsonParser := json.NewDecoder(configFile)
    if err = jsonParser.Decode(&config); err != nil {
        log.Fatal(err)
    }

    return &config
}

配置文件功能

• 服务器配置: 指定服务器监听的端口。
• 数据库配置: 指定数据库类型和连接信息。

---

以上是 Shiori 项目的目录结构、启动文件和配置文件的介绍。希望这份教程能帮助你更好地理解和使用 Shiori 项目。

Shiori The app you need for Genshin Impact 项目地址: https://gitcode.com/gh_mirrors/shio/Shiori