Web开发|第七堂课—— 基于sprintboot和mybatis实现前后端分离用户注册登陆|接口文档模板|优雅的定义全局错误码

最新推荐文章于 2024-06-24 15:42:47 发布
最新推荐文章于 2024-06-24 15:42:47 发布
阅读量294 收藏
点赞数
分类专栏： web服务端开发|学习笔记
caesarding07@gmail.com
本文链接：https://blog.csdn.net/qq_44628595/article/details/109643406
版权

基于sprintboot和mybatis实现前后端分离的用户注册登陆

实验

准备

实验目的

实现以下功能：

  • 用户注册登陆
  • （绑定）邮箱添加
  • 邮箱模糊查询
  • 邮箱信息修改
  • 邮箱注销
  • 单元测试

实验环境

  • 后端：spring boot、mybatis、mysql
  • 前端：html、css、js、jquery、ajax
  • 工具：vscode（前端）、idea（后端）

接口文档

序言

这是一个用于学习的示例文档
hello world

全局错误码

状态码设计参考

错误码错误解释
1001接口认证失败
1002授权过期
1003缺失参数
修改记录
  • 2020年11月
日期修改人涉及接口修改内容
11月13日caesar所有初始化接口内容
11月13日caesar邮箱相关-邮箱注册修改url地址
11月15日Caesar所有使用swagger托管接口文档，故不再更新当前接口文档

>>配置和使用swagger<<

接口
用户相关
用户注册
  • 简要描述
    用户注册接口
  • 请求URL
    http://localhost:8080/api/user/register
  • 请求方式
    POST
  • 参数
