express 项目分层实践详解


Posted in Javascript onDecember 10, 2018

前言

上次我们搭建了一个基本的 express 后台,但是这样的项目结构的可扩展性,维护性和代码复用性都不是很好,参照之前学习 JavaWeb 时候的四层架构设计,用分层的思想来对 express 进行一点小优化,进一步提高代码的可拓展性。本文的源代码在 Github 上,建议看着代码来看这篇文章。

1 四(五)层结构概念

这个就简单说一下,所谓四层架构就是 Model实体层,Dao层(数据访问层也就是从数据库中查数据),Service层(业务逻辑层,也就是处理好数据),Controller层(视图控制层,在前后端分离的情况下就是写接口响应前端请求)和前端的 view(视图层),为啥要搞分层咧,说到底就是要解耦合,提高拓展性和维护性,写代码的时候,思路清晰一点,后面改代码的时候也知道要改哪边。

但是我们这次只是涉及后台的,视图层我们就不用管了,只需看前面的就行了。

2 分层

首先看一下项目结构哈

│ app.js
│ package.json
│ README.md
│
├─.idea
│ │ express-project.iml
│ │ misc.xml
│ │ modules.xml
│ │ vcs.xml
│ │ watcherTasks.xml
│ │ workspace.xml
│ │
│ └─inspectionProfiles
├─bin
│  www
│
├─config
│  db.json
│
├─dao
│  BaseDao.js
│  UserDao.js
│
├─models
│  user.js
│
├─public
│ ├─images
│ ├─javascripts
│ └─stylesheets
│   style.css
│
├─routes
│  index.js
│  users.js
│
├─services
│  UserService.js
│
├─utils
│  db-util.js
│
└─views
  error.jade
  index.jade
  layout.jade

按照分层思想,我们新建几个文件夹哈,首先是 Model层的 models 文件夹,dao 层的 dao 文件夹,service 层的 services 文件夹,controller 层的话就用原来的 routes 文件夹就可以了,为了方便,我加了一个全局配置的 config 文件夹和工具函数 utils 文件夹。具体项目如下,我们从最底层开始来一个一个来分析

2.1 config

这个就放着各种配置文件,例如我的 db.json 里面就放了mongodb 的端口号,数据库名那些,反正就是各种配置啦

2.2 utils

这个就是有一些创建型的方法或者其他公共方法,像创建数据库连接池的方法我就放在这边的 db-util 里面了。

2.3 models

实体层,针对 mongodb 来说,一个集合对应一个 model,然后都是这样的形式啦。

const mongoose = require('mongoose');
const { mongoClient } = require('../utils/db-util');

// 创建 user Schema
const user = new mongoose.Schema({
 name: String,
 id: String,
},{versionKey: false});

/*model 的参数1 导出的模块名,
参数2 创建的 Schema,
参数2 指定数据库中的集合的名字,若不加的,则抹默认取‘第一个参数s'的集合*/
let User = mongoClient.model('User', user, 'user');

module.exports = User;

2.4 dao

创建完实体层,接下来就是 dao 层了,这边我封装了一个 BaseDao,基本的数据库操作都有了,后面我们创建其他 dao 的时候就很舒服啦,直接继承一下 BaseDao 就好了。例如下面的这个 UserDao:

let BaseDao = require('./BaseDao');
// 导入对应的实体
let User = require('../models/user');

class UserDao extends BaseDao{
 constructor() {
 super(User);
 }
 //如果有啥特殊需求的话,自己再重写方法咯
}

module.exports = UserDao;

这样就写好了一个基本的 dao 了,增删改查这些他都从 BaseDao 中继承了,

2.5 services

service 层是业务逻辑层,这么写就看你项目的业务啦。我下面就简单些一个查询所有 user 数据的方法啦。

const UserDao = require('../dao/UserDao');

let userDao = new UserDao();

class UserService {
 async getUserList() {
 try {
  // 调用 dao 层查询数据
  let userList = await userDao.findAll();
  return userList;
 } catch (err) {
  console.log(`getUserList error--> ${error}`);
  return error;
 }
 }
}
module.exports = UserService;

2.6 routes

controller 层,写接口用,这个写起来简单,就拿一下 service 层的数据返回就可以啦。

var express = require('express');
var router = express.Router();
const UserService = require('../services/UserService');
let userService = new UserService();

/* GET users listing. */
router.get('/', function(req, res, next) {
 userService.getUserList().then((data)=>{
 res.json({
  code:0,
  msg:'OK',
  data:data
 })
 });
 // res.send('respond with a resource');
});

router.get('/login',(req,res,next)=>{
 res.json({
 code:0,
 msg:'OK',
 data:{result:true}
 })
});
module.exports = router;

然后这边的话,我有一个想法,就是想着每次多一个路由实例(controller)的时候,就要往 app.js 里面导入并引入,觉得这样 controller 多了的时候,app.js 里面代码会很多,所以就想着把模块导入的代码移到 routes 文件夹里面的 index.js 里面来,app.js 就引入个 index 就好啦。所以就有了下面 index.js 的代码。

