Mybatis --- 创建方法全局配置

Posted 2020-10-05 Lverson_tester

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Mybatis --- 创建方法全局配置相关的知识，希望对你有一定的参考价值。

总体介绍：MyBatis实际上是Ibatis3.0版本以后的持久化层框架【也就是和数据库打交道的框架】!

和数据库打交道的技术有:

原生的JDBC技术--->Spring的JdbcTemplate技术

这些工具都是提供简单的SQL语句的执行，但是和我们这里学的MyBatis框架还有些不同，

框架是一整套的东西，例如事务控制，查询缓存，字段映射等等。

我们用原生JDBC操作数据库的时候都会经过：
编写sql---->预编译---->设置参数----->执行sql------->封装结果

我们之所以不使用原生的JDBC工具，是因为这些工具：
1.功能简单，sql语句编写在java代码里面【一旦修改sql，就需要将java及sql都要重新编译！】这属于硬编码高耦合的方式。
2.我们希望有开发人员自己编写SQL语句，并且希望SQL语句与java代码分离，将SQL语句编写在xml配置文件中，实现数据表中记录到对象之间的映射！

sql和java编码分开，功能边界清晰，一个专注于业务，一个专注于数据，可以使用简单的XML或注解用于配置和原始映射，将接口和Java的POJO映射成数据库中的记录，完成业务+底层数据库的媒介！


1.MyBatis历史
     原是Apache的一个开源项目iBatis, 2010年6月这个项目由Apache Software Foundation 迁移
     到了 Google Code，随着开发团队转投Google Code 旗下， iBatis3.x正式更名为MyBatis ，代码于 2013年11月迁移到Github（下载地址见后）。

     iBatis一词来源于“internet”和“abatis”的组合，是一个基于Java的持久层框架。
     iBatis提供的持久层框架包括SQL Maps和Data Access Objects、（DAO）

2.MyBatis简介：
     MyBatis 是支持定制化 SQL、存储过程以及高级映射的优秀的持久层框架
     MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集
     MyBatis可以使用简单的XML或注解用于配置和原始映射，将接口和
     Java的POJO（Plain Old JavaObjects，普通的Java对象）映射成数据库中的记录.


3.为什么要使用MyBatis？
     MyBatis是一个半自动化的轻量级的持久化层框架。

     JDBC
          –     SQL夹在Java代码块里，耦合度高导致硬编码内伤
          –     维护不易且实际开发需求中sql是有变化，频繁修改的情况多见

     Hibernate和JPA
          –     长难复杂SQL，对于Hibernate而言处理也不容易
          –     内部自动生产的SQL，不容易做特殊优化。
          –     基于全映射的全自动框架，大量字段的POJO进行部分映射时比较困难。导致数据库性能下降。

     对开发人员而言，核心sql还是需要自己优化
     sql和java编码分开，功能边界清晰，一个专注业务、一个专注数据。


4.去哪里找MyBatis？
     https://github.com/mybatis/mybatis-3/
     或者在百度直接搜索mybatis，然后找到github下的地址下载即可！

写一个 MyBatis 的 HelloWorld：

- 创建数据库及数据表并插入数据

- 创建一个动态WEB工程，然后创建与上述数据表对应的实体类

- [参考mybatis官方文档]加入需要的jar包[mybatis所需要的jar包，和数据库打交道的jar包，以及看打印日志所需要的log4j的jar包]：

1.log4j-1.2.17.jar 注意：log4j的jar包是需要log4j.xml文件的

2.mybatis-3.4.1.jar

3.mysql-connector-java-5.1.37-bin.jar

- 创建 mybatis-config.xml 文件并将 mybatis 文档中的内容复制过来,并将数据库配置信息换成自己的：

mybatis-config.xml 是总控制文件，EmployeeMapper.xml 是MyBatis的 sql映射文件，在里面也 sql 语句

所有的 sql映射文件都会写到总控文件中

