MyBatis使用小结

1. MyBatis

1.1. 作用

MyBatis是持久层框架，它是支持JDBC的！简化了持久层开发！

使用MyBatis时，只需要通过接口指定数据操作的抽象方法，然后配置与之关联的SQL语句，即可完成！

持久化存储：在程序运行过程中，数据都是在内存（RAM，即内存条）中的，内存中的数据不是永久存储的，例如程序可以对这些数据进行销毁，或者由于断电也会导致内存中所有数据丢失！而把数据存储到硬盘中的某个文件中，会使得这些数+据永久的存储下来，常见做法是存储到数据库中，当然，也可以使用其它技术把数据存储到文本文件、XML文件等其它文件中！

MyBatis是一个独立的框架，即只添加该依赖就可以实现持久层编程，但是，开发过程相对比较繁琐，而实际应用中，通常会与Spring、SpringMVC一起使用，整合使用时，可以简化大量的配置，使得开发更加简便！整合时，还需要添加相关依赖：

整合的SSM框架是基于JDBC的，所以，还需要添加spring-jdbc的依赖：

添加以上依赖时，直接将此前的spring-webmvc的依赖代码复制一次，将spring-webmvc改成spring-jdbc即可！凡是Spring官方（Group ID是org.springframework）推出的以spring-作为前缀的依赖，必须使用相同的版本，否则，可能存在不兼容的风险！

1.2 配置数据源

在src\main\resources下创建db.properties文件，用于配置与数据库连接相关的信息：

url=jdbc:mysql://localhost:3306/tedu_mybatis?useUnicode=true&characterEncoding=utf8
driver=com.mysql.jdbc.Driver
username=root
password=root
initialSize=2
maxActive=10

以上配置的值以自己使用的数据库为准！

以上配置需要被应用到项目中，则在Spring的配置中通过<util:properties />可以读取该文件：

<!-- 读取db.properties -->
<util:properties id="dbconfig"
	location="classpath:db.properties" />

最后，需要把这些配置应用到数据源（数据库连接池）中，当前项目使用的是Apache的commons-dbcp，则对应的数据源是BasicDataSource类：

<!-- 配置数据源 -->
<bean id="dataSource" 
	class="org.apache.commons.dbcp.BasicDataSource">
	<property name="url" 
		value="#{dbconfig.url}" />
	<property name="driverClassName" 
		value="#{dbconfig.driver}" />
	<property name="username" 
		value="#{dbconfig.username}" />
	<property name="password" 
		value="#{dbconfig.password}" />
	<property name="initialSize" 
		value="#{dbconfig.initialSize}" />
	<property name="maxActive" 
		value="#{dbconfig.maxActive}" />
</bean>

完成以上配置后，可以测试到目前为止的配置是否正确，做法就是：获取BasicDataSource的对象，调用它的getConnection()方法，尝试在Java程序中获取与数据库的连接，如果能够正常连接，则配置无误，如配置有误，将无法获取连接：

@Test
public void getConnection() throws SQLException {
	AbstractApplicationContext ac
		= new ClassPathXmlApplicationContext(
			"spring.xml");
	
	BasicDataSource ds
		= ac.getBean("dataSource", BasicDataSource.class);
	
	Connection conn = ds.getConnection();
	System.out.println(conn);
	
	ac.close();
}

1.3 通过MyBatis插入数据

MyBatis的编码模式是：

1. 创建接口，并声明数据访问的抽象方法；
2. 配置与抽象方法对应的XML映射。

首先，创建cn.tedu.mybatis.entity.User实体类，并添加与t_user数据表匹配的属性。

通常，每张数据表都有一个与之匹配的实体类！

创建cn.tedu.mybatis.mapper.UserMapper接口，并在接口中声明抽象方法：

Integer insert(User user);

在MyBatis中，执行insert/update/delete操作时，均返回受影响的行数，所以，设计抽象方法时，如果对应的是这几种操作，返回值均设计为Integer类型。

通常，一个完整的项目中，会存在许多MyBatis的映射文件，为了便于管理，会在src\main\resources下创建一个名为mappers的文件夹，然后，下载共享的SomeMapper.zip，将解压得到的XML文件复制到刚才创建的mappers文件夹中：

所有映射文件中，根节点都是<mapper>节点，且该节点必须配置名为namespace的属性，属性值是对应的Java接口，例如：

<mapper namespace="cn.tedu.mybatis.mapper.UserMapper">
</mapper>

经过以上配置，指定了XML映射文件与接口文件的对应关系。

