Spring Boot + Mybatis 项目搭建和登录注册例子
开发工具：IntelliJ IDEA
数据库：MySql
目录
本篇将记录创建一个 Spring Boot + Mybatis 项目，并且编写一个注册登录的例子，毕竟Java的东西配置起来真有点麻烦
创建数据库
就随便一点吧，使用MySql，数据库就用 test ，新建一个 users 表，随便设置几个字段
注意
- 要按照命名规范，单词均小写，不同单词之间使用下划线隔开
- Mybatis 貌似不推荐使用外键，需要我们在代码中手动控制实体之间的关系
其实是我在使用 Hibernate 和 Mybatis 的时候，用了很多时间都没解决外键的问题，写配置也觉得挺麻烦的
感觉有时候不如自己封装JDBC，只能感叹 Entity Framework Core 是真的好用（貌似 Mybatis 的外键和 EF Core蛮像的），大概是我还太菜了吧，等我有时间解决外键的问题再写另一篇记录吧 T_T
IDEA 添加数据库
输入用户名和密码，填写连接字符串，然后点击 Test Connection，Schema 可以选择连接的数据库
连接字符串参考：jdbc:mysql://localhost:3306?useUnicode=true&characterEncoding=utf8&serverTimezone=GMT%2B8&useSSL=false
创建项目
注意：有可能因为网络问题创建不成功，可以使用代理网络或者手机热点试试
新建项目，选择 Spring Initializr，JDK 一般都是1.8吧，因为只是例子，所以我就随便选一个版本了
Group：一般的是域名
Artifact：项目名称
因为是例子，所以我随便起名了，然后Next
可以选择一些需要的库，也可以之后用Maven添加，这里我就选这几个，然后Next
吐槽：还是NuGet方便，其实就是我懒
到这里其实只需要改一个路径就好了，路径最后的文件夹名称一定要和项目名称一致，然后就创建了
配置Maven，这里就不详细展开讲了，Maven的配置 baidu bing之类的搜索引擎随便查都有答案
创建完项目，右键 src
修改 pom.xml 文件，因为配置过于麻烦，所以我就懒得改了，不包括数据库日志和连接池依赖库，需要什么就自己添加吧
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.4.3</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com</groupId>
<artifactId>springboot_mybatis_demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>springboot_mybatis_demo</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>11</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.1.4</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
tomcat
这次就使用一一次 Spring Boot 内置的 tomcat 吧，外置的 tomcat 在 Spring Boot + Hibernate 中用过了
Spring Boot + Hibernate 项目搭建和登录注册例子：https://www.cnblogs.com/zzy-tongzhi-cnblog/p/14402297.html
也可以自己去 baidu bing 啥的找答案
application.properties 配置文件中设置
# 配置 Web 容器的端口号（默认为 8080）
# server.port=
# 配置当前项目出错时跳转去的页面。
# server.error.path=
# 配置 session 失效时间。30m 表示 30 分钟，如果不写单位则默认单位是秒。（注意：由于 Tomcat 中配置 session 过期时间是以分钟为单位，如果我们这里设置是秒的话，那么会自动转换为一个不超过所配置秒数的最大分钟数。比如配置了 119 秒，那么实际 session 过期时间是 1 分钟）
# server.servlet.session.timeout=
# 配置项目名称（默认为 /），如果配置了项目名称，那么在访问路径中要加上配置的路径
# server.servlet.context-path=
# 配置 Tomcat 请求编码
# server.tomcat.uri-encoding=
# 配置 Tomcat 的最大线程数
# server.tomcat.max-threads=
# 配置 Tomcat 运行日志和临时文件的目录。若不配置，则默认使用系统的临时目录。
# server.tomcat.basedir=
# 配置 Servlet
#配置程序端口，默认为8080
server.port= 8080
# 配置默认访问路径，默认为/
server.servlet.context-path=/springboot_mybatis_demo
# 配置Tomcat编码,默认为UTF-8
server.tomcat.uri-encoding=UTF-8
# 配置最大线程数
server.tomcat.max-threads=1000
# 数据库
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf8&serverTimezone=GMT%2B8&useSSL=false
spring.datasource.username=root
spring.datasource.password=123456
# 视图
# 编码
spring.thymeleaf.encoding=UTF-8
# 前缀
spring.thymeleaf.prefix=classpath:/templates/Views/
# 后缀
spring.thymeleaf.suffix=.html
项目结构
- Controllers：控制器
- DAO：数据库访问
- Filters：过滤器
- Models：实体模型类
- Services：服务层
- Utils：工具类
- Mappers：映射 xml 文件
- Generator：Mybatis Generator 配置文件
- Views：视图
主页
HomeController ，因为是主页，所以我直接给方法标注 @RequestMapping("/") ，这样只需要输入项目名就可以转到主页
至于返回是 ModelAndView ，纯粹是我懒得写前端代码，其实可以返回任何你想返回的类型，靠前端去处理
@RestController
public class HomeController
{
@RequestMapping("/")
public ModelAndView Index()
{
ModelAndView mav=new ModelAndView();
mav.setViewName("Home/Index");
return mav;
}
}
Views/Home/Index.html ，这个路径要根据 application.properties 配置文件修改
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<link href="http://localhost:8080/springboot_mybatis_demo/css/MyStyleSheet.css" type="text/css" rel="stylesheet">
<title>Index</title>
</head>
<body>
<h1>
This is Home Index Page
</h1>
</body>
</html>
注意：
http://localhost:8080/springboot_mybatis_demo/是根据 application.properties 配置中的server.port和server.servlet.context-path决定- 静态文件，即 static 路径下的文件，可以直接通过
http://localhost:8080/springboot_mybatis_demo/xxx访问
然后运行项目，在浏览器中输入上面的地址就能访问
配置 Mybatis Generator 自动生成 Model 实体
pom.xml 添加依赖项和插件
<!-- mybatis-generator -->
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.3.7</version>
</dependency>
<!-- mybatis generator 自动生成代码插件 -->
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.7</version>
<configuration>
<configurationFile>src/main/resources/Generator/GeneratorConfig.xml</configurationFile>
<overwrite>true</overwrite>
<verbose>true</verbose>
</configuration>
</plugin>
resources/Generator 目录下新建 GeneratorConfig.xml 文件
这个配置文件中涉及到路径的节点都可以改
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<generatorConfiguration>
<!--mysql 连接数据库jar 这里选择自己本地位置-->
<classPathEntry location="E:\Maven\Repository\mysql\mysql-connector-java\8.0.23\mysql-connector-java-8.0.23.jar" />
<context id="default" targetRuntime="MyBatis3">
<commentGenerator>
<!-- 是否去除自动生成的注释 true：是 ： false:否 -->
<property name="suppressAllComments" value="true" />
</commentGenerator>
<!--数据库连接的信息：驱动类、连接地址、用户名、密码 -->
<jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
connectionURL="jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf8&serverTimezone=GMT%2B8&useSSL=false&nullCatalogMeansCurrent=true"
userId="root"
password="123456">
</jdbcConnection>
<!-- 默认false，把JDBC DECIMAL 和 NUMERIC 类型解析为 Integer，为 true时把JDBC DECIMAL 和
NUMERIC 类型解析为java.math.BigDecimal -->
<javaTypeResolver>
<property name="forceBigDecimals" value="false" />
</javaTypeResolver>
<!-- targetProject:生成PO类的位置 -->
<javaModelGenerator targetPackage="com.springboot_mybatis_demo.Models"
targetProject="src/main/java">
<!-- enableSubPackages:是否让schema作为包的后缀 -->
<property name="enableSubPackages" value="false" />
<!-- 从数据库返回的值被清理前后的空格 -->
<property name="trimStrings" value="true" />
</javaModelGenerator>
<!-- targetProject:mapper映射文件生成的位置
如果maven工程只是单独的一个工程，targetProject="src/main/java"
若果maven工程是分模块的工程，targetProject="所属模块的名称"，例如：
targetProject="ecps-manager-mapper"，下同-->
<sqlMapGenerator targetPackage="com.springboot_mybatis_demo.Mappers"
targetProject="src/main/java">
<!-- enableSubPackages:是否让schema作为包的后缀 -->
<property name="enableSubPackages" value="false" />
</sqlMapGenerator>
<!-- targetPackage：mapper接口生成的位置 -->
<javaClientGenerator type="XMLMAPPER"
targetPackage="com.springboot_mybatis_demo.DAO"
targetProject="src/main/java">
<!-- enableSubPackages:是否让schema作为包的后缀 -->
<property name="enableSubPackages" value="false" />
</javaClientGenerator>
<!-- 指定数据库表 -->
<table schema="" tableName="users" domainObjectName="UserEntity"></table>
</context>
</generatorConfiguration>
还有一个坑
机翻：
MySql不支持SQL目录和模式。如果在MySql中运行createschema命令，它实际上会创建一个数据库，而JDBC驱动程序会将其报告为一个目录。但是MySql语法不支持标准的catalog..table SQL语法。
因此，最好不要在生成器配置中指定目录或模式。只需在JDBC URL中指定表名和数据库。
如果您使用的是8.x版的Connector/J，您可能会注意到生成器试图为MySql信息模式（sys、information_schema、performance_schema等）中的表生成代码，这可能不是您想要的！要禁用此行为，请将属性“nullCatalogMeansCurrent=true”添加到JDBC URL。
双击插件生成实体类
实体类 UserEntity
public class UserEntity
{
private Integer id;
private String username;
private String password;
public Integer getId()
{
return id;
}
public void setId(Integer id)
{
this.id = id;
}
public String getUsername()
{
return username;
}
public void setUsername(String username)
{
this.username = username == null ? null : username.trim();
}
public String getPassword()
{
return password;
}
public void setPassword(String password)
{
this.password = password == null ? null : password.trim();
}
}
DAO 和 Mapper
其实这里的DAO和Mapper是一样的
MyBatis支持2种类型的映射器：XML映射器和接口映射器，在这里以定义并使用接口映射器为例
自动生成的 Mapper 可能不会加 @Mapper 注解，要注意
UserEntityMapper
@Mapper
public interface UserEntityMapper
{
long countByExample(UserEntityExample example);
int deleteByExample(UserEntityExample example);
int deleteByPrimaryKey(Integer id);
int insert(UserEntity record);
int insertSelective(UserEntity record);
List<UserEntity> selectByExample(UserEntityExample example);
UserEntity selectByPrimaryKey(Integer id);
int updateByExampleSelective(@Param("record") UserEntity record, @Param("example") UserEntityExample example);
int updateByExample(@Param("record") UserEntity record, @Param("example") UserEntityExample example);
int updateByPrimaryKeySelective(UserEntity record);
int updateByPrimaryKey(UserEntity record);
@Insert("insert into users(username, password) values(#{username,jdbcType=VARCHAR},#{password,jdbcType=VARCHAR})")
void Save(@Param("username") String username, @Param("password") String password);
@Select("select * from users where username=#{username}")
UserEntity GetUserByUsername(@Param("username") String username);
@Select("select * from users where username=#{username} and password=#{password}")
UserEntity GetUserByUsernameAndPassowrd(@Param("username") String username, @Param("password") String password);
}
Service
UserService ，这里的 @Autowired可能会标红，可以不管
@Service
public class UserService
{
@Autowired
private UserEntityMapper _userEntityMapper;
public UserEntity GetUserByUsername(String username)
{
return this._userEntityMapper.GetUserByUsername(username);
}
public UserEntity GetUserByUsernameAndPassword(String username, String password)
{
return this._userEntityMapper.GetUserByUsernameAndPassowrd(username, password);
}
public void Save(UserEntity userEntity)
{
this._userEntityMapper.Save(userEntity.getUsername(), userEntity.getPassword());
}
}
Controller
UserController，这里的控制器使用了两种获取值的方式分别是 th:object 和 name
@RestController
@RequestMapping("/UserController")
public class UserController
{
@Autowired
private UserService _userService;
@RequestMapping("/")
public ModelAndView Index(Model model)
{
ModelAndView mav = new ModelAndView();
mav.setViewName("User/Index");
//初始化Index页面需要的变量
model.addAttribute("userEntity", new UserEntity());
model.addAttribute("LoginMessage", "");
return mav;
}
@RequestMapping(value = "/Login/DoLogin", method = RequestMethod.POST)
public ModelAndView DoLogin(@ModelAttribute UserEntity userEntity, Model model, @RequestParam(name = "btn") String btn)
{
ModelAndView mav = new ModelAndView();
model.addAttribute("userEntity", new UserEntity());
model.addAttribute("LoginMessage", "");
//先确定点击的按钮
if (true == btn.equals("Register"))
{
mav.setViewName("User/Register");
}
else
{
String username = userEntity.getUsername();
String password = userEntity.getPassword();
if (username.equals("") || password.equals(""))
{
model.addAttribute("LoginMessage", "用户名或密码不能为空");
mav.setViewName("User/Index");
}
else
{
UserEntity user = this._userService.GetUserByUsernameAndPassword(username, password);
if (user == null)
{
model.addAttribute("LoginMessage", "用户名或密码错误");
mav.setViewName("User/Index");
}
else
{
mav.setViewName("User/Success");
}
}
}
return mav;
}
//初始化注册页面
@RequestMapping("/User/Register")
public ModelAndView Register(Model model)
{
model.addAttribute("username", "");
model.addAttribute("RegisterMessage", "");
ModelAndView mav = new ModelAndView();
mav.setViewName("User/Register");
return mav;
}
//注册操作
@RequestMapping(value = "/Register/DoRegister", method = RequestMethod.POST)
public ModelAndView DoRegister(Model model, @RequestParam(name = "username") String username, @RequestParam(name = "password") String password, @RequestParam(name = "repeatPassword") String repeatPassword)
{
ModelAndView mav = new ModelAndView();
if (username.equals("") || password.equals("") || repeatPassword.equals(""))
{
model.addAttribute("RegisterMessage", "用户名、密码或重复密码不能为空");
mav.setViewName("User/Register");
}
else
{
if (false == password.equals(repeatPassword))
{
model.addAttribute("RegisterMessage", "两次密码不一致");
model.addAttribute("username", username);
mav.setViewName("User/Register");
}
else if (null != this._userService.GetUserByUsername(username))
{
model.addAttribute("RegisterMessage", "用户已存在");
mav.setViewName("User/Register");
}
else
{
UserEntity user = new UserEntity();
user.setUsername(username);
user.setPassword(password);
this._userService.Save(user);
model.addAttribute("userEntity", new UserEntity());
model.addAttribute("LoginMessage", "");
mav.setViewName("User/Index");
}
}
return mav;
}
}
html 页面
Index.html，登录和注册使用的是不同的传值方法，登录使用的是 th:object ，注册用的是从标签的 name 属性取值， th:value 只用于显示后端传到前端的值，可以不用
<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<link href="http://localhost:8080/springboot_mybatis_demo/css/MyStyleSheet.css" type="text/css" rel="stylesheet">
<title>User Index</title>
</head>
<body>
<h1>This is User Index View</h1>
<form action="#" th:action="@{/UserController/Login/DoLogin}" th:object="${userEntity}" method="post">
<label>用户名：
<input type="text" th:field="*{username}"/>
</label>
<br>
<label>密码：
<input type="password" th:field="*{password}"/>
</label>
<br>
<label style="color: red" th:text="${LoginMessage}" th:if="${not #strings.isEmpty(LoginMessage)}">
</label>
<br>
<label>
<button type="submit" name="btn" value="Login">登录</button>
</label>
<button type="submit" name="btn" value="Register">注册</button>
</form>
</body>
</html>
Success.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<link href="http://localhost:8080/springboot_mybatis_demo/css/MyStyleSheet.css" type="text/css" rel="stylesheet">
<title>Success Page</title>
</head>
<body>
<h1>Login Success</h1>
</body>
</html>
Register.html
<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<link href="http://localhost:8080/springboot_mybatis_demo/css/MyStyleSheet.css" type="text/css" rel="stylesheet">
<title>Register Page</title>
</head>
<body>
<h1>This is Register Page</h1>
<form action="#" th:action="@{/UserController/Register/DoRegister}" method="post">
<label>用户名：
<input type="text" name="username" th:value="${username}"/>
</label>
<br>
<label>密码：
<input type="password" name="password" />
</label>
<br>
<label>重复密码：
<input type="password" name="repeatPassword"/>
</label>
<br>
<label style="color: red" th:text="${RegisterMessage}" th:if="${not #strings.isEmpty(RegisterMessage)}">
</label>
<br>
<label>
<input type="submit" value="注册"/>
</label>
</form>
</body>
</html>
完整项目结构
完整 pom.xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.4.3</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com</groupId>
<artifactId>springboot_mybatis_demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>springboot_mybatis_demo</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>11</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.1.4</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<!-- mybatis-generator -->
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.3.7</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
<!-- mybatis generator 自动生成代码插件 -->
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.7</version>
<configuration>
<configurationFile>src/main/resources/Generator/GeneratorConfig.xml</configurationFile>
<overwrite>true</overwrite>
<verbose>true</verbose>
</configuration>
</plugin>
</plugins>
</build>
</project>
因为控制器的返回值是视图，所以要这样访问，根据控制器的标注修改 url ，如果只是 html + js 的话，可以直接 Views/ 访问视图
