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 原型模式实现OOP的再研究
Apr 09 Javascript
js 数据类型转换总结笔记
Jan 17 Javascript
javascript中的对象创建 实例附注释
Feb 08 Javascript
一个可拖拽列宽表格实例演示
Nov 26 Javascript
文件编码导致jquery失效的解决方法
Jun 26 Javascript
window.location.href = window.location.href 跳转无反应 a超链接onclick事件写法
Aug 21 Javascript
详解vue-cli本地环境API代理设置和解决跨域
Sep 05 Javascript
静态页面实现 include 引入公用代码的示例
Sep 25 Javascript
vue+webpack实现异步组件加载的方法
Feb 03 Javascript
vue下history模式刷新后404错误解决方法
Aug 18 Javascript
vue vantUI tab切换时 list组件不触发load事件的问题及解决方法
Feb 14 Javascript
小程序Scroll-view上拉滚动刷新数据
Jun 21 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 中dirname(_file_)讲解
2007/03/18 PHP
php登陆页的密码处理方式分享
2013/10/14 PHP
php版淘宝网查询商品接口代码示例
2014/06/17 PHP
js弹窗代码 可以指定弹出间隔
2010/07/03 Javascript
javascript中关于执行环境的杂谈
2011/08/14 Javascript
jquery ui对话框实例代码
2013/05/10 Javascript
javascript动态添加样式(行内式/嵌入式/外链式等规则)
2013/06/24 Javascript
JQuery使用$.ajax和checkbox实现下次不在通知功能
2015/04/16 Javascript
整理AngularJS框架使用过程当中的一些性能优化要点
2016/03/05 Javascript
jQuery获取同级元素的简单代码
2016/07/09 Javascript
详解Nodejs get获取远程服务器接口数据
2019/03/26 NodeJs
javascript实现的字符串转换成数组操作示例
2019/06/13 Javascript
JS回调函数 callback的理解与使用案例分析
2019/09/09 Javascript
Vue+Element UI 树形控件整合下拉功能菜单(tree + dropdown +input)
2020/08/28 Javascript
Vue单页面应用中实现Markdown渲染
2021/02/14 Vue.js
玩转python爬虫之URLError异常处理
2016/02/17 Python
Python的净值数据接口调用示例分享
2016/03/15 Python
PHP网页抓取之抓取百度贴吧邮箱数据代码分享
2016/04/13 Python
Python读取图片属性信息的实现方法
2016/09/11 Python
Django ORM框架的定时任务如何使用详解
2017/10/19 Python
Python文件如何引入?详解引入Python文件步骤
2018/12/10 Python
python Pillow图像处理方法汇总
2019/10/16 Python
Django如何批量创建Model
2020/09/01 Python
Python 列表反转显示的四种方法
2020/11/16 Python
美国乡村商店:Plow & Hearth
2016/09/12 全球购物
Marriott国际:万豪国际酒店查询预订
2017/09/25 全球购物
最便宜促销价格订机票:Airpaz(总部设在印尼,支持中文)
2018/11/13 全球购物
泰国王权免税店官方网站:KingPower
2019/03/11 全球购物
Clos19英国:高档香槟、葡萄酒和烈酒在线购物平台
2020/07/10 全球购物
酷瑞网络科技面试题
2012/03/30 面试题
建筑学专业自荐书
2014/07/09 职场文书
大学奖学金获奖感言
2014/08/15 职场文书
优秀教师申报材料
2014/12/16 职场文书
广告公司文案策划岗位职责
2015/04/14 职场文书
Python 循环读取数据内存不足的解决方案
2021/05/25 Python
JavaScript实现简单的音乐播放器
2022/08/14 Javascript