Node+Express搭建个人博客(纯后端)-基础项目搭建(四)

基础项目搭建

在上一篇文章对Express脚手架进行了简单分析和改造之后,接下来开始搭建自己的项目。

目录结构

目录结构概览

项目搭建的第一步,是约定项目的目录结构,项目的目录结构如下:

express-blog
│  CHANGELOG.md
│  package.json
│  README.md
│  server.js 
│      
├─app
│  ├─apidoc
│  │          
│  ├─controllers
│  │      
│  ├─middlewares
│  │      
│  ├─models
│  │      
│  ├─myutil
│  │
│  ├─public
│  │          
│  ├─routes
│  │      
│  └─services
│          
├─build
│                  
├─config
│      
├─logs
│                    
├─resource
│
└─test

目录结构说明

目录结构说明如下:

  • CHANGELOG.md项目更新日志的记录文件。
  • server.js程序的初始化和启动文件。
  • app/apidoc/**用于编写接口文档说明,然后使用apidoc生成接口文档。
  • app/controller/**用于接收和处理用户输入的参数,然后将处理结果返回。
  • aoo/middleware/**用于编写中间件函数。
  • app/model/**用于编写定义数据库相关的文件。
  • app/myutil/**用于存放编写的工具函数。
  • app/public/**用于存放项目的静态资源。
  • app/routes/routes.js用于添加和配置路由规则。
  • app/service/**用于编写业务逻辑代码,可供controller层调用。
  • build/**用于项目初次部署时初始化基础数据,比如初始化管理员。
  • config/**用于项目的相关配置文件,比如数据库配置
  • logs/**用于存放程序的请求日志、错误日志等日志文件。
  • resource/**用于存放文档资料。
  • test/**用于单元测试。

看到这里,不知道是否看出来些什么没有,我是尽力在向Egg.js框架的目录结构靠拢,我曾使用egg框架完成过两个web项目,使用下来的最大感受就是省心,根据egg框架核心开发人员的说法,阿里内部有很多个基于egg框架的项目在运行,起码可以得出一点,这个框架是经过多个项目实践之后的一个成果,那我们对egg框架的一点借鉴也会是好的借鉴【手动捂脸】。

基础项目搭建

现在,开始按照上面的目录结构,开始搭建项目。

生成启动文件

按照上一篇文章的设想,首先创建目录express-blog,将其作为项目的根目录,然后将项目的初始化文件和启动文件合二为一,在项目的根目录下创建app.js文件,代码如下:

'use strict'
const express = require('express')
const path = require('path')
const app = express()
const bodyParser = require('body-parser')

// 配置静态文件
app.use(express.static(path.join(__dirname, 'app/public')))
// 配置apidoc
app.use('/apidoc', express.static(path.join(__dirname, 'app/public/apidoc/')))

// 请求体解析中间件
app.use(bodyParser.urlencoded({ extended: true }))
app.use(bodyParser.json())

app.listen(3000)
console.log('express-blog server started on: ' + 3000)

创建完成app.js文件之后,我们还需要安装文件中依赖的npm包,执行以下命令:

npm init
<!--无所谓项目基础信息的话,执行完上面的命令之后可以一直回车,当然,还是建议认真填写-->
npm install --save-dev express

这时候,项目的启动文件已经创建成功,依赖包也安装完毕,可以启动项目了,就是这么简单,执行以下命令:

node server.js

看到控制台输出express-blog server started on: 4000,表明我们的项目成功运行,项目初始化的第一步完成。

完成第一个接口

项目已经可以成功运行,接下来要按照以上的目录结构,完成项目的第一个接口,首先,在项目的根目录下创建app目录,一般的代码文件都会放置于该目录下。然后根据以上的目录结构,创建app目录下的其他目录,待app下的目录创建完毕之后,开始编写代码。

在项目中,会将封装好的同类函数存放于目录的index.js文件中,然后导出,以供其他模块调用,在其他模块调用该目录时会默认加载该目录下的index.js具体原理见Node.js官方文档-module (模块)

同时,在项目中,会使用ES6及ES6+的语法糖,比如Promiseclassasync/await等,如果不理解,可以去看阮一峰老师的ECMAScript 6 入门,快速入口:

controller层

创建app/controllers/users.js文件,代码如下:

'use strict'
const Services = require('../services')
class UsersController {
  async create (req, res) {
    const paramas = req.body
    const result = await Services.users.addUser(paramas)
    res.send(result)
  }
}

module.exports = new UsersController()

创建app/controllers/index.js文件,代码如下:

'use strict'

const controllers = {}
controllers.users = require('./users')

module.exports = controllers

service层

创建app/services/users.js文件,代码如下:

'use strict'
class UserService {
  async addUser (data) {
    return 'create success'
  }
}

module.exports = new UserService()

创建app/services/index.js文件,代码如下:

'use strict'
const Services = {}

Services.users = require('./users')

module.exports = Services

middlewares层

创建app/middlewares/not-find.js文件,代码如下:

'use strict'
// 404错误处理中间件

module.exports = (req, res, next) => {
  res.send('404,您访问的路由不存在!')
}

创建app/middlewares/index.js文件,代码如下:

'use strict'
const middleware = {}

middleware.notFind = require('./not-find')

module.exports = middleware

routes层

创建app/routes/routes.js文件,同时注册上面的404错误处理中间件,代码如下:

'use strict'

const Controllers = require('../controllers')
const middleware = require('../middlewares')

module.exports = function (app) {
  app.post('/users', Controllers.users.create)

  app.use(middleware.notFind)
}

修改app.js文件,引用路由文件,并传递app对象给routes层,添加的代码如下:

// 引入路由
const routes = require('./app/routes/routes')
// 注册路由
routes(app)

注:该代码要添加在生成app实例的代码之后,即const app = express()之后。

测试接口

至此,第一个接口完成,当然,这只是一个接口,没有任何逻辑,但是也够了,逻辑可以后面再添加。接下来,对接口做简单测试。

首先,node server.js,启动程序。

然后,打开postman,发送POST请求到localhost:4000/users,发现返回create success,看来接口是生效的。

然后再发送POST请求到localhost:4000/users1212,发现返回404,您访问的路由不存在!,看来404错误处理中间件也是生效的。

小结

本文主要依据上一篇文章的分析,初始化了自己的项目,完成了一个没有任何逻辑的接口(逻辑目前不重要),同时很好的完成了各层分离的目的。接下来会在此基础上,使用版本控制工具git完成一个项目相对完整的git操作流程。

下面附上项目的github地址:

项目地址

我的个人博客:

毛浩先生的个人博客

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,456评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,370评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,337评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,583评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,596评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,572评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,936评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,595评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,850评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,601评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,685评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,371评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,951评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,934评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,167评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,636评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,411评论 2 342

推荐阅读更多精彩内容