然后，在该文件内部，使用各级子节点配置与抽象方法的对应关系，子节点名称的选取，取决于要执行的操作的类型，例如要执行的数据操作是insert类型，则使用<insert>节点，这些节点都必须指定id属性，属性值是与之对应的抽象方法的方法名：

<!-- id：抽象方法的名称 -->
<insert id="insert">
</insert>

在<insert>节点中，添加parameterType属性，用于指定参数的类型，即抽象方法中的参数类型：

<!-- id：抽象方法的名称 -->
<!-- parameterType：抽象方法中的参数的类型 -->
<insert id="insert"
	parameterType="cn.tedu.mybatis.entity.User">
</insert>

然后，在节点内部，编写需要执行的SQL语句：

<!-- id：抽象方法的名称 -->
<!-- parameterType：抽象方法中的参数的类型 -->
<insert id="insert"
	parameterType="cn.tedu.mybatis.entity.User">
	INSERT INTO t_user (
		username, password, 
		age, phone, email
	) VALUES (
		#{username}, #{password}, 
		#{age}, #{phone}, #{email}
	)
</insert>

执行SQL语句时的参数值均使用#{}类似的语法，其中的名称是User类中的属性名：

1.4 最后的配置

首先，需要配置SqlSessionFactoryBean，通过它指定数据源与XML映射的文件位置：

<!-- SqlSessionFactoryBean -->
<bean class="org.mybatis.spring.SqlSessionFactoryBean">
	<!-- 指定数据源，值为以上配置的数据源 -->
	<property name="dataSource"
		ref="dataSource" />
	<!-- 指定XML映射文件的位置 -->
	<property name="mapperLocations"
		value="classpath:mappers/*.xml" />
</bean>