参数名 必选 类型说明
username是 string用户名
password 是 string 密码
mobile 是 string 手机号
  • 返回示例
{	
	#######示例#######
	# 返回状态码 JSON
	"error_code":0,
	# 返回信息描述
	"message":string,
	# 返回值
	"data":{
		"uid":"1",
		"name":"caesar",
		"mobile":"123456",
}
  • 返回参数说明
  • 备注
    更多返回错误代码请看首页的错误代码
用户登陆
  • 简要描述
    用户登陆接口
  • 请求URL
    http://localhost:8080/api/user/login
  • 请求方式
    POST
  • 参数
参数名 必选 类型说明
username是 string用户名
password 是 string 密码
  • 返回示例
{
	“error_code”:0,
	“data”:{
		“uid”:”1”,
		”name”:”caesar”,
		”mobile”:”123456”,
}
  • 返回参数说明
  • 备注
    更多返回错误代码请看首页的错误代码
邮箱相关
邮箱添加
  • 简要描述
    用户绑定邮箱
  • 请求URL
    http://localhost:8080/api/mail/insert
  • 请求方式
    POST
  • 参数
参数名 必选 类型说明
id是 string用户名
password 是 string 密码
mobile 是 string 手机号
  • 返回示例
{
	“error_code”:0,
	“data”:{
		“uid”:”1”,
		”name”:”caesar”,
		”email”:”123456”,
}
  • 返回参数说明
  • 备注
    更多返回错误代码请看首页的错误代码
邮箱注销
  • 简要描述
    注销邮箱，修改is_used=0
  • 请求URL
    http://localhost:8080/api/email/cancel
  • 请求方式
    POST
  • 参数
参数名 必选 类型说明
uid 是 string 用户id
  • 返回示例
{
	“error_code”:0,
	“data”:{
		“uid”:”1”,
		}
}
  • 返回参数说明
  • 备注
    更多返回错误代码请看首页的错误代码
邮箱列表
  • 简要描述
    展示邮箱列表
  • 请求URL
    http://localhost:8080/api/email/list
  • 请求方式
    POST
  • 参数
参数名 必选 类型说明
  • 返回示例
{
	“error_code”:0,
	“data”:{
		“uid”:”1”,
		”name”:”caesar”,
		”mobile”:”123456”,
}
  • 返回参数说明
  • 备注
    更多返回错误代码请看首页的错误代码
邮箱模糊查询
  • 简要描述
    邮箱模糊查询
  • 请求URL
    http://localhost:8080/api/email/select
  • 请求方式
    POST
  • 参数
参数名 必选 类型说明
username 必选 类型说明
mobile 必选 类型说明
  • 返回示例
{
	“error_code”:0,
	“data”:{
		“uid”:”1”,
		”name”:”caesar”,
		”mobile”:”123456”,
}
  • 返回参数说明
  • 备注
    更多返回错误代码请看首页的错误代码
邮箱信息修改
  • 简要描述
    修改邮箱信息
  • 请求URL
    http://localhost:8080/api/email/update
  • 请求方式
    POST
  • 参数
参数名 必选 类型说明
uid是 stringid
new_email 是 string 新的邮箱
  • 返回示例
{
	“error_code”:0,
	“data”:{
		“uid”:”1”,
}
  • 返回参数说明
  • 备注
    更多返回错误代码请看首页的错误代码
数据字典
  1. mybatis_db.users
  • 用户表，保存用户数据
字段类型空默认注释
字段类型空默认注释
字段类型空默认注释
字段类型空默认注释
字段类型空默认注释
字段类型空默认注释
  • 备注：无
  1. mybatis_db.mails
  • 用户邮箱
字段类型长度默认注释
字段类型空默认注释
字段类型空默认注释
字段类型空默认注释
字段类型空默认注释
字段类型空默认注释
- 备注

版本控制

github仓库
项目包括前端以及后端源码

实验

问题

解决前后端分离导致的跨域问题

知识

resultMap多表查询

resultType 和 resultMap的区别

小技巧

@getter、@setter注解可以取代多个domain类里面的getter、setter方法

操作步骤

  1. 定义mailMapper.xml
  2. 添加接口定义
  3. 接口调用

总结：resultMap——collection映射的一个集合列表，处理的是一对多的关联关系

Mybatis缓存

一级缓存：作用于SqlSession
二级缓存：默认是关闭的
查询的顺序：二级缓存->一级缓存->数据库

状态码设计参考    继续阅读

部分HTTP请求返回状态码参考
200 - 请求成功
301 - 资源（网页等）被永久转移到其他URL
404 - 请求的资源（网页等）不存在
500 - 内部服务器错误

分类区间分类描述
1**100~199信息，服务器收到请求，需要请求者继续执行操作
2**200~299成功，操作被成功接受并处理
3**300~399重定向，需要进一步的操作以完成请求
4**400~499客户端错误，请求包含语法错误或无法完成请求
5**500~599服务器错误，服务器在处理请求过程中发生了错误
# 如果区间不够，可以设计成下面的四位数
# 1000~1999 区间表示参数错误
# 2000~2999 区间表示用户错误
# 3000~3999 区间表示接口异常

<<配置和使用swagger>>

  1. 配置pom.xml文件
        <!-- swagger核心组件，在代码配置swagger时会依赖到它 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <!-- swagger的用户界面，用于展示api接口文档 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>
  1. 添加配置文件（多种方式，这里只介绍一种）
package com.example.web_class.config;

import com.google.common.base.Predicate;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import static com.google.common.base.Predicates.not;
import static com.google.common.base.Predicates.or;
import static springfox.documentation.builders.RequestHandlerSelectors.withMethodAnnotation;

/**
*@ClassName: SpringfoxSwagger2Config
*@Description swagger配置文件
*@Author CaesarDing
*@Date 2020/11/15
*@Time 14:41
*/
@Configuration
@EnableSwagger2
//包扫描，在此包下的Controller都会被纳入swagger接口文档生成的范围，这里也可以配置类扫描，同时也可以在这个配置类里面细化过滤规则
@ComponentScan(basePackages = "com.example.web_class.controller")
public class SpringfoxSwagger2Config {
    //组织Docket对象，翻译过来就是摘要的意思，它是生成API文档的核心对象，里面配置一些必要的信息
    @Bean
    public Docket swaggerSpringMvcPlugin(){
        //指定规范，这里是SWAGGER_2
        return new Docket(DocumentationType.SWAGGER_2)
                //设定Api文档头信息，这个信息会展示在文档UI的头部位置
                .apiInfo(swaggerDemoApiInfo())
                .select()
                //添加过滤条件，谓词过滤predicate，这里是自定义注解进行过滤
                //.apis(not(withMethodAnnotation(SwaggerCustomIgnore.class)))
                //这里配合@ComponentScan一起使用，又再次细化了匹配规则(当然，我们也可以只选择@ComponentScan、paths()方法当中的一中)
//                .paths(allowPaths())
                .build();
    }
    /**
    *@Author CaesarDing
    *@Description 自定义API文档基本信息实体
    *@Date 2020/11/15
    *@Time 14:52
    *@Param []
    *@Return com.google.common.base.Predicate<java.lang.String>
    *@MethodName: allowPaths
    */
    private ApiInfo swaggerDemoApiInfo() {
        //构建联系实体，在UI界面会显示
        Contact contact = new Contact("web_class", "http://caesarding.space", "caesarding07@gmail.com");
        return new ApiInfoBuilder()
                //联系人信息
                .contact(contact)
                //文档标题
                .title("WebClass")
                //文档描述
                .description("WebClass API document 2020.11")
                //文档版本
                .version("1.0.0")
                .build();
    }
    /**
    *@Author CaesarDing
    *@Description PATH匹配规则
    *@Date 2020/11/15
    *@Time 14:55
    *@Param []
    *@Return com.google.common.base.Predicate<java.lang.String>
    *@MethodName: allowPaths
    */
    private Predicate<String> allowPaths() {
        return or(
                PathSelectors.regex("/api/user/*")
        );
    }
}
  1. 更多
caesarding
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
springboot+mybatis+vue前后端分离实现用户登陆注册功能
a13535154153的博客
05-18 7743
springboot+mybatis+vue前后端分离实现用户登陆注册功能效果图：环境介绍核心代码介绍 效果图： 登陆页 注册页 登陆成功页： 环境介绍 jdk：1.8以及上 前端：vue 后端：springboot+mybatis 数据库：mysql5.6 如果你在运行这个代码的过程中有遇到问题，请加小编vi信xxf960513，我拉你进对应学习群！！帮助你快速掌握这个功能代码！ 核心代码介绍 登陆注册核心代码 package com.example.demo.controller; import
springboot+mybatis简易登录功能实现
Rmx的技术小站
02-05 1188
1.准备工作 项目生成网站： https://start.spring.io 然后软件导入即可 如果是用idea,只需要搭配maven创建Spring Initializr项目即可。 网上有教程，不多做介绍 2.项目文件预览 登录功能只需要用到controller,dao和entity 3.功能实现 Mysql建数据库建表 entity包创建User.java 写好setter/getter ...
[超详细]SpringBoot+MyBatisPlus+Vue 前后端分离项目实现登录注册-前端篇
zqc的博客
05-27 3338
SpringBoot+MyBatisPlus+Vue 前后端分离项目实现登录注册-前端篇 1.使用WebStorm创建一个空项目2.安装插件3.router 路由映射4.登录注册界面5.修改App.vue6.修改main.js 后端搭建博客路径：后端搭建博客 1.使用WebStorm创建一个空项目 创建一个名为vuedemo的空项目 2.创建Vue项目 然后选择Default < [ Vue 2] babel, eslint > 2.安装插件 安装element-ui npm i ele
快速上手 Spring Boot：基础使用详解
最新发布
小林的博客
06-24 2244
Spring Boot 是一个基于 Spring 的框架，旨在简化 Spring 应用的配置和开发过程，通过自动配置和约定大于配置的原则，使开发者能够快速搭建独立、生产级别的应用程序。Spring程序缺点配置繁琐依赖设置繁琐SpringBoot程序优点自动配置起步依赖（简化依赖配置）版本锁定内置tomcat服务器辅助功能（内置服务器，……）
SpringBoot+MyBatis+VUE前后端分离
hypertext123的博客
08-02 3865
文章目录需求分析1、创建表2、创建SpringBoot项目2.1 选择项目类型2.2 设置组名包名等（根据个人需求更改）2.3 选择依赖2.3.1 选择Web依赖2.3.2 选择MySQL和MyBatis依赖2.4 设置项目名和模板名（根据个人需求进行更改）3、在resources下新建配置文件application.yml3.1 在application.yml文件中设置mapper.xml文件所在位置3.2 第二种方法4、分页插件的配置以及文件映射的配置4.1 分页插件（使用pagehelper-spr
快速上手之SpringBoot+Mybatis实现简单登录功能
smietao的博客
05-26 4539
使用SpringBoot&Mybatis&通用Mapper快速实现一个简单的Web登录功能。
java毕业设计 基于SpringBoot+Mybatis的前后端分离图书管理系统的设计与实现+详细文档+全部资料（优秀项目）
04-17
java毕业设计 基于SpringBoot+Mybatis的前后端分离图书管理系统的设计与实现+详细文档+全部资料（优秀项目）.zipjava毕业设计 基于SpringBoot+Mybatis的前后端分离图书管理系统的设计与实现+详细文档+全部资料（优秀...
基于SpringBoot+MyBatis前后端开发的博客网站项目源码.zip
01-06
1、基于SpringBoot+MyBatis前后端开发的博客网站项目源码.zip 2、该资源包括项目的全部源码，下载可以直接使用！ 3、本项目适合作为计算机、数学、电子信息等专业的课程设计、期末大作业和毕设项目，作为参考资料...
毕设项目：基于SpringBoot+MyBatis-Plus 前后端分离的影院选座购票系统.zip
06-28
本资源中的源码都是经过本地编译过可运行的，下载后按照文档配置好环境就可以运行。资源项目的难度比较适中，内容都是经过助教老师审定过的，应该能够满足学习、使用需求，如果有需要的话可以放心下载使用。有任何...
基于SpringBoot+Mybatis+Redis开发的一款前后端分离的个人博客源码.zip
08-10
基于SpringBoot+Mybatis+Redis开发的一款前后端分离的个人博客源码.zip 该项目是基于SpringBoot+Mybatis+Redis技术开发的一款前后端分离的个人博客项目，是刚入门SpringBoot学习开发的一个小项目。目前能够实现文章...
基于springboot + mybatis + mySQL 前后端分离番茄书城项目源码.zip
05-26
《基于SpringBoot+MyBatis+MySQL的前后端分离番茄书城项目源码解析》 在现代Web开发中，SpringBoot、MyBatis和MySQL是常见的技术栈，它们结合使用可以构建高效、稳定的Web应用程序。本项目“番茄书城”正是这样的一...
【小程序开发】开发一个短信登录验证（后端采用springboot）
qq_44654974的博客
03-26 809
一、前言 前两天发布了一篇关于大创项目的一个小程序开发（vant组件引入），然后有一位粉丝（仅有的）询问能帮忙开发一个小程序吗？于是我又开始了小程序的学习（记得上次还是半年前了）。这次来一起使用小程序实现一个短信登录验证。希望大家多多支持，不足之处望见谅。 参考：微信公众号开发文档、vant组件库 二、开发步骤 设计页面 采用vant组件库进行组件的搭配。由于前端写的比较少，所以页面有点不怎么好看。如下图左侧部分： 部分代码： <!--pages/login.wxml--> <
Mybatis注册
q19973643718的博客
10-06 283
1.注册分析 1.编写测试方法 com\xjj\service\TestUserService.java @Test public void register(){ UserService userService=new UserService(); User user =new User(); user.setUid(8); user.setUsername("xjj03"); user.setPassword("1
前后端分离项目初始化和MyBatisPlus的使用
快乐星球的博客
03-28 1128
1、创建新项目 2、添加依赖项，引用MybatisPlus <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.5.1</version> </dependency> 3、配置
springBoot+mybatis-plus+MySQL实现前后端登录注册案例（跟着做完直接成为老师眼中的好学生^_^）
weixin_61561974的博客
06-24 1842
springBoot+mybatis-plus+MySQL+VueCli实现前后端登录注册（跟着做完直接成为老师眼中的好学生^_^） : 1.注册流程 前端注册时不携带token，后端springboot接收数据对用户名进行加jwt加密返回token操作，密码则进行加密操作存储到数据库（使用BCrypt.hashpw进行加密）， 2.登录流程 前端登录发送用户名,密码等数据到后端，使用mp查询数据库中加密的密码和用户名，判断用户名是否一致，后端接收数据然后把前端发来的密码和数据库........
springboot-vue
hzk_niubi1313的博客
08-09 374
每次请求都得要人为添加参数token. 我们可以使用axios得请求拦截器。当使用异步请求从一个网址访问另一个网址时可能会出现跨域问题。allowedHeaders:允许哪些请求头信息跨域。origins: 允许哪些域可以跨域访问我这个接口。methods: 允许哪些请求方式跨域。前端调用后端登录接口时出现如下的错误。后面每次请求都可以携带该token,后面每次请求都可以携带该token。（2）添加配置类，全局配置。增加redis的序列化配置。加入swagger配置类。加入swagger依赖。.......
快速通过Spring Boot和mybatis制作登陆Demo（内附源码）
qq_40128367的博客
10-07 832
国庆小长假用 Spring Boot 和 mybatis 写了一个带有登陆功能的后台文章管理微服务，感觉非常的快捷和愉快，在这里总结一下登录部分的做法和实现思路，希望大家多提宝贵意见。 在这里先分享我之前的一篇一篇博客：一个基于Spring Boot的API、RESTful API项目种子（骨架）。可以快速通过数据库表生成实体、Dao、service、controller的Spring Boo...
前后端分离开发——登录页面（后端部分）
weixin_52880572的博客
11-30 3186
前后端分离开发——登录页面制作（后端部分）
什么是springboot
qq_46136801的博客
01-05 3226
Spring Boot是由Pivotal团队提供的全新框架，其设计目的是用来简化Spring应用的创建、运行、调试、部署等。使用Spring Boot可以做到专注于Spring应用的开发，而无需过多关注XML的配置。Spring Boot使用“习惯优于配置”的理念，简单来说，它提供了一堆依赖打包，并已经按照使用习惯解决了依赖问题。使用Spring Boot可以不用或者只需要很少的Spring配置就...
springboot+mybatis实现登录注册前后端交互
05-23
要实现登录注册前后端交互，可以按照以下步骤进行： 1. 创建一个SpringBoot项目，可以使用Spring Initializr来快速创建。 2. 添加MyBatis依赖，可以在pom.xml文件中添加以下依赖： ``` <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>2.2.0</version> </dependency> ``` 3. 创建数据库表，用于存储用户信息，例如用户ID、用户名、密码等。 4. 创建实体类，用于映射数据库表的字段。 5. 创建Mapper接口，用于定义SQL语句，可以使用注解方式或XML方式。 6. 创建Service层，用于调用Mapper接口，并对返回结果进行处理。 7. 创建Controller层，用于处理前后端交互，接收前端请求参数，并调用Service层进行处理，并返回相应结果给前端。 下面是一个简单的登录注册示例（以注解方式使用MyBatis）： User.java ``` public class User { private int id; private String username; private String password; // ... // getters and setters } ``` UserMapper.java ``` @Mapper public interface UserMapper { @Select("SELECT * FROM user WHERE username = #{username} AND password = #{password}") User selectUserByUsernameAndPassword(@Param("username") String username, @Param("password") String password); @Insert("INSERT INTO user (username, password) VALUES (#{username}, #{password})") int insertUser(User user); } ``` UserService.java ``` @Service public class UserService { @Autowired private UserMapper userMapper; public User login(String username, String password) { return userMapper.selectUserByUsernameAndPassword(username, password); } public int register(User user) { return userMapper.insertUser(user); } } ``` UserController.java ``` @RestController public class UserController { @Autowired private UserService userService; @PostMapping("/login") public Result login(@RequestParam("username") String username, @RequestParam("password") String password) { User user = userService.login(username, password); if (user != null) { return Result.success("登录成功", user); } else { return Result.fail("用户名或密码错误"); } } @PostMapping("/register") public Result register(@RequestBody User user) { int result = userService.register(user); if (result > 0) { return Result.success("注册成功", user); } else { return Result.fail("注册失败"); } } } ``` 在上述示例中，我们定义了一个UserController类，用于处理前后端交互。其中，@RestController注解用于标记该类为RESTful服务，@PostMapping注解用于标记该方法接收POST请求，@RequestParam注解用于接收请求参数，@RequestBody注解用于接收请求体中的参数。 最后，我们需要定义一个Result类，用于封装返回结果： ``` public class Result { private int code; private String message; private Object data; // ... // getters and setters } ``` 通过封装Result类，我们可以统一返回结果的格式和内容，方便前端进行处理。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

caesarding

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值