<!DOCTYPE configuration  PUBLIC "-//mybatis.org//DTD Config 3.0//EN"  
"http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
      <properties resource="jdbc.properties"/>

      <environments default="development">
            <environment id="development">
                  <transactionManager type="JDBC" />
                  <dataSource type="POOLED">
                        <property name="driver" value="${jdbc.driver}" />
                        <property name="url" value="${jdbc.url}" />
                        <property name="username" value="${jdbc.username}" />
                        <property name="password" value="${jdbc.password}" />
                  </dataSource>
            </environment>
      </environments>

      <mappers>
            <mapper resource="com/neuedu/mapper/EmployeeMapper.xml" />
      </mappers>
</configuration>

- 创建测试用例,.复制mybatis官方文档代码，代码如下：

public class TestMyBatis {
      @Test
      public void test() {
            String resource = "mybatis-config.xml";
            InputStream inputStream = null;
            try {
                  inputStream = Resources.getResourceAsStream(resource);//从配置文件中读取一个流
            } catch (IOException e) {
                  e.printStackTrace();
            }
            //利用这个流创建一个sqlSessionFactory对象，也就是总控文件创建了这个对象
            SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
            //和数据库建立的一次会话，通过openSession，创建一个sqlsession对象
            SqlSession sqlsession = sqlSessionFactory.openSession();
            try {
                  //selectOne查询一条记录，第一个参数时sql语句的唯一标识，第二个参数时sql要用的参数
                  //为了确保唯一标识唯一，所以在前面写上namespace，因为namesapce唯一
                  //如果第二个参数"4"在数据库中找不到的话，不会报错，返回null
                  Object selectOne = sqlsession.selectOne("com.neuedu.MyBatis.EmployeeMapper.selectStudentById",4 );
                  System.out.println(selectOne);
            } finally {
                  sqlsession.close();
            }
      }
}

- 创建sql语句的映射文件EmployeeMapper.xml；

<mapper namespace="com.neuedu.MyBatis.EmployeeMapper">
<!--
      namespace：名称空间，随便起一个名，但是要唯一
      id：sql 语句的唯一标识
      #{id}：接收参数传递过来的id值
      resultType：将 sql语句返回成什么对象
 -->
      <select id="selectStudentById" resultType="com.neuedu.entity.Employee">
            select * from student where id = #{id}
      </select>
</mapper>

总结:

– 创建一张测试表

– 创建对应的javaBean

– 创建mybatis配置文件，sql映射文件

– 测试

/**

* 1.根据xml配置文件(全局配置文件)创建一个SqlSessionFactory对象

* 有数据源的一些运行环境信息

* 2.sql映射文件，配置了每一个sql，以及sql的封装规则等。

* 3.将sql映射文件注册在全局配置文件中

* 4.写代码：

* 1)根据全局配置文件得到SqlSessionFactory

* 2)使用sqlSession工厂，获取到sqlSession对象使用它来执行增删改查！

* sqlSession就是代表和数据库的一次会话!用完要关闭！

* 3)使用sql的唯一标识告诉MyBatis执行哪个sql。而sql都是保存

* 在sql映射文件中的。

上面这种开发方式是老版本的Mybatis使用者的开发方式！而新一批的Mybatis使用者都是使用接口的方法

HelloWorld----接口式编程

- 新创建一个 mapper包，里面包含 mapper接口，与 mapper.xml文件相对应

public interface EmployeeMapper {
      /*
       * 增删改查方法
       * */
      public Employee getEmployeeById(Integer id);

}

- 通过mapper.xml的 namespace 相关联

<mapper namespace="com.neuedu.mapper.EmployeeMapper">
<!--
      namespace：将sql映射文件和Mapper接口进行关联
      id：要和相对应的mapper接口的方法名保持一致
      #{id}：从参数中获取id
      resultType：将 sql语句返回成什么对象
 -->

      <!-- public Employee getEmployeeById(Integer id); -->
      <select id="getEmployeeById" resultType="com.neuedu.entity.Employee">
            select * from student where id = #{id}
      </select>

</mapper>

- sqlSession 对象表示服务器和数据库的一次会话，是一个非线程安全的，所以不能定义在类中，定义在类中，多线程的情况下会有多个线程共用，一次使用获取一次，保证时线程安全的

