经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置：技术经验 » Java相关 » Java » 查看文章
使用 Mybatis-plus 进行 crud 操作
来源：cnblogs　　作者：Carlos_Ouyang　　时间：2019/8/16 9:44:19　　对本文有异议

1 Mybatis-Plus简介

1.1 什么是Mybatis-Plus

MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

1.2 为什么要学习Mybatis-Plus

我们已经学习过Mybatis这个框架，我们只需要在dao层定义抽象接口，基于Mybatis零实现的特性，就可以实现对数据库的crud操作。在业务类型比较多的时候，我们需要重复的定义一堆功能类似的接口方法。

使用Mybatis-plus工具，我们只需要将我们定义的抽象接口，继承一个公用的 BaseMapper<T> 接口，就可以获得一组通用的crud方法，来操作数据库。使用Mybatis-plus时，甚至都不需要任何的xml映射文件或者接口方法注解，真正的dao层零实现。

2 入门示例

2.1 需求

使用Mybatis-Plus实现对用户的crud操作。

2.2 配置步骤说明

  1. 搭建环境（创建项目、导入包）
  2. 配置Mybaits-Plus（基于Spring实现）
  3. 编写测试代码

2.3 配置步骤

2.3.1 第一步：搭建环境

2.3.1.1 数据库准备

  1. CREATE TABLE `tb_user` (
  2.   `id` bigint(20) NOT NULL COMMENT '主键ID',
  3.   `name` varchar(30) DEFAULT NULL COMMENT '姓名',
  4.   `age` int(11) DEFAULT NULL COMMENT '年龄',
  5.   `email` varchar(50) DEFAULT NULL COMMENT '邮箱',
  6.   PRIMARY KEY (`id`)
  7. )

2.3.1.2 说明

  1. Mybatis-Plus并没有提供单独的jar包，而是通过Maven（或者gradle）来管理jar依赖。
  2. Mybatis-Plus是基于Spring框架实现的，因此使用Mybatis-Plus，必须导入Spring相关依赖。

2.3.1.3 添加依赖

编写 pom 配置文件

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <modelVersion>4.0.0</modelVersion>
  7.     <groupId>org.oza.mybatisplus</groupId>
  8.     <artifactId>mybatisplus-demo-start</artifactId>
  9.     <version>1.0-SNAPSHOT</version>
  11.     <dependencies>
  12.         <!--mybatis-plus-->
  13.         <dependency>
  14.             <groupId>com.baomidou</groupId>
  15.             <artifactId>mybatis-plus</artifactId>
  16.             <version>3.1.2</version>
  17.         </dependency>
  18.         <!--spring 基础依赖-->
  19.         <dependency>
  20.             <groupId>org.springframework</groupId>
  21.             <artifactId>spring-context</artifactId>
  22.             <version>4.3.2.RELEASE</version>
  23.         </dependency>
  24.         <!--spring jdbc 依赖-->
  25.         <dependency>
  26.             <groupId>org.springframework</groupId>
  27.             <artifactId>spring-jdbc</artifactId>
  28.             <version>4.3.2.RELEASE</version>
  29.         </dependency>
  30.         <!--spring test-->
  31.         <dependency>
  32.             <groupId>org.springframework</groupId>
  33.             <artifactId>spring-test</artifactId>
  34.             <version>4.3.2.RELEASE</version>
  35.         </dependency>
  36.         <!--mysql 驱动-->
  37.         <dependency>
  38.             <groupId>mysql</groupId>
  39.             <artifactId>mysql-connector-java</artifactId>
  40.             <version>8.0.16</version>
  41.         </dependency>
  42.         <!--连接池-->
  43.         <dependency>
  44.             <groupId>com.alibaba</groupId>
  45.             <artifactId>druid</artifactId>
  46.             <version>1.1.9</version>
  47.         </dependency>
  48.         <!--junit-->
  49.         <dependency>
  50.             <groupId>junit</groupId>
  51.             <artifactId>junit</artifactId>
  52.             <version>4.12</version>
  53.         </dependency>
  54.     </dependencies>
  55. </project>

2.3.2 第二步：创建User实体类

使用Mybatis-Plus可以不使用xml文件，而是基于一组注解来解决实体类和数据库表的映射问题。以下注解作用于实体类的字段声明上：

