手把手教你基于springboot+vue搭建前后台分离的个人博客系统
Hello,你好呀,我是灰小猿,一个超会写bug的程序猿!
利用国庆期间做了一个基于springboot+vue的前后端分离的个人博客网站,今天在这里将开发过程和大家分享一下,手把手教你搭建一个自己专属的个人博客。
完整源码放置在Gitee上了,【 】
小伙伴们记得⭐star⭐哟!
小伙伴们一键三连➕关注!灰小猿带你上高速啦🎉🎉🎉!
⚡项目目录⚡
一、个人博客网站项目整体思路
整个项目的设计是前后端分离的,后端使用的是SpringBoot+MybatisPlus设计,前端使用Vue+ElementUI搭建页面。安全验证等操作由shiro安全框架完成,在进行前后端数据交互的时候采用路由传输,同时在前后端解决了跨域问题。博客实现登录功能,在未登录的情况下只能访问博客主页,在登录的状态下可以实现博客的发布与编辑功能。
整个博客主页的博客采用时间线的方式布局,先发布的文章会在最前面展示;博客编辑功能同时支持Markdown编辑器编辑。具体的功能实现小伙伴们继续往下看!
二、Java后端接口开发
(1)数据库设计
在数据库设计上主要就是两个表,一个用户信息表和一个博客信息表,
博客信息表中的数据ID会和用户ID相对应。详细的表结构如下:
(2)整合MybatisPlus
平常我们使用的都是mybatis来做数据库操作,MybatisPlus是在Mybatis的基础上兴起的,我个人的理解是它在Mybatis和逆向工程的结合,可以直接读取我们的数据库,并且自动的生成*Mapper.xml、Dao、Service中的代码,提高我们的开发效率。
整合MybatisPlus的步骤如下:
第一步,导入所需jar包
在这里我们需要导入MybatisPlus所依赖的jar包,同时因为MybatisPlus需要涉及到代码的自动生成,所以还需要引入freemarker的页面模版引擎。
第二步、写入配置文件
因为我们需要连接数据库嘛,所以当然需要用到数据库连接驱动,同时还需要在配置文件中进行配置,指定好我们的数据库驱动、用户名、密码、数据库名称这些。
同时还需要指定好MybatisPlus扫描的xml文件,
第三步、开启mapper接口扫描,添加分页插件
在这里需要实现一个分页插件PaginationInterceptor,使用该分页插件的目的很简单,就是让我们在每次查询到的结果以分页的形式展示出来。该插件是写在MybatisPlusConfig类下的,
同时还有一点需要注意的是,在添加该配置文件的时候我们需要在类上增加@MapperScan("")注解,在其中传入我们想要将接口写入到的包名,该接口的目的就是执行想要变成实现类的接口所在的包,如@MapperScan("com.gyg.mapper")
第四步、生成相关代码
想要通过mybatisplus生成代码,官方是给了我们一个工具类的,通过该工具类,我们可以写入自己的参数,然后就可以自动的生成相关的代码了。
工具类名叫:CodeGenerator ,使用时我们需要将其和springboot的启动类放置在同级目录下。启动运行之后,输入我们想要生成对应代码的表名即可。
工具类的代码比较长,我放置在了gitee上,【
】运行这个代码生成器我们就可以自动的生成相关数据表的mapper、dao、service等内容了!
现在数据库相关的代码已经是基本完成了,
(3)统一结果封装
由于我们的数据都是需要通过json串的形式返回给我们的前端页面的,所以我们就需要对返回的结果进行一个统一的封装。在这里我们可以自定义一个封装类Result,方便我们将数据以统一的格式返回出去。
该封装类中一般需要返回的信息有三个:
- 状态码code(如200表示操作正确,400表示异常)
- 结果消息msg
- 结果数据data
同时在封装类中定义全局方法,用于在不同的状态下返回不同的数据。封装类的代码如下:
(4)整合shiro+jwt实现安全验证
在进行安全验证的时候我采用的是shiro+jwt结合的方式,大概验证思路是这样的:
前端将登陆信息传送过来之后,通过shiro的Realm进行安全验证,如果验证不通过,那么直接将错误信息返回到前端。如果登录信息验证通过,就将用户信息存储到服务器端,然后通过jwtUtils工具类根据用户的ID生成一个token,并且将该token放入返回请求的请求头中,携带给浏览器,浏览器在接收到服务器的返回的请求的时候,就会解析并获取到该token,并将该token存储到本地;
这样在浏览器每次向服务器发送请求的时候都会从本地携带上该token,服务器也会对每次浏览器发送的请求进行验证,验证浏览器返回的token和服务器端保存的token是否相同。如果相同就放行进行处理;如果不相同就将错误信息返回到浏览器。
附上一个请求过程的图示:
安全验证所用到的类有:
- ShiroConfig:用于配置shiro的验证信息
- AccountRealm:用于对浏览器返回的登录信息进行验证
- JwtToken:封装和获取token中的数据
- AccountProfile:登录之后返回的用户信息的一个载体
- JwtFilter:jwt过滤器,用于过滤浏览器的请求
其中的代码比较多,我就放置在的Gitee上,小伙伴们可以在其中获取【
】(5)全局异常处理
无论我们平常在进行什么样的项目开发,进行全局异常处理都是一个非常好的习惯,进行全局异常处理,它可以将我们的错误信息用最简单的方式表示出来,并不会出现大量的报错信息。方便我们查阅,在这里我声明了几个在项目中经常会遇到的报错信息。
(6)实体校验
在表单数据提交的时候,我们通常会对数据进行校验,比如不能为空,或长度不能小于指定值等,在前端我们可以通过js插件来完成,但是如果在后端的话,我们可以通过使用Hibernate validatior的方式来进行校验。
在springboot中已经自动集成了Hibernate validatior的校验,我们只需要在代码中直接使用就可以了。
所以我们只需要在实体的属性上添加相应的校验规则就可以了,比如在user实例类中:
(7)跨域问题
由于我们做的是前后端分离的项目,所以在请求发送上一定会出现同源策略的相关问题,这就需要我们解决跨域问题了,关于在前后端交互中解决跨域问题,我专门写了一篇博客,小伙伴们可以去看那一篇《 》
在springboot的后端解决跨域问题的策略比较简单,只需要添加一个类CorsConfig,并且让它实现WebMvcConfigurer接口, 其中代码如下,一般在开发的时候直接将代码复制过去就可以了。
(8)登录接口开发
登录接口的开发思路很简单,就是接收前端发送过来的登录信息,进行验证是否通过。同时还有一个退出登录的接口,传入用户的信息,确定是在登录状态时可以实现退出登录操作。
代码如下;
(9)博客接口开发
博客接口中主要实现的功能有:返回主页信息,返回指定博客信息,编辑和发布博客、删除博客的功能,其中编辑和删除博客只有在登录状态下才能请求成功,其他两个请求无需进行登录。
代码如下:
以上就是我们后台接口开发的全部过程,在开发完成之后需要进行相关的接口测试,测试完成无误之后就可以进行前台页面的开发了。
三、Vue前端页面开发
前端页面的开发我们是基于Vue和Element-Ui的,同时涉及axios发送请求,markdown编辑器的引入、登录验证、跨域请求等问题。
博客主页的页面是这样的:
接下来和大家分享一下前端页面的开发流程。
(1)安装Element-UI
Element-UI是进行前端开发的一个组件库,官网地址。这里面提供了各种已经开发好的组件供我们使用。
使用该组件库我们首先是需要引入的。在vue的根目录下,输入如下命令:
# 切换到项目根目录
cd vueblog-vue
# 安装element-ui
npm install element-ui --save
之后打开项目的src目录下的main.js文件,引入Element-UI依赖。
到现在,组件库中的组件我们就可以任意使用了。
(2)安装axios
axios是一个基于promise的HTTP库,在我们进行前后端项目开发的时候,使用该工具可以提高我们的开发效率。【 】
Axios的安装命令如下:
cnpm install axios --save
同样需要在main.js中全局引入axios,
之后我们就可以通过this.$axios.get()来发起我们的请求了!
(3)配置页面路由
接下来是定义页面路由,定义页面路由的目的是我们在访问相应路径的时候,可以根据路由来确定到我们将要访问的页面。
在views文件夹中的页面有:
- BlogDetail.vue(博客详情页)
- BlogEdit.vue(编辑博客)
- Blogs.vue(博客列表)
- Login.vue(登录页面)
页面路由设置在router文件下的index.js中。配置如下:
在上述代码中带有meta:requireAuth: true说明是需要登录之后才能访问的受限资源,后面我们路由权限拦截时候会讲到这个。
(4)登录页面
登录页面我们这里是由用户名和密码进行登录的,组件我采用了element-ui中的组件,所以在登录中直接就有了登录校验的功能,
登录验证
在这里点击登录按钮之后,会有一个验证登录的过程,简单说一下验证的思路,
我们发起登录请求之后,获取到它返回的请求,查看请求中是否存在我们需要的jwttoken,如果存在的,那么我们就将获取到的token和用户信息共享给我们的浏览器,之后跳转到主页。如果不存在,就弹窗提示,并且不做任何操作。
代码如下:
token状态同步
在上述代码中,我们用到了$store来同步token和用户信息,那么这个同步是如何完成的呢,其实是我们在store文件下的index.js中进行了封装和设置。
存储token,我们用的是localStorage,存储用户信息,我们用的是sessionStorage。毕竟用户信息我们不需要长久保存,保存了token信息,我们随时都可以初始化用户信息。
index.js中的代码如下:
定义全局axios拦截器
由于我们的登录有时候会出现密码输出错误的情况,虽然不需要做任何操作,但是有时候我们还是需要进行弹窗提示,这样对于这种错误信息的弹窗,我们就可以对其进行统一的封装和设置。所以我对axios设置一个拦截器,包括前置拦截和后置拦截,如果说我们返回数据的code或者status不正常就会弹窗提示相应的信息。
操作是在在src目录下创建一个文件axios.js(与main.js同级),定义axios的拦截:
之后别忘了在main,js文件中导入axios,js文件。
简单说一下这几个拦截的作用:
前置拦截:在请求之前的拦截,可以在其中统一为所有需要权限的请求装配上header的token信息,这样就不要在使用的时候再配置。
后缀拦截:在请求返回之后的拦截,可以在请求之后对返回的数据进行处理和验证,
(5)博客列表
在我们登录完成之后就会进入了博客的主页面,在该页面主要是展示了当前录入到系统中的博客信息,界面如下:
整个博客的显示是按照时间线的方式展开的,最后发布的博客会在第一个出现,同时你会发现在博客主页的头部会展示我们的一些基本信息,包括个人信息以及编辑和退出的功能,这个头部信息会一直显示在我们的页面中,所以为了能够实现代码复用,减少代码的使用量,我们将头部信息全部都抽取了出来,放置在了Header.vue页面中,
如果在其他页面中需要该头部信息时,只需要将Header页面引用到该页面中,之后在内容中写入即可。如下:
然后模板中调用组件
在该博客主页中包括博客分页,以及博客排列,因为我们使用了分页组件,所以在返回的信息会直接带有分页信息,我们直接拿来用就可以了。
data()中直接定义博客列表blogs、以及一些分页信息。methods()中定义分页的调用接口page(currentPage),参数是需要调整的页码currentPage,得到结果之后直接赋值即可。然后初始化时候,直接在mounted()方法中调用第一页this.page(1)。
(6)博客编辑
博客编辑页面中我们可以对已经发布的博客进行编辑,也可以发布新的博文,但是该项功能是只有在登录的状态下才能使用的,在博客编辑页面中,我们引入了markdown编辑器,该编辑器有关于vue的支持。我们直接导入相关依赖拿来用就可以了,
Markdown编辑器引入
第一步、进入插件
Markdown编辑器中比较好用的插件是mavon-editor,首先我们需要安装相关插件。
cnpm install mavon-editor --save
第二步、全局注册
引入之后如果想要使用,当然是需要在main.js文件中全局注册的,
第三步、定义到页面中
Markdown编辑器的使用,在注册到全局页面中之后,只需要我们在页面中使用如下代码引入即可。
以上就是vue引入markdown编辑器的步骤了,
另外附上博客编辑页面的代码:
效果如下:
(7)博客详情页
在博客详情页中,我们需要回显我们的博客信息,但是我们在发布博客的时候,使用的是markdown编辑器,所以在回显的时候,我们回显的内容带有markdown标签的,那么应该如何回显我们正式编辑的文本呢?
在这里需要使用一个插件markdown-it,它的作用是解析md文档,之后再导入github-markdown-it,使用md样式。
# 用于解析md文档
cnpm install markdown-it --save
# md样式
cnpm install github-markdown-css
在需要写入博客文本的地方的使用方法是:
其中还涉及到一些md相关的渲染,可以看代码,
具体逻辑是这样的;初始化create()方法中调用getBlog()方法,请求博客详情接口,返回的博客详情content通过markdown-it工具进行渲染。
再导入样式:
然后在content的div中添加class为markdown-body即可
得到的效果如下,其中的博文是我之前在CSDN发布过的,效果基本上一样。
(8)权限路由拦截
因为我们最开始也提到了部分页面是需要在登录的状态下才能访问的,那么在前台应该如何进行拦截呢?其实思路是很简单的,主要就是给每一个页面请求添加一个参数,标记其是否是需要在登录状态下才能访问,同时过滤拦截每一个请求,如果该请求是需要登录才能访问的,那么就从浏览器中获取token,如果能够够获取到,就放行,否则就跳转到登录页面。
关于这个知识点我单独总结了一篇博客,欢迎小伙伴们学习!
四、写在最后&项目总结
到这里整个项目就算是开发完成了,其中也参考了b站大佬的视频讲解,自己也学到到了很多东西,整个项目对学习前后台分离的新手来说还是非常友好的。其中的shiro+jwt安全验证、统一结果封装、以及前台页面中路由的设置、存储和获取token、跨域解决、登录验证等都是非常值得学习的。
项目参考自MarkerHub老师的《4小时开发一个SpringBoot+vue前后端分离博客项目》,本文章中的讲解是我个人的开发总结和思路,如有问题欢迎批评指正!
项目源码我放在gitee了,【⭐ 】,小伙伴们别忘了star⭐哟!
一键三连加关注!灰小猿带你上高速啦!✨✨✨
我是灰小猿,我们下期见!
- 点赞
- 收藏
- 关注作者
评论(0)