private SqlSessionFactory getSqlSessionFactory(){
     String resource = "mybatis-config.xml";
     InputStream inputStream = null;
     try {
           inputStream = Resources.getResourceAsStream(resource);//从配置文件中读取一个流
     } catch (IOException e) {
           e.printStackTrace();
     }
     //利用这个流创建一个sqlSessionFactory对象
     SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

     return sqlSessionFactory;
}

- 测试

@Test
public void test01(){
      //1.获取sqlSessionFactory对象
      SqlSessionFactory sqlSessionFactory = getSqlSessionFactory();
      //2.利用sqlSessionFactory创建一个session对象，表示和数据库的一次会话
      SqlSession session = sqlSessionFactory.openSession();
      //3.用session对象获取mapper接口的代理对象
      //因为sql映射文件给相应的接口创建了一个代理对象，所以mapper接口类不需要实现类
      EmployeeMapper mapper = session.getMapper(EmployeeMapper.class);
      //通过mapper接口的代理对象就可以对数据库进行增删改查操作
      Employee employee = mapper.getEmployeeById(4);
      System.out.println(employee);
      session.close();
}

以前都是需要为接口写一个实现类，但是此时，mybatis提供了接口可以与sql配置文件动态绑定！

如何将两者进行绑定？以前sql配置文件的namespace可以随便写，现在就不能随便写了，需要指定为接口的全限定名！

此时接口和sql配置文件做了绑定，还要将select标签的id和方法名进行绑定

总结：

1.接口式编程

原生: Dao ==================> DaoImpl

mybatis: xxMapper ================> xxMapper.xml

2.SqlSession代表和数据库的一次会话，用完必须关闭。

3.SqlSession和Connection一样，都是非线程安全的，每次使用都是应该去获取新的对象，不要将这个对象定义在类变量中使用！

4.mapper接口没有实现类，但是mybatis这个接口生成一个代理对象

<!--将接口与xml文件进行绑定 -->
EmployeeMapper employeeMapper = sqlSession.getMapper(EmployeeMapper.class);

5.两个重要的配置文件

- mybatis的全局配置文件（mybatis-config.xml）：包含数据库连接池信息，事务管理器信息等..系统运行环境信息。

- sql映射文件（EmployeeMapper.xml）：保存了每一个sql语句的映射信息。

Mybatis的全局配置文件

MyBatis 的配置文件包含了影响 MyBatis 行为甚深的设置（settings）和属性（properties）信息。文档的顶层结构顺序如下：

- configuration 配置

- properties 属性：加载properties文件

- settings 设置

- typeAliases 类型命名

- typeHandlers 类型处理器

- objectFactory 对象工厂

- plugins 插件

- environments 环境

- environment 环境变量

- transactionManager 事务管理器

- dataSource 数据源

- databaseIdProvider 数据库厂商标识

- mappers 映射器

dtd文档规定了以上顺序不能变

具体介绍：

1.configuration 为全局配置文件绑定dtd约束：

1）联网会自动绑定

2）没网的时候【/org/apache/ibatis/builder/xml/mybatis-3-config.dtd】：解压mybatis 的jar包然后在eclipse中绑定

Window-->Preference-->XML-->XML Catalog

2. properties属性

<configuration>
     <!--
          mybatis可以使用properties来引入外部properties配置文件的内容
          resource:引入类路径下的资源
          url:引入网络路径或者磁盘路径下的资源
     -->
     <properties resource="jdbc.properties"></properties>
          <environments default="development">
               <environment id="development">
                     <transactionManager type="JDBC"/>
                     <dataSource type="POOLED">
                          <property name="driver" value="${jdbc.driver}"/>
                          <property name="url" value="${jdbc.url}"/>
                          <property name="username" value="${jdbc.user}"/>
                           <property name="password" value="${jdbc.passowrd}"/>
                     </dataSource>
               </environment>
          </environments>
          <!-- 将我们写好的sql映射文件一定要注册到全局配置文件中，文件用/，类用.，也就是如果是class就用.分隔 -->
          <mappers>
                <mapper resource="EmployeeMapper.xml"/>
          </mappers>
