MyBatis之xml配置大全

向右看齐 2022-12-16 04:00 72阅读 0赞

**Table of Contents**

环境配置（environments）

属性（properties）

设置（settings）（还有很多配置可以看官网）

插件（plugins）

映射器（mappers）

设置日志输出

--------------------

注意点：mybatis配置文件中的书写顺序

<?xml version="1.0" encoding="UTF-8"?>
    <configuration>
    	<properties/>
    	<settings/>
    	<typeAliases/> 
    	<typeHandlers/> 
    	<objectFactory/>  
    	<plugins/> 
    	<environments> 
    		<environment> 
    		<transactionManager/> 
    			<dataSource/> 
    		</environment>
    	</environments>
    	<databaseidProvider/>  
    	<mappers/> 
    </configuration>

主配置文件之 mybatis-config.xml

<?xml version="1.0" encoding="UTF-8" ?>
    <!DOCTYPE configuration
            PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
            "http://mybatis.org/dtd/mybatis-3-config.dtd">
    <configuration>
        
        <environments default="development">
            <environment id="development">
                <transactionManager type="JDBC"/>
                <dataSource type="POOLED">
                    <property name="driver" value="${driver}"/>
                    
                    <property name="url" value="${url}"/>
                    <property name="username" value="${username}"/>
                    <property name="password" value="${password}"/>
                </dataSource>
            </environment>
        </environments>
        
        <mappers>
            <mapper resource="org/mybatis/example/BlogMapper.xml"/>
        </mappers>
    </configuration>

Mybatis工具类

/*
     * MyBatis连接工具类
     */
    public class MyBatisUtil {
    	private static SqlSessionFactory factory;
    	//加载mybatis的配置文件
    	static{
    		try {
    			InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
    			factory = new SqlSessionFactoryBuilder().build(is);
    		} catch (IOException e) {
    			e.printStackTrace();
    		}
    		
    	}
    	//获得Sqlsession对象
    	public static SqlSession getSqlSession(){
    		return factory.openSession(true);
    	}
    	//关流
    	public static void close(SqlSession sqlSession){
    		//sqlSession.commit();
    		if(sqlSession!=null){
    			sqlSession.close();
    		}
    	}
    	
    }

mybatis之mapper.xml配置