注解 含义
@TableName(value="tb_user") 指定对应的表，表名和类名一致时，可以省略value属性。
@TableId 指定表的主键。Value属性指定表的主键字段，和属性名一致时，可以省略。Type指定主键的增长策略。
@TableField 指定类的属性映射的表字段，名称一致时可以省略该注解。

源码如下：

  1. package org.oza.mybatisplus.pojo;
  3. import com.baomidou.mybatisplus.annotation.IdType;
  4. import com.baomidou.mybatisplus.annotation.TableField;
  5. import com.baomidou.mybatisplus.annotation.TableId;
  6. import com.baomidou.mybatisplus.annotation.TableName;
  8. @TableName("tb_user")
  9. public class User {
  11.     @TableId(value = "u_id", type = IdType.AUTO)
  12.     private Long id;
  13.     @TableField("u_name")
  14.     private String name;
  15.     @TableField("u_age")
  16.     private Integer age;
  17.     @TableField("u_email")
  18.     private String email;
  19. }

2.3.3 第三步：创建UserMapper接口

只需要继承BaseMapper公共接口即可。

  1. package org.oza.mybatisplus.mapper;
  3. import com.baomidou.mybatisplus.core.mapper.BaseMapper;
  4. import org.apache.ibatis.annotations.Result;
  5. import org.apache.ibatis.annotations.Results;
  6. import org.apache.ibatis.annotations.Select;
  7. import org.oza.mybatisplus.pojo.User;
  9. import java.util.List;
  12. public interface UserMapper extends BaseMapper<User> {
  13.     /**
  14.      * 自定义方法，展示所有用户的用户名
  15.      * @return 用户名集合
  16.      */
  17.     @Select("select u_name from tb_user")
  18.     List<String> listAllUsername();
  20.     /**
  21.      * 自定义方法，搜索所有用户的邮箱，并封装进 user 对象里
  22.      * @return
  23.      */
  24.     @Select("select u_email from tb_user")
  25.     @Results(
  26.             @Result(column = "u_email", property = "email")
  27.     )
  28.     List<User> listAllEmail();
  29. }

2.3.4 第四步：配置 spring 配置文件

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <beans xmlns="http://www.springframework.org/schema/beans"
  3.        xmlns:context="http://www.springframework.org/schema/context"
  4.        xmlns:tx="http://www.springframework.org/schema/tx"
  5.        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  6.        xsi:schemaLocation="http://www.springframework.org/schema/beans
  7.         http://www.springframework.org/schema/beans/spring-beans.xsd
  8.         http://www.springframework.org/schema/context
  9.         http://www.springframework.org/schema/context/spring-context.xsd
  12.         http://www.springframework.org/schema/tx
  13.         http://www.springframework.org/schema/tx/spring-tx.xsd">
  15.     <!--开启 spring 组件扫描-->
  16.     <context:component-scan base-package="org.oza.mybatisplus"/>
  18.     <!--1. 数据源-->
  19.     <bean name="dataSource" class="com.alibaba.druid.pool.DruidDataSource">
  20.         <property name="driverClassName" value="com.mysql.cj.jdbc.Driver"/>
  21.         <property name="url" value="jdbc:mysql://localhost:3306/mybatisplus?serverTimezone=UTC&amp;useUnicode=true&amp;characterEncoding=utf8&amp;useSSL=false"/>
  22.         <property name="username" value="root"/>
  23.         <property name="password" value="password"/>
  24.         <property name="maxActive" value="10"/>
  25.         <property name="minIdle" value="5"/>
  26.     </bean>
  28.     <!--2. mybatis-plus 整合 spring-->
  29.     <bean name="sqlSessionFactoryBean" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean">
  30.         <!--加载数据源-->
  31.         <property name="dataSource" ref="dataSource"/>
  32.         <!--配置插件-->
  33.         <property name="plugins">
  34.             <array>
  35.                 <!--物理分页支持-->
  36.                 <bean class="com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor"/>
  37.                 <!--SQL语句输出-->
  38.                 <bean class="com.baomidou.mybatisplus.extension.plugins.PerformanceInterceptor"/>
  39.             </array>
  40.         </property>
  41.     </bean>
  43.     <!--3. 配置 mybatis-plus 动态代理-->
  44.     <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
  45.         <property name="sqlSessionFactoryBeanName" value="sqlSessionFactoryBean"/>
  46.         <property name="basePackage" value="org.oza.mybatisplus.mapper"/>
  47.     </bean>
  49.     <!--4. 配置事务管理器-->
  50.     <bean name="txManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
  51.         <property name="dataSource" ref="dataSource"/>
  52.     </bean>
  54.     <!--5. 开启事务注解支持，指定事务管理器-->
  55.     <tx:annotation-driven transaction-manager="txManager"/>
  56. </beans>