var express = require('express');
var router = express.Router();

/* GET home page. */
router.get('/', function(req, res, next) {
 res.render('index', { title: 'Express' });
});
// user 路由模块
// 当我在 user 文件里面写一个 '/login' 的时候,前端访问就要访问 '/user/login'
router.use('/user', require('./users'));
module.exports = router;

至此,全文就结束啦,对于 express 框架的分层实践如果有更好的建议或者我这样分层有啥问题的话,欢迎在在下方留言哈,大家一起学习一下。也希望大家多多支持三水点靠木。

Javascript 相关文章推荐
Javascript里使用Dom操作Xml
Jan 22 Javascript
JavaScript 面向对象之命名空间
May 04 Javascript
JS中for循序中延迟加载动态效果的具体实现
Aug 18 Javascript
javascript模块化是什么及其优缺点介绍
Sep 02 Javascript
如何在MVC应用程序中使用Jquery
Nov 17 Javascript
angularJS中router的使用指南
Feb 09 Javascript
jQuery动态背景图片效果实现方法
Jul 03 Javascript
js调用百度地图及调用百度地图的搜索功能
Sep 07 Javascript
js实现3D图片逐张轮播幻灯片特效代码分享
Sep 09 Javascript
探讨:JavaScript ECAMScript5 新特性之get/set访问器
May 05 Javascript
JS访问DOM节点方法详解
Nov 29 Javascript
vue+vant使用图片预览功能ImagePreview的问题解决
Apr 10 Javascript
JS选取DOM元素常见操作方法实例分析
Dec 10 #Javascript
微信小程序分享海报生成的实现方法
Dec 10 #Javascript
jQuery选择器选中最后一个元素,倒数第二个元素操作示例
Dec 10 #jQuery
详解Angular Forms中自定义ngModel绑定值的方式
Dec 10 #Javascript
jQuery+css last-child实现选择最后一个子元素操作示例
Dec 10 #jQuery
微信小程序与后台PHP交互的方法实例分析
Dec 10 #Javascript
引入外部js脚本加载慢与页面白屏问题的解决
Dec 10 #Javascript
You might like
php 数学运算验证码实现代码
2009/10/11 PHP
在Mac上编译安装PHP7的开发环境
2015/07/28 PHP
PHP实现页面静态化的超简单方法
2016/09/06 PHP
JavaScript 克隆数组最简单的方法
2009/02/12 Javascript
jQuery each()方法的使用方法
2010/03/18 Javascript
IE6不能修改NAME问题的解决方法
2010/09/03 Javascript
JavaScript词法作用域与调用对象深入理解
2012/11/29 Javascript
JavaScript将数据转换成整数的方法
2014/01/04 Javascript
JS执行删除前的判断代码
2014/02/18 Javascript
jquery对dom节点的操作【推荐】
2016/04/15 Javascript
jQuery代码实现对话框右上角菜单带关闭×
2016/05/03 Javascript
JS给swf传参数的实现方法
2016/09/13 Javascript
微信小程序开发教程之增加mixin扩展
2017/08/09 Javascript
把JavaScript代码改成ES6语法不完全指南(分享)
2017/09/10 Javascript
nodejs发送http请求时遇到404长时间未响应的解决方法
2017/12/10 NodeJs
为vue-router懒加载时下载js的过程中添加loading提示避免无响应问题
2018/04/03 Javascript
vue router返回到指定的路由的场景分析
2020/11/10 Javascript
[01:43]深扒TI7聊天轮盘语音出处4
2017/05/11 DOTA
详解Python中__str__和__repr__方法的区别
2015/04/17 Python
轻松理解Python 中的 descriptor
2017/09/15 Python
一文总结学习Python的14张思维导图
2017/10/17 Python
python卸载后再次安装遇到的问题解决
2019/07/10 Python
python实现时间序列自相关图(acf)、偏自相关图(pacf)教程
2020/06/03 Python
tensorflow基于CNN实战mnist手写识别(小白必看)
2020/07/20 Python
python缩进长度是否统一
2020/08/02 Python
Anaconda使用IDLE的实现示例
2020/09/23 Python
python脚本定时发送邮件
2020/12/22 Python
HTML5+CSS3实现机器猫
2016/10/17 HTML / CSS
德国大型和小型家用电器网上商店:Energeto
2019/05/15 全球购物
2014小学植树节活动总结
2014/03/10 职场文书
校运会口号
2014/06/18 职场文书
部队反四风对照检查材料
2014/09/26 职场文书
承租经营合作者协议书
2014/10/01 职场文书
2014年依法行政工作总结
2014/11/19 职场文书
青年岗位能手事迹材料
2014/12/23 职场文书
Python insert() / append() 用法 Leetcode实战演示
2021/03/31 Python