前言 最近收到公众号留言说，单纯的Mybatis的集成和使用。前面在第九章：Mybatis-plus的集成和使用介绍了基于mybatis-plus的集成和使用。后者也只是对mybatis进行了功能增强，原本的用法都是没有变化的。那今天就来简单介绍了如何springboot中如何集成和使用Mybatis吧。 SpringBoot的集成和使用 通用配置 注解方式 xml方式 枚举类型处理器配置 参考资料 总结https://www.cnblogs.com/okong/p/springboot-thirty-five.html 最后 老生常谈 SpringBoot的集成和使用 MyBatis是一款优秀的持久层框架，它支持定制化SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。MyBatis可以使用简单的XML或注解来配置和映射原生信息，将接口和Java的POJOs(Plain Old Java Objects,普通的 Java对象)映射成数据库中的记录。 这里介绍基于xml和注解两种方式进行配置。同时使用mybatis-spring-boot-starter进行集成。 这里选用的mybatis-spring-boot-starter版本为：1.3.2。 对应Mybatis版本为：3.4.6 通用配置 两种方式都引入一下的pom配置： org.mybatis.spring.boot mybatis-spring-boot-starter 1.3.2 mysql mysql-connector-java 这里以user表为例子，数据库为mysql DROP TABLE IF EXISTS `user`; CREATE TABLE `user` ( `id` bigint(20) DEFAULT NULL COMMENT '唯一标示', `code` varchar(20) DEFAULT NULL COMMENT '编码', `name` varchar(64) DEFAULT NULL COMMENT '名称', `status` char(1) DEFAULT '1' COMMENT '状态 1启用 0 停用', `gmt_create` datetime DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间', `gmt_modified` datetime DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '修改时间' ) ENGINE=InnoDB DEFAULT CHARSET=utf8; 实体类User为： /** *

* *

