1. 引言
MyBatis是一个强大且稳定的持久层解决方案,也是众多java程序员入门的首选,而MyBatis-Plus是MyBatis 的增强工具,在MyBatis的基础上只做增强不做改变,为简化开发、提高效率而生。
有人会将MyBatis和Hibernate放在一起比较,其实明显感觉MyBatis-Plus正在向全自动的ORM框架进发,有可能这才是主流的方向。
- 请事先准备一个可以访问的MySQL数据库,记录下访问连接,用户名,密码。
2. 创建项目
创建一个名为mybatis-plus-demo的项目,使用Maven+JDK17。不会的请看 IntelliJ IDEA快速创建Spring Boot项目,最终项目结构,如下图。
3. 编写代码
根据最终项目结构,从下往上依次列出各个文件的代码。
3.1 pom.xml
这里用的springboot3.x的版本,对应的MySQL驱动需要mysql-connector-j。修改完成后,更新maven,等待资源下载完成。
<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.example</groupId>
<artifactId>mybatis-plus-demo</artifactId>
<version>1.0-SNAPSHOT</version>
<properties>
<maven.compiler.source>17</maven.compiler.source>
<maven.compiler.target>17</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<!-- 为Spring Boot项目提供一系列默认的配置和依赖管理-->
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>3.3.2</version>
<relativePath/>
</parent>
<dependencies>
<!-- Spring Boot核心依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<!-- Spring Boot单元测试和集成测试的依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<!-- Spring Boot构建Web应用程序的依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- mysql驱动-->
<dependency>
<groupId>com.mysql</groupId>
<artifactId>mysql-connector-j</artifactId>
</dependency>
<!-- mybatis-plus核心依赖-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-spring-boot3-starter</artifactId>
<version>3.5.7</version>
</dependency>
</dependencies>
</project>
3.2 application.properties
需要配置好自己的数据库连接,用户名,密码。
#数据库连接
spring.datasource.url=jdbc:mysql://localhost:3306/test1
#数据库用户名
spring.datasource.username=您的数据库用户名
#数据库密码
spring.datasource.password=您的数据库密码
#显示sql
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
3.3 mapper/UserMapper.xml
注意namespace的值对应org/example/mapper/UserMapper.java,这个是一一对应的,不要写错了。
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="org.example.mapper.UserMapper">
<select id="selectAllPage" parameterType="java.util.Map" resultType="java.util.Map">
select * from t_user_test
<where>
<if test="param.name != null and param.name != ''">
INSTR(CONCAT(IFNULL(name,'')),#{param.name})>0
</if>
</where>
</select>
</mapper>
3.4 org/example/Main.java
这个是启动类,注意@MapperScan的值对应org/example/mapper,这个是一一对应的,不要写错了。
package org.example;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.transaction.annotation.EnableTransactionManagement;
@EnableTransactionManagement // 启用事务管理
@MapperScan("org.example.mapper") // 扫描mapper
@SpringBootApplication
public class Main {
public static void main(String[] args) {
SpringApplication.run(Main.class, args);
}
}
3.5 org/example/mapper/UserMapper.java
注意selectAllPage方法和UserMapper.xml中的节点需要一一对应。
package org.example.mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import org.apache.ibatis.annotations.MapKey;
import org.apache.ibatis.annotations.Param;
import org.example.entity.User;
import java.util.List;
import java.util.Map;
public interface UserMapper extends BaseMapper<User> {
@MapKey("")
List<Map<String, Object>> selectAllPage(Page<?> page, @Param("param") Map<String, Object> param);
}
3.6 org/example/entity/User.java
这个就是实体类,与数据库中的表对应。
package org.example.entity;
import com.baomidou.mybatisplus.annotation.*;
import java.util.Date;
@TableName("t_user_test")
public class User {
@TableId(type = IdType.ASSIGN_ID)
private Long id;
private String name;
private String phone;
@TableField(fill = FieldFill.INSERT)
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;
public Long getId() {
return id;
}
public void setId(Long id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getPhone() {
return phone;
}
public void setPhone(String phone) {
this.phone = phone;
}
public Date getCreateTime() {
return createTime;
}
public void setCreateTime(Date createTime) {
this.createTime = createTime;
}
public Date getUpdateTime() {
return updateTime;
}
public void setUpdateTime(Date updateTime) {
this.updateTime = updateTime;
}
}
3.7 org/example/controller/UserController.java
UserController类用于测试,正常情况下还需要创建service层,在service层操作数据库,但是这里为了方便测试,就直接在controller层操作数据库。
注意@Transactional是事务注解,增、删、改数据时,需要加上这个注解才能使用事务功能。
package org.example.controller;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import org.example.entity.User;
import org.example.mapper.UserMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.transaction.annotation.Transactional;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
@Controller
@RequestMapping("/UserController")
public class UserController {
@Autowired
private UserMapper userMapper;
@RequestMapping(value = "/insert")
@ResponseBody
@Transactional
public Object insert() {
for (int i = 0; i < 20; i++) {
User user = new User();
user.setName("张"+i);
user.setPhone(new Date().getTime()+"");
userMapper.insert(user);
}
return "数据插入成功";
}
@RequestMapping(value = "/listAll")
@ResponseBody
public Object listAll() {
QueryWrapper<User> q = new QueryWrapper<>();
q.like("name", "张1");
List<User> list = userMapper.selectList(q);
return list;
}
@RequestMapping(value = "/listPage")
@ResponseBody
public Object list() {
Page<?> page = new Page<>(1, 3);
Map<String, Object> param = new HashMap<>();
param.put("name", "张");
List<Map<String, Object>> list = userMapper.selectAllPage(page, param);
return list;
}
}
3.8 org/example/conf/MyMetaObjectHandler.java
package org.example.conf;
import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;
import java.util.Date;
/*
MyBatis-Plus 提供了一个便捷的自动填充功能,用于在插入或更新数据时自动填充某些字段,如创建时间、更新时间等
*/
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
@Override
public void insertFill(MetaObject metaObject) {
this.setFieldValByName("createTime", new Date(), metaObject);
this.setFieldValByName("updateTime", new Date(), metaObject);
}
@Override
public void updateFill(MetaObject metaObject) {
this.setFieldValByName("updateTime", new Date(), metaObject);
}
}
3.9 org/example/conf/MybatisPlusConfig.java
package org.example.conf;
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/*
MyBatis-Plus 配置
*/
@Configuration
public class MybatisPlusConfig {
/**
* 添加分页插件
*/
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
return interceptor;
}
}
4,运行代码
4.1 创建数据库和表
首先使用您的数据库工具,在MySQL中创建一个数据库test1,与application.properties中的配置的数据库相对应。然后再创建表t_user_test,表名与User.java中@TableName的值对应。字段名与User.java的属性相对应,这里的字段名默认将驼峰命名转下划线命名。
CREATE TABLE t_user_test (
id bigint(20) NOT NULL,
name varchar(255) DEFAULT NULL,
phone varchar(255) DEFAULT NULL,
create_time datetime DEFAULT NULL,
update_time datetime DEFAULT NULL,
PRIMARY KEY (`id`)
);
4.2 启动项目
在Main上右键Run,启动项目,可以看到端口是8080。
4.3 新增数据
4.4 查询数据
打开浏览器访问http://localhost:8080/UserController/listAll,可以看到页面上返回了所有包含“张1”的数据,刚好和UserController类中的代码功能一致。
4.5 整合成功
打开数据库工具,查看t_user_test表中的数据,和刚才新增的数据一致。自此Spring Boot和MyBatis-Plus简单整合完成。
版权归原作者 D_J_Dragon 所有, 如有侵权,请联系我们删除。