耗时半载(半个月)的大项目终于完成了。这是一个博客系统,使用 Vue 做前端框架,Node + express 做后端,数据库使用的是 MongoDB。实现了用户注册、用户登录、博客管理(文章的修改和删除)、文章编辑(Markdown)、标签分类等功能。
很早之前就想写一个个人博客。学了 Vue 之后,把前端部分写出来,然后 Node 一直拖拖拉拉的学了很久,中间又跑去实习了一段时间,所以直到回学校之后才列了个计划把这个项目实现了。
翻出之前写的前端部分,好丑啊,干脆推掉重写吧。前端模仿的是 hexo 的经典主题 NexT ,本来是想把源码直接拿过来用的,后来发现还不如自己写来得快,就全部自己动手实现成 vue components。
实现的功能
- 文章的编辑,修改,删除
- 支持使用
Markdown
编辑与实时预览 - 支持代码高亮
- 给文章添加标签
- 支持用户注册登录
使用到的技术
前端
- Vue.js
- vue-cli
- vue-router
- vue-resource
- element-ui
- marked
- highlight.js
后端
- Node.js
- Express
- Mongoose
基本思路
前端使用 vue-router
操作路由,实现单页应用的效果。使用 vue-resource
从后台获取数据,数据的处理全部都在前端,所以后端要做的事情很简单——把前端打包好的数据存进数据库中和从数据库中取出数据。前后端使用统一的路由命名规则。
项目目录
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
|
| app.js 后端入口
| index.html 入口页面
| .babelrc babel配置
| .gitignore git配置
| package.json
| webpack.config.js webpack配置
|
|-dist vue打包生成的文件
|
|-node_modules 模块
|
|-server 后端
| check.js
| db.js 数据库
__ | router.js 路由
|
|-src 前端
|-assets 静态资源
|-components 组件
| App.vue
| main.js
|
webpack 配置
webpack 大部分是 vue-cli 自动生成的,添加了让前后端http请求都转到node的3000端口,而不是前端的8080端口的配置。
1
2
3
4
5
6
7
8
9
10
11
|
devServer: {
historyApiFallback:
true,
noInfo:
true,
proxy: {
'/': {
target:
'http://localhost:3000/'
}
}
}
|
这里涉及一个新手可能会不明白的问题(我之前就捣鼓了半天)。
开发的时候要先打开数据库 MongoDB ,使用命令 mongod
。
然后打开后端服务器 node app
,后端监听 3000 端口。
最后打开前端开发模式 npm run dev
,前端启动了一个 webpack 服务器,监听 8080 端口用于热刷新。通过配置把前端的http请求转到 3000 端口。
前端部分
命名视图
所有页面都用到的元素可以写在 App.vue
上面,也可以写成公共组件。我在 App.vue 中使用了命名视图,因为 sidebar 这个组件有的页面需要有的不需要,不需要的时候就不用加载。
1
2
3
4
5
6
7
8
9
10
|
<template>
<div id="app">
<div class="black_line">
</div>
<div id="main">
<router-view name="sidebar">
</router-view>
<router-view>
</router-view>
</div>
</div>
</template>
|
router
路由的配置写在 main.js 中,分为前台展示和后台管理。后台管理统一以 ‘/admin’ 开头。注册页和登录页写在一起了,上面有两个按钮“注册”和“登录”(我好懒-_-)。
1
2
3
4
5
6
7
8
9
10
11
12
13
|
const router =
new VueRouter({
routes: [
{
path:
'/',
components: {
default: article,
sidebar: sidebar}},
{
path:
'/article',
components: {
default: article,
sidebar: sidebar}},
{
path:
'/about',
components: {
default: about,
sidebar: sidebar}},
{
path:
'/articleDetail/:id',
components: {
default: articleDetail,
sidebar: sidebar}},
{
path:
'/admin/articleList',
components: {
default: articleList,
sidebar: sidebar}},
{
path:
'/admin/articleEdit',
component: articleEdit},
{
path:
'/admin/articleEdit/:id',
component: articleEdit},
{
path:
'/admin/signin',
component: signin}
]
})
|
element UI
使用了 element 用于消息提醒和标签分类。并不需要整个引入,而是使用按需引入。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
import { Button, Message, MessageBox, Notification, Popover, Tag, Input }
from
'element-ui'
import
'element-ui/lib/theme-default/index.css'
const components = [Button, Message, MessageBox, Notification, Popover, Tag, Input]
components.forEach(
(item) => {
Vue.component(item.name, item)
})
const MsgBox = MessageBox
Vue.prototype.$msgbox = MsgBox
Vue.prototype.$alert = MsgBox.alert
Vue.prototype.$confirm = MsgBox.confirm
Vue.prototype.$prompt = MsgBox.prompt
Vue.prototype.$message = Message
Vue.prototype.$notify = Notification
|
vue-resource
用于向后端发起请求。打通前后端的关键。
1
2
3
4
5
6
|
this.$http.get(
'/someUrl').then(
response => {
}, response => {
});
|
get 请求
前端发起 get 请求,当请求成功被返回执行第一个回调函数,请求没有被成功返回则执行第二个回调函数。
1
2
3
4
|
this.$http.get(
'/api/articleDetail/' + id).then(
response =>
this.article = response.body,
response =>
console.log(response)
)
|
后端响应请求并返回结果
1
2
3
4
5
6
7
8
9
10
|
router.get(
'/api/articleDetail/:id',
function (req, res) {
db.Article.findOne({
_id: req.params.id },
function (err, docs) {
if (err) {
console.error(err)
return
}
res.send(docs)
})
})
|
post 请求
前端发起 post 请求,当请求成功被返回执行第一个回调函数,请求没有被成功返回则执行第二个回调函数。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
|
let obj = {
title:
this.title,
date:
this.date,
content:
this.content,
gist:
this.gist,
labels:
this.labels
}
this.$http.post(
'/api/admin/saveArticle', {
articleInformation: obj
}).then(
response => {
self.$message({
message:
'发表文章成功',
type:
'success'
})
self.refreshArticleList()
},
response =>
console.log(response)
)
|
后端存储数据并返回结果
1
2
3
4
5
6
7
8
9
10
11
|
router.post(
'/api/admin/saveArticle',
function (req, res) {
new db.Article(req.body.articleInformation).save(
function (err) {
if (err) {
res.status(
500).send()
return
}
res.send()
})
})
|
后端部分
后端使用 express 构建了一个简单的服务器,几乎只用于操作数据库。
app.js 位于项目根目录,使用 node app
运行服务器。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
|
const express =
require(
'express')
const fs =
require(
'fs')
const path =
require(
'path')
const bodyParse =
require(
'body-parser')
const session =
require(
'express-session')
const MongoStore =
require(
'connect-mongo')(session)
const router =
require(
'./server/router')
const app = express()
const resolve =
file => path.resolve(__dirname, file)
app.use(
'/dist', express.static(resolve(
'./dist')))
app.use(bodyParse.json())
app.use(bodyParse.urlencoded({
extended:
true }))
app.use(router)
app.set(
'trust proxy',
1)
app.use(session({
secret:
'blog',
resave:
false,
saveUninitialized:
true,
cookie: {
secure:
true,
maxAge:
2592000000
},
store:
new MongoStore({
url:
'mongodb://localhost:27017/blog'
})
}))
app.get(
'*',
function (req, res) {
let html = fs.readFileSync(resolve(
'./' +
'index.html'),
'utf-8')
res.send(html)
})
app.listen(
3000,
function () {
console.log(
'访问地址为 localhost:3000')
})
|
给自己挖了一个坑。因为登录之后需要保存用户状态,用来判断用户是否登录,如果登录则可以进入后台管理,如果没有登录则不能进入后台管理页面。之前写 node 的时候用的是 session 来保存,不过spa应用不同于前后端不分离的应用,我在前端对用户输入的账号密码进行了判断,如果成功则请求登录在后端保存 session。不过不知道出于什么原因,session 总是没办法赋值。因为我 node 学的也是半吊子,所以暂时放着,等我搞清楚了再来填坑。
收获
- 学一个新模块,新框架第一步就是阅读官方文档。
- 不要觉得读文档费时间,认真的读一遍官方文档比你瞎折腾来得有效率。
- 阅读与你项目相关的优秀项目的源码,学习别人如何组织代码。
- 自己的解决方案不一定是最优解,不过在找到最优解之前不妨自己先试试。
- 框架模块的使用都不难,套API的活每个人都能干,只是快与慢的差别。
- 尝试思考这个API是如何实现的。
- 了解了完整的web应用是如何运作的,包括服务器,数据库,前端是如何联系在一起的。