我的第一个开源项目——基于Node.js和MongoDB的Bookkeeping在线记账本

开源项目 Bookkeeping

开发者: LeonardoSya

https://github.com/LeonardoSya

这是我自学开发以来发布的第一个开源项目，项目学习自尚硅谷的Node.js公开课，这也是我做的第一个基于后端后台管理系统的项目。我目前在购买了阿里云服务器远端搭建过程中遇到了一些问题导致网址还无法被本机以外的设备访问，不过我正在尝试解决这些问题，并且在不久的将来会对外发布网址供大众访问.

​ 我是一名大一的非科班学生, 正在学习cs和前端开发.

---

项目介绍：

这是一个在线记账本网页，这是我学习编程以来在github发布的第一个开源项目

用户可以注册及登陆账号来使用这个在线记账本网页进行新增账目、编辑账目、删除账目等操作。在这个项目里，用户数据被保存到远程服务器下的数据库，并且做了加密处理，保证了数据的安全性。

This is an online bookkeeping page, and it was my first open source project since I learned programming.

Users can register and log in an account to use this online bookkeeping page to add accounts, edit accounts, delete accounts and other operations. In this project, user data is stored in a database on a remote server and encrypted to ensure data security.

技术栈 :

JavaScript + Node.js + MongoDB

第三方框架和库：

epxress.js, Generator, ejs, moment.js, cookie, session, token, lodash, mongoose

部署流程：

初期搭建

0. 利用generator包搭建框架 express -e accounts 安装accounts文件夹
1. 文件夹内 npm i 安装依赖
2. package.json start属性里node改成nodemon实现自动重启及时看到效果
3. 搭建“账单”account 和“账本”两个路由规则
4. 把index.html放到3000端口下作为我的服务：views中创建名为list.ejs的模板，同时在index.js中render引入3list.ejs的内容作为响应页面。create.html同理(把引入js/css文件由相对路径改为绝对路径，因为相对路径不可靠，会受到当前网页url路径的影响，url路径变化会造成引入文件相对路径变化，而绝对路径始终指向服务器的某个静态资源)
5. 获取请求体数据(新增账目后对表单数据提取)：路由设置router.post，create.ejs中form链接至账单页面(/account)
6. 保存账单信息并跳转：lowdb包与shortid包，在路由内生成id并写入数据至db.json，res.render()至添加成功页面 ejs渲染提示文字与返回链接url
7. 账单信息列表渲染：router.get(‘/account’, )内获取账单信息并渲染至list，list.ejs修改为模板引擎语法
8. 删除账目：搭建/account/:id 路由规则，通过database内账目对应id删除账目并页面跳转渲染

配置 MongoDB

0. config, db, models 三个文件夹放入accounts文件夹目录下
1. 入口bin/www内导入db函数 并把所有代码放入 db(()=>{}) 回调函数内
2. models文件夹下配置AccountModel，根据db.json创建文档结构对象并设置文档属性及值类型，并暴露模型对象
3. 通过moment包将日期字符串转成Date对象，在router.post(‘/account’)中AccountModel.create插入数据库
4. router.get(‘/account’)内读取信息改为读取数据库集合中的信息
5. 在list.js中ejs格式化日期对象：item.time模板语法改为moment(item.time).format(‘YYYY-MM-DD’)，并在res.render(‘list’)中加入模板语法moment:moment
6. 删除操作绑定Mongodb: list.ejs内删除某条账单的h5 ||a href="/account/<%= item.id %>"||在id前加（Mongoose会自动往对象内添加id属性)。同时在index.js中router.get(‘/account/:id’)(// 删除记录)内改写删除操作为AccountModel.deleteOne()
7. 优化删除操作：为了防止用户误删，在list.ejs中删除标签写防止误删操作的js代码。顺便在记账本title边上写一个“添加账单”的跳转按钮

结合API接口

0. 删去users.js和app.js中对users的调用。在routes文件夹下新建web文件夹并放入Index.js并修改路径。删除index.js中lowdb等文件存储相关代码删去(因为已经存到数据库)
1. routes下新建api接口文件夹下account.js接口路由文件，并在app.js中导入account接口路由文件
2. 获取账单接口：account.js内响应成功和响应失败的提示改为响应json格式，并进行接口测试
3. 创建账单接口：修改新增记录的失败和成功响应为json格式，并在新增记录里做表单验证
4. 删除账单接口：删除记录的路由规则请求方法改为delete，并修改删除后响应结果
5. 获取单条账单接口：新增router.get(‘/account/id’)获取单个账单信息的路由规则
6. 更新账单接口：新增router.patch(‘/account/id’)更新单个账单信息的路由规则

配置cookie，session

0. 响应注册页面：reg.ejs放到views文件夹下，并在routes/web下新建auth.js并响应req.ejs。app.js中导入注册页面的路由文件并app.use设置注册页面
1. 注册用户：auth.js中增加注册用户的post路由规则，models下新增UserModel.js创建文档结构对象，并把该用户模型导入auth.js中
2. 用户密码加密：安装md5包，导入auth.js并在auth.js中router.post(‘/reg’)下UserModel.create()中设置md5加密
3. 用户登录：views/auth下新增login.ejs登录页面，并在auth.js下增加登录页面和登录操作的路由规则
4. 写入session：express-session路由文件导入app.js中并设置session中间件。把config导入配置项至app.js，便于设置session中间件的store mongoUrl。在auth.js中登陆操作中写入session
5. 登录检测：在index.js(负责account页面路由的)声明中间件检测登录，并在每个需要登录后才可操作的路由规则内添加中间件。由于可能会在其他代码中也使用登录检测的中间件，所以在记账本下新建middlewares下新建checkLoginMiddleware.js模块化中间件函数，并作暴露
6. 退出登录：auth.js中写退出登录的post路由规则(之所以用post是为了防止CSRF跨站请求伪造攻击)并且销毁session，在list,js中增加退出登录的btn
7. 首页和404页面：index.js中添加首页路由规则。app.js中在 // catch 404 and forward to error handler下的函数内响应404页面，并在views下新建404.ejs，引入腾讯公益404

配置token 以及功能完善

session存在的问题：网页端已经做了未登录账密无法访问account的约束了，但是接口端还没有，/api/account还是能够访问数据库信息，因此要做token进行api约束

0. 登录响应token：routes/API下新建auth.js，复制Web/auth.js并删去注册、注册用户、登录页面模块。修改登录操作的账密校验: 删去res.send改为响应res.json。删去写入session，安装并引入jwt，创建当前用户的token并响应token，删去登录成功响应。在app.js中导入authApiRouter并使用auth接口路由文件，并postmen测试
1. token校验：新建middlewares/checkTokenMiddleware, 导入jwt，获取token并校验token并封装成中间件，暴露并在account.js中引入。
2. token功能完善：config配置文件中新增token密钥secret，在需要验证密钥的文件中读取配置项。在checkTokenMiddleware内next()之前 新增req.user = data，这样可以保存当前登录的用户信息到req.user中，方便将来编写多用户记账本
3. 代码上传仓库：删去不需要的内容：data/db.json, db.json，初始化仓库，新建.gitignore文件并做忽略(在.gitignore内输入node_modules)，然后上传即可完成建立本地仓库。然后在gitee/github添加远程仓库。最后Publish Branch

---

我是栖夜，一名对开发充满热爱的文科出身的大一非科班学生，感谢阅读。