* * @author oKong * @since 2018-12-02 */ @Data @Accessors(chain = true) public class User implements Serializable{ /** * */ private static final long serialVersionUID = 1779270373648636358L; /** * 唯一标示 */ private Long id; /** * 编码 */ private String code; /** * 名称 */ private String name; /** * 状态1 启用 0 停用 */ private StatusEnum status; /** * 创建时间 */ private Date gmtCreate; /** * 修改时间 */ private Date gmtModified; } 状态枚举类StatusEnum： public enum StatusEnum { DISABLE, ENABLE; } 配置文件：application.properties # 实体别名 mybatis.type-aliases-package=cn.lqdev.learning.springboot.chapter35.biz.entity # 数据库配置 spring.datasource.driverClassName=com.mysql.jdbc.Driver spring.datasource.url=jdbc:mysql://localhost:3306/learning?useUnicode=true&characterEncoding=utf-8 spring.datasource.username=root spring.datasource.password= spring.profiles.active=anno 启动类 /** * mybaits集成 * @author oKong * */ @SpringBootApplication @Slf4j public class MybatisApplication { public static void main(String[] args) throws Exception { SpringApplication.run(MybatisApplication.class, args); log.info("spring-boot-mybatis-chapter35启动!"); } } 注解方式 0.创建注解版的mapper： UserMapper.java /** * 注解配置 * @author okong * */ public interface UserMapper { //配置返回的字段类型，这里配置了创建日期和修改日期自动 @Select("select * from user where id = #{id}") @Results({ @Result(column = "gmt_create",property = "gmtCreate",jdbcType=JdbcType.DATE), @Result(column = "gmt_modified",property = "gmtModified",jdbcType=JdbcType.DATE) }) User queryOne(Long id); // 枚举类 默认是使用 EnumTypeHandler 处理类，即使用枚举name作为值 //status 为枚举类 也可以直接指定了 typeHandler类 作为处理类 ，如：#{status,typeHandler=org.apache.ibatis.type.EnumOrdinalTypeHandler} //还可以在sqlFactory 直接使用 TypeHandlerRegistry 进行注册 详看；MybatisConfig 类 //最简单：自定义 ConfigurationCustomizer 了进行设置 详看；MybatisConfig 类 @Insert("insert into user(code,name,status) values(#{code},#{name}, #{status})") //以下配置会对user对象进行id赋值 @Options(keyProperty="id",keyColumn="id",useGeneratedKeys=true) int insert(User user); @Update("update user set code=#{code}, name = #{name}, status = #{status} where id=#{id}") void update(User user); @Delete("delete from user where id=#{id}") void delete(Long id); @Select("select * from user where code = #{code}") @Results({ @Result(column = "gmt_create",property = "gmtCreate",jdbcType=JdbcType.DATE), @Result(column = "gmt_modified",property = "gmtModified",jdbcType=JdbcType.DATE) }) List queryByParams(@Param("code")String code); } 简单对以上相关注解进行说明下： @Select 是查询类的注解，所有的查询均使用这个 @Result 修饰返回的结果集，关联实体类属性和数据库字段一一对应，如果实体类属性和数据库属性名保持一致，就不需要这个属性来修饰。 @Insert 插入数据库使用，直接传入实体类会自动解析属性到对应的值 @Update 负责修改，也可以直接传入对象 @delete 负责删除 @Options 映射语句的属性，如新增时需要返回自增的ID时:@Options(keyProperty="id",keyColumn="id",useGeneratedKeys=true) 具体的可以去官网查阅：http://www.mybatis.org/mybatis-3/zh/java-api.html 映射器注解 2.指定mapper扫描包路径，使用注解@MapperScan /** * mybaits配置 * @author oKong * */ @Configuration @MapperScan("cn.lqdev.learning.springboot.chapter35.biz.mapper")//mapper地址 public class MybatisConfig { } 注意：若使用Druid进行数据连接池管理，也可以在此类中进行DataSource的相关配置。 3.编写测试类进行测试。 /** * 测试类 * @author oKong * */ @RunWith(SpringRunner.class) @SpringBootTest @ActiveProfiles("anno") @Slf4j public class UserMapperTest { @Autowired UserMapper userMpper; @Test public void testInsert() { User user = new User(); user.setCode("002"); user.setName("name002"); user.setStatus(StatusEnum.ENABLE); //新增 userMpper.insert(user); } @Test public void testQueryOne() { User user = userMpper.queryOne(1L); log.info("id为1的查询结果为：{}", user); } @Test public void testUpdate() { User user = new User(); user.setCode("002"); user.setName("testUpdate"); user.setStatus(StatusEnum.ENABLE); userMpper.insert(user); User userUpd = userMpper.queryOne(user.getId()); userUpd.setName("更新name"); userMpper.update(userUpd); Assert.assertEquals("更新失败",userUpd.getName(), userMpper.queryOne(user.getId()).getName()); } @Test public void testParamSelect() { String code = "002"; List list = userMpper.queryByParams(code); log.info("查询编码为002,查询结果为：{}条,结果集为：{}",list.size(), Arrays.toString(list.toArray())); } } 运行测试用例后，就可以看见效果了。 具体控制台输出就输出了，可下载源码自行测试下。 xml方式 0.配置xml版的mapper。 /** * xml映射 * @author oKong * */ public interface UserXmlMapper { User queryOne(Long id); int insert(User user); void update(User user); void delete(Long id); List queryByParams(@Param("code")String code); } 没啥区别，就是讲sql语句放入到了xml中进行编写而已。 1.编写mapper.xml配置映射文件。 id, code, name, status, gmt_create, gmt_modified select from user where id = #{id} insert into user(code,name,status) values(#{code},#{name}, #{status}) update user set code=#{code}, name = #{name}, status = #{status} where id=#{id} delete from user where id=#{id} select from user where code = #{code} 2.mybatis配置文件。 mybatis-config.xml 对于特殊的类型，可以通过typeHandlers进行配置。稍后章节也会讲解想通过其他的方式进行配置。 3.创建xml方式配置文件：application-xml.properties，配置xml和config的路径地址 # 配置mapper.xml和mybatis-config.xml路径 mybatis.config-location=classpath:mybatis/mybatis-config.xml mybatis.mapper-locations=classpath:mybatis/mapper/*.xml 4.编写测试类：UserXmlMapperTest.java 此类和UserMapperTest类似的，唯一区别就是制定了运行环境变量为：xml @ActiveProfiles("xml") 枚举类型处理器配置 在实体对象中我们设置了枚举类型:StatusEnum。在mybatis中对于枚举的默认配置是由EnumTypeHandler处理类进行处理的，其会默认使用name进行赋值。同时mybatis还提供了一个EnumOrdinalTypeHandler处理类，其是根据枚举的索引值进行赋值的。 注册类型处理类有很多中方式，但每一种方式最后都是通过TypeHandlerRegistry类进行处理的，这里讲解下通过多种方式进行配置。 配置文件中新增属性：mybatis.type-handlers-package：配置处理类的路径。 # 类型处理类 mybatis.type-handlers-package=cn.lqdev.learning.springboot.chapter35.config 处理类示例：CustomEnumOrdinalTypeHandler.java。这里直接继承EnumOrdinalTypeHandler进行自定义。 /** * * @author oKong * */ //枚举索引处理类 @MappedTypes(value = { StatusEnum.class }) public class CustomEnumOrdinalTypeHandler> extends EnumOrdinalTypeHandler{ public CustomEnumOrdinalTypeHandler(Class type) { super(type); } } 其中，@MapperType指定了哪些类型指定此处理类的。 自定义ConfigurationCustomizer类进行配置（推荐）。 /** * *

