本章主要讲什么(一句话)?
《项目实战:基于Angular2+Mongodb+Node技术实现的多用户博客系统教程(6)》
-- 多用户博客项目需求分析&路由规划
一、前言
上一章主要对Express框架作了的剖析和局部优化工作,本节继续。从本节起,我将正式讲解本项目需求及UI设计和项目路由规则。本项目虽小,但无论前期的项目规划设计还是后期的代码规范,我还是想立求正规化,努力做到 ”麻雀虽小,五脏俱全“ ,争取本项目源码你拿到后可直接上手真实项目开发。
二、 需求功能分析
功能分析
搭建一个简单的具有多人注册、登录、发表文章、登出功能的博客。
设计目标
未登录:主页左侧导航显示 home、login、register,右侧显示已发表的文章、发表日期及作者。
登陆后:主页左侧导航显示 home、post、logout,右侧显示已发表的文章、发表日期及作者。
用户登录、注册、发表成功以及登出后都返回到主页。
界面原型
1. 主页:
2. 登录页:
3. 注册页:
4. 登录后:
主页:
5. 发表页:
注意:没有登出页,当点击LOGOUT后,退出登陆并返回到主页。
6. 关于我们
三、 路由规划
接下来的任务就是完成路由规划了。路由规划,或者说控制器规划是整个网站的骨架部分,因为它处于整个架构的枢纽位置,相当于各个接口之间的粘合剂,所以应该优先考虑。
根据构思的设计图,我们作以下路由规划:
/login :用户登录
/reg :用户注册
/post :发表文章
/logout :登出
要求/login和/reg只能是未登录的用户访问,而/post和/logout只能是已登录的用户访问。左侧导航列表则针对已登录和未登录的用户显示不同的内容。
具体如下,见代码注释:
修改routes/index.js如下:
module.exports = function(app) {
/*
说明:本接口用于获取博客列表的信息的。http://localhost:3000/get/post?name=zzz
1.get/:说明是get请求
2.如果传递了name参数,则说明是:请求某一个人的博文。如:http://localhost:3000/get/post?name=zzz
3.如果没传递name参数,则说明是请求所有人的博文列表,显示在首页
*/
app.get('/get/post', function(req, res) {
res.send('本接口用于获取博客列表的信息的!');
});
/*
说明:本接口用于获取用户信息的。http://localhost:3000/get/user?name=zzz
1.get:说明是get请求
2.如果传递了name参数,则说明是:请求某个用户的信息。如:http://localhost:3000/get/user?name=admin
3.如果没传递name参数,则说明是请求所有用户的信息
*/
app.get('/get/user', function(req, res) {
res.send('本接口用于获取用户信息的!');
});
/*
说明:本接口用于提交注册用户信息的。http://localhost:3000/post/reg
1.post/:说明是post请求
2.注册未成功,返回Json格式如下:{status:'failed',message:"xxxxxx!"}
3.注册成功,返回Json格式如下:{status:'success',message:"注册成功!",user:user}
*/
app.post('/post/reg', function(req, res) {
res.send('本接口用于提交注册用户信息的!');
});
/*
说明:本接口用于提交用户登录信息的。http://localhost:3000/post/login
1.post/:说明是post请求
2.登录未成功,返回Json格式如下:{status:'failed',message:"xxxxxx!"}
3.登录成功,将用户对象保存到Session
4.登录成功,返回Json格式如下:{status:'success',message:"登陆成功!",user:user}
*/
app.post('/post/login', function(req, res) {
res.send('本接口用于提交用户登录信息的!');
});
/*
说明:本接口用于提交用户的编写的博文的。http://localhost:3000/post/post
1.post/:说明是post请求
2.提交未成功,返回Json格式如下:{status:'failed',message:"出错了,原因如下:"+err}
3.提交成功,返回Json格式如下:{status:'successed',message:"保存成功!"}
*/
app.post('/post/post', function(req, res) {
res.send('本接口用于提交用户的编写的博文的!');
});
/*
说明:本接口用于用户注销。http://localhost:3000/get/logout
1.get/:说明是get请求
2.注销用户,即清除服务端的Session
*/
app.get('/get/logout', function(req, res) {
res.send('本接口用于用户注销的!');
});
};
PS: 每个路由前面加上:/get/ 或 /post/ 的目的,主要是为了将来做跨域处理时写路由正则更方便处理,同时也是为了更加高效及安全性上考虑,你也可以不要此前缀,这个不是必须的。
四、 运行测试
第一步:运行Node服务器: > node app
第二步:打开浏览器:http://localhost:3000/get/post
第三步:打开浏览器:http://localhost:3000/get/user
第四步:打开浏览器:http://localhost:3000/get/logout
PS: app.post所对应的接口,不允许直接浏览器方式访问,这里不作测试!
五、其他
1. 删除掉 routes/user.js
2. app.js再作部分优化,主要是删掉了
var index = require('./routes/index');
var users = require('./routes/users');
部分,其他也略调整了下顺序,这里就不再累述,具体见后继提供的代码!
下章剧透:
《项目实战:基于Angular2+Mongodb+Node技术实现的多用户博客系统教程(7)》
-- 引入MongoDB存储数据
作者:fwytech
链接:https://www.jianshu.com/p/fb87757180db