</configuration>

3.settings包含很多重要的设置项

setting:用来设置每一个设置

- name：设置属性名

- value：设置属性值

<!-- settings标签可以设置多个属性值 -->
<settings>
      <!-- setting标签负责每一个属性的设置 -->
      <setting name="mapUnderscoreToCamelCase" value="true"/>
</settings>

- mapUnderscoreToCamelCase 可以将数据库中带下划线的名称，与类中驼峰式命名的名称对应起来

比如，在数据库中名称为 user_name，在实体类中名称为userName，value值是true的话，也可以对应上

4.typeAliases：起别名

<!-- typeAliases可以为多个类起别名 -->
<typeAliases>
      <!-- 别名处理器，可以为某个java类型设置别名
      默认是该类名的首字母小写,别名不区分大小写
      alias：可以通过该属性单独指定别名-->
      <!-- <typeAlias type="com.neuedu.entity.Employee" alias="asd"/> -->
      <!-- 用package可以批量为类起别名 -->
      <!-- 批量起别名的情况下，使用@Alias注解为某个实体类指定新的别名 -->
      <package name="com.neuedu.entity"/>
</typeAliases>

虽然有这么多的别名可以使用：但是建议还是使用全类名，看SQL语句是怎么被封装为JAVA 对象的时候简单！

5.typeHandlers：类型处理器

类型处理器：负责如何将数据库的类型和java对象类型之间转换的工具类

6.environments：环境们

<!--
    environments:环境们，mybatis可以配置多种环境，default指定使用某种环境。可以达到快速切换环境。
    environment:配置一个具体的环境信息；必须有两个标签；id代表当前环境的唯一标识
    transactionManager：事务管理器
    type:事务管理器的类型;type="[JDBC|MANAGED]"),这两个都是别名，在Configuration类中可以查看具体类！但是Spring对事务的控制才是最终的管理方案!
         当然也可以自定义事务管理器：只需要和人家一样实现TransactionFactory接口，type指定为全类名。
    dataSource:数据源
    type:type="[UNPOOLED|POOLED|JNDI]"
    自定义数据源：实现DataSourceFactory接口,type也是全类名

    但是我们也说了，无论是事务管理器的配置还是数据源的配置我们都会使用spring来做，这里只需要了解一下即可！
    -->
<environments default="development">
      <environment id="test">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                    <property name="driver" value="${jdbc.driver}"/>
                    <property name="url" value="${jdbc.url}"/>
                    <property name="username" value="${jdbc.user}"/>
                    <property name="password" value="${jdbc.passowrd}"/>
             </dataSource>
       </environment>
       <environment id="development">
             <transactionManager type="JDBC"/>
             <dataSource type="POOLED">
                    <property name="driver" value="${jdbc.driver}"/>
                    <property name="url" value="${jdbc.url}"/>
                    <property name="username" value="${jdbc.user}"/>
                    <property name="password" value="${jdbc.passowrd}"/>
             </dataSource>
        </environment>
</environments>

7.databaseIdProvider环境

MyBatis 可以根据不同的数据库厂商执行不同的语句

<databaseIdProvider type="DB_VENDOR">
      <property name="SQL Server" value="sqlserver"/>
      <property name="DB2" value="db2"/>
      <property name="Oracle" value="oracle"/>
      <property name="MySQL" value="mysql"/>
</databaseIdProvider>

Type： DB_VENDOR

– 使用MyBatis提供的VendorDatabaseIdProvider解析数据库厂商标识。也可以实现DatabaseIdProvider接口来自定义。

Property-name：数据库厂商标识

Property-value：为标识起一个别名，方便SQL语句使用

在mybatis的全局配置文件配置了这个之后，我们只需要在sql映射文件中通过在执行语句的标签上加一个属性databaseId即可!

databaseId 与 value 值对应

<select id="getEmployeeById" resultType="emp">
       select * from tbl_employee where id = #{id}
