开源项目 dbblog 使用教程

开源项目 dbblog 使用教程

dbblog基于SpringBoot2.x+Vue2.x+ElementUI+Iview+Elasticsearch+RabbitMQ+Redis+Shiro的多模块前后端分离的博客项目项目地址:https://gitcode.com/gh_mirrors/db/dbblog

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

dbblog 项目的目录结构如下：

dbblog/
├── config/
│   ├── default.json
│   ├── development.json
│   └── production.json
├── controllers/
│   ├── auth.js
│   ├── blog.js
│   └── user.js
├── models/
│   ├── blog.js
│   └── user.js
├── routes/
│   ├── auth.js
│   ├── blog.js
│   └── user.js
├── services/
│   ├── auth.js
│   ├── blog.js
│   └── user.js
├── utils/
│   ├── helpers.js
│   └── validators.js
├── app.js
├── package.json
└── README.md

目录结构介绍

• config/: 存放项目的配置文件，包括默认配置、开发环境和生产环境的配置。
• controllers/: 存放控制器文件，处理业务逻辑。
• models/: 存放数据模型文件，定义数据结构和操作。
• routes/: 存放路由文件，定义API接口。
• services/: 存放服务文件，处理复杂的业务逻辑。
• utils/: 存放工具函数文件，提供通用的辅助功能。
• app.js: 项目的启动文件。
• package.json: 项目的依赖管理文件。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

项目的启动文件是 app.js，其主要功能是初始化应用并启动服务器。以下是 app.js 的主要内容：

const express = require('express');
const bodyParser = require('body-parser');
const config = require('config');
const routes = require('./routes');

const app = express();

// 使用 body-parser 中间件
app.use(bodyParser.json());
app.use(bodyParser.urlencoded({ extended: true }));

// 加载路由
app.use('/api', routes);

// 获取配置端口
const port = config.get('port') || 3000;

// 启动服务器
app.listen(port, () => {
  console.log(`Server is running on port ${port}`);
});

启动文件介绍

• 引入 express 框架并创建应用实例。
• 使用 body-parser 中间件处理请求体。
• 加载路由文件，定义API接口。
• 从配置文件中获取端口并启动服务器。

3. 项目的配置文件介绍

项目的配置文件存放在 config/ 目录下，包括 default.json、development.json 和 production.json。以下是配置文件的示例内容：

default.json

{
  "port": 3000,
  "jwtSecret": "your_jwt_secret",
  "database": {
    "host": "localhost",
    "user": "root",
    "password": "",
    "name": "dbblog"
  }
}

development.json

{
  "database": {
    "password": "dev_password"
  }
}

production.json

{
  "port": 8080,
  "database": {
    "host": "prod_host",
    "user": "prod_user",
    "password": "prod_password"
  }
}

配置文件介绍

• default.json: 默认配置文件，包含通用的配置项。
• development.json: 开发环境配置文件，覆盖默认配置中的部分配置项。
• production.json: 生产环境配置文件，覆盖默认配置中的部分配置项。

配置文件使用 config 模块进行加载，可以根据环境变量自动选择相应的配置文件。

dbblog基于SpringBoot2.x+Vue2.x+ElementUI+Iview+Elasticsearch+RabbitMQ+Redis+Shiro的多模块前后端分离的博客项目项目地址:https://gitcode.com/gh_mirrors/db/dbblog