关键词:
项目地址:https://mapper.mybatis.io
介绍
这是一个不需要任何配置就可以直接使用的通用 Mapper,通过简单的学习就可以直接在项目中使用。
1.1 主要目标
- 开箱即用,无需任何配置,继承基类 Mapper 即可获得大量通用方法;
- 随心所欲,通过复制粘贴的方式可以组建自己的基类 Mapper;
- 全面贴心,提供 Service 层的封装方便业务使用和理解 Mapper;
- 简单直观,提供 ActiveRecord 模式,结合 Spring Boot 自动配置直接上手用;
- 自定义方法,简单几行代码即可实现自定义通用方法;
- 轻松扩展,通过 Java SPI 轻松扩展。
1.2 系统要求
MyBatis Mapper 要求 MyBatis 最低版本为3.5.1,推荐使用最新版本。
和 MyBatis 框架一样,最低需要 Java 8。
1.3 安装
如果你使用 Maven,在你的 pom.xml
添加下面的依赖:
<dependencies>
<dependency>
<groupId>io.mybatis</groupId>
<artifactId>mybatis-mapper</artifactId>
<version>1.0.0</version>
</dependency>
<!-- TODO 按需选择依赖 -->
<!-- 使用 Service 层封装时 -->
<dependency>
<groupId>io.mybatis</groupId>
<artifactId>mybatis-service</artifactId>
<version>1.0.0</version>
</dependency>
<!-- TODO 按需选择依赖 -->
<!-- 使用 ActiveRecord 模式时 -->
<dependency>
<groupId>io.mybatis</groupId>
<artifactId>mybatis-activerecord</artifactId>
<version>1.0.0</version>
</dependency>
</dependencies>
如果使用 Gradle,在 build.gradle
中添加:
dependencies
compile("io.mybatis:mybatis-mapper:1.0.0")
// 使用 Service 层封装时
compile("io.mybatis:mybatis-service:1.0.0")
// 使用 ActiveRecord 模式时
compile("io.mybatis:mybatis-activerecord:1.0.0")
1.4 快速设置
MyBatis Mapper 的基本原理是将实体类映射为数据库中的表和字段信息,因此实体类需要通过注解配置基本的元数据,配置好实体后,只需要创建一个继承基础接口的 Mapper 接口就可以开始使用了。
1.4.1 实体类配置
假设有一个表:
create table user
(
id INTEGER GENERATED BY DEFAULT AS IDENTITY (START WITH 1) PRIMARY KEY,
name VARCHAR(32) DEFAULT 'DEFAULT',
sex VARCHAR(2)
);
对应的实体类:
import io.mybatis.provider.Entity;
@Entity.Table("user")
public class User
@Entity.Column(id = true)
private Long id;
@Entity.Column("name")
private String username;
@Entity.Column
private String sex;
//省略set和get方法
实体类上 必须添加 @Entity.Table
注解指定实体类对应的表名,建议明确指定表名,不提供表名的时候,使用类名作为表名。所有属于表中列的字段,必须添加 @Entity.Column
注解,不指定列名时,使用字段名(不做任何转换),通过 id=true
可以标记字段为主键。
@Entity
中包含的这两个注解提供了大量的配置属性,想要使用更多的配置,参考下面 3. @Entity 注解 的内容,
下面是一个简单示例:@Entity.Table(value = "sys_user", remark = "系统用户", autoResultMap = true) public class User @Entity.Column(id = true, remark = "主键", updatable = false, insertable = false) private Long id; @Entity.Column(value = "name", remark = "帐号") private String userName; //省略其他
1.4.2 Mapper接口定义
有了 User
实体后,直接创建一个继承了 Mapper
的接口即可:
//io.mybatis.mapper.Mapper
public interface UserMapper extends Mapper<User, Long>
这个接口只要被 MyBatis 扫描到即可直接使用。
下面是几种常见的扫描配置:
- MyBatis 自带的配置文件方式
mybatis-config.xml
:<mappers> <!-- 扫描指定的包 --> <package name="com.example.mapper"/> </mappers>
- Spring 中的
spring.xml
配置:<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer"> <property name="basePackage" value="com.example.mapper"/> <property name="markerInterface" value="io.mybatis.service.mapper.RoleMarker"/> <property name="sqlSessionFactoryBeanName" value="sqlSessionFactoryRole"/> </bean>
- Spring Boot 配置,启动类注解方式:
@MapperScan(basePackages = "com.example.mapper") @SpringBootApplication public class SpringBootDemoApplication public static void main(String[] args) SpringApplication.run(SpringBootDemoApplication.class, args);
Spring Boot 中,还可以直接给接口添加
@org.apache.ibatis.annotations.Mapper
注解,增加注解后可以省略@MapperScan
配置。
1.4.3 使用
定义好接口后,就可以获取 UserMapper
使用,下面是简单示例:
User user = new User();
user.setUserName("测试");
userMapper.insert(user);
//保存后自增id回写,不为空
Assert.assertNotNull(user.getId());
//根据id查询
user = userMapper.selectByPrimaryKey(user.getId());
//删除
Assert.assertEquals(1, userMapper.deleteByPrimaryKey(user.getId()));
看到这里,可以发现除了 MyBatis 自身的配置外,MyBatis Mapper 只需要配置实体类注解,
创建对应的 Mapper 接口就可以直接使用,没有任何繁琐的配置。
上面的示例只是简单的使用了 MyBatis Mapper,还有很多开箱即用的功能没有涉及,
建议在上述示例运行成功后,继续查看本项目其他模块的详细文档,熟悉各部分文档后,
在使用 MyBatis Mapper 时会更得心应手,随心所欲。
更多文档可以通过 https://mapper.mybatis.io 进行了解。
mybatis-mapper示例封装baseid(代码片段)
mybatis-mapper快速上手项目分支介绍https://github.com/mybatis-mapper/mybatis-mapper-example-springboot项目目前包含3个分支,分别为:master简单集成baseid简单封装,所有表都使用名为id,类型为bigint的自增主键shardingsphere分库分表 查看详情
mybatis-mapper示例封装baseid(代码片段)
mybatis-mapper快速上手项目分支介绍https://github.com/mybatis-mapper/mybatis-mapper-example-springboot项目目前包含3个分支,分别为:master简单集成baseid简单封装,所有表都使用名为id,类型为bigint的自增主键shardingsphere分库分表 查看详情
mybatis-mapper示例spring-boot(代码片段)
mybatis-mapper快速上手项目分支介绍https://github.com/mybatis-mapper/mybatis-mapper-example-springboot项目目前包含3个分支,分别为:master简单集成baseid简单封装,所有表都使用名为id,类型为bigint的自增主键shardingsphere分库分表 查看详情
mybatis-mapper示例spring-boot(代码片段)
mybatis-mapper快速上手项目分支介绍https://github.com/mybatis-mapper/mybatis-mapper-example-springboot项目目前包含3个分支,分别为:master简单集成baseid简单封装,所有表都使用名为id,类型为bigint的自增主键shardingsphere分库分表 查看详情
mybatis-mapper示例sharding-jdbc(代码片段)
mybatis-mapper快速上手项目分支介绍https://github.com/mybatis-mapper/mybatis-mapper-example-springboot项目目前包含3个分支,分别为:master简单集成baseid简单封装,所有表都使用名为id,类型为bigint的自增主键shardingsphere分库分表 查看详情
mybatis-mapper示例sharding-jdbc(代码片段)
mybatis-mapper快速上手项目分支介绍https://github.com/mybatis-mapper/mybatis-mapper-example-springboot项目目前包含3个分支,分别为:master简单集成baseid简单封装,所有表都使用名为id,类型为bigint的自增主键shardingsphere分库分表... 查看详情
前端layui框架快速上手详解(代码片段)
✍LayUI🔥前端框架LayUI详解地址🔥前端LayUI框架快速上手详解(一)https://blog.csdn.net/Augenstern_QXL/article/details/119748962🔥前端LayUI框架快速上手详解(二)https://blog.csdn.net/Augenstern_QXL/article/details/119 查看详情
前端layui框架快速上手详解(代码片段)
✍目录总览🔥LayUI🔥前端框架LayUI详解地址🔥前端LayUI框架快速上手详解(一)https://blog.csdn.net/Augenstern_QXL/article/details/119748962🔥前端LayUI框架快速上手详解(二)https://blog.csdn.net/Augenstern_QXL/articl 查看详情
nvm快速上手(代码片段)
...nodejs版本管理工具,下面记录一些常用的使用方式。快速上手1.安装nvmnpminstallnvm2.常用命令只有这两个命令常用,也基本只用得上这两个命令。nvmlist//判断nvm版本nvmuse16.6.0//使用16.6.0版本注意:在打开DOS命令窗口的时候一定... 查看详情
nativefier快速上手(代码片段)
...app的插件,写这篇博客仅仅是因为怕自己忘记了怎么快速调用,下面将介绍一些常用的语法。快速上手1.安装nativefiernativefier依赖于nodejs,因此只要在有nodejs的环境中运行以下命令即可npminstallnativefier-g2.创建app如果你... 查看详情
cookiesessionstoragelocalstorage快速上手(代码片段)
cookie、Sessionstorage、Localstorage快速上手先说区别cookie:数据大小不能超过4KB。不管是否有需求,cookie数据都会在HTTP请求中携带,在浏览器和服务器中来回传递,占用资源。可以在后端设置修改,数据仅在本地浏览器保存。cookie数... 查看详情
reactnative快速上手(代码片段)
工欲善其事,必先利其器。搭建ReactNative开发环境,需要安装以下辅助工具。Node.js:ReactNative需要借助Node.js来创建和运行JavaScript代码。原生开发工具及环境:ReactNative的运行需要依赖原生Android和iOS环境,因此需要分别安装原生An... 查看详情
elasticsearchik分词器快速上手(代码片段)
简介: ElasticSearchIK分词器快速上手一、安装IK分词器1.分配伪终端我的ElasticSearch是使用Docker安装的,所以先给容器分配一个伪终端.之后就可以像登录服务器一样直接操作docker中的内容了dockerexec-it容器ID/bin/bash2.使用elasticsearch-... 查看详情
前端echarts可视化框架快速上手详解(代码片段)
✍前端ECharts可视化框架完结🔥前端ECharts可视化框架完结地址🔥前端ECharts可视化框架快速上手详解(一)https://blog.csdn.net/Augenstern_QXL/article/details/119850486🔥前端ECharts可视化框架快速上手详解(二)https://blog.csdn.net/Augenste 查看详情
前端echarts可视化框架快速上手详解(代码片段)
✍目录脑图🔥前端ECharts可视化框架完结地址🔥前端ECharts可视化框架快速上手详解(一)https://blog.csdn.net/Augenstern_QXL/article/details/119850486🔥前端ECharts可视化框架快速上手详解(二)https://blog.csdn.net/Augenstern_QXL/artic 查看详情
paddle点灯人之10分钟快速上手paddle(代码片段)
Paddle点灯人之10分钟快速上手Paddle文章目录Paddle点灯人之10分钟快速上手Paddle一、快速安装飞桨二、导入飞桨三、实践:手写数字识别任务3.1数据集定义与加载3.2模型组网3.3模型训练与评估3.3.1模型训练3.3.2模型评估3.4模型推... 查看详情
快速上手angular8常见使用(代码片段)
上一篇文章地址:快速上手angular8常见使用(一)1、HttpClientHttpClient服务:是Angular提供的用于发起异步XHR请求的对象使用步骤:1)主模块中导入importBrowserModulefrom'@angular/platform-browser';impor 查看详情
androidjetpackcompose快速上手(代码片段)
一、JetpackCompose简介JetpackCompose是Google推出的一个用于构建原生Android界面的工具包,旨在帮助开发者更快、更轻松地在Android平台上构建原生客户端应用。同时,作为全新的声明式的UI框架,JetpackCompose可以使用声明式KotlinAPI取代An... 查看详情