以上配置中，XML映射文件的位置使用了mappers/*.xml，即：在mappers文件夹下的所有XML文件都应该是MyBatis的映射文件，所以，后续使用时，不可以在这个文件夹中存放其它XML文件。

然后，还需要配置MapperScannerConfigurer，用于指定接口文件在哪里：

<!-- MapperScannerConfigurer -->
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
	<!-- 指定接口文件的位置 -->
	<property name="basePackage"
		value="cn.tedu.mybatis.mapper" />
</bean>

关于配置

使用MyBatis添加了一些新的依赖，及一些配置，这些属于固定的一次性操作，在后续的项目中，每个项目中只需要做1次即可。

关于这些配置，需要记住配置的作用，及可能需要修改的位置，至少包括：

1. db.properties的文件名，因为<util:properties>需要使用它；
2. 在db.properties中配置的值，重点是数据库名称、访问数据库的密码，在更换项目或更换计算机后都可能需要调整；
3. 在配置SqlSessionFactoryBean时指定的映射文件的位置；
4. 在配置MapperScannerConfigurer时指定的接口文件所在的包；

关于开发

1. 每张数据表，都应该有1个与之对应的实体类；
2. 每种数据（视为每个实体类）的处理都应该有对应的接口文件，例如项目中有User实体类，则应该有UserMapper接口；
3. 在接口中声明抽象方法时，如果最终将执行insert/delete/update操作，返回值类型应该是Integer；
4. 每个持久层接口，都应该有对应的XML映射文件，例如有UserMapper.java接口，就应该有UserMapper.xml文件；
5. 在配置XML文件内部，根据执行操作选择节点，如果执行的是insert操作，则通过<insert>节点进行配置；
6. 在XML映射中，每个节点都必须配置id属性，取值是接口中抽象方法的名称，由于id具有唯一的特性，所以，在接口中声明抽象方法时，不要使用重载；
7. 在配置SQL语句时，使用#{}表示预编译时的?对应的值，括号中的名称是参数名称，或参数对象中的属性名称；
8. 当执行delete/update时，配置的节点不需要指定parameterType属性。

2. 在MyBatis中查询数据

使用MyBatis执行查询操作时，抽象方法的设计中，返回值应该根据查询需求来决定，例如查询用户列表时，可以使用List<User>作为返回值类型，查询某个用户时，可以使用User作为返回值类型，查询的是计数等操作时，可以使用Integer作为返回值类型。

其实，无论执行什么样的查询，MyBatis的查询结果都是List集合，只不过，如果抽象方法声明的不是集合，而是具体的某个类型，例如User时，MyBatis会尝试从集合中获取第1个元素作为返回值！

查询是可能失败，即没有匹配的数据，在这种情况下，如果返回值是List集合，则返回的是空集合（集合对象是存在的，但是集合中没有任何元素），如果返回值是某个类型，则返回null。

在配置的XML映射中，每个查询对应的都是<select>节点，该节点必须配置resultType或resultMap属性，用于表示查询结果的类型（即使返回值类型是Integer也必须配置）！

如果返回结果是User对象，则resultType的值是User类的全名，如果返回结果是List，其resultType也是User类的全名，而不是List的全名！

在MyBatis中，其实只支持1个参数，并且，Java源文件编译为class字节码文件后，也会丢失参数名称，所以，需要为每一个参数添加@Param注解：

Integer changePassword(
	@Param("id") Integer arg0, 
	@Param("password") String arg1);

则MyBatis会把这些参数全部封装在一个Map中，注解中的名称就是每个参数的Key，后续，在配置映射时，在#{}中填入的也就是注解的名称，即各参数在Map中的Key：

3. 插入数据时获取数据自增长的id

在配置映射时，为<insert>节点添加2个属性：useGeneratedKeys="true"表示需要获取自动生成的键，通常就是数据表中的主键字段，即id字段，然后配置keyProperty="id"，表示获取到的键的值（即自增长的id值）将要封装到哪个属性中（即实体类中的属性名）：

经过以上配置后，当成功插入数据时，就会获取到该数据的自增长的id值，并且，会将值封装到参数对象中，即：调用Integer insert(User user)方法时，假设使用user1作为调用时的参数，当方法执行结果后，参数user1中就已经包含了id值！

@Test
public void insert() {
	// 测试功能
	User user = new User();
	user.setUsername("java");
	user.setPassword("1234");
	
	System.out.println("执行前：" + user);
	Integer rows = userMapper.insert(user);
	System.out.println("rows=" + rows);
	System.out.println("执行后：" + user);
}

小结

如果某次查询涉及多张表，存在关联查询，通常是没有匹配的实体类可以直接使用的，在这种情况下，就需要自定义VO类。

VO类与实体类的代码表现基本相似，只是定位不同，实体类是与数据表对应的，而VO类是为了满足编码需求，更方便的获取查询结果而存在的！

VO类的属性的设计原则完全取决于所需要执行的查询的结果。

产生了关联查询后，可以直接用VO类作为resultType，但是，如果查询结果中存在数据之间的1对多等关系，则需要配置<resultMap>。

5. 动态SQL

在MyBatis中配置映射时，允许使用例如<if>此类的标签，使得每次执行的SQL语句可以产生动态调整，则称之为动态SQL。

目标：实现根据id修改用户信息，可修改的字段有：密码、年龄、手机号码、电子邮件，如果执行的参数中，某项数据为null，则不修改原有值，例如修改时，参数中没有年龄值，则不修改原有的年龄，其它字段也是相同的处理方式。

注意：在编写动态SQL时，参数直接写名字即可，例如test="age != null"中的age就是参数的名称，不需要使用#{}这类的语法！

目标：一次删除多条数据，这些数据的id是作为参数体现的，但是，是没有规律的。
在接口中声明抽象方法：

Integer deleteUserByIds(List<Integer> ids);

以上方法的设计，参数可以是List<Integer>，也可以是Integer[]。

然后，配置映射：

<!-- collection：使用哪个集合，取值使用list或array -->
<!-- item：每次遍历到的元素的名称 -->
<!-- separator：IN内部的各个值之间使用的分隔符 -->
<!-- open：遍历后的结果的起始字符 -->
<!-- close：遍历后的结果的结束字符 -->
<delete id="deleteUserByIds">
	DELETE FROM t_user 
	WHERE id IN 
	<foreach collection="list"
		item="id" separator=","
		open="(" close=")">
		#{id}
	</foreach>
</delete>

注意：在中的collection属性，当抽象方法只有1个参数时，取值为list或array，根据参数类型决定，当抽象方法的参数超过1个时，该属性的值为参数的名称（参数的注解中使用的名称）！

关于动态SQL，主要掌握<if>和<foreach>的使用！

框架执行流程
1、将sql语句和数据库配置信息保存在配置文件
2、在Mybatis运行时，将配置信息存储Configration对象
2、在创建SqlSession对象提供属性
1）、Configration对象
2）、dirty：true sql语句执行完毕后 可以事务提交
false sql语句执行发送错误 事务可以回滚
3、Executor 执行器对象：
创建Statement对象，在创建过程中，依靠MapperStatement对象将赋值内容与sql占位
符进行绑定
4、SqlSession.commit():根据此时dirty属性决定提交和回滚
5、SqlSession.close()

mybatis 实体类的属性名与表中字段名不一致
1、在写sql语句的时候写别名
2、在Mybatis的全局配置文件中开启驼峰命名规则， 在官方文档复制，将false改为true
3、在Mapper映射文件中使用resultMap来自定义映射规则

resultMap 自定义高级映射，将表中的字段名和实体类的属性一一对应

sql语句