该系列博文是站在MyBatis
的立场上谈论与SpringBoot
集成,通过集成案例我们分析其执行流程及原理,最后我们升华为解读源码。
新建Maven工程
- 新建
SpringBoot
项目可以从国内大厂阿里巴巴的镜像地址下载构建,好处是,可以自动集成Spring Cloud Alibaba
的生态,也可以从Spring官方构建网站进行构建项目;这里我们示范的是从start.aliyun.com构建; - 在start.aliyun.com中,我们为广大开发者带来了如下便利特性:
- 为每个组件提供了单独的DemoCode和对应的配置样例;
- 工程内置说明,减少用户查找文档的困难(部分实现);
- 开发者只需要做减法,而非加法的使用方式(部分实现);
- 提供多组件集成的解决方案(开发中);
- 定期跟进start.spring.io的更新,方便大家使用到spring的最新功能;
- 如图:在构建项目的时候,添加
mybatis-spring-boot-starter
依赖和Spring Web
依赖;
-
mybatis-spring-boot-starter
已经引用了mybatis
相关依赖,所以我们这里值引用mybatis-spring-boot-starter
就可以了,不用额外引用mybatis
、mybatis-spring
等; -
spring-boot-starter-web
是SpringBoot
必不可少的一个依赖,它构建了一个web
的场景,自动帮我们引入了web模块开发需要的相关依赖包;
新建数据表
- 新建好项目之后,我们新建数据表,并生成持久层代码
CREATE TABLE `delve_user` (
`ID` varchar(40) NOT NULL COMMENT '主键ID',
`name` varchar(200) DEFAULT NULL COMMENT '名称',
`age` varchar(200) DEFAULT NULL COMMENT '年龄',
`addr` varchar(200) DEFAULT NULL COMMENT '住址',
`phone` varchar(200) DEFAULT NULL COMMENT '手机号',
`email` varchar(200) DEFAULT NULL COMMENT '邮箱',
PRIMARY KEY (`ID`) USING BTREE
) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=DYNAMIC COMMENT='用户信息表';
使用MyBatis Generator
生成代码
在项目中添加mybatis generator maven
插件与依赖
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.5</version>
<configuration>
<!--generatorConfig.xml位置-->
<configurationFile>src/main/resources/mybatis-generator/generatorConfig.xml</configurationFile>
<verbose>true</verbose>
<overwrite>true</overwrite>
</configuration>
<executions>
<execution>
<id>Generate MyBatis Artifacts</id>
<goals>
<goal>generate</goal>
</goals>
<phase>generate-sources</phase>
</execution>
</executions>
<!--此处必须添加mysql驱动包-->
<dependencies>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
<version>5.1.46</version>
</dependency>
</dependencies>
</plugin>
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.3.7</version>
</dependency>
配置generatorConfig.xml
MyBatis Generate
的XML配置,配置生成规则;
<!-- 配置生成器 -->
<generatorConfiguration>
<!--执行generator插件生成文件的命令: call mvn mybatis-generator:generate -e -->
<!-- 引入配置文件 -->
<properties resource="mybatis-generator/generator.properties"/>
<!--classPathEntry:数据库的JDBC驱动,换成你自己的驱动位置 可选 -->
<!--<classPathEntry location="E:\mybatis\mysql-connector-java-5.1.24-bin.jar" /> -->
<!-- 一个数据库一个context -->
<!--defaultModelType="flat" 大数据字段,不分表 -->
<context id="MysqlTables" targetRuntime="MyBatis3Simple" defaultModelType="flat">
<!-- 自动识别数据库关键字,默认false,如果设置为true,根据SqlReservedWords中定义的关键字列表;
一般保留默认值,遇到数据库关键字(Java关键字),使用columnOverride覆盖 -->
<property name="autoDelimitKeywords" value="true" />
<!-- 生成的Java文件的编码 -->
<property name="javaFileEncoding" value="utf-8" />
<!-- beginningDelimiter和endingDelimiter:指明数据库的用于标记数据库对象名的符号,比如ORACLE就是双引号,MYSQL默认是`反引号; -->
<property name="beginningDelimiter" value="`" />
<property name="endingDelimiter" value="`" />
<!-- 格式化java代码 -->
<property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
<!-- 格式化XML代码 -->
<property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>
<plugin type="org.mybatis.generator.plugins.SerializablePlugin" />
<plugin type="org.mybatis.generator.plugins.ToStringPlugin" />
<!-- 注释 -->
<commentGenerator >
<property name="suppressAllComments" value="false"/><!-- 是否取消注释 -->
<property name="suppressDate" value="true" /> <!-- 是否生成注释代时间戳-->
</commentGenerator>
<!-- jdbc连接 -->
<jdbcConnection driverClass="${jdbc_driver}" connectionURL="${jdbc_url}" userId="${jdbc_user}" password="${jdbc_password}" />
<!-- 类型转换 -->
<javaTypeResolver>
<!-- 是否使用bigDecimal, false可自动转化以下类型(Long, Integer, Short, etc.) -->
<property name="forceBigDecimals" value="false"/>
</javaTypeResolver>
<!-- 生成实体类地址 -->
<javaModelGenerator targetPackage="com.albert.delve.mybatis.entity" targetProject="${models}" >
<property name="enableSubPackages" value="false"/>
<property name="trimStrings" value="true"/>
</javaModelGenerator>
<!-- 生成mapperxml文件 -->
<sqlMapGenerator targetPackage="mapper" targetProject="${resources}" >
<property name="enableSubPackages" value="false" />
</sqlMapGenerator>
<!-- 生成mapxml对应client,也就是接口dao -->
<javaClientGenerator targetPackage="com.albert.delve.mybatis.dao" targetProject="${dao}" type="XMLMAPPER" >
<property name="enableSubPackages" value="true" />
</javaClientGenerator>
<!-- table可以有多个,每个数据库中的表都可以写一个table,tableName表示要匹配的数据库表,也可以在tableName属性中通过使用%通配符来匹配所有数据库表,只有匹配的表才会自动生成文件 -->
<!--如果想生成一个表则tableName="table_name"-->
<table tableName="%"
enableCountByExample="true"
enableUpdateByExample="true"
enableDeleteByExample="true"
enableSelectByExample="true"
selectByExampleQueryId="true">
<property name="useActualColumnNames" value="false" />
<!-- 数据库表主键 -->
<generatedKey column="id" sqlStatement="Mysql" identity="true" />
</table>
</context>
</generatorConfiguration>
generator.properties
配置
jdbc_driver=com.mysql.jdbc.Driver
jdbc_url=jdbc:mysql://localhost:3306/数据库名称?useUnicode=true&characterEncoding=utf-8&useSSL=true
jdbc_user=用户名
jdbc_password=密码
# 生成地址,可以指定生成到自己的项目中去,这里博主是做示范,则配置到D盘
# 如过你和博主配置一直,则需要保证下面你配置的路径已经存在
models=D:\\CodeGen\\src\\main\\java
resources=D:\\CodeGen\\src\\main\\resources
dao=D:\\CodeGen\\src\\main\\java
运行生成
- 使用
IDEA
的童鞋,可以点击Maven--->Plugins---mybatis-generator
中的mybatis-generator:generate运行生成代码,如图:
- 使用
Eclipse
的童鞋,自行摸索去吧!【偷笑脸】
需要注意的地方
- 如果数据库中有很多表,但你要生成的只是其中几张甚至更多张,则你需要在
generatorConfig.xml
中的<table>
节点配置你要生成的表,如果数据表太多,则此时博主建议,你直接把你想要的表结构复制到另一个新的数据库,然后生成就好; - 如果生成中还有问题,请记得仔细查看
generatorConfig.xml
中的节点处中文说明; - 再再再还有问题,请联系博主,讨论讨论。
编辑测试代码
- 基于以上工作,我们已经生成了数据访问层的代码,接下来我们编写业务层代码;
- 业务层接口:
public interface DelveUserService {
boolean insert(DelveUser record);
DelveUser selectByPrimaryKey(String id);
List<DelveUser> selectAll();
}
- 业务实现:
@Service
public class DelveUserServiceImpl implements DelveUserService {
@Autowired
DelveUserMapper delveUserMapper;
@Override
public boolean insert(DelveUser record) {
int num = delveUserMapper.insert(record);
return num > 0;
}
@Override
public DelveUser selectByPrimaryKey(String id) {
return delveUserMapper.selectByPrimaryKey(id);
}
@Override
public List<DelveUser> selectAll() {
return delveUserMapper.selectAll();
}
}
- 控制层,页面交互层:
@RestController
public class DelveUserController {
@Autowired
DelveUserService delveUserService;
@GetMapping("/test")
public String test() {
DelveUser record = new DelveUser();
record.setId(UUID.randomUUID().toString());
record.setName("小明");
record.setAge("25");
delveUserService.insert(record);
return "123";
}
@GetMapping("/view")
public List<DelveUser> view() {
return delveUserService.selectAll();
}
}
配置application.properties
######################## common config : ########################
spring.application.name=albert-delve
server.port=8666
#--------------mybatis配置---------
spring.datasource.url=jdbc:mysql://localhost:3306/数据库名称?useUnicode=true&characterEncoding=utf-8&autoReconnect=true&serverTimezone=GMT%2B8
spring.datasource.username=用户名
spring.datasource.password=密码
#在此版本中,数据库驱动文件com.mysql.jdbc.Driver(版本5)已由变为com.mysql.cj.jdbc.Driver(版本6及以上)
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
#mybatis 配置
# 配置映射文件加载
mybatis.mapper-locations=classpath*:mapper/*.xml
# 实体类通过别名使用
mybatis.type-aliases-package=com.albert.delve.mybatis.entity.entity
运行
启动项目,访问:localhost:8666/test或localhost:8666/view新增和查看数据信息;如下图:
总结与疑问
- 综上,总体来说,
MyBatis
与SpringBoot
的集成并不复杂,而我们费这劲讲这个集成,难道真的只是为了搬砖,不不不,我们此举是为了升华而来,如果你不是无脑的搬运代码,想必你已经发现了奥秘,我们的集成代码能如此简单,则首功要归功于我们的镇南大将军:mybatis-spring-boot-starter
,spring-boot-starter-web
你就不要进来搅局了,这是人家MyBatis
的场子;
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.1.1</version>
</dependency>
- 以前我们用
SSM
开发的时候,是会有很多的配置信息需要我们一个个手动去配置,现在这些工作,都交由一个starter
来完成,大大简化了我们的开发,所以,下篇博文我们将集中剖析一个mybatis-spring-boot-starter
到底是如何帮我们简化开发的。