什么是 Mybatis?
MyBatis 本是apache的一个开源项目 iBatis, 2010年这个项目由apache software foundation 迁移到了google code,并且改名为 MyBatis。
MyBatis 是一个基于 Java 的持久层框架。MyBatis 提供的持久层框架包括 SQL Maps 和 Data Access Objects(DAO),它消除了几乎所有的 JDBC 代码和参数的手工设置以及结果集的检索。
MyBatis 几乎可以代替 JDBC,是一个支持普通 SQL 查询,存储过程和高级映射的基于 Java 的优秀持久层框架。MyBatis 与 JDBC 相比,减少了 50% 以上的代码量。并且满足高并发和高响应的要求,所以它成为最流行的 Java 互联网持久框架。
在移动互联网时代,MyBatis 成为了目前互联网 Java 持久框架的首选。
Mybatis 的优缺点?
优点:
简单易学:本身就很小且简单。没有任何第三方依赖,易于学习,易于使用,通过文档和源代码,可以比较完全的掌握它的设计思路和实现。
灵活:mybatis不会对应用程序或者数据库的现有设计强加任何影响。 SQL写在xml里,便于统一管理和优化。
解除SQL与程序代码的耦合:通过提供DAL层,将业务逻辑和数据访问逻辑分离,使系统的设计更清晰,更易维护,更易单元测试。SQL和代码的分离,提高了可维护性。
提供映射标签,支持对象与数据库的orm字段关系映射。提供xml标签,支持编写动态SQL。
缺点:
SQL语句依赖于数据库,导致数据库移植性差,不能更换数据库。
编写SQL语句时工作量很大,尤其是字段多、关联表多时,更是如此。
Mybatis 逆向工程
1、创建数据库名:mybatis_study
对着数据库连接鼠标右键“新建数据库”
输入数据库名,选择字符集 utf8mb4(如果是互联网项目,优先选择 utf8mb4,可以存放 emoji 表情等特殊符号。)。
然后我们创建一个学生表:t_student
CREATE TABLE `t_student` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`student_no` varchar(50) DEFAULT NULL COMMENT '学号',
`student_name` varchar(50) DEFAULT NULL COMMENT '学生姓名',
`introduce` varchar(255) DEFAULT NULL COMMENT '自我介绍',
PRIMARY KEY (`id`),
KEY `student_no` (`student_no`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
2、创建新的 Maven 工程:MybatisStudy
pom.xml 配置如下:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.study</groupId>
<artifactId>MybatisStudy</artifactId>
<version>1.0-SNAPSHOT</version>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
</properties>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.0.8.RELEASE</version>
</parent>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- 数据库MySQL 依赖包 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.48</version>
</dependency>
<!-- mybatis 依赖包 -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.4.6</version>
</dependency>
<!-- 该 starter 会扫描配置文件中的 DataSource,然后自动创建使用该 DataSource 的 SqlSessionFactoryBean,并注册到 Spring 上下文中 -->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.0.0</version>
</dependency>
<!-- 阿里巴巴的druid数据库连接池 -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid-spring-boot-starter</artifactId>
<version>1.1.20</version>
</dependency>
</dependencies>
<build>
<plugins>
<!-- mybatis generator 自动生成代码插件 -->
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.7</version>
<configuration>
<configurationFile>${basedir}/src/main/resources/mybatis-generator.xml</configurationFile>
<overwrite>true</overwrite>
<verbose>true</verbose>
</configuration>
</plugin>
</plugins>
</build>
</project>
说明:
①
我们在 pom.xml 配置里引入“org.mybatis.spring.boot”依赖,SpringBoot 在启动的时候,会自动检测现有的 DataSource 配置,然后创建并注册 SqlSessionFactory 实例,该实例使用 SqlSessionFactoryBean 将该 DataSource 作为输入进行传递,然后创建 SqlSessionTemplate 实例,自动扫描 mapper 文件,然后注入到 Spring 上下文中(这个后续博客会用到)。
pom.xml 里增加了 mysql-connector-java 的依赖,主要是为了下载 mysql 的驱动包。在左边的 External Libraries 里可以看到有这个依赖。
②我们对着 mysql-connector-java-5.1.48.jar 鼠标右键,找到【Show in Explorer】,会自动帮我们把该 jar 包所在的文件目录打开。
③我们复制该 jar 包,粘贴到项目的 resources 目录下,方便使用。
如图:
④pom.xml 里增加了 mybatis-generator-maven-plugin 的依赖,会在右边的 Maven 插件里生成对应的 Maven 插件,方便我们使用 Mybatis 的插件管理。
同时,还有一段配置文件的代码:
${basedir}/src/main/resources/mybatis-generator.xml
⑤因此,我们在项目的 resources 目录下,创建一个 mybatis-generator.xml 文件。可以对着 resources 目录鼠标右键,New 一个 Mybatis 配置文件,如图:
这时候,会默认帮我们生成一个 mybatis 的配置文件,完整的配置如下(后面有具体说明如何修改配置):
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<!-- 配置生成器 -->
<generatorConfiguration>
<!-- 需要额外加载的依赖包,location属性指明加载jar/zip包的全路径。可以复制本地仓库的 jar 包粘贴到项目中 -->
<classPathEntry location="src/main/resources/mysql-connector-java-5.1.48.jar"/>
<!--
context:生成一组对象的环境
id:必选,上下文id,用于在生成错误时提示
defaultModelType:指定生成对象的样式
1,conditional:类似hierarchical;
2,flat:所有内容(主键,blob)等全部生成在一个对象中;
3,hierarchical:主键生成一个XXKey对象(key class),Blob等单独生成一个对象,其他简单属性在一个对象中(record class)
targetRuntime:
1,MyBatis3:默认的值,生成基于MyBatis3.x以上版本的内容,包括XXXBySample;
2,MyBatis3Simple:类似MyBatis3,只是不生成XXXBySample;
introspectedColumnImpl:类全限定名,用于扩展MBG
-->
<context id="mysql" defaultModelType="hierarchical" targetRuntime="MyBatis3Simple">
<!-- 自动识别数据库关键字,默认false,如果设置为true,根据SqlReservedWords中定义的关键字列表;
一般保留默认值,遇到数据库关键字(Java关键字),使用columnOverride覆盖
-->
<property name="autoDelimitKeywords" value="false"/>
<!-- 生成的Java文件的编码 -->
<property name="javaFileEncoding" value="UTF-8"/>
<!-- 格式化java代码 -->
<property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
<!-- 格式化XML代码 -->
<property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>
<!-- beginningDelimiter和endingDelimiter:指明数据库的用于标记数据库对象名的符号,比如ORACLE就是双引号,MYSQL默认是`反引号; -->
<property name="beginningDelimiter" value="`"/>
<property name="endingDelimiter" value="`"/>
<property name="useActualColumnNames" value="false"/>
<!-- 使用这个配置链接数据库 -->
<jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/mybatis_study"
userId="root"
password="root">
<property name="useUnicode" value="true"/>
<property name="characterEncoding" value="UTF-8"/>
<property name="serverTimezone" value="UTC"/>
<!-- 这里面可以设置property属性,每一个property属性都设置到配置的Driver上 -->
</jdbcConnection>
<!-- java模型创建器,是必须要的元素
负责:1,key类(见context的defaultModelType);2,java类;3,查询类
targetPackage:生成的类要放的包,真实的包受enableSubPackages属性控制;
targetProject:目标项目,指定一个存在的目录下,生成的内容会放到指定目录中,如果目录不存在,MBG不会自动建目录
-->
<!-- 根据实际应用修改自动生成实体类文件的路径 -->
<javaModelGenerator targetPackage="com.study.entity.template" targetProject="src/main/java">
<!-- for MyBatis3/MyBatis3Simple
自动为每一个生成的类创建一个构造方法,构造方法包含了所有的field;而不是使用setter;
-->
<property name="constructorBased" value="false"/>
<!-- 在targetPackage的基础上,根据数据库的schema再生成一层package,最终生成的类放在这个package下,默认为false -->
<property name="enableSubPackages" value="true"/>
<!-- for MyBatis3 / MyBatis3Simple
是否创建一个不可变的类,如果为true,
那么MBG会创建一个没有setter方法的类,取而代之的是类似constructorBased的类
-->
<property name="immutable" value="false"/>
<!-- 设置是否在getter方法中,对String类型字段调用trim()方法 -->
<property name="trimStrings" value="false"/>
</javaModelGenerator>
<!-- 生成SQL map的XML文件生成器,
注意,在Mybatis3之后,我们可以使用mapper.xml文件+Mapper接口(或者不用mapper接口),
或者只使用Mapper接口+Annotation,所以,如果 javaClientGenerator配置中配置了需要生成XML的话,这个元素就必须配置
targetPackage/targetProject:同javaModelGenerator
-->
<!-- 生成的 mapper 文件存放路径 -->
<sqlMapGenerator targetPackage="mapper.template" targetProject="src/main/resources">
<!-- 在targetPackage的基础上,根据数据库的schema再生成一层package,最终生成的类放在这个package下,默认为false -->
<property name="enableSubPackages" value="true"/>
</sqlMapGenerator>
<!-- 对于mybatis来说,即生成Mapper接口,注意,如果没有配置该元素,那么默认不会生成Mapper接口
targetPackage/targetProject:同javaModelGenerator
type:选择怎么生成mapper接口(在MyBatis3/MyBatis3Simple下):
1,ANNOTATEDMAPPER:会生成使用Mapper接口+Annotation的方式创建(SQL生成在annotation中),不会生成对应的XML;
2,MIXEDMAPPER:使用混合配置,会生成Mapper接口,并适当添加合适的Annotation,但是XML会生成在XML中;
3,XMLMAPPER:会生成Mapper接口,接口完全依赖XML;
注意,如果context是MyBatis3Simple:只支持ANNOTATEDMAPPER和XMLMAPPER
-->
<javaClientGenerator type="XMLMAPPER" targetPackage="com.study.dao.templete" targetProject="src/main/java">
<!-- 在targetPackage的基础上,根据数据库的schema再生成一层package,最终生成的类放在这个package下,默认为false -->
<property name="enableSubPackages" value="true"/>
<!-- 可以为所有生成的接口添加一个父接口,但是MBG只负责生成,不负责检查
<property name="rootInterface" value=""/>
-->
</javaClientGenerator>
<!-- 选择一个table来生成相关文件,可以有一个或多个table,必须要有table元素
选择的table会生成一下文件:
1,SQL map文件
2,生成一个主键类;
3,一个用户生成动态查询的条件类(selectByExample, deleteByExample),可选;
4,Mapper接口(可选)
tableName(必要):要生成对象的表名;
注意:大小写敏感问题。
可选:
1,domainObjectName:生成的domain类的名字,如果不设置,直接使用表名作为domain类的名字;
2,enableInsert(默认true):指定是否生成insert语句;
3,enableSelectByPrimaryKey(默认true):指定是否生成按照主键查询对象的语句(就是getById或get);
4,enableSelectByExample(默认true):MyBatis3Simple为false,指定是否生成动态查询语句;
5,enableUpdateByPrimaryKey(默认true):指定是否生成按照主键修改对象的语句(即update);
6,enableDeleteByPrimaryKey(默认true):指定是否生成按照主键删除对象的语句(即delete);
7,enableDeleteByExample(默认true):MyBatis3Simple为false,指定是否生成动态删除语句;
8,enableCountByExample(默认true):MyBatis3Simple为false,指定是否生成动态查询总条数语句(用于分页的总条数查询);
9,enableUpdateByExample(默认true):MyBatis3Simple为false,指定是否生成动态修改语句(只修改对象中不为空的属性);
10,modelType:参考context元素的defaultModelType,相当于覆盖;
-->
<table tableName="t_student" domainObjectName="StudentEntity">
<generatedKey column="id" sqlStatement="MySql"/>
</table>
</context>
</generatorConfiguration>
说明:
- xml 配置报红色:URI is not registered (Settings | Languages & Frameworks | Schemas and DTDs)
URI 是“统一资源定位符”的意思,字面意思是没有被注册。可以按照字面提示信息在 IDEA 的 File ——》Settings ——》Languages & Frameworks ——》Schemas and DTDs 下配置,把告警的 URI 复制,添加到 Ignored 忽略列表即可:
http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd
- 需要增加 mysql 的驱动 jar 包
- 需要修改数据库配置(根据实际环境修改)
- 实体类生成路径
- mybatis 的 mapper 文件路径
- dao层mapper生成路径
- 要生成逆向工程的表名(要同时生成多个表的话,就配置多个 table 节点)
3、配置完之后,双击 mybatis 的插件,运行。找到 IDEA 右边的 Maven Projects ——》Plugins ——》mybatis-generator——》mybatis-generator:generate。双击运行即可。
4、如果运行成功,会生成对应的实体类和 mapper 文件。
在 StudentEntityMapper.xml 文件我们看到有个 URI 警告,使用刚才说的方法去掉警告。
然后我们就可以把这些文件移动到我们需要的目录下了。如果多次生成,后面的会覆盖前面生成的文件。所以要谨慎生成,并且及时把生成的文件移动到指定的目录。
移动的时候,会提示我们把引用的地方也一起移动的。
OK,SpringBoot 整合 Mybatis 逆向工程讲解到这。可以收藏,以后项目用得着。