Lumie 项目教程-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00062/article/details/136982373

本文介绍了ProgrammingProjectList，一个开源的编程项目列表，涵盖了多种语言和难度，适合学习者和开发者寻找挑战项目，通过GitCode进行协作，是提升技能、寻找灵感和面试准备的理想资源。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Lumie 项目教程

Lumie ✨ An opinionated way to keep your express API organized 项目地址: https://gitcode.com/gh_mirrors/lu/Lumie

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

Lumie 项目的目录结构如下：

project/
├── controllers/
│   ├── users/
│   │   ├── users-routing.js
│   │   ├── users-action.js
│   │   └── users-spec.js
│   ├── cars/
│   │   ├── cars-routing.js
│   │   ├── cars-spec.js
│   │   ├── cars-get-action.js
│   │   └── cars-post-action.js
│   └── simple-ctrl.js
├── core/
│   └── permissions.js
├── app.js
└── package.json

目录结构介绍

controllers/: 包含所有控制器文件。每个控制器通常包含一个路由定义文件（如 users-routing.js）、一个或多个动作文件（如 users-action.js），以及一个可选的测试文件（如 users-spec.js）。
- users/: 用户相关的控制器文件。
- cars/: 车辆相关的控制器文件。
- simple-ctrl.js: 简单的控制器文件。
core/: 包含核心功能文件，如权限管理文件 permissions.js。
app.js: 项目的启动文件。
package.json: 项目的配置文件，包含依赖项和脚本等信息。

2. 项目的启动文件介绍

`app.js`

app.js 是 Lumie 项目的启动文件，负责初始化 Express 应用并加载控制器。以下是 app.js 的主要内容：

const express = require("express");
const path = require("path");
const lumie = require("lumie");

const app = express();

lumie.load(app, {
  preURL: "api",
  verbose: true,
  ignore: ["*.spec", "*.action"],
  controllers_path: path.join(__dirname, "controllers")
});

const server = app.listen(3000, "127.0.0.1", () => {
  const { address, port } = server.address();
  console.log("Example app listening at http://%s:%s", address, port);
});

启动文件介绍

Express 初始化: 使用 express() 初始化一个 Express 应用。
Lumie 加载: 使用 lumie.load 方法加载控制器，配置了 preURL、verbose、ignore 和 controllers_path 等选项。
服务器启动: 使用 app.listen 方法启动服务器，监听端口 3000。

3. 项目的配置文件介绍

`package.json`

package.json 是 Node.js 项目的配置文件，包含项目的元数据、依赖项和脚本等信息。以下是 package.json 的主要内容：

{
  "name": "lumie",
  "version": "1.0.0",
  "description": "An opinionated way to keep your express API organized",
  "main": "app.js",
  "scripts": {
    "start": "node app.js",
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "dependencies": {
    "express": "^4.17.1",
    "lumie": "^1.0.0"
  },
  "license": "MIT"
}