Yearning 项目安装与使用教程

Yearning 项目安装与使用教程

Yearning cookieY/Yearning: 这是一个用于SQL注入检测和防御的工具。适合用于需要检测和防御SQL注入的场景。特点：易于使用，支持多种数据库，提供实时检测和防御功能。 项目地址: https://gitcode.com/gh_mirrors/ye/Yearning

1. 项目目录结构及介绍

Yearning 项目的目录结构如下：

Yearning/
├── cmd/
├── docker/
├── img/
├── migration/
├── src/
├── .gitignore
├── LICENSE
├── README.md
├── README_zh-CN.md
├── conf.toml.template
├── go.mod
├── logo_s.png
└── main.go

目录介绍

• cmd/: 存放项目的命令行工具相关文件。
• docker/: 存放 Docker 相关的配置文件和脚本。
• img/: 存放项目所需的图片资源。
• migration/: 存放数据库迁移相关的文件。
• src/: 存放项目的源代码。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目的英文介绍文档。
• README_zh-CN.md: 项目的中文介绍文档。
• conf.toml.template: 配置文件模板。
• go.mod: Go 模块依赖管理文件。
• logo_s.png: 项目的小图标。
• main.go: 项目的启动文件。

2. 项目启动文件介绍

项目的启动文件是 main.go，该文件负责初始化项目并启动服务。以下是 main.go 的基本结构：

package main

import (
    "Yearning/src/server"
    "Yearning/src/config"
)

func main() {
    // 加载配置文件
    config.LoadConfig()
    
    // 启动服务器
    server.Start()
}

启动文件功能

• 加载配置文件: 在启动时，首先加载配置文件 conf.toml，确保项目能够正确配置运行环境。
• 启动服务器: 调用 server.Start() 函数启动 HTTP 服务器，监听指定端口并处理请求。

3. 项目配置文件介绍

项目的配置文件是 conf.toml，该文件包含了项目的各项配置参数。以下是 conf.toml 的基本结构：

[database]
user = "your_mysql_user"
password = "your_mysql_password"
addr = "your_mysql_address"
db = "your_mysql_database"

[server]
port = 8000
secret_key = "your_secret_key"

[language]
lang = "zh_CN"

配置文件参数介绍

• database: 数据库连接配置。

  • user: MySQL 用户名。
  • password: MySQL 密码。
  • addr: MySQL 地址。
  • db: MySQL 数据库名。

• server: 服务器配置。

  • port: 服务器监听端口。
  • secret_key: 服务器密钥，用于加密和解密敏感数据。

• language: 语言配置。

  • lang: 项目语言，支持 zh_CN 和 en。

配置文件使用方法

1. 将 conf.toml.template 复制为 conf.toml。
2. 根据实际环境修改 conf.toml 中的配置参数。
3. 启动项目时，配置文件会自动加载并应用。

总结

通过以上步骤，您可以成功安装并配置 Yearning 项目。项目的目录结构清晰，启动文件和配置文件的介绍帮助您快速上手。希望本教程对您有所帮助！

Yearning cookieY/Yearning: 这是一个用于SQL注入检测和防御的工具。适合用于需要检测和防御SQL注入的场景。特点：易于使用，支持多种数据库，提供实时检测和防御功能。 项目地址: https://gitcode.com/gh_mirrors/ye/Yearning