MyBatis Mapper 正在参加 2021 年度 OSC 中国开源项目评选,请投票支持!
MyBatis Mapper 在 2021 年度 OSC 中国开源项目评选 中已获得 {{ projectVoteCount }} 票,请投票支持!
2021 年度 OSC 中国开源项目评选 正在火热进行中,快来投票支持你喜欢的开源项目!
2021 年度 OSC 中国开源项目评选 >>> 中场回顾
MyBatis Mapper 获得 2021 年度 OSC 中国开源项目评选「最佳人气项目」 !
授权协议 Apache
开发语言 Java 查看源码 »
操作系统 跨平台
软件类型 开源软件
开源组织
地区 国产
投 递 者 Liuzh_533
适用人群 未知
收录时间 2021-08-13

软件简介

项目地址:https://mapper.mybatis.io

介绍

这是一个不需要任何配置就可以直接使用的通用 Mapper,通过简单的学习就可以直接在项目中使用。

1.1 主要目标

1. 开箱即用,无需任何配置,继承基类 Mapper 即可获得大量通用方法;
2. 随心所欲,通过复制粘贴的方式可以组建自己的基类 Mapper;
3. 全面贴心,提供 Service 层的封装方便业务使用和理解 Mapper;
4. 简单直观,提供 ActiveRecord 模式,结合 Spring Boot 自动配置直接上手用;
5. 自定义方法,简单几行代码即可实现自定义通用方法;
6. 轻松扩展,通过 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中包含的这两个注解提供了大量的配置属性,想要使用更多的配置,参考 实体类注解 中的内容,下面是一个简单示例:

@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 扫描到即可直接使用。

下面是几种常见的扫描配置:

1. MyBatis 自带的配置文件方式 `mybatis-config.xml`:

 <mappers>
   <!-- 扫描指定的包 -->
   <package name="com.example.mapper"/>
 </mappers>

2. 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>

3. 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 配置。

可以注意到上面都是 MyBatis 自己的配置方式,新版 mybatis-mapper 本身不需要任何配置即可使用。

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 进行了解。

展开阅读全文

代码

的 Gitee 指数为
超过 的项目

评论 (0)

加载中
更多评论
发表了资讯
2021/08/16 07:40

mybatis-mapper 1.0.1 发布

2021年8月12日 - 1.0.0 发布了🎉🎉🎉 项目地址:https://mapper.mybatis.io 介绍 这是一个不需要任何配置就可以直接使用的通用 Mapper,通过简单的学习就可以直接在项目中使用。 1.1 主要目标 1. 开箱即用,无需任何配置,继承基类 Mapper 即可获得大量通用方法; 2. 随心所欲,通过复制粘贴的方式可以组建自己的基类 Mapper; 3. 全面贴心,提供 Service 层的封装方便业务使用和理解 Mapper; 4. 简单直观,提供 ...

23
6
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
发表了博客
2018/03/08 21:29

通用Mapper(Mybatis)

1.Mapper的简单介绍 2.Mapper的作用 通用Mapper可以通过Mybatis的拦截器原理,动态的帮我们实现单表的增删改查功能,大大降低了我们的开发成本,减少了我们的工作量。 3.Mapper的使用 该Mapper是一个接口,里面提供给了一系列的方法,导入依赖,配置插件,利用Mybatis使用通用的Mapper接口,首先继承该接口,泛型为类中的类型。这样就没有配置文件了,所以要在Mybatis核心配置文件中,配置扫描的包。编写测试类。 3.1导入依赖(...

0
0
发表了博客
2018/10/18 15:04

Mybatis的mapper注册

既然 MyBatis 的行为已经由上述元素配置完了,我们现在就要定义 SQL 映射语句了。但是首先我们需要告诉 MyBatis 到哪里去找到这些语句。 Java 在自动查找这方面没有提供一个很好的方法,所以最佳的方式是告诉 MyBatis 到哪里去找映射文件。你可以使用相对于类路径的资源引用, 或完全限定资源定位符(包括 file:/// 的 URL),或类名和包名等。例如: <!-- Using classpath relative resources --> <mappers> <mapper resource...

0
0
发表了博客
2019/04/10 10:10

mybatis - 通用mapper

作为持久层的ORM框架,目前在国内主流之一就是MyBatis,学会用它,用好它肯定是必备的功课 我会主要从下面几个方面入整理本篇博客 快速搭建快发环境 常见的注解 怎么玩? <!--more--> 一. 快速搭建开发环境 小插曲,添加测试模块的时候,引入junit模块和spring-boot-text-starter模块有先顺序,不然ide会报错... 坐标 <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-paren...

0
1
发表了博客
2019/03/30 12:38

Mybatis之加载Mapper接口和mapper XML

概述 Mybatis加载Mapper接口有两个入口:一个是指定mapper xml,另一个是指定Mapper接口。 mapper xml 通过指定mapper xml的路径,Mybatis使用XMLMapperBuilder类来加载解析mapper xml文件。最后会使用mapperRegistry.addMapper(type)来加载,这个type就是mapper xml的namespace属性。 Mapper接口 指定Mapper接口,Mybatis使用方法mapperRegistry.addMapper(type)来加载,在这个方法内部会使用类MapperAnnotationBuilder来解析M...

0
1
发表了博客
2018/07/01 19:19

MyBatis:自定义Mapper

在开发中有时可能需要我们自己自定义一些mapper还有些一些自定义的xml,SQL语句。其实在我们的框架中很方便。只需要在mapper中添加自定义接口,在resources中自定义一个mapper的xml文件,将它们一一映射出来。 之后在service中注入对象,在controller层写一个方法调用即可 运行成功

0
0
2020/09/28 19:03

MyBatis扫描mapper

1. 扫描代码包下mapper ```xml ``` 2. 扫描resources下mapper ```xml ```

0
0
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
发表于开发技能专区
2021/10/27 14:02

MyBatis问题帮忙看看怎么解决:Could not find result map?

在一个xml中引入另外一个xml的ResultMap,然后就出问题了: /Library/Java/JavaVirtualMachines/adoptopenjdk-11.jdk/Contents/Home/bin/java -agentlib:jdwp=transport=dt_socket,address=127.0.0.1:65177,suspend=y,server=n -XX:TieredStopAtLevel=1 -noverify -Dspring.output.ansi.enabled=always -javaagent:/Users/wangbin/Library/Caches/JetBrains/IntelliJIdea2021.2/captureAgent/debugger-agent.jar -Dcom.sun.man...

1
0
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
0 评论
7 收藏
分享
OSCHINA
登录后可查看更多优质内容
返回顶部
顶部