Minum 项目教程

Minum 项目教程

minum An obsessively minimal Java web framework built from scratch 项目地址: https://gitcode.com/gh_mirrors/mi/minum

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

Minum 项目的目录结构如下：

minum/
├── docs/
├── src/
├── utils/
├── .gitattributes
├── .gitignore
├── CONTRIBUTING.md
├── DIRECTORIES_AND_FILES.md
├── LICENSE
├── Makefile
├── README.md
├── RELEASE_NOTES.md
├── minum-config/
├── mvnw
├── mvnw.cmd
├── pom.xml

目录结构介绍

• docs/: 存放项目的文档文件，包括开发手册、代码覆盖报告等。
• src/: 存放项目的源代码文件。
• utils/: 存放项目的工具类文件。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• CONTRIBUTING.md: 贡献指南文件。
• DIRECTORIES_AND_FILES.md: 目录和文件说明文件。
• LICENSE: 项目许可证文件。
• Makefile: 项目构建文件。
• README.md: 项目介绍文件。
• RELEASE_NOTES.md: 发布说明文件。
• minum-config/: 存放项目的配置文件。
• mvnw: Maven 包装器脚本。
• mvnw.cmd: Maven 包装器脚本（Windows 版本）。
• pom.xml: Maven 项目对象模型文件。

2. 项目的启动文件介绍

Minum 项目的启动文件是 src/Main.java。以下是启动文件的简要介绍：

public class Main {
    public static void main(String[] args) {
        var minum = FullSystem.initialize();
        var wf = minum.getWebFramework();
        wf.registerPath(GET, "", r -> Response.htmlOk("<p>Hi there world</p>"));
        minum.block();
    }
}

启动文件介绍

• FullSystem.initialize(): 初始化 Minum 系统。
• minum.getWebFramework(): 获取 Web 框架实例。
• wf.registerPath(): 注册 HTTP 路径和处理函数。
• minum.block(): 阻塞主线程，保持服务器运行。

3. 项目的配置文件介绍

Minum 项目的配置文件主要存放在 minum-config/ 目录下。以下是配置文件的简要介绍：

配置文件介绍

• minum-config/: 存放项目的配置文件，包括数据库配置、日志配置等。

示例配置文件

// 示例配置文件内容
public class Config {
    public static final String DB_PATH = "db/";
    public static final String LOG_PATH = "logs/";
}

配置文件使用

在项目中，可以通过 Config 类来访问配置文件中的配置项，例如：

String dbPath = Config.DB_PATH;
String logPath = Config.LOG_PATH;

通过以上配置文件，可以灵活地调整项目的运行参数，满足不同的需求。

minum An obsessively minimal Java web framework built from scratch 项目地址: https://gitcode.com/gh_mirrors/mi/minum