</select>
<select id="getEmployeeById" resultType="emp" databaseId="mysql">
       select * from tbl_employee where id = #{id}
</select>
<select id="getEmployeeById" resultType="emp" databaseId="oracle">
       select * from tbl_employee where id = #{id}
</select>

这样在执行不同数据库的时候，就会执行不同数据库的语句了

当然如上所示：当有指定了databaseId属性的和没有指定databaseId属性的，都有的情况下那就按着有指定databaseId属性的sql语句执行！

<environments default="development">
      <environment id="development">
            <transactionManager type="JDBC" />
            <dataSource type="POOLED">
                  <property name="driver" value="${jdbc.driver}" />
                  <property name="url" value="${jdbc.url}" />
                  <property name="username" value="${jdbc.username}" />
                  <property name="password" value="${jdbc.password}" />
            </dataSource>
      </environment>

      <environment id="dev_oracle">
            <transactionManager type="JDBC" />
            <dataSource type="POOLED">
                  <property name="driver" value="${jdbc.driver}" />
                  <property name="url" value="${jdbc.url}" />
                  <property name="username" value="${jdbc.username}" />
                  <property name="password" value="${jdbc.password}" />
            </dataSource>
      </environment>
</environments>

8.mapper映射

<!-- mappers:将sql映射注册到全局配置中 -->
     <mappers>
     <!-- mapper：注册一个sql映射
          注册配置文件：
               resource:引用类路径下的sql映射文件  mybatis/mapper/EmployeeMapper.xml
               url:引用网络路径下或者磁盘路径下的sql映射文件  url="file:///var/mappers/AuthorMapper.xml"

          注册接口
               class:引用(注册)接口：
                    1.有sql映射文件，映射文件名必须和接口同名，并且放在与接口同一个目录下（可以在conf下见一个同名的包，放在里面）；
                    2.没有sql映射文件，所有的sql都是利用注解写在接口方法上；
                    推荐：
                        比较重要的，复杂的Dao接口我们来写sql映射文件
                        不重要，见到的Dao接口为了开发快速可以使用注解
      -->
      <!-- <mapper class="com.neuedu.mapper.EmployeeMapper"/> -->
     <mapper resource="com/neuedu/mapper/EmployeeMapper.xml"/>
      <!-- 批量注册：
           对于sql 映射文件和接口需要保证在同一个包下，且名字必须相同 -->
      <package name="com.neuedu.mapper"/>
</mappers>

class：当映射文件和接口文件不在同一目录下时，用注解

但是不建议使用注解，建议使用sql映射文件

public interface EmployeeMapper {
      /*
       * 增删改查方法
       * */
      @Select("select * from student where id = #{id}")
      public Employee getEmployeeById(Integer id);

}

9.最后就是全局配置文件中标签实际上是有顺序的！

使用自定义的数据源

- 导包：C3P0

- 新建类继承 UnpooledDataSourceFactory

- 提供无参构造器，并将 dataSource属性设置成想要连接的数据库连接池

public class C3P0DateSource extends UnpooledDataSourceFactory{

      public C3P0DateSource() {
            this.dataSource = new ComboPooledDataSource();
      }
}

- 在总控文件 mybatis-config.xml 中修改 dataSource 路径

将 property 中的 name 换做 C3P0 中的写法

<environments default="development">
      <environment id="development">
            <transactionManager type="JDBC" />
            <dataSource type="com.neuedu.datasource.C3P0DateSource">
                  <property name="driverClass" value="${jdbc.driver}" />
                  <property name="jdbcUrl" value="${jdbc.url}" />
                  <property name="user" value="${jdbc.username}" />
                  <property name="password" value="${jdbc.password}" />
            </dataSource>
      </environment>
</environments>

以上是关于Mybatis --- 创建方法全局配置的主要内容，如果未能解决你的问题，请参考以下文章

MyBatis框架—动态 SQL配置文件事务

[mybatis]Getting Started

MyBatis基本入门篇

MyBatis-全局配置文件

MyBatis全局配置文件mybatis-config.xml如何写

1MyBatis 快速入门