2.3.5 第五步：编写测试代码

  1. package org.oza.mybatisplus;
  3. import com.baomidou.mybatisplus.core.conditions.Wrapper;
  4. import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
  5. import com.baomidou.mybatisplus.core.conditions.update.UpdateWrapper;
  6. import com.baomidou.mybatisplus.core.metadata.IPage;
  7. import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
  8. import org.apache.ibatis.session.RowBounds;
  9. import org.junit.Test;
  10. import org.junit.runner.RunWith;
  11. import org.oza.mybatisplus.mapper.UserMapper;
  12. import org.oza.mybatisplus.pojo.User;
  13. import org.springframework.beans.factory.annotation.Autowired;
  14. import org.springframework.test.context.ContextConfiguration;
  15. import org.springframework.test.context.TestExecutionListeners;
  16. import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
  18. import java.sql.SQLOutput;
  19. import java.util.List;
  21. @RunWith(SpringJUnit4ClassRunner.class)
  22. @ContextConfiguration("classpath:spring-mybatisplus.xml")
  23. public class CrudTest {
  24.     @Autowired
  25.     private UserMapper userMapper;
  27.     /**
  28.      * 插入一条数据
  29.      */
  30.     @Test
  31.     public void insert() {
  32.         User user = new User(null, "张无忌", 18, "zwj@qq.com");
  33.         int insert = userMapper.insert(user);
  34.         System.out.println("Affected rows: " + insert);
  35.     }
  37.     /**
  38.      * 根据 ID 删除
  39.      */
  40.     @Test
  41.     public void deleteById(){
  42.         int delete = userMapper.deleteById(1);
  43.         System.out.println("Affected rows: " + delete);
  45.     }
  47.     /**
  48.      * 根据 ID 查询
  49.      */
  50.     @Test
  51.     public void selectById() {
  52.         User user = userMapper.selectById(1);
  53.         System.out.println(user);
  54.     }
  56.     /**
  57.      * 根据条件删除, 删除名字含 张 字的
  58.      */
  59.     @Test
  60.     public void deleteByCondition(){
  61.         QueryWrapper<User> userWrapper = new QueryWrapper<>();
  62.         userWrapper.like("u_name", "张");
  63.         int delete = userMapper.delete(userWrapper);
  64.         System.out.println("Affected rows: " + delete);
  65.     }
  67.     /**
  68.      * 根据 Id 进行修改，只修改不为空的数据
  69.      */
  70.     @Test
  71.     public void update() {
  72.         User user = new User(4L, null, 25, null);
  73.         int update = userMapper.updateById(user);
  74.         System.out.println("Affected rows: " + update);
  75.     }
  77.     /**
  78.      * 批量修改，将所有名字含有 张 的都修改
  79.      */
  80.     @Test
  81.     public void updateByCondition() {
  82.         User user = new User(null, null, 25, null);
  83.         UpdateWrapper<User> updateWrapper = new UpdateWrapper<>();
  84.         updateWrapper.like("u_name", "张");
  85.         int update = userMapper.update(user, updateWrapper);
  86.         System.out.println("Affected rows: " + update);
  87.     }
  89.     /**
  90.      * 根据条件查询，将所有名字带 张 的查出来
  91.      */
  92.     @Test
  93.     public void selectByCondition() {
  94.         QueryWrapper<User> queryWrapper = new QueryWrapper<>();
  95.         queryWrapper.like("u_name", "张");
  96.         List<User> users = userMapper.selectList(queryWrapper);
  97.         users.forEach(user -> System.out.println(user));
  98.     }
  100.     /**
  101.      * 分页查询，selectPage 可以传入两个参数
  102.      *  参数 1：Page 对象，包含了分页信息，其构造方法参数
  103.      *      参数 1：当前页，从 1 开始
  104.      *      参数 2：页面容量
  105.      *  参数 2：QueryWrapper 对象，设置搜索的条件
  106.      * 结果：IPage 抽象类的子类对象，包含了一下信息：
  107.      *  1. 当前页
  108.      *  2. 总页数
  109.      *  3. 总记录数
  110.      *  4. 页面容量
  111.      *  5. 当前页的记录
  112.      */
  113.     @Test
  114.     public void selectByPage() {
  115.         IPage iPage = userMapper.selectPage(new Page(1L, 2), null);
  116.         System.out.println("current page: " + iPage.getCurrent());
  117.         System.out.println("total pages: " + iPage.getPages());
  118.         System.out.println("total records: " + iPage.getTotal());
  119.         System.out.println("page size: " + iPage.getSize());
  120.         System.out.println("records: " + iPage.getRecords());
  121.     }
  123.     /**
  124.      * 自定义方法测试
  125.      */
  126.     @Test
  127.     public void listAllUsername() {
  128.         List<String> usernames = userMapper.listAllUsername();
  129.         System.out.println(usernames);
  131.         List<User> users = userMapper.listAllEmail();
  132.         users.forEach(user -> System.out.println(user.getEmail()));
  133.     }
  134. }

