关于mybatis:SpringBoot-Mybatis系列Mapper接口注册的几种方式

36次阅读

共计 6395 个字符，预计需要花费 16 分钟才能阅读完成。

【SpringBoot + Mybatis 系列】Mapper 接口注册的几种形式

SpringBoot 我的项目中借助 Mybatis 来操作数据库，对大部分 java 技术栈的小伙伴来说，并不会生疏；咱们晓得，应用 mybatis，个别会有上面几个

  • Entity: 数据库实体类
  • Mapper: db 操作接口
  • Service: 服务类

本片博文中的注解，放在 Mapper 上，你晓得注册 Mapper 有几种形式么（这个问题像不像 ” 茴 ” 字有几个写法😬）

<!– more –>

I. 环境筹备

1. 数据库筹备

应用 mysql 作为本文的实例数据库，新增一张表

CREATE TABLE `money` (`id` int(11) unsigned NOT NULL AUTO_INCREMENT,
  `name` varchar(20) NOT NULL DEFAULT ''COMMENT' 用户名 ',
  `money` int(26) NOT NULL DEFAULT '0' COMMENT '钱',
  `is_deleted` tinyint(1) NOT NULL DEFAULT '0',
  `create_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创立工夫',
  `update_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新工夫',
  PRIMARY KEY (`id`),
  KEY `name` (`name`)
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4;

2. 我的项目环境

本文借助 SpringBoot 2.2.1.RELEASE + maven 3.5.3 + IDEA进行开发

pom 依赖如下

<dependencies>
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>2.2.0</version>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
    </dependency>
</dependencies>

db 配置信息 application.yml

spring:
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/story?useUnicode=true&characterEncoding=UTF-8&useSSL=false&serverTimezone=Asia/Shanghai
    username: root
    password:

II. 实例演示

后面根底环境搭建实现，接下来筹备下 Mybatis 的 Entity,Mapper 等根底类

1. 实体类,Mapper 类

数据库实体类MoneyPo

@Data
public class MoneyPo {
    private Integer id;

    private String name;

    private Long money;

    private Integer isDeleted;

    private Timestamp createAt;

    private Timestamp updateAt;
}

对应的 Mapper 接口（这里间接应用注解的形式来实现 CURD）

public interface MoneyMapper {

    /**
     * 保留数据，并保留主键 id
     *
     * @param po
     * @return int
     */
    @Options(useGeneratedKeys = true, keyProperty = "po.id", keyColumn = "id")
    @Insert("insert into money (name, money, is_deleted) values (#{po.name}, #{po.money}, #{po.isDeleted})")
    int save(@Param("po") MoneyPo po);

    /**
     * 更新
     *
     * @param id    id
     * @param money 钱
     * @return int
     */
    @Update("update money set `money`=#{money} where id = #{id}")
    int update(@Param("id") int id, @Param("money") long money);

    /**
     * 删除数据
     *
     * @param id id
     * @return int
     */
    @Delete("delete from money where id = #{id}")
    int delete(@Param("id") int id);

    /**
     * 主键查问
     *
     * @param id id
     * @return {@link MoneyPo}
     */
    @Select("select * from money where id = #{id}")
    @Results(id = "moneyResultMap", value = {@Result(property = "id", column = "id", id = true, jdbcType = JdbcType.INTEGER),
            @Result(property = "name", column = "name", jdbcType = JdbcType.VARCHAR),
            @Result(property = "money", column = "money", jdbcType = JdbcType.INTEGER),
            @Result(property = "isDeleted", column = "is_deleted", jdbcType = JdbcType.TINYINT),
            @Result(property = "createAt", column = "create_at", jdbcType = JdbcType.TIMESTAMP),
            @Result(property = "updateAt", column = "update_at", jdbcType = JdbcType.TIMESTAMP)})
    MoneyPo getById(@Param("id") int id);
}

对应的 Service 类

@Slf4j
@Service
public class MoneyService {
    @Autowired
    private MoneyMapper moneyMapper;

    public void basicTest() {int id = save();
        log.info("save {}", getById(id));
        boolean update = update(id, 202L);
        log.info("update {}, {}", update, getById(id));
        boolean delete = delete(id);
        log.info("delete {}, {}", delete, getById(id));
    }

    private int save() {MoneyPo po = new MoneyPo();
        po.setName("一灰灰 blog");
        po.setMoney(101L);
        po.setIsDeleted(0);
        moneyMapper.save(po);
        return po.getId();}

    private boolean update(int id, long newMoney) {int ans = moneyMapper.update(id, newMoney);
        return ans > 0;
    }

    private boolean delete(int id) {return moneyMapper.delete(id) > 0;
    }

    private MoneyPo getById(int id) {return moneyMapper.getById(id);
    }
}

2. 注册形式

留神，下面写完之后，若不通过上面的几种形式注册 Mapper 接口，我的项目启动会失败，提醒找不到 MoneyMapper 对应的 bean

Field moneyMapper in com.git.hui.boot.mybatis.service.MoneyService required a bean of type 'com.git.hui.boot.mybatis.mapper.MoneyMapper' that could not be found.

2.1 @MapperScan 注册形式

在配置类 or 启动类上，增加 @MapperScan 注解来指定 Mapper 接口的包门路，从而实现 Mapper 接口的注册

@MapperScan(basePackages = "com.git.hui.boot.mybatis.mapper")
@SpringBootApplication
public class Application {public Application(MoneyService moneyService) {moneyService.basicTest();
    }

    public static void main(String[] args) {SpringApplication.run(Application.class);
    }
}

执行之后输入后果如下

2021-07-06 19:12:57.984  INFO 1876 --- [main] c.g.h.boot.mybatis.service.MoneyService  : save MoneyPo(id=557, name= 一灰灰 blog, money=101, isDeleted=0, createAt=2021-07-06 19:12:57.0, updateAt=2021-07-06 19:12:57.0)
2021-07-06 19:12:58.011  INFO 1876 --- [main] c.g.h.boot.mybatis.service.MoneyService  : update true, MoneyPo(id=557, name= 一灰灰 blog, money=202, isDeleted=0, createAt=2021-07-06 19:12:57.0, updateAt=2021-07-06 19:12:57.0)
2021-07-06 19:12:58.039  INFO 1876 --- [main] c.g.h.boot.mybatis.service.MoneyService  : delete true, null

留神：

  • basePackages: 传入 Mapper 的包门路，数组，能够传入多个

  • 包门路反对正则，如com.git.hui.boot.*.mapper

    • 下面这种形式，能够防止让咱们所有的 mapper 都放在一个包门路下，从而导致浏览不敌对

2.2 @Mapper 注册形式

后面的 @MapperScan 指定 mapper 的包门路，这个注解则间接放在 Mapper 接口上

@Mapper
public interface MoneyMapper {...}

测试输入省略 …

2.3 MapperScannerConfigurer 注册形式

应用 MapperScannerConfigurer 来实现 mapper 接口注册，在很久以前，还是应用 Spring 的 xml 进行 bean 的申明的时候，mybatis 的 mapper 就是这么玩的

<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <property name="basePackage" value="xxx"/>
        <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"/>
</bean>

对应的 java 代码如下：

@Configuration
public class AutoConfig {@Bean(name = "sqlSessionFactory")
    public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {SqlSessionFactoryBean bean = new SqlSessionFactoryBean();
        bean.setDataSource(dataSource);
        bean.setMapperLocations(
                // 设置 mybatis 的 xml 所在位置，这里应用 mybatis 注解形式，没有配置 xml 文件
                new PathMatchingResourcePatternResolver().getResources("classpath*:mapping/*.xml"));
        return bean.getObject();}

    @Bean("sqlSessionTemplate")
    public SqlSessionTemplate sqlSessionTemplate(SqlSessionFactory storySqlSessionFactory) {return new SqlSessionTemplate(storySqlSessionFactory);
    }

    @Bean
    public MapperScannerConfigurer mapperScannerConfigurer() {MapperScannerConfigurer mapperScannerConfigurer = new MapperScannerConfigurer();
        mapperScannerConfigurer.setBasePackage("com.git.hui.boot.mybatis.mapper");
        mapperScannerConfigurer.setSqlSessionFactoryBeanName("sqlSessionFactory");
        mapperScannerConfigurer.setSqlSessionTemplateBeanName("sqlSessionTemplate");
        return mapperScannerConfigurer;
    }
}

测试输入省略

3. 小结

本文次要介绍 Mybatis 中 Mapper 接口的三种注册形式，其中常见的两种注解形式

  • @MapperScan: 指定 Mapper 接口的包门路
  • @Mapper: 放在 mapper 接口上
  • MapperScannerConfigurer: 编程形式注册

那么疑难来了，为啥要介绍这三种形式，咱们理论的业务开发中，后面两个基本上就满足了；什么场景会用到第三种形式？

  • 如写通用的 Mapper（相似 Mybatis-Plus 中的 BaseMapper）
  • 如一个 Mapper，多数据源的场景（如主从库，冷热库，db 的操作 mapper 统一，然而底层的数据源不同）

本文到此结束，对于下面两个场景的实例 case，前面有空再补上，我是一灰灰，有缘再见（欢送关注长草的公众号 一灰灰 blog）

III. 不能错过的源码和相干知识点

0. 我的项目

  • 工程：https://github.com/liuyueyi/spring-boot-demo
  • 源码：https://github.com/liuyueyi/spring-boot-demo/tree/master/spring-boot/104-mybatis-ano

1. 一灰灰 Blog

尽信书则不如，以上内容，纯属一家之言，因集体能力无限，不免有疏漏和谬误之处，如发现 bug 或者有更好的倡议，欢送批评指正，不吝感谢

上面一灰灰的集体博客，记录所有学习和工作中的博文，欢送大家前去逛逛

  • 一灰灰 Blog 集体博客 https://blog.hhui.top
  • 一灰灰 Blog-Spring 专题博客 http://spring.hhui.top

正文完
mybatis
发表至： mybatis
2021-07-26
 0
关于mybatis:Mybatis介绍使用IDEA快速入门
关于mybatis:Mybatis
关于mybatis:三天吃透mybatis面试八股文
关于mybatis:Mybatis注解CRUD