文章版权所有:中国移动通信集团 – 山东有限公司 – 烟台分公司 – 市场经营部 – 业务支撑中心
如果要转载或者使用请联系wechat:mickeywang1998,本项目是借助网上开源的代码二次开发而成,本项目及其文档是单一来源付费的开源项目,请尊重作者创作!
项目Demo展示
为什么要做这个教程?
在你看之前:事先说明,教程很简单,是入门教程,不喜勿喷,出门右拐,喷子视情况删评论的嗷!
本人普通一本毕业,本科计算机专业,入职某国企,毕业之后希望自己能利用所学在企业施展一些拳脚,但是技术所限,这个教程是给所有的初学者,也是给我自己,好脑子不如烂笔头,希望这个教程能够帮助到更多像我一样的人。
很简单的一个项目,其实说简单也简单,说困难也困难,对于初学者,我相信大家踩了不少坑,也绕了不少的弯路。
网上大部分基于vue和springboot的项目都是非常成熟的项目,具体成熟到什么地步呢,可以这么说,项目和框架体量大的,可以大到初学者一眼看不出相互逻辑的,框架的API文档也看不懂,怎么办呢,把项目git下来自己摸索着改一下吧,发现根本改不动。
登录项目固然非常简单,但是对于初学前后端分离开发的同学或者想要转行计算机的人士来说,迫切需要一个非常基础的前后端框架逻辑及其要点的一个教程,我就是基于这个想法来做这个教程的。
界面展示
本地环境搭建
前置:nodejs安装
nodejs就是运行在服务端的JavaScript,你的JS速度越快,那么对于我们的这个登录项目来说,我们前端的用户交互和提交速度也就越快。
学过Html5+CSS+JavaScript这一套基本前端的开发流程的同学应该都知道
这样一来,有了nodejs,我们的vue项目就可以很好的运行了。下面来介绍一下nodejs安装步骤:
nodejs安装步骤
- Node.js 安装包及源码下载地址为:点我去官网下载nodejs
- win10-64bit系统用户点击下载Windows Installer (.msi)64-bit
- 进行安装,要记住下面图片的安装目录,防止后期环境变量PATH中没有nodejs我们还要去文件管理器中找目录
- 安装完毕之后要win+R运行CMD,显示如下:
1 | Java复制代码Microsoft Windows [版本 10.0.18363.1316] |
插播:PATH没有nodejs看这里!!!环境变量
在CMD的PATH路径下面没有看见nodejs路径的看这里!!!
首先,win10环境下面,右击“此电脑”,点击“属性”
其次,点击“高级系统设置”,再点击“环境变量”
最后,我们需要在第二个,系统变量这一栏新建变量NODE_PATH,将刚才的安装路径/bin复制进去,一路保存就可以了!
好的,我们继续刚才的话题,下面是第5步:
- 随后检查nodejs的版本,如何用CMD命令行查看nodejs的版本?输入在CMD中,代码如下:
1 | Java复制代码node -v |
或者
1 | Java复制代码node --version |
安装版本为V14.12.0
前置:npm安装
npm的作用
npm是一个在nodejs下面的包管理器,他在nodejs安装完毕时就已经完成安装了,只不过有可能不是最新版本。顾名思义,没有这个包管理器,你的所有后续工作都无法进行。
NPM能解决NodeJS代码部署上的很多问题,常见的使用场景有以下几种:
- 允许用户从NPM服务器下载别人编写的第三方包到本地使用。
- 允许用户从NPM服务器下载并安装别人编写的命令行程序到本地使用。
- 允许用户将自己编写的包或命令行程序上传到NPM服务器供别人使用。
查看npm版本
其实nodejs安装完了,npm也会自动完成安装,如何用CMD命令行查看npm的版本?
1 | Java复制代码npm -v |
npm的全局安装和本地安装
- 全局安装
这里是全局安装可以看到在根目录下都有cmd后缀的文件,通过这些文件,我们就可以直接在命令行中使用了。 如使用 xxx –version等等都是有效的,且不管你是在哪个目录文件下运行的。
也就是说,全局安装的意思,就是在计算机的任何一个角落,任何一个目录下,你都可以通过CMD等方式,找到安装好的组件
- 局部安装
但是局部安装并不是这样,往往是在一个项目中安装之后装入 ./node_nodules 目录下面,这样的局限在于,只能是在本项目中使用。
特别的是,webpack和babel这样的工具可以在各种情况、各种项目中使用。
升级npm/利用淘宝镜像升级
- 如果你想升级的话,可以在CMD输入
1 | Java复制代码npm install npm -g |
- 配置淘宝镜像源,随后利用淘宝镜像源的资源来升级npm,方法如下:
首先,修改npm的镜像站点配置
1 | Java复制代码npm install -g cnpm --registry=https://registry.npm.taobao.org |
其次,检查我们的npm
1 | Java复制代码C:\Users\w1248>npm config get registry |
最后,通过淘宝镜像源更新npm
1 | Java复制代码C:\Users\w1248>npm install npm -g |
屏幕显示如下:
1 | Java复制代码C:\Users\w1248\AppData\Roaming\npm\npm -> C:\Users\w1248\AppData\Roaming\npm\node_modules\npm\bin\npm-cli.js |
可选:cnpm安装
其实在安装完npm之后,我们可以利用npm包管理器的作用来完成cnpm的安装
- 打开CMD,输入命令(其实刚才配置了镜像源的话,npm install -g cnpm就可以了)
1 | Java复制代码npm install -g cnpm --registry=https://registry.npm.taobao.org |
- 检查cnpm的版本,输入
1 | Java复制代码cnpm -v |
显示如下(这段显示是我的计算机没有配置环境变量为nodejs的node_modules目录,如果你在我的上面文章介绍中配置了,那你的会和我不一样)
1 | Java复制代码cnpm@6.1.1 (C:\Users\w1248\AppData\Roaming\npm\node_modules\cnpm\lib\parse_argv.js) |
vue安装
vue.js安装
我们之前已经安装好了nodejs和npm,要安装vue.js,CMD输入
1 | Java复制代码npm install vue -g |
vue-router安装
我们之前已经安装好了nodejs和npm,要安装vue-router,CMD输入
1 | Java复制代码npm install vue-router -g |
vue-cli 3 脚手架安装(内置webpack)
现在我们来安装vue-cli的开发脚手架,CMD输入
1 | Java复制代码npm install vue-cli -g |
利用CMD命令行,输入下面的命令,对vue的版本进行查看
1 | Java复制代码vue -V |
环境变量配置
上述nodejs配置,我们已经解决了环境变量的配置
Vue前端页面开发
前端开发用到的IDE:Visual Studio Code
前端项目目录:
vue项目初始构建(附录:VSCode加右键菜单)
创建VUE项目
- 创建 Vue 项目(进入自己想创建的文件夹位置,我放在 D:\teaching),创建语句是 vue create vue-spring-loginwork,方向键上下可以你的选择创建方式,我选择默认default Vue 2(因为Vue 3的一些语法改变我不是很熟悉,我没有选择3)
1 | Java复制代码vue create vue-spring-loginwork |
创建完成之后是这样的
- 进入到创建的 Vue 项目目录,添加依赖框架,在cmd中代码如下:
1 | Java复制代码cd vue-spring-loginwork |
(1) 进入目录cd vue-spring-loginwork
(2) 添加饿了么团队研发的element-ui组件,我们在vue中会用到一些el-form等等样式(这个时候要等待一会比较慢)
这个地方要选择Fully import,y,zh-CN,切记
完成截图:
(3) 安装 axios,用于网络请求
(4) 安装 Vuex,用于管理前端的状态
(5) 安装vue框架路由,用于实现vue页面的跳转
(6) 这个时候就基本框架搞定了,我们先做个小测试
打开项目,我们的目录是这样的,如图
这个时候我们打开VSCode下方的终端,输入npm run serve测试:
浏览器输入http://localhost:8080/ 发现页面,说明成功!(这个页面说明我们的element和vue都已经安装好了)
将VSCODE加入右键菜单,方便我们打开项目!
PS:在这里,教给大家如何将VSCode加入我们的右键菜单当中,方便我们打开项目
首先,桌面创建一个aaa.txt文件,将下面的代码copy进去
1 | Java复制代码Windows Registry Editor Version 5.00 |
其次,将里面所有的路径,改为你的Code.exe路径,查看自己的VSCODE安装路径,我的Code.exe路径为”D:\Program Files\Microsoft VS Code\Code.exe”(自己文件路径不是双斜线的一定要自己改成双斜线\,例如,D:\Program Files改成D:\Program Files,否则会失败的)
最后,将txt命名为aaa.reg,执行文件,完成!
修改index.html,App.vue和main.js
初始前端Vue项目显示逻辑
项目建立完毕之后,页面的显示逻辑是:
- 浏览器访问项目,最先访问的是index.html文件
- 上面有一个id为app的挂载点,之后我们的Vue根实例就会挂载到该挂载点上
- main.js作为vue项目的入口文件,在main.js中,新建了一个Vue实例,在Vue实例中,通过下图告诉该实例要挂载的地方
- 所以Vue这个实例就是战士的是App.vue这个组件的内容。
显示结果:在网页的Title部分,加载了index.html中定义的Title,而在正文部分,加载了App.vue中定义的部分。(但是需要注意的是,在浏览器打开的瞬间,浏览器中正文部分会瞬间显示index.html中定义的正文部分)
在做这一步之前,我们需要往项目的src目录当中,先添加几个文件夹目录,他们分别是
- api (网络请求接口)
- router (路由配置)
- store (Vuex 状态管理)
- utils (项目的工具包)
- views (视图包,存放页面代码,可根据功能模块进行相应分包)
如图所示:
下面我们来修改基本的入口App.vue和main.js
修改index.html
- public目录下的index.html
1 | Html复制代码<!DOCTYPE html> |
修改App.vue
- App.vue
1 | Html复制代码<template> |
修改main.js
- main.js
1 | javascript复制代码import Vue from 'vue' |
编写error,login,success的vue界面
修改完基本的项目入口御三家之后,我们开始编写登录页面组件,以及登陆之后的反馈页面组件error和success
login.vue
1 | Html复制代码<template> |
success.vue
1 | Html复制代码<template> |
error.vue
1 | Html复制代码<template> |
注册路由vue-router
这一步我们需要将我们我们写好的页面配置到路由里面,这样我们的router/index.js需要配置我们的views里面页面组件
router/index.js代码
1 | javascript复制代码import Vue from 'vue' //引入 Vue |
this里面的内容(也就是data里面的)
利用postman进行后端–前端测试
发现返回的数据如下
1 | Java复制代码{ |
这就已经和代码对应上了
使用 Vuex + Axios 方式进行网络请求(本章需先看后端再来)
这个地方就是前端项目的重中之重了,我会重点来讲解,他们这个前后端到底是如何交互的。
其实这个教程我是写反了了的,正常是先写好后端,才能写前端,因为前端他不能架空来写,他是需要后端和数据库来做沟通交流的。
重点:前端和后端的传值字段
我们的json里面是包含两个字段的,也就是:
1 | Java复制代码{ |
前端是通过访问了页面之后,向http://localhost:8088/admin/login POST username和password。
这个从src/api/login.js里面可以看到.
之后呢?后端反馈的是什么呢?
- 如果成功的话,返回的是:
1 | Java复制代码{ |
- 如果失败的话,返回的是:
1 | Java复制代码{ |
你会发现成功的时候,提示信息是放在data里面的,然而,失败是放在message里面的。
这是因为后端的controller里面调用的CommomResult的缘故:
在src/main/java/cn.eli.vue.api里面的CommonResult方法写到:
仔细看一下顺序,和传参类型:
- 如果成功的话:
方法是读进来一个泛型的data,返回的是code,message(这两个在枚举里面都写了),还有一个泛型data。
- 如果失败的话:
方法是读进来一个字符串的message,返回的是code,刚才读进来的message,还有一个泛型data(这个data已经被置为空)。
这个时候我们看看枚举里面怎么写的:
1 | Java复制代码 |
这就可以看出我们传值的类型了。
重点:本项目如何前端向后端传json的,以及网络请求逻辑
前面解释清楚了前端和后端传值的类型和具体名字,我们在这里讨论一下,前端向后端的POST流程:
页面的逻辑没有什么好说的,一个入口,页面写完,路由配置好,这样静态页面就能一个一个访问了。
关键的是vuex和axios的部分:
- 首先,先运行main.js,要引入store(为啥不引入axios呢,后面在utils里面的request会用到),进而通过store进行网络请求(store文件夹是vuex的状态管理器)
- 在store里面的index.js,在我们的项目里面是一个组装模块并且导出store的地方,主要写法:const store=new Vuex.Store(option),是一个vuex固定写法
(1) 对于options这个const里面的参数可以是state, getters(key: string),mutations[type: string],actions,[type: string],modules(store里面的模块),plugins(Array<Function(store)>,自定义插件),strict, (Boolean,默认false),devtools,(Boolean,默认false)
(2) 对于每一个module都可以随意创建一个对应模块语义化的.js文件(如test.js),然后export输出
(3) 把store,拆分成多个子模块(module),以方便开发维护。
使用方法:在new Vuex.Store({modules:{m1,m2,m3}}),子模块(module)就是一个普通的对象。
(4) module里面js写法:
export default {
namespaced:true,//为了解决不同模块命名冲突的问题
state:{},//规定变量名并且初始化值
getters:{},// 获取用户信息
mutations:{},//将信息可以通过mutations里面的方法放进state
actions:{}//动作
}
(5)讲一下插件plugins,plugins实际上是函数,它接收 store 作为唯一参数
1 | Java复制代码const store = new Vuex.Store({ |
那么plugins的肚子里都是什么东西呢?
1 | Java复制代码const myPlugin = store => { |
首先,在插件内提交 Mutation,生成 State 快照,快照就是像一个瞬间曝光的照片,可以比较所拍事物的前后变化,在这里大体说一下,我们项目里没有用到,官方详细讲plugins的文档,vuex.vuejs.org/zh/guide/pl…
- store通过user.js这个模块进行网络请求,actions里面定义Login方法,这个方法在login.vue组件中使用,语法是this.$store.dispatch(“Login”)
user.js里面的逻辑其实网上很多大佬已经写好了,包括之前login.vue的登录逻辑,废话不说看一下代码,我从user.js文件中拿出来的,我把第一句import和最后一句export删了!
1 | Java复制代码const user = { |
这里上面const username=userInfo.username.trim(),其实可以不做处理改成const { username, password } = userInfo。commit为了后面提交一个token,我们这里没有设置,token就是在本地的一个验证的东西。
网上有一些不良代码写的很误导人,虽然我写的也不是很好,但是我有讲解,没有讲解的话真的很容易误导别人。
- 随后user.js在return Promise里面利用api/login.js接口的login来发网络请求
- 之后你会发现,login接口里面用到的request是utils/request.js
utils/request.js里面对axios基本配置,创建axios实例:
1 | Javascript复制代码import axios from 'axios'; |
export语法声明用于导出函数、对象、指定文件(或模块)的原始值
import花括号里面的变量与export后面的变量一一对应
这时,api/login.js里面就可以import request from ‘@/utils/request’
直接把实例化axios引入,也就是说,在api/login.js里面的request这个量,可以使用axios的get,post等等,也可以通过向axios传递相关配置来创建请求
请看官网写法:axios.create([config])
写一个实例,之后往这个实例里面,我们可以有axios([config])这种写法(这种就是请求方法的写法了)
之后还有“别名”写法
为方便起见,为所有支持的请求方法提供了别名
axios.request(config)
axios.get(url[, config])
axios.delete(url[, config])
axios.head(url[, config])
axios.post(url[, data[, config]])
axios.put(url[, data[, config]])
axios.patch(url[, data[, config]])
- 访问逻辑顺序:main.js调用store/index.js调用user.js调用api/login.js调用request.js调用api/baseUrl.js
Vuex + Axios部分所有源文件代码
api/baseUrl.js
1 | Javascript复制代码let baseUrl = ""; |
api/login.js
1 | Javascript复制代码import request from '@/utils/request' //引入封装好的 axios 请求 |
store/modules/user.js
1 | Javascript复制代码import { login } from '@/api/login' |
store/index.js
1 | Javascript复制代码import Vue from 'vue' |
utils/request.js
1 | Javascript复制代码import axios from 'axios'; |
SpringBoot后端接口逻辑开发
后端的IDE用的是:Intellij IDEA 2020.2
后端项目目录:
第二个图接上面的test
前置:Java注解开发
这个问题,可以说是从大学的汇编语言,C,Java,数据结构,编译原理算法导论等等一系列软件底层技术学完之后,在开发上遇到的第一个算是挺困惑的问题,在介绍后端开发之前,我们先来介绍这个后端开发最为基本的问题。
什么是注解(annotation)
Java 注解是在 JDK5 时引入的新特性,注解(也被称为元数据)为我们在代码中添加信息提供了一种形式化的方法,使我们可以在稍后某个时刻非常方便地使用这些数据。
注解类型定义指定了一种新的类型,一种特殊的接口类型。
既然注解是一种特殊的接口,那么关键词@interface的写法也就表示注解的特殊性,来区分注解的定义和普通的接口声明。
程序可以通过反射来获取指定程序元素的注解对象,然后通过注解对象来获取注解里面的元数据。注解可以用于创建文档,跟踪代码中的依赖性,甚至执行基本编译时检查。
通俗的说,通过反射得到类里的各种注解信息,比如注解下的字段和属性方法,然后就可以根据这些信息执行特定的代码。
在框架里面使用注解的多,因为注解中的代码都已经实现过了,知道注解含义拿来用就完事了
项目携带信息的方式
- 通过注解来携带信息,然后通过反射来读取信息
- 通过文件来携带信息,然后通过IO来读取信息
元注解(meta-annotation)与自定义注解
我们还可以自定义注解,在JDK 1.5中提供了4个标准的用来对注解类型进行注解的注解类,我们称之为元注解。
我们可以使用这4个元注解来对我们自定义的注解类型进行注解,接下来,我们挨个对这4个元注解的作用进行介绍。
- @Target注解:描述注解的使用范围,说明被Target修饰的注解可以用在什么地方
- @Retention注解:描述注解保留的时间范围(被Retention描述的注解在它所修饰的类中可以被保留到何时) 。
- @Documented注解:描述在使用 javadoc 工具为类生成帮助文档时是否要保留其注解信息
- @Inherited注解:使被它修饰的注解具有继承性(如果某个类使用了被@Inherited修饰的注解,则其子类将自动具有该注解)
对于元注解的应用,在这里我们就不过多介绍,这里只是说一下元注解的定义和作用意义,想要学习元注解怎么用的可以去自行学习一下。
注解的作用
- 提供信息给编译器:编译器可以利用注解来探测错误和警告信息,@Override(编译器给你验证@Override接下来后面的方法名是否是你父类中所有的,如果没有则报错)、@Deprecated(表示接下来的方法不推荐使用,因为还有更好的方法可以调用)。
- 编译阶段时的处理: 软件工具可以用来利用注解信息来生成代码、Html 文档或者做其它相应处理,如 @Param(@Param是org.apache.ibatis.annotations.Param提供的,作为实体类entity/Dao层的注解,作用是用于传递参数,从而可以与SQL中的的字段名相对应,一般在2=<参数数<=5时使用最佳)、@Return(生成JavaDoc的说明)、@Author(文件开头注释生成作者信息)。
- 运行时的处理: 某些注解可以在程序运行的时候接受代码的提取,值得注意的是,注解不是代码本身的一部分。Spring 2.5开始注解配置,减少了配置。
注解的特殊性
通过 @interface 定义注解后,该注解也不能继承其他的注解或接口,注解是不支持继承(extends)的。
几种特殊的注解
下面介绍几种常用注解,因为4级标题没有目录,下面我都换成了3级标题,目录有了也好方便查看!
@Override
重写方法需要的注解,举个例子:
@RequestMapping
@RequestMapping其实在功能上来说,是@PostMapping和@GetMapping的组合,如果怕在映射的时候出现这种不必要的书写错误,不知道后面的方法是GET还是POST的时候,可以统一写@RequestMapping
(<=>表示等价于)
@RequestMapping(method = RequestMethod.GET) <=> @GetMapping
@RequestMapping(method = RequestMethod.POST) <=> @PostMapping
常用的@RequestMapping包含七种请求方式,他们是:
GET(请求指定页面信息),POST(向指定资源提交数据),HEAD,(前面三种是HTTP1.0就已经规定好的)PUT(客户端->服务器),DELETE(服务器删除指定页面),CONNECT(连接改为管道方式),OPTIONS(客户端查看服务器性能)
@ResponseBody和@RequestBody
- @ResponseBody
将java对象转为json格式的数据,作用在方法上
将ajax(datas)发出的请求写入 User 对象中
如果返回值是字符串,那么直接将字符串写到客户端;如果是一个对象,会将对象转化为json串,然后写到客户端。
- @RequestBody
如下面例子演示,@ResponseBody和@RequestBody配合这样就不会再被解析为跳转路径,而是直接将user对象写入 HTTP 响应正文中
例如:
1 | Java复制代码@RequestMapping(value = "user/login") |
@RestController和@Controller
@Controller 控制器(注入服务)
用于标注控制层,相当于struts中的action层
@Autowired
后面结合@Repository讲到,在这列出,但是不做赘述
@Service
@Service 服务(注入dao)
用于标注服务层,主要用来进行业务的逻辑处理
@Mapper和@Repository
- 相同点
@Mapper和@Repository都是作用在实体层(dao/entity)接口,使得其生成代理对象bean,交给spring容器管理
对于mybatis来说,都可以不用写mapper.xml文件
@Repository(实现实体层(dao/entity)访问)
用于标注数据访问层,也可以说用于标注数据访问组件,即DAO组件
- 不同点
(1)@Mapper不需要配置扫描地址,通过mapper.xml里面的namespace里面的接口地址,生成了Bean后注入到Service层中。
@Mapper不需要配置扫描地址,可以单独使用,如果有多个mapper文件的话,可以在项目启动类中加入@MapperScan(“mapper文件所在包”),这样就不需要每个mapper文件都加@Mapper注解了
(2)@Repository需要在Spring中配置扫描地址,然后生成Dao层的Bean才能被注入到Service层中。
@Repository不可以单独使用,否则会报错误找不到bean,这是因为项目启动的时候没有去扫描使用@Repository注解的文件,所以使用@Repository需要配置扫描地址;
在idea中,使用@Repository可以消除在业务层中注入mapper对象时的错误;
如果你没有在mapper接口类(class)的头上标注@Repository注解,并配置value=’地址’,那么你必须在serviceImpl的中引用接口时在头上标注@Autowired,如下图所示:
@component和@MapperScan
一旦使用关于Spring的注解出现在类里,例如我在实现类中用到了@Autowired注解,被注解的这个类是从Spring容器中取出来的,那调用的实现类也需要被Spring容器管理,加上@Component
@Component (把普通pojo实例化到spring容器中,相当于配置文件)泛指各种组件,就是说当我们的类不属于各种归类的时候(不属于@Controller、@Service等的时候),我们就可以使用@Component来标注这个类。
Q:为啥UserMapper上面不用写@Component?
mapper接口怎么被spring管理的?
- 通过 @MapperScan 扫描到对应的接口
- 对接口进行动态代理,代理类做到的事情就是拿到sql,连接数据库,执行sql
- 通过spring扩展机制FactoryBean将代理对象交给spring管理
综上所述,所以mapper使用的时候,只需要在启动类Application.class里面的主类头上标注@MapperScan,下图,注意:在引号里写包目录,要精确到mapper包(com.xxx.mapper)
项目初始化
点击左上角File->New->Project,按照箭头点击
Next之后,再按照箭头点击,注意Java Version选择8
到下图页面就是选择基本的依赖了,
我一般是选择下列这些作为基本的依赖,如果自己想要的包这些栏目里面没有的话,后期可以在pom.xml自己添加的:
- Developer Tools里面的Spring Boot DevTools
- Developer Tools里面的Lombok
- Web里面的Spring Web
- Security里面的Spring Security
- SQL里面的Spring Data JDBC
最后呢就到了工程项目路径选择啦,选一个放我们的项目文件,最好不要C盘呦,C盘满了的话就很头疼啦!之后点个Finish!
下面就正式进入后端文件的编写了
pom.xml编写
如果后端项目,你是按照我上面的步骤下来的,那么在pom.xml文件里面一定会出现下面几个依赖(dependency),他们的artifactId分别是
- spring-boot-starter-parent:这个依赖的版本,我的是2.4.1,他是 Spring Boot 的父级依赖(总依赖),这样代表当前的项目就是 Spring Boot 项目了。spring-boot-starter-parent 是一个特殊的 starter,它用来提供相关的 Maven 默认依赖。
- properties,声明我们Java JDK版本,一般是1.8
- dependencies里面,spring-boot-starter-web:项目启动的时候,使用嵌入式的tomcat作为web容器提供HTTP服务,提供注解@EnableWebMvc的@configuration配置类完全接管所有SpringMVC的相关配置,Converter和Formatter注册到IOC容器
pom.xml的目的:
POM是项目对象模型(Project Object Model)的简称,它是Maven项目中的文件,使用XML表示,名称叫做pom.xml。该文件用于管理:源代码、配置文件、开发者的信息和角色、问题追踪系统、组织信息、项目授权、项目的url、项目的依赖关系等等。事实上,在Maven世界中,project可以什么都没有,甚至没有代码,但是必须包含pom.xml文件。
pom.xml可以多写,但是一定不能少写
本项目的pom.xml如下:
1 | Java复制代码<?xml version="1.0" encoding="UTF-8"?> |
下面来解释一下pom文件
有一部分的依赖是在Spring Initializr
大标签project部分表示:本工程的依赖
在声明的时候,version标签可以不写,为什么可以不写呢?
这是parent标签里面的spring-boot-starter-parent会为我们提供常用jar包版本,其实不是不用指定,是人家为我们指定好了。自己指定版本号也可以,会覆盖官方版本,自己用maven helper查看一下有没有冲突即可。
本工程的依赖也不是特别多,列举几个重要的:
(本项目中spring-boot-devtools,lombok,spring-boot-starter-data-jdbc没有用到,我一般是都引入的)
- mybatis-plus-boot-starter
mybatis必需的包
- mybatis-plus-generator
mybatis必需的包
- spring-boot-starter-web:这个在上面我们已经解释过了。
- spring-boot-devtools:devtools可以实现页面热部署(即页面修改后会立即生效,这个可以直接在application.properties文件中配置spring.thymeleaf.cache=false来实现),实现类文件热部署(类文件修改后不会立即生效),实现对属性文件的热部署。
- lombok:根据代码生成抽象语法树AST(参见《数据结构》)
举个简单的例子:
我们建一个实体类的时候,往往要自动生成他的所有基本操作方法。一开始我们肯定是这么写
1 | Java复制代码public class Mountain{ |
现在有了lombok之后,我们加一个@data注解
1 | Java复制代码@Data |
我们会发现
贼jb方便对不对!
对于lombok中注解的使用,介绍几个常用的,如下。
@Getter/@Setter:作用在类上,生成所有成员变量的getter/setter方法
@ToString:作用于类,覆盖默认toString()方法,可以通过of属性限定显示某些字段
@EqualsAndHashCode:作用于类,覆盖默认的equals和hashCode方法
@NonNull:主要作用于成员变量和参数中,标识不能为空,否则抛出空指针异常
@Data:作用于类上,是以下注解的集合:@ToString @EqualsAndHashCode @Getter @Setter @RequiredArgsConstructor
- spring-boot-starter-data-jdbc:
Spring Data 包含对 JDBC 的存储库支持,并将自动为 CrudRepository 上的方法生成 SQL。当 classpath 上存在必要的依赖项时,Spring Boot 将自动配置 Spring Data 的 JDBC 存储库。
这个包引入之后,可以通过方法的方式来操作数据库(这里我不讲,想学的自己查资料,因为我不常用,项目里面也没有用!),当然,你也可以不用,后面有xml操作数据库的使用介绍
我个人认为,这个包存在的目的是为了给出数据源的配置语法:
在 src/main/resource 目录下添加 application.properties 配置文件,内容如下:
1 | Java复制代码spring.datasource.url = jdbc:mysql://localhost:3306/test?serverTimezone=UTC&useUnicode=true&characterEncoding=utf8&useSSL=false |
懂得都懂,这就是yml里面那一坨。
- mysql-connector-java:
JAVA通过jdbc访问mySQL数据库时需要该包支持,
首先在这里说一下这个包的版本问题,自己曾经因为mysql8和mysql5的版本问题项目出了问题没有搞定,贼烦,你在写项目之前首先要搞明白你自己的项目要用的是5还是8
(1)mysql-connector-java与Mysql对应版本:
(2)mysql-connector-java与Java对应版本:
- spring-boot-starter-test:
项目自动生成的时候,会带着一个测试类,我就没删,讲道理是可以删的
定义返回类result和API操作码
通用的返回对象,API接口的操作码,这些网上有统一的格式规范,建议同学们搞懂一个写法之后一直用就可以了。
在这里我讲一下我用的一套写法,这东西是配套的,要用就用一套,不要去东配西凑,很容易出岔子。
返回类result和API操作码,这些东西我放在了一个叫api的包下面,目录如下:
OK,现在开始放代码嗷!
- CommonResult.java(类)
1 | Java复制代码package cn.eli.vue.api; |
- IErrorCode.java(接口)
1 | Java复制代码package cn.eli.vue.api; |
- ResultCode.java(类)
1 | Java复制代码package cn.eli.vue.api; |
后端对跨域请求的解决CorsConfig
对于跨域请求的处理,我们这里在后端进行处理,代码目录如下:
跨域请求的详细原理请自行百度,在这里我只说明怎么用
文件:CorsConfig.java
代码:
1 | Java复制代码package cn.eli.vue.config; |
编写实体类entity中的user
大家都知道springboot的业务逻辑:
实体类User从controller中根据service中的逻辑在mapper接口中和数据库交互这个逻辑
我们,先写实体类Dao/entity,规定好用户实体的基本方法,随后根据登录功能开发对应的mapper接口和数据库操作即为mapper对应的xml,写好之后,再写基本的service层里面的service接口以及对service的实现(即为Impl),最后,写登录的controller,说简单也简单,说困难也困难。
User.java实体类很简单,目录逻辑如下:
User.java代码如下,里面用不着任何注解,都是基本的get和set,如果自己不想写,可以去用我上面介绍的lombok包自动实现一下。
1 | Java复制代码package cn.eli.vue.entity; |
mapper层和service层开发
mapper层和service层的目录逻辑如下:
mapper层
- UserMapper.java(用户接口)
1 | Java复制代码package cn.eli.vue.mapper; |
- UserMapper.xml(用户操作数据库的sql)
1 | Java复制代码<?xml version="1.0" encoding="UTF-8"?> |
service层
- service层的接口:UserService.java
1 | Java复制代码package cn.eli.vue.service; |
- 对service层接口的实现:UserServiceImpl.java
1 | Java复制代码package cn.eli.vue.service.impl; |
controller层业务逻辑开发
controller层目录逻辑:
LoginController.java
1 | Java复制代码package cn.eli.vue.controller; |
修改VueLoginJavaApplication
目录逻辑:
VueLoginJavaApplication.java代码:
1 | Java复制代码package cn.eli.vue; |
项目总体配置application.yml编写
项目总体配置目录逻辑:
1 | Java复制代码server: |
postman进行后端的数据POST测试
先用postman进行我们后端的测试
maven中遇到的坑,详解(欢迎向我投稿,我会在这里继续做补充)
首先说明,这是我自己在整理这个项目的时候遇到的一些小问题,很简单,大佬勿喷!
- maven中的依赖(dependency)会出现红色波浪线,怎么办?
(1) 注释掉pom.xml的所有依赖(即为dependencies标签中的所有东西)
(2) 点击Reload All Maven Projects(那个“循环”的图标)
(3) 此时你会发现依赖文件夹直接消失了,说明注释成功;
(4) 这个时候,再把注释取消掉,点击Reload All Maven Projects(那个“循环”的图标),让依赖重新导入一遍就可以了
- 用maven打包完成的target文件总是运行报错,检查语法是正确的,怎么办?
(1) 检查mapper里面的xml有没有
(2) 检查application.yml有没有
(3) 解决措施:在pom.xml里面要求打包的时候强制带上后缀为yml和xml文件(这个我上面的源代码已经带上了,大家可以自己去看)
本地JavaWeb应用拉起,项目运行(视频录制编写!!)
云服务器上线本机JavaWeb应用
基于Linux的CentOS环境配置
拉起redis,nginx,mysql
部署jar和前端页面
本文转载自: 掘金