函数名称： ConfigurationCustomizer

*

功能说明： 自定义相关注册器 * *

*

参数说明：

* @return * * @date 创建时间：2018年12月2日 * @author 作者：oKong */ @Bean public ConfigurationCustomizer configurationCustomizer() { ConfigurationCustomizer config = new ConfigurationCustomizer() { @Override public void customize(org.apache.ibatis.session.Configuration configuration) { // TypeAliasRegistry typeAliasRegistry = configuration.getTypeAliasRegistry(); // mapper接口注册器 // MapperRegistry mapperRegistry = configuration.getMapperRegistry(); // 类型处理器 TypeHandlerRegistry typeHandlerRegistry = configuration.getTypeHandlerRegistry(); typeHandlerRegistry.register(StatusEnum.class, EnumOrdinalTypeHandler.class); } }; return config; } 通过SqlSessionFactory来获取TypeHandlerRegistry进行配置。 @Autowired SqlSessionFactory sqlSessionFactory; @PostConstruct public void registerTypeHandler() { TypeHandlerRegistry registry = sqlSessionFactory.getConfiguration().getTypeHandlerRegistry(); registry.register(StatusEnum.class, EnumOrdinalTypeHandler.class); } 以上三种都可以进行相关类型的处理类配置，建议直接使用第二种。 完整的MybatisConfig类： /** * mybaits配置 * @author oKong * */ @Configuration @MapperScan("cn.lqdev.learning.springboot.chapter35.biz.mapper")//mapper地址 public class MybatisConfig { //使用 SqlSessionFactory 类获取 TypeHandlerRegistry 进行注册 // @Autowired // SqlSessionFactory sqlSessionFactory; // // @PostConstruct // public void registerTypeHandler() { // TypeHandlerRegistry registry = sqlSessionFactory.getConfiguration().getTypeHandlerRegistry(); // registry.register(StatusEnum.class, EnumOrdinalTypeHandler.class); // } /** * *

函数名称： ConfigurationCustomizer

*

功能说明： 自定义相关注册器 * *

*

参数说明：

* @return * * @date 创建时间：2018年12月2日 * @author 作者：oKong */ @Bean public ConfigurationCustomizer configurationCustomizer() { ConfigurationCustomizer config = new ConfigurationCustomizer() { @Override public void customize(org.apache.ibatis.session.Configuration configuration) { // TypeAliasRegistry typeAliasRegistry = configuration.getTypeAliasRegistry(); // mapper接口注册器 // MapperRegistry mapperRegistry = configuration.getMapperRegistry(); // 类型处理器 TypeHandlerRegistry typeHandlerRegistry = configuration.getTypeHandlerRegistry(); typeHandlerRegistry.register(StatusEnum.class, EnumOrdinalTypeHandler.class); } }; return config; } } 参考资料 http://www.mybatis.org/mybatis-3/zh/ http://www.mybatis.org/spring-boot-starter/mybatis-spring-