<?xml version="1.0" encoding="UTF-8" ?>
    <!DOCTYPE mapper
      PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
      "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
    <mapper namespace="com.gong.mapper.StudentMapper">
    	<resultMap type="student" id="studentShowMap">
    		<id property="stuId" column="stuId"/>
    		<association property="clazz" javaType="clazz">
    			<id property="clazzId" column="clazzId"/>
    			<result property="clazzName" column="clazzName"/>
    		</association>
    	</resultMap>
    	
    	<select id="show" resultMap="studentShowMap">
    		SELECT student.*,clazz.`clazzName` FROM student 
    		INNER JOIN clazz  ON student.stuclazzId=clazz.clazzId 
    		<where>
    			<if test="stuName!=null and stuName!=''">
    				stuName like concat('%',#{stuName},'%')
    			</if>
    			<if test="stuTel!=null and stuTel!=''">
    				and stuTel like concat('%',#{stuTel},'%')
    			</if>
    			<if test="stuClazzId!=null and stuClazzId!=''">
    				and stuClazzId = #{stuClazzId}
    			</if>
    		</where>
    		LIMIT #{start},#{size}
    	</select>

测试类

//注意：增删改需要提交事务，sqlsession.commit();
    @Test
    public void test(){
        //获取sqlSession对象
        SqlSession sqlSession = MyBatisUtils.getSqlSession();
        
        //执行mapper文件映射的接口方法
        UseDao userDao = sqlSession。getMapper(UserDao.class);
        List<User> userList = userDao.getUserList();
        
        for(User user : userList){
            System.out.println(user);
          }
        
        //关闭SqlSession
        sqlSession.close();
    
    }

在真实开发中可能会遇到数据库中的表字段特别多，这就导致了对应实体类的属性特别多，如果这时候只需要传实体类中的一个或少数参数即可完成sql语句的执行，那传这个实体类就会显得有点麻烦，这时候可以考虑使用map来传递数据

**配置解析：**

### 环境配置（environments） ###

MyBatis 可以配置成适应多种环境，这种机制有助于将 SQL 映射应用于多种数据库之中， 现实情况下有多种理由需要这么做。例如，开发、测试和生产环境需要有不同的配置；或者想在具有相同 Schema 的多个生产数据库中使用相同的 SQL 映射。还有许多类似的使用场景。

**不过要记住：尽管可以配置多个环境，但每个 SqlSessionFactory 实例只能选择一种环境。**

**事务管理器（transactionManager）**

在 MyBatis 中有两种类型的事务管理器（也就是 type="\[JDBC|MANAGED\]"）：

*  JDBC – 这个配置直接使用了 JDBC 的提交和回滚设施，它依赖从数据源获得的连接来管理事务作用域。
 *  MANAGED – 这个配置几乎没做什么。它从不提交或回滚一个连接，而是让容器来管理事务的整个生命周期（比如 JEE 应用服务器的上下文）。 默认情况下它会关闭连接。然而一些容器并不希望连接被关闭，因此需要将 closeConnection 属性设置为 false 来阻止默认的关闭行为。

**数据源（dataSource）**

dataSource 元素使用标准的 JDBC 数据源接口来配置 JDBC 连接对象的资源。

*  大多数 MyBatis 应用程序会按示例中的例子来配置数据源。虽然数据源配置是可选的，但如果要启用延迟加载特性，就必须配置数据源。

有三种内建的数据源类型（也就是 type="\[UNPOOLED|POOLED|JNDI\]"）

### 属性（properties） ###

这些属性可以在外部进行配置，并可以进行动态替换。你既可以在典型的 Java 属性文件中配置这些属性，也可以在 properties 元素的子元素中设置。例如：

<properties resource="org/mybatis/example/config.properties">
       //这里的两句话不是必须的,如果写了也会优先使用外部引入文件中的属性
      <property name="username" value="dev_user"/>
      <property name="password" value="F2Fa3!33TYyg"/>
    </properties>

设置好的属性可以在整个配置文件中用来替换需要动态配置的属性值。比如:

**类型别名（typeAliases）**

**给指定类起别名**

**给指定包起别名(默认以实体类的首字母小写)**

**用注解起别名**

@Alias("user")
    public class User {
        ...
    }

mybatis中常用别名

<table> 
 <thead> 
  <tr> 
   <th>别名</th> 
   <th>映射的类型</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>_byte</td> 
   <td>byte</td> 
  </tr> 
  <tr> 
   <td>_long</td> 
   <td>long</td> 
  </tr> 
  <tr> 
   <td>_short</td> 
   <td>short</td> 
  </tr> 
  <tr> 
   <td>_int</td> 
   <td>int</td> 
  </tr> 
  <tr> 
   <td>_integer</td> 
   <td>int</td> 
  </tr> 
  <tr> 
   <td>_double</td> 
   <td>double</td> 
  </tr> 
  <tr> 
   <td>_float</td> 
   <td>float</td> 
  </tr> 
  <tr> 
   <td>_boolean</td> 
   <td>boolean</td> 
  </tr> 
  <tr> 
   <td>string</td> 
   <td>String</td> 
  </tr> 
  <tr> 
   <td>byte</td> 
   <td>Byte</td> 
  </tr> 
  <tr> 
   <td>long</td> 
   <td>Long</td> 
  </tr> 
  <tr> 
   <td>short</td> 
   <td>Short</td> 
  </tr> 
  <tr> 
   <td>int</td> 
   <td>Integer</td> 
  </tr> 
  <tr> 
   <td>integer</td> 
   <td>Integer</td> 
  </tr> 
  <tr> 
   <td>double</td> 
   <td>Double</td> 
  </tr> 
  <tr> 
   <td>float</td> 
   <td>Float</td> 
  </tr> 
  <tr> 
   <td>boolean</td> 
   <td>Boolean</td> 
  </tr> 
  <tr> 
   <td>date</td> 
   <td>Date</td> 
  </tr> 
  <tr> 
   <td>decimal</td> 
   <td>BigDecimal</td> 
  </tr> 
  <tr> 
   <td>bigdecimal</td> 
   <td>BigDecimal</td> 
  </tr> 
  <tr> 
   <td>object</td> 
   <td>Object</td> 
  </tr> 
  <tr> 
   <td>map</td> 
   <td>Map</td> 
  </tr> 
  <tr> 
   <td>hashmap</td> 
   <td>HashMap</td> 
  </tr> 
  <tr> 
   <td>list</td> 
   <td>List</td> 
  </tr> 
  <tr> 
   <td>arraylist</td> 
   <td>ArrayList</td> 
  </tr> 
  <tr> 
   <td>collection</td> 
   <td>Collection</td> 
  </tr> 
  <tr> 
   <td>iterator</td> 
   <td>Iterator</td> 
  </tr> 
 </tbody> 
</table>

### 设置（settings）（还有很多配置可以看官网） ###

这是 MyBatis 中极为重要的调整设置，它们会改变 MyBatis 的运行时行为。 下表描述了设置中各项设置的含义、默认值等。

<table> 
 <thead> 
  <tr> 
   <th>设置名</th> 
   <th>描述</th> 
   <th>有效值</th> 
   <th>默认值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>cacheEnabled</td> 
   <td>全局性地开启或关闭所有映射器配置文件中已配置的任何缓存。</td> 
   <td>true | false</td> 
   <td>true</td> 
  </tr> 
  <tr> 
   <td>lazyLoadingEnabled</td> 
   <td>延迟加载的全局开关。当开启时，所有关联对象都会延迟加载。 特定关联关系中可通过设置&nbsp;<code>fetchType</code>&nbsp;属性来覆盖该项的开关状态。</td> 
   <td>true | false</td> 
   <td>false</td> 
  </tr> 
 </tbody> 
</table>

### 插件（plugins） ###

mybatis-generator-core

mybatis-plus（可以简化mybatis代码，自动生成增删改查业务）

通用mapper

### 映射器（mappers） ###

<mappers>
      <mapper resource="org/mybatis/builder/AuthorMapper.xml"/>
      <mapper resource="org/mybatis/builder/BlogMapper.xml"/>
      <mapper resource="org/mybatis/builder/PostMapper.xml"/>
    </mappers>
    
    <mappers>
      <mapper url="file:///var/mappers/AuthorMapper.xml"/>
      <mapper url="file:///var/mappers/BlogMapper.xml"/>
      <mapper url="file:///var/mappers/PostMapper.xml"/>
    </mappers>
    
    <mappers>
      <mapper class="org.mybatis.builder.AuthorMapper"/>
      <mapper class="org.mybatis.builder.BlogMapper"/>
      <mapper class="org.mybatis.builder.PostMapper"/>
    </mappers>
    
    <mappers>
      <package name="org.mybatis.builder"/>
    </mappers>

### 设置日志输出 ###

如果使用log4j需要导入log4j的依赖，编写log4j.properties

[https://blog.csdn.net/qq\_47759220/article/details/109204363][https_blog.csdn.net_qq_47759220_article_details_109204363]

private static Logger log = Logger.getLogger(当前类.class);

### 设置数据库字段和Java属性名自动转换 ###

可以自动把数据库中带\_的字段跟pojo实体类中驼峰命名规则的属性相互转换

### Mapper文件之sql片段的使用 ###

主要作用于提取重复的sql语句

<mapper namespace="com.gong.mappper.userMapper">
        <sql id="name_age">
            <if test="name!=null">
                and name=#{name}
            </if>
            <if test="age!=null">
                and age=#{age}
            </if>
        </sql>
        <select id="getUser" resultType="user">
            select * from user
            <where>
                <include refid="name_age"></include>
            </where>
        </select>
    </mapper>

[https_blog.csdn.net_qq_47759220_article_details_109204363]: https://blog.csdn.net/qq_47759220/article/details/109204363