2.3.6 第六步：编写 Service 层

mybatis-plus 还提供了 Service 层的快速实现。同样不需要写任何实现方法，即可轻松构建 Service 层。

需要注意的是，service 层方法名和 dao 层的方法名有些许不同

编写 UserService 接口

  1. package org.oza.mybatisplus.service;
  3. import com.baomidou.mybatisplus.extension.service.IService;
  4. import org.oza.mybatisplus.pojo.User;
  6. /**
  7.  * 继承 IService，泛型中写入 pojo 类
  8.  */
  9. public interface UserService extends IService<User> {
  10. }

编写 UserServiceImpl 实现类

  1. package org.oza.mybatisplus.service.impl;
  3. import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
  4. import org.oza.mybatisplus.mapper.UserMapper;
  5. import org.oza.mybatisplus.pojo.User;
  6. import org.oza.mybatisplus.service.UserService;
  7. import org.springframework.stereotype.Service;
  9. /**
  10.  * 继承 ServiceImpl，实现 UserService 接口
  11.  *      ServiceImpl：该类实现了 IService 接口，需要两个泛型参数
  12.  *          参数1：对应的 Mapper 类
  13.  *          参数2：对应的 Pojo 类
  14.  */
  15. @Service
  16. public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {
  17. }

测试代码

  1. /**
  2.  * 使用 service 层执行分页查询
  3.  */
  4. @Test
  5. public void serviceTest() {
  6.     IPage iPage = userService.page(new Page(1L, 2), null);
  7.     System.out.println("current page: " + iPage.getCurrent());
  8.     System.out.println("total pages: " + iPage.getPages());
  9.     System.out.println("total records: " + iPage.getTotal());
  10.     System.out.println("page size: " + iPage.getSize());
  11.     System.out.println("records: " + iPage.getRecords());
  12. }

原文链接：http://www.cnblogs.com/carlosouyang/p/11361882.html

 友情链接：直通硅谷 　点职佳 　北美留学生论坛

Java热门文章

  • 【IDEA】Application context not configured for this file
  • [IDEA] chapter_reader - idea看小说插件 idea阅读插件 idea摸鱼插件
  • thrift常见异常及原因分析
  • Java 调用 PaddleDetection 模型
  • JVM 详解，大白话带你认识 JVM
  • spring-boot-2.0.3不一样系列之番外篇 - @Configuration、Condition与@Conditional
  • Java Comparator.comparing比较导致空指针异常的解决
  • Java使用EasyExcel进行单元格合并的问题详解
  • 死磕 java集合之ArrayBlockingQueue源码分析
  • Java基础之集合Set详解

    • Java推荐文章

  • 面试场景题：一次关于线程池使用场景的讨论。
  • 前端黑科技：使用 JavaScript 实现网页扫码功能
  • 聊一聊 Netty 数据搬运工 ByteBuf 体系的设计与实现
  • 简单设计一个JAVA并行处理工具类
  • 【杂谈】JPA乐观锁改悲观锁遇到的一些问题与思考
  • 认识netty的基本组件
  • Jenkins如何使用CrumbIssuer防御CSRF攻击
  • 如何平稳地从nacos迁移到r-nacos？
  • 线程池遇到父子任务，有大坑，要注意！
  • Java JVM——12. 垃圾回收理论概述

    • 本站QQ群：前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

    W3xue 的所有内容仅供测试，对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
    关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接（目前9元/月）请联系QQ：27243702 沸活量
    皖ICP备17017327号-2　皖公网安备34020702000426号