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 相关文章推荐
用prototype实现的简单小巧的多级联动菜单
Mar 24 Javascript
jquery属性过滤选择器使用示例
Jun 18 Javascript
我的Node.js学习之路(一)
Jul 06 Javascript
js判断手机和pc端选择不同执行事件的方法
Jan 30 Javascript
HTML+CSS+JS实现完美兼容各大浏览器的TABLE固定列
Apr 26 Javascript
简介JavaScript中strike()方法的使用
Jun 08 Javascript
js中 javascript:void(0) 用法详解
Aug 11 Javascript
关于JS中setTimeout()无法调用带参函数问题的解决方法
Jun 21 Javascript
第九篇Bootstrap导航菜单创建步骤详解
Jun 21 Javascript
详解vue.js根据不同环境(正式、测试)打包到不同目录
Jul 13 Javascript
Vue引用Swiper4插件无法重写分页器样式的解决方法
Sep 27 Javascript
vue中eslintrc.js配置最详细介绍
Dec 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绘制在图片上的正余弦曲线
2013/06/08 PHP
PHP实现原生态图片上传封装类方法
2016/11/08 PHP
使用PHP反射机制来构造"CREATE TABLE"的sql语句
2019/03/21 PHP
PHP实现字母数字混合验证码功能
2019/07/11 PHP
jQuery div层的放大与缩小简单实现代码
2013/03/28 Javascript
jquery实现弹出层遮罩效果的简单实例
2014/03/03 Javascript
jquery中one()方法的用法实例
2015/01/16 Javascript
jQuery实现新消息闪烁标题提示的方法
2015/03/11 Javascript
Node.js本地文件操作之文件拷贝与目录遍历的方法
2016/02/16 Javascript
Bootstrap3制作搜索框样式的方法
2016/07/11 Javascript
总结Node.js中的一些错误类型
2016/08/15 Javascript
Vue2路由动画效果的实现代码
2017/07/10 Javascript
Bootstrap Table 在指定列中添加下拉框控件并获取所选值
2017/07/31 Javascript
element ui 对话框el-dialog关闭事件详解
2018/02/26 Javascript
Vue单页应用引用单独的样式文件的两种方式
2018/03/30 Javascript
Node.js使用Angular简单示例
2018/05/11 Javascript
浅入深出Vue之自动化路由
2019/08/06 Javascript
vue.js中ref及$refs的使用方法解析
2019/10/08 Javascript
js实现碰撞检测
2021/01/29 Javascript
Python操作MongoDB数据库的方法示例
2018/01/04 Python
python selenium自动上传有赞单号的操作方法
2018/07/05 Python
python f-string式格式化听语音流程讲解
2019/06/18 Python
python 从list中随机取值的方法
2020/11/16 Python
美国销售第一的智能手机和平板电脑保护壳:OtterBox
2017/12/21 全球购物
德国内衣、泳装和睡衣网上商店:Bigsize Dessous
2018/07/09 全球购物
联想印度官方网上商店:Lenovo India
2019/08/24 全球购物
卫校毕业生自我鉴定
2013/10/31 职场文书
国贸专业大学生职业生涯规划范文
2014/01/10 职场文书
考试不及格的检讨书
2014/01/22 职场文书
事假请假条范文
2014/04/11 职场文书
社区综治宣传月活动总结
2014/07/02 职场文书
2014年度培训工作总结
2014/11/27 职场文书
2014年节能工作总结
2014/12/18 职场文书
董事长岗位职责
2015/02/13 职场文书
详解Python 3.10 中的新功能和变化
2021/04/28 Python
CSS filter 有什么神奇用途
2021/05/25 HTML / CSS